你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

az k8s-configuration flux

注意

此参考是 Azure CLI(版本 2.15.0 或更高版本)的 k8s 配置扩展的一部分。 该扩展将在首次运行 az k8s-configuration flux 命令时自动安装。 详细了解扩展。

用于管理 Flux v2 Kubernetes 配置的命令。

命令

名称 说明 类型 状态
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 配置关联的 Kustomizations 的命令。

扩展 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 配置关联的 Kustomizations。

分机 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 存储容器的名称。

--https-ca-cert

Base64 编码的 HTTPS CA 证书,用于与专用存储库同步的 TLS 通信。

--https-ca-cert-file

用于与专用存储库同步通信的 HTTPS CA 证书文件的文件路径。

--https-key

专用存储库同步的 HTTPS 令牌/密码。

--https-user

专用存储库同步的 HTTPS 用户名。

--interval --sync-interval

在群集上调整源的时间间隔。

--kind

要调整的源类型。

接受的值: azblob, bucket, git
默认值: git
--known-hosts

Base64 编码known_hosts数据,其中包含访问专用 Git 实例所需的公钥。

--known-hosts-file

用于known_hosts内容的文件路径,其中包含访问专用 Git 实例所需的公钥。

--kustomization -k

定义 kustomizations,以便将源与参数 ['name', 'path', 'depends_on', 'timeout', 'sync_interval', 'retry_interval', 'prune', 'force']。

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

对配置命名空间中用于与源通信的 kubernetes 机密的本地引用。

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

使用 Azure Blob 进行身份验证的托管标识的客户端 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-private-key-file

用于专用存储库同步的私钥的文件路径。

--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

使用 Bucket 源类型更新 Flux v2 Kubernetes 配置,以不安全地连接

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

使用 Azure Blob 源类型使用另一个容器名称更新 Flux v2 Kubernetes 配置

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 存储容器的名称。

--https-ca-cert

Base64 编码的 HTTPS CA 证书,用于与专用存储库同步的 TLS 通信。

--https-ca-cert-file

用于与专用存储库同步通信的 HTTPS CA 证书文件的文件路径。

--https-key

专用存储库同步的 HTTPS 令牌/密码。

--https-user

专用存储库同步的 HTTPS 用户名。

--interval --sync-interval

在群集上调整源的时间间隔。

--kind

要调整的源类型。

接受的值: azblob, bucket, git
--known-hosts

Base64 编码known_hosts数据,其中包含访问专用 Git 实例所需的公钥。

--known-hosts-file

用于known_hosts内容的文件路径,其中包含访问专用 Git 实例所需的公钥。

--kustomization -k

定义 kustomizations,以便将源与参数 ['name', 'path', 'depends_on', 'timeout', 'sync_interval', 'retry_interval', 'prune', 'force']。

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

对配置命名空间中用于与源通信的 kubernetes 机密的本地引用。

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

使用 Azure Blob 进行身份验证的托管标识的客户端 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-private-key-file

用于专用存储库同步的私钥的文件路径。

--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 获取完整的调试日志。