az k8s-configuration flux
Note
This reference is part of the k8s-configuration extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an az k8s-configuration flux command. Learn more about extensions.
Commands to manage Flux v2 Kubernetes configurations.
Commands
Name | Description | Type | Status |
---|---|---|---|
az k8s-configuration flux create |
Create a Flux v2 Kubernetes configuration. |
Extension | GA |
az k8s-configuration flux delete |
Delete a Flux v2 Kubernetes configuration. |
Extension | GA |
az k8s-configuration flux deployed-object |
Commands to see deployed objects associated with Flux v2 Kubernetes configurations. |
Extension | GA |
az k8s-configuration flux deployed-object list |
List deployed objects associated with a Flux v2 Kubernetes configuration. |
Extension | GA |
az k8s-configuration flux deployed-object show |
Show a deployed object associated with a Flux v2 Kubernetes configuration. |
Extension | GA |
az k8s-configuration flux kustomization |
Commands to manage Kustomizations associated with Flux v2 Kubernetes configurations. |
Extension | GA |
az k8s-configuration flux kustomization create |
Create a Kustomization associated with a Flux v2 Kubernetes configuration. |
Extension | GA |
az k8s-configuration flux kustomization delete |
Delete a Kustomization associated with a Flux v2 Kubernetes configuration. |
Extension | GA |
az k8s-configuration flux kustomization list |
List Kustomizations associated with a Flux v2 Kubernetes configuration. |
Extension | GA |
az k8s-configuration flux kustomization show |
Show a Kustomization associated with a Flux v2 Kubernetes configuration. |
Extension | GA |
az k8s-configuration flux kustomization update |
Update a Kustomization associated with a Flux v2 Kubernetes configuration. |
Extension | GA |
az k8s-configuration flux list |
List all Flux v2 Kubernetes configurations. |
Extension | GA |
az k8s-configuration flux show |
Show a Flux v2 Kubernetes configuration. |
Extension | GA |
az k8s-configuration flux update |
Update a Flux v2 Kubernetes configuration. |
Extension | GA |
az k8s-configuration flux create
Create a Flux v2 Kubernetes configuration.
az k8s-configuration flux create --cluster-name
--cluster-type {connectedClusters, managedClusters, provisionedClusters}
--name
--resource-group
--url
[--account-key]
[--branch]
[--bucket-access-key]
[--bucket-insecure {false, true}]
[--bucket-name]
[--bucket-secret-key]
[--cluster-resource-provider --cluster-rp]
[--commit]
[--container-name]
[--https-ca-cert]
[--https-ca-cert-file]
[--https-key]
[--https-user]
[--interval --sync-interval]
[--kind {azblob, bucket, git}]
[--known-hosts]
[--known-hosts-file]
[--kustomization]
[--local-auth-ref --local-ref]
[--managed-identity-client-id --mi-client-id]
[--namespace --ns]
[--no-wait]
[--provider {azure, generic}]
[--sas-token]
[--scope {cluster, namespace}]
[--semver]
[--service-principal-client-certificate --sp-client-cert]
[--service-principal-client-certificate-password --sp-cert-password]
[--service-principal-client-certificate-send-chain --sp-cert-send-chain]
[--service-principal-client-id --sp-client-id]
[--service-principal-client-secret --sp-client-secret]
[--service-principal-tenant-id --sp-tenant-id]
[--ssh-private-key]
[--ssh-private-key-file]
[--suspend {false, true}]
[--tag]
[--timeout]
Examples
Create a Flux v2 Kubernetes configuration
az k8s-configuration flux create --resource-group my-resource-group \
--cluster-name mycluster --cluster-type connectedClusters \
--name myconfig --scope cluster --namespace my-namespace \
--kind git --url https://github.com/Azure/arc-k8s-demo \
--branch main --kustomization name=my-kustomization
Create a Kubernetes v2 Flux Configuration with Bucket Source Kind
az k8s-configuration flux create --resource-group my-resource-group \
--cluster-name mycluster --cluster-type connectedClusters \
--name myconfig --scope cluster --namespace my-namespace \
--kind bucket --url https://bucket-provider.minio.io \
--bucket-name my-bucket --kustomization name=my-kustomization \
--bucket-access-key my-access-key --bucket-secret-key my-secret-key
Create a Kubernetes v2 Flux Configuration with Azure Blob Source Kind
az k8s-configuration flux create --resource-group my-resource-group \
--cluster-name mycluster --cluster-type connectedClusters \
--name myconfig --scope cluster --namespace my-namespace \
--kind azblob --url https://mystorageaccount.blob.core.windows.net \
--container-name my-container --kustomization name=my-kustomization \
--account-key my-account-key
Required Parameters
Name of the Kubernetes cluster.
Specify Arc connected clusters or AKS managed clusters or provisioned clusters.
Property | Value |
---|---|
Accepted values: | connectedClusters, managedClusters, provisionedClusters |
Name of the flux configuration.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
URL of the source to reconcile.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
The Azure Blob Shared Key for authentication.
Property | Value |
---|---|
Parameter group: | Azure Blob Auth Arguments |
Branch within the git source to reconcile with the cluster.
Property | Value |
---|---|
Parameter group: | Git Repo Ref Arguments |
Access Key ID used to authenticate with the bucket.
Property | Value |
---|---|
Parameter group: | Bucket Auth Arguments |
Communicate with a bucket without TLS.
Property | Value |
---|---|
Default value: | False |
Accepted values: | false, true |
Name of the S3 bucket to sync.
Secret Key used to authenticate with the bucket.
Property | Value |
---|---|
Parameter group: | Bucket Auth Arguments |
Cluster Resource Provider name for this clusterType (Required for provisionedClusters).
Commit within the git source to reconcile with the cluster.
Property | Value |
---|---|
Parameter group: | Git Repo Ref Arguments |
Name of the Azure Blob Storage container to sync.
Base64-encoded HTTPS CA certificate for TLS communication with private repository sync.
Property | Value |
---|---|
Parameter group: | Git Auth Arguments |
File path to HTTPS CA certificate file for TLS communication with private repository sync.
Property | Value |
---|---|
Parameter group: | Git Auth Arguments |
HTTPS token/password for private repository sync.
Property | Value |
---|---|
Parameter group: | Git Auth Arguments |
HTTPS username for private repository sync.
Property | Value |
---|---|
Parameter group: | Git Auth Arguments |
Time between reconciliations of the source on the cluster.
Source kind to reconcile.
Property | Value |
---|---|
Default value: | git |
Accepted values: | azblob, bucket, git |
Base64-encoded known_hosts data containing public SSH keys required to access private Git instances.
Property | Value |
---|---|
Parameter group: | Git Auth Arguments |
File path to known_hosts contents containing public SSH keys required to access private Git instances.
Property | Value |
---|---|
Parameter group: | Git Auth Arguments |
Define kustomizations to sync sources with parameters ['name', 'path', 'depends_on', 'timeout', 'sync_interval', 'retry_interval', 'prune', 'force', 'disable_health_check'].
Local reference to a kubernetes secret in the configuration namespace to use for communication to the source.
Property | Value |
---|---|
Parameter group: | Auth Arguments |
The client ID of the managed identity for authentication with Azure Blob.
Property | Value |
---|---|
Parameter group: | Azure Blob Auth Arguments |
Namespace to deploy the configuration.
Property | Value |
---|---|
Default value: | default |
Do not wait for the long-running operation to finish.
Property | Value |
---|---|
Default value: | False |
Name of the provider used for authentication, azure provider can be used to authenticate to Azure DevOps repositories using Managed Identity.
Property | Value |
---|---|
Parameter group: | Git Auth Arguments |
Accepted values: | azure, generic |
The Azure Blob SAS Token for authentication.
Property | Value |
---|---|
Parameter group: | Azure Blob Auth Arguments |
Specify scope of the operator to be 'namespace' or 'cluster'.
Property | Value |
---|---|
Default value: | cluster |
Accepted values: | cluster, namespace |
Semver range within the git source to reconcile with the cluster.
Property | Value |
---|---|
Parameter group: | Git Repo Ref Arguments |
The Base64 encoded client certificate for authenticating a service principal with Azure Blob.
Property | Value |
---|---|
Parameter group: | Azure Blob Auth Arguments |
The password for the client certificate used to authenticate a service principal with Azure Blob.
Property | Value |
---|---|
Parameter group: | Azure Blob Auth Arguments |
Specify whether to include x5c header in client claims when acquiring a token to enable subject name / issuer based authentication for the client certificate.
Property | Value |
---|---|
Parameter group: | Azure Blob Auth Arguments |
Default value: | False |
The client ID for authenticating a service principal with Azure Blob, required for this authentication method.
Property | Value |
---|---|
Parameter group: | Azure Blob Auth Arguments |
The client secret for authenticating a service principal with Azure Blob.
Property | Value |
---|---|
Parameter group: | Azure Blob Auth Arguments |
The tenant ID for authenticating a service principal with Azure Blob, required for this authentication method.
Property | Value |
---|---|
Parameter group: | Azure Blob Auth Arguments |
Base64-encoded private ssh key for private repository sync.
Property | Value |
---|---|
Parameter group: | Git Auth Arguments |
File path to private ssh key for private repository sync.
Property | Value |
---|---|
Parameter group: | Git Auth Arguments |
Suspend the reconciliation of the source and kustomizations associated with this configuration.
Property | Value |
---|---|
Default value: | False |
Accepted values: | false, true |
Tag within the git source to reconcile with the cluster.
Property | Value |
---|---|
Parameter group: | Git Repo Ref Arguments |
Maximum time to reconcile the source before timing out.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az k8s-configuration flux delete
Delete a Flux v2 Kubernetes configuration.
az k8s-configuration flux delete --cluster-name
--cluster-type {connectedClusters, managedClusters, provisionedClusters}
--name
--resource-group
[--cluster-resource-provider --cluster-rp]
[--force {false, true}]
[--no-wait]
[--yes]
Examples
Delete an existing Flux v2 Kubernetes configuration
az k8s-configuration flux delete --resource-group my-resource-group \
--cluster-name mycluster --cluster-type connectedClusters --name myconfig
Required Parameters
Name of the Kubernetes cluster.
Specify Arc connected clusters or AKS managed clusters or provisioned clusters.
Property | Value |
---|---|
Accepted values: | connectedClusters, managedClusters, provisionedClusters |
Name of the flux configuration.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Cluster Resource Provider name for this clusterType (Required for provisionedClusters).
Force delete the flux configuration from the cluster.
Property | Value |
---|---|
Default value: | False |
Accepted values: | false, true |
Do not wait for the long-running operation to finish.
Property | Value |
---|---|
Default value: | False |
Do not prompt for confirmation.
Property | Value |
---|---|
Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az k8s-configuration flux list
List all Flux v2 Kubernetes configurations.
az k8s-configuration flux list --cluster-name
--cluster-type {connectedClusters, managedClusters, provisionedClusters}
--resource-group
[--cluster-resource-provider --cluster-rp]
Examples
List Flux v2 Kubernetes configurations on a cluster
az k8s-configuration flux list --resource-group my-resource-group \
--cluster-name mycluster --cluster-type connectedClusters
Required Parameters
Name of the Kubernetes cluster.
Specify Arc connected clusters or AKS managed clusters or provisioned clusters.
Property | Value |
---|---|
Accepted values: | connectedClusters, managedClusters, provisionedClusters |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Cluster Resource Provider name for this clusterType (Required for provisionedClusters).
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az k8s-configuration flux show
Show a Flux v2 Kubernetes configuration.
az k8s-configuration flux show --cluster-name
--cluster-type {connectedClusters, managedClusters, provisionedClusters}
--name
--resource-group
[--cluster-resource-provider --cluster-rp]
Examples
Show details of a Flux v2 Kubernetes configuration
az k8s-configuration flux show --resource-group my-resource-group \
--cluster-name mycluster --cluster-type connectedClusters --name myconfig
Required Parameters
Name of the Kubernetes cluster.
Specify Arc connected clusters or AKS managed clusters or provisioned clusters.
Property | Value |
---|---|
Accepted values: | connectedClusters, managedClusters, provisionedClusters |
Name of the flux configuration.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Cluster Resource Provider name for this clusterType (Required for provisionedClusters).
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az k8s-configuration flux update
Update a Flux v2 Kubernetes configuration.
az k8s-configuration flux update --cluster-name
--cluster-type {connectedClusters, managedClusters, provisionedClusters}
--name
--resource-group
[--account-key]
[--branch]
[--bucket-access-key]
[--bucket-insecure {false, true}]
[--bucket-name]
[--bucket-secret-key]
[--cluster-resource-provider --cluster-rp]
[--commit]
[--container-name]
[--https-ca-cert]
[--https-ca-cert-file]
[--https-key]
[--https-user]
[--interval --sync-interval]
[--kind {azblob, bucket, git}]
[--known-hosts]
[--known-hosts-file]
[--kustomization]
[--local-auth-ref --local-ref]
[--managed-identity-client-id --mi-client-id]
[--no-wait]
[--provider {azure, generic}]
[--sas-token]
[--semver]
[--service-principal-client-certificate --sp-client-cert]
[--service-principal-client-certificate-password --sp-cert-password]
[--service-principal-client-certificate-send-chain --sp-cert-send-chain]
[--service-principal-client-id --sp-client-id]
[--service-principal-client-secret --sp-client-secret]
[--service-principal-tenant-id --sp-tenant-id]
[--ssh-private-key]
[--ssh-private-key-file]
[--suspend {false, true}]
[--tag]
[--timeout]
[--url]
[--yes]
Examples
Update a Flux v2 Kubernetes configuration
az k8s-configuration flux update --resource-group my-resource-group \
--cluster-name mycluster --cluster-type connectedClusters --name myconfig \
--url https://github.com/Azure/arc-k8s-demo --branch main \
--kustomization name=my-kustomization path=./my/new-path
Update a Flux v2 Kubernetes configuration with Bucket Source Kind to connect insecurely
az k8s-configuration flux update --resource-group my-resource-group \
--cluster-name mycluster --cluster-type connectedClusters --name myconfig \
--bucket-insecure
Update a Flux v2 Kubernetes configuration with Azure Blob Source Kind with another container name
az k8s-configuration flux update --resource-group my-resource-group \
--cluster-name mycluster --cluster-type connectedClusters --name myconfig \
--container-name other-container
Required Parameters
Name of the Kubernetes cluster.
Specify Arc connected clusters or AKS managed clusters or provisioned clusters.
Property | Value |
---|---|
Accepted values: | connectedClusters, managedClusters, provisionedClusters |
Name of the flux configuration.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
The Azure Blob Shared Key for authentication.
Property | Value |
---|---|
Parameter group: | Azure Blob Auth Arguments |
Branch within the git source to reconcile with the cluster.
Property | Value |
---|---|
Parameter group: | Git Repo Ref Arguments |
Access Key ID used to authenticate with the bucket.
Property | Value |
---|---|
Parameter group: | Bucket Auth Arguments |
Communicate with a bucket without TLS.
Property | Value |
---|---|
Accepted values: | false, true |
Name of the S3 bucket to sync.
Secret Key used to authenticate with the bucket.
Property | Value |
---|---|
Parameter group: | Bucket Auth Arguments |
Cluster Resource Provider name for this clusterType (Required for provisionedClusters).
Commit within the git source to reconcile with the cluster.
Property | Value |
---|---|
Parameter group: | Git Repo Ref Arguments |
Name of the Azure Blob Storage container to sync.
Base64-encoded HTTPS CA certificate for TLS communication with private repository sync.
Property | Value |
---|---|
Parameter group: | Git Auth Arguments |
File path to HTTPS CA certificate file for TLS communication with private repository sync.
Property | Value |
---|---|
Parameter group: | Git Auth Arguments |
HTTPS token/password for private repository sync.
Property | Value |
---|---|
Parameter group: | Git Auth Arguments |
HTTPS username for private repository sync.
Property | Value |
---|---|
Parameter group: | Git Auth Arguments |
Time between reconciliations of the source on the cluster.
Source kind to reconcile.
Property | Value |
---|---|
Accepted values: | azblob, bucket, git |
Base64-encoded known_hosts data containing public SSH keys required to access private Git instances.
Property | Value |
---|---|
Parameter group: | Git Auth Arguments |
File path to known_hosts contents containing public SSH keys required to access private Git instances.
Property | Value |
---|---|
Parameter group: | Git Auth Arguments |
Define kustomizations to sync sources with parameters ['name', 'path', 'depends_on', 'timeout', 'sync_interval', 'retry_interval', 'prune', 'force', 'disable_health_check'].
Local reference to a kubernetes secret in the configuration namespace to use for communication to the source.
Property | Value |
---|---|
Parameter group: | Auth Arguments |
The client ID of the managed identity for authentication with Azure Blob.
Property | Value |
---|---|
Parameter group: | Azure Blob Auth Arguments |
Do not wait for the long-running operation to finish.
Property | Value |
---|---|
Default value: | False |
Name of the provider used for authentication, azure provider can be used to authenticate to Azure DevOps repositories using Managed Identity.
Property | Value |
---|---|
Parameter group: | Git Auth Arguments |
Accepted values: | azure, generic |
The Azure Blob SAS Token for authentication.
Property | Value |
---|---|
Parameter group: | Azure Blob Auth Arguments |
Semver range within the git source to reconcile with the cluster.
Property | Value |
---|---|
Parameter group: | Git Repo Ref Arguments |
The Base64 encoded client certificate for authenticating a service principal with Azure Blob.
Property | Value |
---|---|
Parameter group: | Azure Blob Auth Arguments |
The password for the client certificate used to authenticate a service principal with Azure Blob.
Property | Value |
---|---|
Parameter group: | Azure Blob Auth Arguments |
Specify whether to include x5c header in client claims when acquiring a token to enable subject name / issuer based authentication for the client certificate.
Property | Value |
---|---|
Parameter group: | Azure Blob Auth Arguments |
Default value: | False |
The client ID for authenticating a service principal with Azure Blob, required for this authentication method.
Property | Value |
---|---|
Parameter group: | Azure Blob Auth Arguments |
The client secret for authenticating a service principal with Azure Blob.
Property | Value |
---|---|
Parameter group: | Azure Blob Auth Arguments |
The tenant ID for authenticating a service principal with Azure Blob, required for this authentication method.
Property | Value |
---|---|
Parameter group: | Azure Blob Auth Arguments |
Base64-encoded private ssh key for private repository sync.
Property | Value |
---|---|
Parameter group: | Git Auth Arguments |
File path to private ssh key for private repository sync.
Property | Value |
---|---|
Parameter group: | Git Auth Arguments |
Suspend the reconciliation of the source and kustomizations associated with this configuration.
Property | Value |
---|---|
Accepted values: | false, true |
Tag within the git source to reconcile with the cluster.
Property | Value |
---|---|
Parameter group: | Git Repo Ref Arguments |
Maximum time to reconcile the source before timing out.
URL of the source to reconcile.
Do not prompt for confirmation.
Property | Value |
---|---|
Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |