Skip to content

Commit 5930508

Browse files
Stacyrch140Stacyrch140
authored
Merge pull request #231734 from JnHs/jh-arck8-gotutc
remove example output and link to CLI reference
2 parents d6d5ce9 + 15cd3eb commit 5930508

File tree

1 file changed

+7
-209
lines changed

1 file changed

+7
-209
lines changed

‎articles/azure-arc/kubernetes/conceptual-gitops-flux2.md

Lines changed: 7 additions & 209 deletions
Original file line numberDiff line numberDiff line change
@@ -113,151 +113,19 @@ Because Azure Resource Manager manages your configurations, you can automate cre
113113

114114
## Parameters
115115

116-
For a description of all parameters that Flux supports, see the [official Flux documentation](https://fluxcd.io/docs/). Flux in Azure doesn't support all parameters yet. Let us know if a parameter you need is missing from the Azure implementation.
116+
To see all the parameters supported by Flux in Azure, see the [`az k8s-configuration` documentation](/cli/azure/k8s-configuration). This implementation doesn't currently support every parameter that Flux supports (see the [official Flux documentation](https://fluxcd.io/docs/)). Let us know if a parameter you need is missing from the Azure implementation.
117117

118-
You can see the full list of parameters that the `k8s-configuration flux` Azure CLI command supports by using the `-h` parameter:
119-
az k8
120-
```azurecli
121-
az k8s-configuration flux -h
122-
123-
Group
124-
az k8s-configuration flux : Commands to manage Flux v2 Kubernetes configurations.
125-
126-
Subgroups:
127-
deployed-object : Commands to see deployed objects associated with Flux v2 Kubernetes
128-
configurations.
129-
kustomization : Commands to manage Kustomizations associated with Flux v2 Kubernetes
130-
configurations.
131-
132-
Commands:
133-
create : Create a Flux v2 Kubernetes configuration.
134-
delete : Delete a Flux v2 Kubernetes configuration.
135-
list : List all Flux v2 Kubernetes configurations.
136-
show : Show a Flux v2 Kubernetes configuration.
137-
update : Update a Flux v2 Kubernetes configuration.
138-
```
118+
You can also see the full list of parameters for the `az k8s-configuration flux` by using the `-h` parameter in Azure CLI (for example, `az k8s-configuration flux -h` or `az k8s-configuration flux create -h`).
139119

140-
Here are the parameters for the `k8s-configuration flux create` CLI command:
141-
142-
```azurecli
143-
az k8s-configuration flux create -h
144-
145-
This command is from the following extension: k8s-configuration
146-
147-
Command
148-
az k8s-configuration flux create : Create a Flux v2 Kubernetes configuration.
149-
150-
Arguments
151-
--cluster-name -c [Required] : Name of the Kubernetes cluster.
152-
--cluster-type -t [Required] : Specify Arc connected clusters or AKS managed clusters.
153-
Allowed values: connectedClusters, managedClusters.
154-
--name -n [Required] : Name of the flux configuration.
155-
--resource-group -g [Required] : Name of resource group. You can configure the default group
156-
using `az configure --defaults group=<name>`.
157-
--url -u [Required] : URL of the source to reconcile.
158-
--bucket-insecure : Communicate with a bucket without TLS. Allowed values: false,
159-
true.
160-
--bucket-name : Name of the S3 bucket to sync.
161-
--container-name : Name of the Azure Blob Storage container to sync
162-
--interval --sync-interval : Time between reconciliations of the source on the cluster.
163-
--kind : Source kind to reconcile. Allowed values: bucket, git, azblob.
164-
Default: git.
165-
--kustomization -k : Define kustomizations to sync sources with parameters ['name',
166-
'path', 'depends_on', 'timeout', 'sync_interval',
167-
'retry_interval', 'prune', 'force'].
168-
--namespace --ns : Namespace to deploy the configuration. Default: default.
169-
--no-wait : Do not wait for the long-running operation to finish.
170-
--scope -s : Specify scope of the operator to be 'namespace' or 'cluster'.
171-
Allowed values: cluster, namespace. Default: cluster.
172-
--suspend : Suspend the reconciliation of the source and kustomizations
173-
associated with this configuration. Allowed values: false,
174-
true.
175-
--timeout : Maximum time to reconcile the source before timing out.
176-
177-
Auth Arguments
178-
--local-auth-ref --local-ref : Local reference to a kubernetes secret in the configuration
179-
namespace to use for communication to the source.
180-
181-
Bucket Auth Arguments
182-
--bucket-access-key : Access Key ID used to authenticate with the bucket.
183-
--bucket-secret-key : Secret Key used to authenticate with the bucket.
184-
185-
Git Auth Arguments
186-
--https-ca-cert : Base64-encoded HTTPS CA certificate for TLS communication with
187-
private repository sync.
188-
--https-ca-cert-file : File path to HTTPS CA certificate file for TLS communication
189-
with private repository sync.
190-
--https-key : HTTPS token/password for private repository sync.
191-
--https-user : HTTPS username for private repository sync.
192-
--known-hosts : Base64-encoded known_hosts data containing public SSH keys
193-
required to access private Git instances.
194-
--known-hosts-file : File path to known_hosts contents containing public SSH keys
195-
required to access private Git instances.
196-
--ssh-private-key : Base64-encoded private ssh key for private repository sync.
197-
--ssh-private-key-file : File path to private ssh key for private repository sync.
198-
199-
Git Repo Ref Arguments
200-
--branch : Branch within the git source to reconcile with the cluster.
201-
--commit : Commit within the git source to reconcile with the cluster.
202-
--semver : Semver range within the git source to reconcile with the
203-
cluster.
204-
--tag : Tag within the git source to reconcile with the cluster.
205-
206-
Global Arguments
207-
--debug : Increase logging verbosity to show all debug logs.
208-
--help -h : Show this help message and exit.
209-
--only-show-errors : Only show errors, suppressing warnings.
210-
--output -o : Output format. Allowed values: json, jsonc, none, table, tsv,
211-
yaml, yamlc. Default: json.
212-
--query : JMESPath query string. See http://jmespath.org/ for more
213-
information and examples.
214-
--subscription : Name or ID of subscription. You can configure the default
215-
subscription using `az account set -s NAME_OR_ID`.
216-
--verbose : Increase logging verbosity. Use --debug for full debug logs.
217-
218-
Azure Blob Storage Account Auth Arguments
219-
--sp_client_id : The client ID for authenticating a service principal with Azure Blob, required for this authentication method
220-
--sp_tenant_id : The tenant ID for authenticating a service principal with Azure Blob, required for this authentication method
221-
--sp_client_secret : The client secret for authenticating a service principal with Azure Blob
222-
--sp_client_cert : The Base64 encoded client certificate for authenticating a service principal with Azure Blob
223-
--sp_client_cert_password : The password for the client certificate used to authenticate a service principal with Azure Blob
224-
--sp_client_cert_send_chain : Specifies whether to include x5c header in client claims when acquiring a token to enable subject name / issuer based authentication for the client certificate
225-
--account_key : The Azure Blob Shared Key for authentication
226-
--sas_token : The Azure Blob SAS Token for authentication
227-
--mi_client_id : The client ID of the managed identity for authentication with Azure Blob
228-
229-
Examples
230-
Create a Flux v2 Kubernetes configuration
231-
az k8s-configuration flux create --resource-group my-resource-group \
232-
--cluster-name mycluster --cluster-type connectedClusters \
233-
--name myconfig --scope cluster --namespace my-namespace \
234-
--kind git --url https://github.com/Azure/arc-k8s-demo \
235-
--branch main --kustomization name=my-kustomization
236-
237-
Create a Kubernetes v2 Flux Configuration with Bucket Source Kind
238-
az k8s-configuration flux create --resource-group my-resource-group \
239-
--cluster-name mycluster --cluster-type connectedClusters \
240-
--name myconfig --scope cluster --namespace my-namespace \
241-
--kind bucket --url https://bucket-provider.minio.io \
242-
--bucket-name my-bucket --kustomization name=my-kustomization \
243-
--bucket-access-key my-access-key --bucket-secret-key my-secret-key
244-
245-
Create a Kubernetes v2 Flux Configuration with Azure Blob Storage Source Kind
246-
az k8s-configuration flux create --resource-group my-resource-group \
247-
--cluster-name mycluster --cluster-type connectedClusters \
248-
--name myconfig --scope cluster --namespace my-namespace \
249-
--kind azblob --url https://mystorageaccount.blob.core.windows.net \
250-
--container-name my-container --kustomization name=my-kustomization \
251-
--account-key my-account-key
252-
```
120+
The following information describes some of the parameters and arguments available for the `az k8s-configuration flux create` command.
253121

254122
### Configuration general arguments
255123

256124
| Parameter | Format | Notes |
257125
| ------------- | ------------- | ------------- |
258126
| `--cluster-name` `-c` | String | Name of the cluster resource in Azure. |
259-
| `--cluster-type` `-t` | `connectedClusters`, `managedClusters` | Use `connectedClusters` for Azure Arc-enabled Kubernetes clusters and `managedClusters` for AKS clusters. |
260-
| `--resource-group` `-g` | String | Name of the Azure resource group that holds the Azure Arc or AKS cluster resource. |
127+
| `--cluster-type` `-t` | Allowed values: `connectedClusters`, `managedClusters`, `provisionedClusters` | Use `connectedClusters` for Azure Arc-enabled Kubernetes clusters, `managedClusters` for AKS clusters, or `provisionedClusters` for [AKS hybrid clusters provisioned from Azure](extensions.md#aks-hybrid-clusters-provisioned-from-azure-preview) (installing extensions on these clusters is currently in preview). |
128+
| `--resource-group` `-g` | String | Name of the Azure resource group that holds the cluster resource. |
261129
| `--name` `-n`| String | Name of the Flux configuration in Azure. |
262130
| `--namespace` `--ns` | String | Name of the namespace to deploy the configuration. Default: `default`. |
263131
| `--scope` `-s` | String | Permission scope for the operators. Possible values are `cluster` (full access) or `namespace` (restricted access). Default: `cluster`.
@@ -420,7 +288,7 @@ For on-premises repositories, Flux uses `libgit2`.
420288

421289
### Kustomization
422290

423-
By using `az k8s-configuration flux kustomization create`, you can create one or more kustomizations during the configuration.
291+
By using [`az k8s-configuration flux kustomization create`](/cli/azure/k8s-configuration/flux/kustomization#az-k8s-configuration-flux-kustomization-create), you can create one or more kustomizations during the configuration.
424292

425293
| Parameter | Format | Notes |
426294
| ------------- | ------------- | ------------- |
@@ -435,77 +303,7 @@ By using `az k8s-configuration flux kustomization create`, you can create one or
435303
| `validation` | String | Values: `none`, `client`, `server`. Default: `none`. See [Flux documentation](https://fluxcd.io/docs/) for details.|
436304
| `force` | Boolean | Default: `false`. Set `force=true` to instruct the kustomize controller to re-create resources when patching fails because of an immutable field change. |
437305

438-
You can also use `az k8s-configuration flux kustomization` to create, update, list, show, and delete kustomizations in a Flux configuration:
439-
440-
```console
441-
az k8s-configuration flux kustomization -h
442-
443-
Group
444-
az k8s-configuration flux kustomization : Commands to manage Kustomizations associated with Flux
445-
v2 Kubernetes configurations.
446-
447-
Commands:
448-
create : Create a Kustomization associated with a Flux v2 Kubernetes configuration.
449-
delete : Delete a Kustomization associated with a Flux v2 Kubernetes configuration.
450-
list : List Kustomizations associated with a Flux v2 Kubernetes configuration.
451-
show : Show a Kustomization associated with a Flux v2 Kubernetes configuration.
452-
update : Update a Kustomization associated with a Flux v2 Kubernetes configuration.
453-
```
454-
455-
Here are the kustomization creation options:
456-
457-
```azurecli
458-
az k8s-configuration flux kustomization create -h
459-
460-
This command is from the following extension: k8s-configuration
461-
462-
Command
463-
az k8s-configuration flux kustomization create : Create a Kustomization associated with a
464-
Kubernetes Flux v2 Configuration.
465-
466-
Arguments
467-
--cluster-name -c [Required] : Name of the Kubernetes cluster.
468-
--cluster-type -t [Required] : Specify Arc connected clusters or AKS managed clusters.
469-
Allowed values: connectedClusters, managedClusters.
470-
--kustomization-name -k [Required] : Specify the name of the kustomization to target.
471-
--name -n [Required] : Name of the flux configuration.
472-
--resource-group -g [Required] : Name of resource group. You can configure the default
473-
group using `az configure --defaults group=<name>`.
474-
--dependencies --depends --depends-on : Comma-separated list of kustomization dependencies.
475-
--force : Re-create resources that cannot be updated on the
476-
cluster (i.e. jobs). Allowed values: false, true.
477-
--interval --sync-interval : Time between reconciliations of the kustomization on the
478-
cluster.
479-
--no-wait : Do not wait for the long-running operation to finish.
480-
--path : Specify the path in the source that the kustomization
481-
should apply.
482-
--prune : Garbage collect resources deployed by the kustomization
483-
on the cluster. Allowed values: false, true.
484-
--retry-interval : Time between reconciliations of the kustomization on the
485-
cluster on failures, defaults to --sync-interval.
486-
--timeout : Maximum time to reconcile the kustomization before
487-
timing out.
488-
489-
Global Arguments
490-
--debug : Increase logging verbosity to show all debug logs.
491-
--help -h : Show this help message and exit.
492-
--only-show-errors : Only show errors, suppressing warnings.
493-
--output -o : Output format. Allowed values: json, jsonc, none,
494-
table, tsv, yaml, yamlc. Default: json.
495-
--query : JMESPath query string. See http://jmespath.org/ for more
496-
information and examples.
497-
--subscription : Name or ID of subscription. You can configure the
498-
default subscription using `az account set -s
499-
NAME_OR_ID`.
500-
--verbose : Increase logging verbosity. Use --debug for full debug
501-
logs.
502-
503-
Examples
504-
Create a Kustomization associated with a Kubernetes v2 Flux Configuration
505-
az k8s-configuration flux kustomization create --resource-group my-resource-group \
506-
--cluster-name mycluster --cluster-type connectedClusters --name myconfig \
507-
--kustomization-name my-kustomization-2 --path ./my/path --prune --force
508-
```
306+
You can also use [`az k8s-configuration flux kustomization`](/cli/azure/k8s-configuration/flux/kustomization) to update, list, show, and delete kustomizations in a Flux configuration.
509307

510308
## Multi-tenancy
511309

0 commit comments

Comments
 (0)