akskubeconfig
A utility to generate a kubeconfig file for all AKS clusters in one or more Azure subscriptions.
Why
Managing and updating a Kubernetes configuration file for AKS clusters can be a nightmare when you manage multiple clusters across multiple subscriptions. This tool aims to simplify the process by generating a kubeconfig file for all AKS clusters that you have access to in all subscriptions that you have access to.
While checking all subscriptions is default behavior, you can also specify a list of subscriptions to check. This can be useful if you have access to a large number of subscriptions and only want to check a subset of them.
It also supports generating that kubeconfig file using a number of different authentication flows, including:
- Default (using the default authentication flow)
- Device Flow (using the device flow authentication flow)
- Interactive (using the interactive web browser authentication flow)
- Service Principal Secret (using a service principal secret to authenticate)
- Service Principal PFX (using a service principal pfx certificate to authenticate)
- Managed Identity (using a managed identity to authenticate)
- Managed Identity ID (using a managed identity to authenticate)
- Azure CLI (using the Azure CLI to authenticate)
- Workload Identity (using a workload identity to authenticate)
This can be useful for a number of reasons, such as generating a bulk kubeconfig file on-the-fly for CI/CD pipelines, or for generating a kubeconfig file for a specific cluster in a specific subscription.
Installation
akskubeconfig is implemented in Python. Assuming you have a
Python interpreter and pip installed you should be able to install with:
pip install akskubeconfig
If you are on a Mac, you may instead want to install it with pipx to avoid breaking system packages:
brew install pipx
pipx install akskubeconfig
Usage
The simplest usage is to just run the tool and specify an output file for it to write to:
akskubeconfig -o ~/.kube/config
Handling Permission Errors
By default, the tool will error if you don't have the required permissions (Microsoft.ContainerService/managedClusters/listClusterUserCredential/action) for any cluster. If you'd like to generate a kubeconfig for only the clusters you have access to, use the --soft-fail flag:
akskubeconfig -o ~/.kube/config --soft-fail
This will log warnings for clusters where access is denied and continue processing the remaining clusters.
Available Options
The tool provides a number of options to modify its behavior and output:
akskubeconfig --help
usage: akskubeconfig [-h] [-v] [-s SUBSCRIPTIONS] [--client-id CLIENT_ID] [--tenant-id TENANT_ID] [--client-secret CLIENT_SECRET] [--certificate-path CERTIFICATE_PATH] [--server-id SERVER_ID]
[--environment ENVIRONMENT] [--default | --device-flow | --interactive | --sp-secret | --sp-pfx | --managed-identity | --managed-identity-id | --az-cli | --workload-identity]
[--json | --yaml] [-m MAX_THREADS] [-o OUTFILE] [--cluster-name CLUSTER_NAME] [--soft-fail]
options:
-h, --help show this help message and exit
-v, --verbose Increase output verbosity
-s, --subscriptions SUBSCRIPTIONS
A comma separated list of subscription to use. If omitted, all subscriptions will be checked.
--client-id CLIENT_ID
Override the client id to write into the kubeconfig. Only applicable if required by the selected authentication flow.
--tenant-id TENANT_ID
Override the tenant id to write into the kubeconfig. Only applicable if required by the selected authentication flow.
--client-secret CLIENT_SECRET
Override the client secret to write into the kubeconfig. Only applicable if required by the selected authentication flow.
--certificate-path CERTIFICATE_PATH
Override the certificate path to write into the kubeconfig. Only applicable if required by the selected authentication flow.
--server-id SERVER_ID
Override the server id to write into the kubeconfig.
--environment ENVIRONMENT
Override the environment to write into the kubeconfig.
--default Use the default flow authenticate within the generated kubeconfig (default)
--device-flow Use device flow to authenticate within the generated kubeconfig
--interactive Use the interactive web browser flow to authenticate within the generated kubeconfig
--sp-secret Use a service principal secret to authenticate within the generated kubeconfig
--sp-pfx Use a service principal pfx certificate to authenticate within the generated kubeconfig
--managed-identity Use a managed identity to authenticate within the generated kubeconfig
--managed-identity-id
Use a managed identity to authenticate within the generated kubeconfig
--az-cli Use the Azure CLI to authenticate within the generated kubeconfig
--workload-identity Use a workload identity to authenticate within the generated kubeconfig
--json Output as JSON
--yaml Output as YAML (default)
-m, --max-threads MAX_THREADS
Maximum number of threads to use
-o, --outfile OUTFILE
Output file
--cluster-name CLUSTER_NAME
Name of the specific cluster to target (required when using --specific-cluster)
--soft-fail Continue processing other clusters if access is denied for a specific cluster
Metadata
Release files for akskubeconfig 1.2.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| akskubeconfig-1.2.4.tar.gz | 25.5 kB | Without provenance | Details for akskubeconfig-1.2.4.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| akskubeconfig-1.2.4-py3-none-any.whl | Python 3 | none | any | Details for akskubeconfig-1.2.4-py3-none-any.whl |
Total release size: 53.7 kB
Release files / akskubeconfig-1.2.4.tar.gz
| Download URL | akskubeconfig-1.2.4.tar.gz |
|---|---|
| Size | 25.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
88f1e69c03b39942b65a89ce6b077da4bf91839b2a364b95249e78be6ce3ee12
|
|
BLAKE2b-256 checksum How to use checksums |
f967d7a0f99289028162572f1e7e96e38ef6d16bc02990d8effdfe14d39d1023
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.5.1 CPython/3.14.8 Linux/6.8.0-1067-azure
|
Release files / akskubeconfig-1.2.4-py3-none-any.whl
| Download URL | akskubeconfig-1.2.4-py3-none-any.whl |
|---|---|
| Size | 28.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
bbdf2b692c243c0946c6fbe1c27748914c3364ee334bb6f1bdc707906c0f3071
|
|
BLAKE2b-256 checksum How to use checksums |
0680104346ef43327474cd9e05d886ec148e4352a41fd1b7f570df09f24c514c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.5.1 CPython/3.14.8 Linux/6.8.0-1067-azure
|
Security for akskubeconfig 1.2.4
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.