az k8s-configuration flux kustomization

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 kustomization command. Learn more about extensions.

Commands to manage Kustomizations associated with Flux v2 Kubernetes configurations.

Commands

Name	Description	Type	Status
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 kustomization create

Create a Kustomization associated with a Flux v2 Kubernetes configuration.

az k8s-configuration flux kustomization create --cluster-name
                                               --cluster-type {connectedClusters, managedClusters, provisionedClusters}
                                               --kustomization-name
                                               --name
                                               --resource-group
                                               [--cluster-resource-provider]
                                               [--dependencies]
                                               [--disable-health-check {false, true}]
                                               [--force {false, true}]
                                               [--interval]
                                               [--no-wait]
                                               [--path]
                                               [--prune {false, true}]
                                               [--retry-interval]
                                               [--timeout]

Examples

Create a Kustomization associated with a Flux v2 Kubernetes configuration

az k8s-configuration flux kustomization create --resource-group my-resource-group \
--cluster-name mycluster --cluster-type connectedClusters --name myconfig \
--kustomization-name my-kustomization-2 --path ./my/path --prune --force

Required Parameters

--cluster-name -c

Name of the Kubernetes cluster.

--cluster-type -t

Specify Arc connected clusters or AKS managed clusters or provisioned clusters.

Accepted values: connectedClusters, managedClusters, provisionedClusters

--kustomization-name -k

Specify the name of the kustomization to target.

--name -n

Name of the flux configuration.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--cluster-resource-provider --cluster-rp

Cluster Resource Provider name for this clusterType (Required for provisionedClusters).

--dependencies --depends --depends-on

Comma-separated list of kustomization dependencies.

--disable-health-check

Disable health checks for kustomizations applied to the cluster.

Accepted values: false, true

--force

Re-create resources that cannot be updated on the cluster (i.e. jobs).

Accepted values: false, true

--interval --sync-interval

Time between reconciliations of the kustomization on the cluster.

--no-wait

Do not wait for the long-running operation to finish.

Default value: False

--path

Specify the path in the source that the kustomization should apply.

--prune

Garbage collect resources deployed by the kustomization on the cluster.

Accepted values: false, true

--retry-interval

Time between reconciliations of the kustomization on the cluster on failures, defaults to --sync-interval.

--timeout

Maximum time to reconcile the kustomization before timing out.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az k8s-configuration flux kustomization delete

Delete a Kustomization associated with a Flux v2 Kubernetes configuration.

az k8s-configuration flux kustomization delete --cluster-name
                                               --cluster-type {connectedClusters, managedClusters, provisionedClusters}
                                               --kustomization-name
                                               --name
                                               --resource-group
                                               [--cluster-resource-provider]
                                               [--no-wait]
                                               [--yes]

Examples

Delete an existing Kustomization associated with a Flux v2 Kubernetes configuration

az k8s-configuration flux kustomization delete --resource-group my-resource-group \
--cluster-name mycluster --cluster-type connectedClusters --name myconfig \
--kustomization-name my-kustomization

Required Parameters

--cluster-name -c

Name of the Kubernetes cluster.

--cluster-type -t

Specify Arc connected clusters or AKS managed clusters or provisioned clusters.

Accepted values: connectedClusters, managedClusters, provisionedClusters

--kustomization-name -k

Specify the name of the kustomization to target.

--name -n

Name of the flux configuration.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--cluster-resource-provider --cluster-rp

Cluster Resource Provider name for this clusterType (Required for provisionedClusters).

--no-wait

Do not wait for the long-running operation to finish.

Default value: False

--yes -y

Do not prompt for confirmation.

Default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az k8s-configuration flux kustomization list

List Kustomizations associated with a Flux v2 Kubernetes configuration.

az k8s-configuration flux kustomization list --cluster-name
                                             --cluster-type {connectedClusters, managedClusters, provisionedClusters}
                                             --name
                                             --resource-group
                                             [--cluster-resource-provider]

Examples

List all Kustomizations associated with a Flux v2 Kubernetes configuration

az k8s-configuration flux kustomization list --resource-group my-resource-group \
--cluster-name mycluster --name myconfig --cluster-type connectedClusters

Required Parameters

--cluster-name -c

Name of the Kubernetes cluster.

--cluster-type -t

Specify Arc connected clusters or AKS managed clusters or provisioned clusters.

Accepted values: connectedClusters, managedClusters, provisionedClusters

--name -n

Name of the flux configuration.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--cluster-resource-provider --cluster-rp

Cluster Resource Provider name for this clusterType (Required for provisionedClusters).

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az k8s-configuration flux kustomization show

Show a Kustomization associated with a Flux v2 Kubernetes configuration.

az k8s-configuration flux kustomization show --cluster-name
                                             --cluster-type {connectedClusters, managedClusters, provisionedClusters}
                                             --kustomization-name
                                             --name
                                             --resource-group
                                             [--cluster-resource-provider]

Examples

Show details of a Kustomization associated with a Flux v2 Kubernetes configuration

az k8s-configuration flux kustomization show --resource-group my-resource-group \
--cluster-name mycluster --cluster-type connectedClusters --name myconfig \
--kustomization-name my-kustomization

Required Parameters

--cluster-name -c

Name of the Kubernetes cluster.

--cluster-type -t

Specify Arc connected clusters or AKS managed clusters or provisioned clusters.

Accepted values: connectedClusters, managedClusters, provisionedClusters

--kustomization-name -k

Specify the name of the kustomization to target.

--name -n

Name of the flux configuration.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--cluster-resource-provider --cluster-rp

Cluster Resource Provider name for this clusterType (Required for provisionedClusters).

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az k8s-configuration flux kustomization update

Update a Kustomization associated with a Flux v2 Kubernetes configuration.

az k8s-configuration flux kustomization update --cluster-name
                                               --cluster-type {connectedClusters, managedClusters, provisionedClusters}
                                               --kustomization-name
                                               --name
                                               --resource-group
                                               [--cluster-resource-provider]
                                               [--dependencies]
                                               [--disable-health-check {false, true}]
                                               [--force {false, true}]
                                               [--interval]
                                               [--no-wait]
                                               [--path]
                                               [--prune {false, true}]
                                               [--retry-interval]
                                               [--timeout]

Examples

Update a Kustomization associated with a Flux v2 Kubernetes configuration

az k8s-configuration flux kustomization update --resource-group my-resource-group \
--cluster-name mycluster --cluster-type connectedClusters --name myconfig \
--kustomization-name my-kustomization --path ./my/new-path --prune --force --disable-health-check

Required Parameters

--cluster-name -c

Name of the Kubernetes cluster.

--cluster-type -t

Specify Arc connected clusters or AKS managed clusters or provisioned clusters.

Accepted values: connectedClusters, managedClusters, provisionedClusters

--kustomization-name -k

Specify the name of the kustomization to target.

--name -n

Name of the flux configuration.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--cluster-resource-provider --cluster-rp

Cluster Resource Provider name for this clusterType (Required for provisionedClusters).

--dependencies --depends --depends-on

Comma-separated list of kustomization dependencies.

--disable-health-check

Disable health checks for kustomizations applied to the cluster.

Accepted values: false, true

--force

Re-create resources that cannot be updated on the cluster (i.e. jobs).

Accepted values: false, true

--interval --sync-interval

Time between reconciliations of the kustomization on the cluster.

--no-wait

Do not wait for the long-running operation to finish.

Default value: False

--path

Specify the path in the source that the kustomization should apply.

--prune

Garbage collect resources deployed by the kustomization on the cluster.

Accepted values: false, true

--retry-interval

Time between reconciliations of the kustomization on the cluster on failures, defaults to --sync-interval.

--timeout

Maximum time to reconcile the kustomization before timing out.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.