az k8s-configuration flux
Note
This reference is part of the k8s-configuration extension for the Azure CLI (version 2.15.0 or higher). 该扩展会在首次运行 az k8s-configuration flux 命令时自动安装。 Learn more about extensions.
用于管理 Flux v2 Kubernetes 配置的命令。
命令
名称 | 说明 | 类型 | Status |
---|---|---|---|
az k8s-configuration flux create |
创建 Flux v2 Kubernetes 配置。 |
Extension | GA |
az k8s-configuration flux delete |
删除 Flux v2 Kubernetes 配置。 |
Extension | GA |
az k8s-configuration flux deployed-object |
用于查看与 Flux v2 Kubernetes 配置关联的已部署对象的命令。 |
Extension | GA |
az k8s-configuration flux deployed-object list |
列出与 Flux v2 Kubernetes 配置关联的已部署对象。 |
Extension | GA |
az k8s-configuration flux deployed-object show |
显示与 Flux v2 Kubernetes 配置关联的已部署对象。 |
Extension | GA |
az k8s-configuration flux kustomization |
用于管理与 Flux v2 Kubernetes 配置关联的 Kustomizations 的命令。 |
Extension | GA |
az k8s-configuration flux kustomization create |
创建与 Flux v2 Kubernetes 配置关联的 Kustomization。 |
Extension | GA |
az k8s-configuration flux kustomization delete |
删除与 Flux v2 Kubernetes 配置关联的 Kustomization。 |
Extension | GA |
az k8s-configuration flux kustomization list |
列出与 Flux v2 Kubernetes 配置关联的 Kustomizations。 |
Extension | GA |
az k8s-configuration flux kustomization show |
显示与 Flux v2 Kubernetes 配置关联的 Kustomization。 |
Extension | GA |
az k8s-configuration flux kustomization update |
更新与 Flux v2 Kubernetes 配置关联的 Kustomization。 |
Extension | GA |
az k8s-configuration flux list |
列出所有 Flux v2 Kubernetes 配置。 |
Extension | GA |
az k8s-configuration flux show |
显示 Flux v2 Kubernetes 配置。 |
Extension | GA |
az k8s-configuration flux update |
更新 Flux v2 Kubernetes 配置。 |
Extension | 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 --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]
示例
创建 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
必需参数
Kubernetes 群集的名称。
指定 Arc 连接的群集或 AKS 托管群集或预配的群集。
属性 | 值 |
---|---|
接受的值: | connectedClusters, managedClusters, provisionedClusters |
flux 配置的名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
要协调的源的 URL。
可选参数
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
用于身份验证的 Azure Blob 共享密钥。
属性 | 值 |
---|---|
Parameter group: | Azure Blob Auth Arguments |
Git 源中的分支以与群集协调。
属性 | 值 |
---|---|
Parameter group: | Git Repo Ref Arguments |
用于在存储桶中进行身份验证的访问密钥 ID。
属性 | 值 |
---|---|
Parameter group: | Bucket Auth Arguments |
与没有 TLS 的存储桶通信。
属性 | 值 |
---|---|
默认值: | False |
接受的值: | false, true |
要同步的 S3 存储桶的名称。
用于对存储桶进行身份验证的密钥。
属性 | 值 |
---|---|
Parameter group: | Bucket Auth Arguments |
此 clusterType 的群集资源提供程序名称(provisionedClusters 必需)。
在 git 源中提交以与群集协调。
属性 | 值 |
---|---|
Parameter group: | Git Repo Ref Arguments |
要同步的 Azure Blob 存储容器的名称。
Base64 编码的 HTTPS CA 证书,用于与专用存储库同步的 TLS 通信。
属性 | 值 |
---|---|
Parameter group: | Git Auth Arguments |
用于与专用存储库同步通信的 HTTPS CA 证书文件的文件路径。
属性 | 值 |
---|---|
Parameter group: | Git Auth Arguments |
专用存储库同步的 HTTPS 令牌/密码。
属性 | 值 |
---|---|
Parameter group: | Git Auth Arguments |
专用存储库同步的 HTTPS 用户名。
属性 | 值 |
---|---|
Parameter group: | Git Auth Arguments |
群集上源的对帐之间的时间。
要协调的源类型。
属性 | 值 |
---|---|
默认值: | git |
接受的值: | azblob, bucket, git |
Base64 编码known_hosts数据,其中包含访问专用 Git 实例所需的公钥。
属性 | 值 |
---|---|
Parameter group: | Git Auth Arguments |
用于known_hosts内容的文件路径,其中包含访问专用 Git 实例所需的公钥。
属性 | 值 |
---|---|
Parameter group: | Git Auth Arguments |
定义 kustomizations,以便将源与参数 ['name', 'path', 'depends_on', 'timeout', 'sync_interval', 'retry_interval', 'prune', 'force', 'disable_health_check']。
对配置命名空间中用于与源通信的 kubernetes 机密的本地引用。
属性 | 值 |
---|---|
Parameter group: | Auth Arguments |
使用 Azure Blob 进行身份验证的托管标识的客户端 ID。
属性 | 值 |
---|---|
Parameter group: | Azure Blob Auth Arguments |
用于部署配置的命名空间。
属性 | 值 |
---|---|
默认值: | default |
不等待长时间运行的操作完成。
属性 | 值 |
---|---|
默认值: | False |
用于身份验证的提供程序的名称,Azure 提供程序可用于使用托管标识向 Azure DevOps 存储库进行身份验证。
属性 | 值 |
---|---|
Parameter group: | Git Auth Arguments |
接受的值: | azure, generic |
用于身份验证的 Azure Blob SAS 令牌。
属性 | 值 |
---|---|
Parameter group: | Azure Blob Auth Arguments |
将运算符的范围指定为“namespace”或“cluster”。
属性 | 值 |
---|---|
默认值: | cluster |
接受的值: | cluster, namespace |
Git 源中的 Semver 范围,用于与群集协调。
属性 | 值 |
---|---|
Parameter group: | Git Repo Ref Arguments |
用于使用 Azure Blob 对服务主体进行身份验证的 Base64 编码客户端证书。
属性 | 值 |
---|---|
Parameter group: | Azure Blob Auth Arguments |
用于使用 Azure Blob 对服务主体进行身份验证的客户端证书的密码。
属性 | 值 |
---|---|
Parameter group: | Azure Blob Auth Arguments |
指定在获取令牌时是否在客户端声明中包括 x5c 标头,以便为客户端证书启用基于使用者名称/颁发者的身份验证。
属性 | 值 |
---|---|
Parameter group: | Azure Blob Auth Arguments |
默认值: | False |
用于使用 Azure Blob 对服务主体进行身份验证的客户端 ID,此身份验证方法是必需的。
属性 | 值 |
---|---|
Parameter group: | Azure Blob Auth Arguments |
用于使用 Azure Blob 对服务主体进行身份验证的客户端密码。
属性 | 值 |
---|---|
Parameter group: | Azure Blob Auth Arguments |
使用 Azure Blob 对服务主体进行身份验证的租户 ID,此身份验证方法是必需的。
属性 | 值 |
---|---|
Parameter group: | Azure Blob Auth Arguments |
用于专用存储库同步的 Base64 编码私钥。
属性 | 值 |
---|---|
Parameter group: | Git Auth Arguments |
用于专用存储库同步的私钥的文件路径。
属性 | 值 |
---|---|
Parameter group: | Git Auth Arguments |
暂停与此配置关联的源和 kustomization 的对帐。
属性 | 值 |
---|---|
默认值: | False |
接受的值: | false, true |
要与群集协调的 git 源中的标记。
属性 | 值 |
---|---|
Parameter group: | Git Repo Ref Arguments |
在超时之前协调源的最长时间。
全局参数
提高日志记录详细程度以显示所有调试日志。
属性 | 值 |
---|---|
默认值: | False |
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
属性 | 值 |
---|---|
默认值: | False |
Output format.
属性 | 值 |
---|---|
默认值: | json |
接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
增加日志记录详细程度。 使用 --debug 获取完整的调试日志。
属性 | 值 |
---|---|
默认值: | False |
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 --cluster-rp]
[--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
必需参数
Kubernetes 群集的名称。
指定 Arc 连接的群集或 AKS 托管群集或预配的群集。
属性 | 值 |
---|---|
接受的值: | connectedClusters, managedClusters, provisionedClusters |
flux 配置的名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
可选参数
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
此 clusterType 的群集资源提供程序名称(provisionedClusters 必需)。
强制从群集中删除 flux 配置。
属性 | 值 |
---|---|
默认值: | False |
接受的值: | false, true |
不等待长时间运行的操作完成。
属性 | 值 |
---|---|
默认值: | False |
不要提示确认。
属性 | 值 |
---|---|
默认值: | False |
全局参数
提高日志记录详细程度以显示所有调试日志。
属性 | 值 |
---|---|
默认值: | False |
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
属性 | 值 |
---|---|
默认值: | False |
Output format.
属性 | 值 |
---|---|
默认值: | json |
接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
增加日志记录详细程度。 使用 --debug 获取完整的调试日志。
属性 | 值 |
---|---|
默认值: | False |
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 --cluster-rp]
示例
列出群集上的 Flux v2 Kubernetes 配置
az k8s-configuration flux list --resource-group my-resource-group \
--cluster-name mycluster --cluster-type connectedClusters
必需参数
Kubernetes 群集的名称。
指定 Arc 连接的群集或 AKS 托管群集或预配的群集。
属性 | 值 |
---|---|
接受的值: | connectedClusters, managedClusters, provisionedClusters |
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
可选参数
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
此 clusterType 的群集资源提供程序名称(provisionedClusters 必需)。
全局参数
提高日志记录详细程度以显示所有调试日志。
属性 | 值 |
---|---|
默认值: | False |
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
属性 | 值 |
---|---|
默认值: | False |
Output format.
属性 | 值 |
---|---|
默认值: | json |
接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
增加日志记录详细程度。 使用 --debug 获取完整的调试日志。
属性 | 值 |
---|---|
默认值: | False |
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 --cluster-rp]
示例
显示 Flux v2 Kubernetes 配置的详细信息
az k8s-configuration flux show --resource-group my-resource-group \
--cluster-name mycluster --cluster-type connectedClusters --name myconfig
必需参数
Kubernetes 群集的名称。
指定 Arc 连接的群集或 AKS 托管群集或预配的群集。
属性 | 值 |
---|---|
接受的值: | connectedClusters, managedClusters, provisionedClusters |
flux 配置的名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
可选参数
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
此 clusterType 的群集资源提供程序名称(provisionedClusters 必需)。
全局参数
提高日志记录详细程度以显示所有调试日志。
属性 | 值 |
---|---|
默认值: | False |
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
属性 | 值 |
---|---|
默认值: | False |
Output format.
属性 | 值 |
---|---|
默认值: | json |
接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
增加日志记录详细程度。 使用 --debug 获取完整的调试日志。
属性 | 值 |
---|---|
默认值: | False |
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 --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]
示例
更新 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
必需参数
Kubernetes 群集的名称。
指定 Arc 连接的群集或 AKS 托管群集或预配的群集。
属性 | 值 |
---|---|
接受的值: | connectedClusters, managedClusters, provisionedClusters |
flux 配置的名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
可选参数
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
用于身份验证的 Azure Blob 共享密钥。
属性 | 值 |
---|---|
Parameter group: | Azure Blob Auth Arguments |
Git 源中的分支以与群集协调。
属性 | 值 |
---|---|
Parameter group: | Git Repo Ref Arguments |
用于在存储桶中进行身份验证的访问密钥 ID。
属性 | 值 |
---|---|
Parameter group: | Bucket Auth Arguments |
与没有 TLS 的存储桶通信。
属性 | 值 |
---|---|
接受的值: | false, true |
要同步的 S3 存储桶的名称。
用于对存储桶进行身份验证的密钥。
属性 | 值 |
---|---|
Parameter group: | Bucket Auth Arguments |
此 clusterType 的群集资源提供程序名称(provisionedClusters 必需)。
在 git 源中提交以与群集协调。
属性 | 值 |
---|---|
Parameter group: | Git Repo Ref Arguments |
要同步的 Azure Blob 存储容器的名称。
Base64 编码的 HTTPS CA 证书,用于与专用存储库同步的 TLS 通信。
属性 | 值 |
---|---|
Parameter group: | Git Auth Arguments |
用于与专用存储库同步通信的 HTTPS CA 证书文件的文件路径。
属性 | 值 |
---|---|
Parameter group: | Git Auth Arguments |
专用存储库同步的 HTTPS 令牌/密码。
属性 | 值 |
---|---|
Parameter group: | Git Auth Arguments |
专用存储库同步的 HTTPS 用户名。
属性 | 值 |
---|---|
Parameter group: | Git Auth Arguments |
群集上源的对帐之间的时间。
要协调的源类型。
属性 | 值 |
---|---|
接受的值: | azblob, bucket, git |
Base64 编码known_hosts数据,其中包含访问专用 Git 实例所需的公钥。
属性 | 值 |
---|---|
Parameter group: | Git Auth Arguments |
用于known_hosts内容的文件路径,其中包含访问专用 Git 实例所需的公钥。
属性 | 值 |
---|---|
Parameter group: | Git Auth Arguments |
定义 kustomizations,以便将源与参数 ['name', 'path', 'depends_on', 'timeout', 'sync_interval', 'retry_interval', 'prune', 'force', 'disable_health_check']。
对配置命名空间中用于与源通信的 kubernetes 机密的本地引用。
属性 | 值 |
---|---|
Parameter group: | Auth Arguments |
使用 Azure Blob 进行身份验证的托管标识的客户端 ID。
属性 | 值 |
---|---|
Parameter group: | Azure Blob Auth Arguments |
不等待长时间运行的操作完成。
属性 | 值 |
---|---|
默认值: | False |
用于身份验证的提供程序的名称,Azure 提供程序可用于使用托管标识向 Azure DevOps 存储库进行身份验证。
属性 | 值 |
---|---|
Parameter group: | Git Auth Arguments |
接受的值: | azure, generic |
用于身份验证的 Azure Blob SAS 令牌。
属性 | 值 |
---|---|
Parameter group: | Azure Blob Auth Arguments |
Git 源中的 Semver 范围,用于与群集协调。
属性 | 值 |
---|---|
Parameter group: | Git Repo Ref Arguments |
用于使用 Azure Blob 对服务主体进行身份验证的 Base64 编码客户端证书。
属性 | 值 |
---|---|
Parameter group: | Azure Blob Auth Arguments |
用于使用 Azure Blob 对服务主体进行身份验证的客户端证书的密码。
属性 | 值 |
---|---|
Parameter group: | Azure Blob Auth Arguments |
指定在获取令牌时是否在客户端声明中包括 x5c 标头,以便为客户端证书启用基于使用者名称/颁发者的身份验证。
属性 | 值 |
---|---|
Parameter group: | Azure Blob Auth Arguments |
默认值: | False |
用于使用 Azure Blob 对服务主体进行身份验证的客户端 ID,此身份验证方法是必需的。
属性 | 值 |
---|---|
Parameter group: | Azure Blob Auth Arguments |
用于使用 Azure Blob 对服务主体进行身份验证的客户端密码。
属性 | 值 |
---|---|
Parameter group: | Azure Blob Auth Arguments |
使用 Azure Blob 对服务主体进行身份验证的租户 ID,此身份验证方法是必需的。
属性 | 值 |
---|---|
Parameter group: | Azure Blob Auth Arguments |
用于专用存储库同步的 Base64 编码私钥。
属性 | 值 |
---|---|
Parameter group: | Git Auth Arguments |
用于专用存储库同步的私钥的文件路径。
属性 | 值 |
---|---|
Parameter group: | Git Auth Arguments |
暂停与此配置关联的源和 kustomization 的对帐。
属性 | 值 |
---|---|
接受的值: | false, true |
要与群集协调的 git 源中的标记。
属性 | 值 |
---|---|
Parameter group: | Git Repo Ref Arguments |
在超时之前协调源的最长时间。
要协调的源的 URL。
不要提示确认。
属性 | 值 |
---|---|
默认值: | False |
全局参数
提高日志记录详细程度以显示所有调试日志。
属性 | 值 |
---|---|
默认值: | False |
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
属性 | 值 |
---|---|
默认值: | False |
Output format.
属性 | 值 |
---|---|
默认值: | json |
接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
增加日志记录详细程度。 使用 --debug 获取完整的调试日志。
属性 | 值 |
---|---|
默认值: | False |