Skip to content

Commit

Permalink
Update help text and validators
Browse files Browse the repository at this point in the history
  • Loading branch information
jonathan-innis committed Sep 8, 2021
1 parent 6e135f3 commit 579ec5c
Show file tree
Hide file tree
Showing 3 changed files with 56 additions and 14 deletions.
60 changes: 53 additions & 7 deletions src/k8s-configuration/README.rst
Expand Up @@ -11,11 +11,57 @@ az extension add --name k8s-configuration
```

### Included Features
#### Kubernetes Configuration:
Kubernetes SourceControl Configuration: [more info](https://docs.microsoft.com/en-us/azure/kubernetessconfiguration/)\

#### Flux Configuration (Flux v2):
Flux Configuration (Flux v1) Configuration: [more info](https://docs.microsoft.com/en-us/azure/kubernetessconfiguration/)\
*Examples:*

##### Create a Flux Configuration (Flux v2)
```
az k8s-configuration create flux \
--resource-group groupName \
--cluster-name clusterName \
--cluster-type clusterType \
--name configurationName \
--namespace configurationNamespace \
--scope cluster
--kind git \
--url https://github.com/Azure/arc-k8s-demo \
--branch main \
--kustomization name=my-kustomization
```

##### Get a Flux Configuration (Flux v2)
```
az k8s-configuration flux show \
--resource-group groupName \
--cluster-name clusterName \
--cluster-type clusterType \
--name configurationName
```

##### Delete a Flux Configuration (Flux v2)
```
az k8s-configuration flux delete \
--resource-group groupName \
--cluster-name clusterName \
--cluster-type clusterType \
--name configurationName
```

##### List all Flux Configuration (Flux v2) on a cluster
```
az k8s-configuration flux list \
--resource-group groupName \
--cluster-name clusterName \
--cluster-type clusterType
```

#### Source Control Configuration (Flux v1):
Source Control Configuration (Flux v1) Configuration: [more info](https://docs.microsoft.com/en-us/azure/kubernetessconfiguration/)\
*Examples:*

##### Create a Source Control Configuration (Fluxv1)
##### Create a Source Control Configuration (Flux v1)
```
az k8s-configuration create \
--resource-group groupName \
Expand All @@ -31,7 +77,7 @@ az k8s-configuration create \
--helm-operator-params chartParameters
```

##### Get a Source Control Configuration (Fluxv1)
##### Get a Source Control Configuration (Flux v1)
```
az k8s-configuration show \
--resource-group groupName \
Expand All @@ -40,7 +86,7 @@ az k8s-configuration show \
--name configurationName
```

##### Delete a Source Control Configuration (Fluxv1)
##### Delete a Source Control Configuration (Flux v1)
```
az k8s-configuration delete \
--resource-group groupName \
Expand All @@ -49,7 +95,7 @@ az k8s-configuration delete \
--name configurationName
```

##### Update a Source Control Configuration (Fluxv1)
##### Update a Source Control Configuration (Flux v1)
```
az k8s-configuration create \
--resource-group groupName \
Expand All @@ -63,7 +109,7 @@ az k8s-configuration create \
--helm-operator-params chartParameters
```

##### List all Source Control Configuration (Fluxv1) on a cluster
##### List all Source Control Configuration (Flux v1) on a cluster
```
az k8s-configuration list \
--resource-group groupName \
Expand Down
2 changes: 1 addition & 1 deletion src/k8s-configuration/azext_k8s_configuration/_help.py
Expand Up @@ -69,7 +69,7 @@
text: |-
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 master --kustomization \\
--kind git --url https://github.com/Azure/arc-k8s-demo --branch main --kustomization \\
name=my-kustomization
"""

Expand Down
8 changes: 2 additions & 6 deletions src/k8s-configuration/azext_k8s_configuration/validators.py
Expand Up @@ -27,17 +27,13 @@

def validate_namespace(namespace):
if namespace.namespace:
__validate_k8s_name(namespace.namespace, "--namespace", 63)
__validate_k8s_name(namespace.namespace, "--namespace", 253)


def validate_configuration_name(namespace):
__validate_k8s_name(namespace.name, "--name", 63)


def validate_extension_name(namespace):
__validate_k8s_cr_name(namespace.name, "--name", 253)


def validate_fluxconfig_name(namespace):
__validate_k8s_cr_name(namespace.name, "--name", 63)

Expand All @@ -57,7 +53,7 @@ def validate_kustomization(values):
for item in values:
key, value = item.split('=', 1)
if key == "name":
__validate_k8s_name(value, key, 63)
__validate_k8s_cr_name(value, key, 63)
elif key in consts.SYNC_INTERVAL_KEYS:
validate_duration("sync-interval", value)
elif key in consts.TIMEOUT_KEYS:
Expand Down

0 comments on commit 579ec5c

Please sign in to comment.