az k8sconfiguration

Commands to manage Kubernetes configuration.

Commands

az k8sconfiguration create

Create a Kubernetes configuration.

az k8sconfiguration delete

Delete a Kubernetes configuration.

az k8sconfiguration list

List Kubernetes configurations.

az k8sconfiguration show

Show details of a Kubernetes configuration.

az k8sconfiguration update

Update a Kubernetes configuration.

az k8sconfiguration create

Create a Kubernetes configuration.

az k8sconfiguration create --cluster-name
                           --cluster-type {connectedClusters, managedClusters}
                           --name
                           --repository-url
                           --resource-group
                           --scope {cluster, namespace}
                           [--enable-helm-operator {false, true}]
                           [--helm-operator-params]
                           [--helm-operator-version]
                           [--operator-instance-name]
                           [--operator-namespace]
                           [--operator-params]
                           [--operator-type]

Examples

Create a Kubernetes configuration

az k8sconfiguration create --resource-group MyResourceGroup --cluster-name MyClusterName \
--cluster-type connectedClusters --name MyConfigurationName --operator-instance-name OperatorInst01 \
--operator-namespace OperatorNamespace01 --repository-url git://github.com/fluxHowTo/flux-get-started \
--operator-params "'--git-readonly'" --enable-helm-operator --helm-operator-version 0.6.0 \
--scope namespace --helm-operator-params '--set helm.versions=v3'

Required Parameters

--cluster-name -c

Name of the Kubernetes cluster.

--cluster-type

Specify Arc clusters or AKS managed clusters.

accepted values: connectedClusters, managedClusters
--name -n

Name of the Kubernetes Configuration.

--repository-url -u

Url of the source control repository.

--resource-group -g

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

--scope

Specify scope of the operator to be 'namespace' or 'cluster'.

accepted values: cluster, namespace

Optional Parameters

--enable-helm-operator

Enable support for Helm chart deployments.

accepted values: false, true
--helm-operator-params

Chart values for the Helm Operator (if enabled).

--helm-operator-version

Chart version of the Helm Operator (if enabled).

default value: 0.3.0
--operator-instance-name

Instance name of the Operator.

--operator-namespace

Namespace in which to install the Operator.

default value: default
--operator-params

Parameters for the Operator.

--operator-type

Type of the operator. Valid value is 'flux'.

default value: flux

az k8sconfiguration delete

Delete a Kubernetes configuration.

az k8sconfiguration delete --cluster-name
                           --cluster-type {connectedClusters, managedClusters}
                           --name
                           --resource-group
                           [--yes]

Examples

Delete a Kubernetes configuration

az k8sconfiguration delete --resource-group MyResourceGroup --cluster-name MyClusterName \
--cluster-type connectedClusters --name MyConfigurationName

Required Parameters

--cluster-name -c

Name of the Kubernetes cluster.

--cluster-type

Specify Arc clusters or AKS managed clusters.

accepted values: connectedClusters, managedClusters
--name -n

Name of the Kubernetes Configuration.

--resource-group -g

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

Optional Parameters

--yes -y

Do not prompt for confirmation.

az k8sconfiguration list

List Kubernetes configurations.

az k8sconfiguration list --cluster-name
                         --cluster-type {connectedClusters, managedClusters}
                         --resource-group

Examples

List all Kubernetes configurations of a cluster

az k8sconfiguration list --resource-group MyResourceGroup --cluster-name MyClusterName \
--cluster-type connectedClusters

Required Parameters

--cluster-name -c

Name of the Kubernetes cluster.

--cluster-type

Specify Arc clusters or AKS managed clusters.

accepted values: connectedClusters, managedClusters
--resource-group -g

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

az k8sconfiguration show

Show details of a Kubernetes configuration.

az k8sconfiguration show --cluster-name
                         --cluster-type {connectedClusters, managedClusters}
                         --name
                         --resource-group

Examples

Show a Kubernetes configuration

az k8sconfiguration show --resource-group MyResourceGroup --cluster-name MyClusterName \
--cluster-type connectedClusters --name MyConfigurationName

Required Parameters

--cluster-name -c

Name of the Kubernetes cluster.

--cluster-type

Specify Arc clusters or AKS managed clusters.

accepted values: connectedClusters, managedClusters
--name -n

Name of the Kubernetes Configuration.

--resource-group -g

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

az k8sconfiguration update

Update a Kubernetes configuration.

az k8sconfiguration update --cluster-name
                           --cluster-type {connectedClusters, managedClusters}
                           --name
                           --resource-group
                           [--enable-helm-operator {false, true}]
                           [--helm-operator-params]
                           [--helm-operator-version]
                           [--operator-params]
                           [--repository-url]

Examples

Update an existing Kubernetes configuration

az k8sconfiguration update --resource-group MyResourceGroup --cluster-name MyClusterName \
--cluster-type connectedClusters --name MyConfigurationName --enable-helm-operator \
--repository-url git://github.com/fluxHowTo/flux-get-started --operator-params "'--git-readonly'" \
--helm-operator-version 0.6.0 --helm-operator-params '--set helm.versions=v3'

Required Parameters

--cluster-name -c

Name of the Kubernetes cluster.

--cluster-type

Specify Arc clusters or AKS managed clusters.

accepted values: connectedClusters, managedClusters
--name -n

Name of the Kubernetes Configuration.

--resource-group -g

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

Optional Parameters

--enable-helm-operator

Enable support for Helm chart deployments.

accepted values: false, true
--helm-operator-params

Chart values for the Helm Operator (if enabled).

--helm-operator-version

Chart version of the Helm Operator (if enabled).

--operator-params

Parameters for the Operator.

--repository-url -u

Url of the source control repository.