AKS Checklist

The AKS Checklist provides an exhaustive list of elements required to prepare an Azure Kubernetes Service (AKS) cluster for production. It is based on common Kubernetes best practices and official Microsoft documentation.

Users can access the deployed version of the checklist at https://aka.ms/the-aks-checklist.

The localization checker is a shell script designed to identify discrepancies between different language directories (e.g., missing files or differences in the number of JSON elements). It compares a base language (typically en) against target languages (like fr or es) to ensure all best practices and content items are present across all translations.

Prerequisites:

• The script requires jq to be installed for parsing JSON files.

Execution: Run the script by sourcing it in your terminal.

. ./localization-checker.sh

The tool provides feedback on two main types of localization discrepancies:

1. Element Count Mismatches: When files exist in both languages but contain a different number of JSON elements (e.g., Files ../en/items/clustersetup.json(10) and fr (8) do not have the same number of elements). This usually indicates missing content within a file.
2. Missing Files: When a file present in the base language is missing in the target language (e.g., ../es/items/windows.json does not exist).

Upon completion, the tool generates a result.txt file containing the full comparison details.

To contribute new best practices to the checklist, follow these steps:

1. Fork the repository.
2. Add the best practices to the items.json file.
   • Note: Entries must be in English, as English is the single source of truth.
3. Submit a pull request on the staging branch.

Guidelines:

• Aim for exhaustiveness while focusing on common usage.
• Custom best practices specific to a single context should be applied locally rather than added to the global list.