az k8s-configuration flux

Note

このリファレンスは、Azure CLI (バージョン 2.15.0 以降) の k8s 構成拡張機能の一部です。 拡張機能は、az k8s-configuration flux コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細をご覧ください。

Flux v2 Kubernetes 構成を管理するコマンド。

コマンド

名前	説明	型	Status
az k8s-configuration flux create	Flux v2 Kubernetes 構成を作成します。	拡張	GA
az k8s-configuration flux delete	Flux v2 Kubernetes 構成を削除します。	拡張	GA
az k8s-configuration flux deployed-object	Flux v2 Kubernetes 構成に関連付けられているデプロイされたオブジェクトを表示するコマンド。	拡張	GA
az k8s-configuration flux deployed-object list	Flux v2 Kubernetes 構成に関連付けられているデプロイされたオブジェクトを一覧表示します。	拡張	GA
az k8s-configuration flux deployed-object show	Flux v2 Kubernetes 構成に関連付けられているデプロイ済みオブジェクトを表示します。	拡張	GA
az k8s-configuration flux kustomization	Flux v2 Kubernetes 構成に関連付けられている Kustomization を管理するコマンド。	拡張	GA
az k8s-configuration flux kustomization create	Flux v2 Kubernetes 構成に関連付けられた Kustomization を作成します。	拡張	GA
az k8s-configuration flux kustomization delete	Flux v2 Kubernetes 構成に関連付けられている Kustomization を削除します。	拡張	GA
az k8s-configuration flux kustomization list	Flux v2 Kubernetes 構成に関連付けられている Kustomization を一覧表示します。	拡張	GA
az k8s-configuration flux kustomization show	Flux v2 Kubernetes 構成に関連付けられている Kustomization を表示します。	拡張	GA
az k8s-configuration flux kustomization update	Flux v2 Kubernetes 構成に関連付けられている Kustomization を更新します。	拡張	GA
az k8s-configuration flux list	Flux v2 Kubernetes のすべての構成を一覧表示します。	拡張	GA
az k8s-configuration flux show	Flux v2 Kubernetes の構成を表示します。	拡張	GA
az k8s-configuration flux update	Flux v2 Kubernetes 構成を更新します。	拡張	GA

az k8s-configuration flux create

Flux v2 Kubernetes 構成を作成します。

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]
                                 [--commit]
                                 [--container-name]
                                 [--https-ca-cert]
                                 [--https-ca-cert-file]
                                 [--https-key]
                                 [--https-user]
                                 [--interval]
                                 [--kind {azblob, bucket, git}]
                                 [--known-hosts]
                                 [--known-hosts-file]
                                 [--kustomization]
                                 [--local-auth-ref]
                                 [--managed-identity-client-id]
                                 [--namespace]
                                 [--no-wait]
                                 [--sas-token]
                                 [--scope {cluster, namespace}]
                                 [--semver]
                                 [--service-principal-client-certificate]
                                 [--service-principal-client-certificate-password]
                                 [--service-principal-client-certificate-send-chain]
                                 [--service-principal-client-id]
                                 [--service-principal-client-secret]
                                 [--service-principal-tenant-id]
                                 [--ssh-private-key]
                                 [--ssh-private-key-file]
                                 [--suspend {false, true}]
                                 [--tag]
                                 [--timeout]

例

Flux v2 Kubernetes 構成を作成する

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

バケット ソースの種類を使用して Kubernetes v2 Flux 構成を作成する

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

Azure BLOB ソースの種類を使用して Kubernetes v2 Flux 構成を作成する

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

必須のパラメーター

--cluster-name -c

Kubernetes クラスターの名前。

--cluster-type -t

Arc 接続クラスターまたは AKS マネージド クラスターまたはプロビジョニング済みクラスターを指定します。

承認された値: connectedClusters, managedClusters, provisionedClusters

--name -n

flux 構成の名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--url -u

調整するソースの URL。

省略可能のパラメーター

--account-key

認証用の Azure BLOB 共有キー。

--branch

クラスターと調整するために Git ソース内で分岐します。

--bucket-access-key

バケットで認証するために使用されるアクセス キー ID。

--bucket-insecure

TLS なしでバケットと通信します。

承認された値: false, true

既定値: False

--bucket-name

同期する S3 バケットの名前。

--bucket-secret-key

バケットで認証するために使用される秘密鍵。

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

この clusterType のクラスター リソース プロバイダー名 (provisionedClusters に必要)。

--commit

クラスターと調整するために Git ソース内でコミットします。

--container-name

同期する Azure Blob Storage コンテナーの名前。

--https-ca-cert

プライベート リポジトリ同期を使用した TLS 通信用の Base64 でエンコードされた HTTPS CA 証明書。

--https-ca-cert-file

プライベート リポジトリ同期との TLS 通信用の HTTPS CA 証明書ファイルへのファイル パス。

--https-key

プライベート リポジトリ同期の HTTPS トークン/パスワード。

--https-user

プライベート リポジトリ同期の HTTPS ユーザー名。

--interval --sync-interval

クラスター上のソースの調整間の時間。

--kind

調整するソースの種類。

承認された値: azblob, bucket, git

既定値: git

--known-hosts

プライベート Git インスタンスにアクセスするために必要な公開 SSH キーを含む Base64 でエンコードされたknown_hosts データ。

--known-hosts-file

プライベート Git インスタンスにアクセスするために必要な公開 SSH キーを含むknown_hostsコンテンツへのファイル パス。

--kustomization -k

パラメーター ['name'、'path'、'depends_on'、'timeout'、'sync_interval'、'retry_interval'、'prune'、'force' を使用してソースを同期する kustomization を定義します。

--local-auth-ref --local-ref

ソースへの通信に使用する構成名前空間内の kubernetes シークレットへのローカル参照。

--managed-identity-client-id --mi-client-id

Azure BLOB を使用した認証用のマネージド ID のクライアント ID。

--namespace --ns

構成をデプロイする名前空間。

既定値: default

--no-wait

実行時間の長い操作の終了を待機しません。

既定値: False

--sas-token

認証用の Azure BLOB SAS トークン。

--scope -s

演算子のスコープを 'namespace' または 'cluster' に指定します。

承認された値: cluster, namespace

既定値: cluster

--semver

クラスターと調整する Git ソース内の Semver 範囲。

--service-principal-client-certificate --sp-client-cert

Azure BLOB でサービス プリンシパルを認証するための Base64 でエンコードされたクライアント証明書。

--service-principal-client-certificate-password --sp-cert-password

Azure BLOB でサービス プリンシパルを認証するために使用するクライアント証明書のパスワード。

--service-principal-client-certificate-send-chain --sp-cert-send-chain

クライアント証明書のサブジェクト名/発行者ベースの認証を有効にするトークンを取得するときに、クライアント要求に x5c ヘッダーを含めるかどうかを指定します。

既定値: False

--service-principal-client-id --sp-client-id

この認証方法に必要な、Azure BLOB を使用してサービス プリンシパルを認証するためのクライアント ID。

--service-principal-client-secret --sp-client-secret

Azure BLOB を使用してサービス プリンシパルを認証するためのクライアント シークレット。

--service-principal-tenant-id --sp-tenant-id

この認証方法に必要な、Azure BLOB を使用してサービス プリンシパルを認証するためのテナント ID。

--ssh-private-key

プライベート リポジトリ同期用の Base64 でエンコードされたプライベート ssh キー。

--ssh-private-key-file

プライベート リポジトリ同期の秘密 SSH キーへのファイル パス。

--suspend

この構成に関連付けられているソースと kustomization の調整を中断します。

承認された値: false, true

既定値: False

--tag

クラスターと調整するために Git ソース内でタグを付ける。

--timeout

ソースを調整してからタイムアウトするまでの最大時間。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az k8s-configuration flux delete

Flux v2 Kubernetes 構成を削除します。

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

例

既存の Flux v2 Kubernetes 構成を削除する

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

必須のパラメーター

--cluster-name -c

Kubernetes クラスターの名前。

--cluster-type -t

Arc 接続クラスターまたは AKS マネージド クラスターまたはプロビジョニング済みクラスターを指定します。

承認された値: connectedClusters, managedClusters, provisionedClusters

--name -n

flux 構成の名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

省略可能のパラメーター

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

この clusterType のクラスター リソース プロバイダー名 (provisionedClusters に必要)。

--force

クラスターから flux 構成を強制的に削除します。

承認された値: false, true

既定値: False

--no-wait

実行時間の長い操作の終了を待機しません。

既定値: False

--yes -y

確認のダイアログを表示しません。

既定値: False

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az k8s-configuration flux list

Flux v2 Kubernetes のすべての構成を一覧表示します。

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

例

クラスター上の Flux v2 Kubernetes 構成を一覧表示する

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

必須のパラメーター

--cluster-name -c

Kubernetes クラスターの名前。

--cluster-type -t

Arc 接続クラスターまたは AKS マネージド クラスターまたはプロビジョニング済みクラスターを指定します。

承認された値: connectedClusters, managedClusters, provisionedClusters

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

省略可能のパラメーター

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

この clusterType のクラスター リソース プロバイダー名 (provisionedClusters に必要)。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az k8s-configuration flux show

Flux v2 Kubernetes の構成を表示します。

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

例

Flux v2 Kubernetes 構成の詳細を表示する

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

必須のパラメーター

--cluster-name -c

Kubernetes クラスターの名前。

--cluster-type -t

Arc 接続クラスターまたは AKS マネージド クラスターまたはプロビジョニング済みクラスターを指定します。

承認された値: connectedClusters, managedClusters, provisionedClusters

--name -n

flux 構成の名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

省略可能のパラメーター

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

この clusterType のクラスター リソース プロバイダー名 (provisionedClusters に必要)。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az k8s-configuration flux update

Flux v2 Kubernetes 構成を更新します。

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]
                                 [--commit]
                                 [--container-name]
                                 [--https-ca-cert]
                                 [--https-ca-cert-file]
                                 [--https-key]
                                 [--https-user]
                                 [--interval]
                                 [--kind {azblob, bucket, git}]
                                 [--known-hosts]
                                 [--known-hosts-file]
                                 [--kustomization]
                                 [--local-auth-ref]
                                 [--managed-identity-client-id]
                                 [--no-wait]
                                 [--sas-token]
                                 [--semver]
                                 [--service-principal-client-certificate]
                                 [--service-principal-client-certificate-password]
                                 [--service-principal-client-certificate-send-chain]
                                 [--service-principal-client-id]
                                 [--service-principal-client-secret]
                                 [--service-principal-tenant-id]
                                 [--ssh-private-key]
                                 [--ssh-private-key-file]
                                 [--suspend {false, true}]
                                 [--tag]
                                 [--timeout]
                                 [--url]
                                 [--yes]

例

Flux v2 Kubernetes 構成を更新する

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

Flux v2 Kubernetes 構成を Bucket Source Kind で更新して安全でない接続を行う

az k8s-configuration flux update --resource-group my-resource-group \
--cluster-name mycluster --cluster-type connectedClusters --name myconfig \
--bucket-insecure

Flux v2 Kubernetes 構成を Azure Blob Source Kind で別のコンテナー名で更新する

az k8s-configuration flux update --resource-group my-resource-group \
--cluster-name mycluster --cluster-type connectedClusters --name myconfig \
--container-name other-container

必須のパラメーター

--cluster-name -c

Kubernetes クラスターの名前。

--cluster-type -t

Arc 接続クラスターまたは AKS マネージド クラスターまたはプロビジョニング済みクラスターを指定します。

承認された値: connectedClusters, managedClusters, provisionedClusters

--name -n

flux 構成の名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

省略可能のパラメーター

--account-key

認証用の Azure BLOB 共有キー。

--branch

クラスターと調整するために Git ソース内で分岐します。

--bucket-access-key

バケットで認証するために使用されるアクセス キー ID。

--bucket-insecure

TLS なしでバケットと通信します。

承認された値: false, true

--bucket-name

同期する S3 バケットの名前。

--bucket-secret-key

バケットで認証するために使用される秘密鍵。

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

この clusterType のクラスター リソース プロバイダー名 (provisionedClusters に必要)。

--commit

クラスターと調整するために Git ソース内でコミットします。

--container-name

同期する Azure Blob Storage コンテナーの名前。

--https-ca-cert

プライベート リポジトリ同期を使用した TLS 通信用の Base64 でエンコードされた HTTPS CA 証明書。

--https-ca-cert-file

プライベート リポジトリ同期との TLS 通信用の HTTPS CA 証明書ファイルへのファイル パス。

--https-key

プライベート リポジトリ同期の HTTPS トークン/パスワード。

--https-user

プライベート リポジトリ同期の HTTPS ユーザー名。

--interval --sync-interval

クラスター上のソースの調整間の時間。

--kind

調整するソースの種類。

承認された値: azblob, bucket, git

--known-hosts

プライベート Git インスタンスにアクセスするために必要な公開 SSH キーを含む Base64 でエンコードされたknown_hosts データ。

--known-hosts-file

プライベート Git インスタンスにアクセスするために必要な公開 SSH キーを含むknown_hostsコンテンツへのファイル パス。

--kustomization -k

パラメーター ['name'、'path'、'depends_on'、'timeout'、'sync_interval'、'retry_interval'、'prune'、'force' を使用してソースを同期する kustomization を定義します。

--local-auth-ref --local-ref

ソースへの通信に使用する構成名前空間内の kubernetes シークレットへのローカル参照。

--managed-identity-client-id --mi-client-id

Azure BLOB を使用した認証用のマネージド ID のクライアント ID。

--no-wait

実行時間の長い操作の終了を待機しません。

既定値: False

--sas-token

認証用の Azure BLOB SAS トークン。

--semver

クラスターと調整する Git ソース内の Semver 範囲。

--service-principal-client-certificate --sp-client-cert

Azure BLOB でサービス プリンシパルを認証するための Base64 でエンコードされたクライアント証明書。

--service-principal-client-certificate-password --sp-cert-password

Azure BLOB でサービス プリンシパルを認証するために使用するクライアント証明書のパスワード。

--service-principal-client-certificate-send-chain --sp-cert-send-chain

クライアント証明書のサブジェクト名/発行者ベースの認証を有効にするトークンを取得するときに、クライアント要求に x5c ヘッダーを含めるかどうかを指定します。

既定値: False

--service-principal-client-id --sp-client-id

この認証方法に必要な、Azure BLOB を使用してサービス プリンシパルを認証するためのクライアント ID。

--service-principal-client-secret --sp-client-secret

Azure BLOB を使用してサービス プリンシパルを認証するためのクライアント シークレット。

--service-principal-tenant-id --sp-tenant-id

この認証方法に必要な、Azure BLOB を使用してサービス プリンシパルを認証するためのテナント ID。

--ssh-private-key

プライベート リポジトリ同期用の Base64 でエンコードされたプライベート ssh キー。

--ssh-private-key-file

プライベート リポジトリ同期の秘密 SSH キーへのファイル パス。

--suspend

この構成に関連付けられているソースと kustomization の調整を中断します。

承認された値: false, true

--tag

クラスターと調整するために Git ソース内でタグを付ける。

--timeout

ソースを調整してからタイムアウトするまでの最大時間。

--url -u

調整するソースの URL。

--yes -y

確認のダイアログを表示しません。

既定値: False

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。