Skip to content

Commit

Permalink
Some improvements based on code reviews
Browse files Browse the repository at this point in the history
  • Loading branch information
wahabmk authored and DinaBelova committed Dec 23, 2024
1 parent 579b47a commit d03b525
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 21 deletions.
36 changes: 18 additions & 18 deletions docs/quick-start/2a-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,13 +95,13 @@ The output should be similar to:

```sh
NAME VALID
cluster-api-0-0-3 true
cluster-api-provider-aws-0-0-3 true
cluster-api-provider-azure-0-0-3 true
cluster-api-provider-vsphere-0-0-3 true
hmc-0-0-4 true
k0smotron-0-0-3 true
projectsveltos-0-42-0 true
cluster-api-X-Y-Z true
cluster-api-provider-aws-X-Y-Z true
cluster-api-provider-azure-X-Y-Z true
cluster-api-provider-vsphere-X-Y-Z true
hmc-X-Y-Z true
k0smotron-X-Y-Z true
projectsveltos-X-Y-Z true
```

Check `ClusterTemplate` objects with:
Expand All @@ -114,13 +114,13 @@ The output should be similar to:

```bash
NAME VALID
aws-eks-0-0-2 true
aws-hosted-cp-0-0-3 true
aws-standalone-cp-0-0-3 true
azure-hosted-cp-0-0-3 true
azure-standalone-cp-0-0-3 true
vsphere-hosted-cp-0-0-3 true
vsphere-standalone-cp-0-0-3 true
aws-eks-X-Y-Z true
aws-hosted-cp-X-Y-Z true
aws-standalone-cp-X-Y-Z true
azure-hosted-cp-X-Y-Z true
azure-standalone-cp-X-Y-Z true
vsphere-hosted-cp-X-Y-Z true
vsphere-standalone-cp-X-Y-Z true
```

Check `ServiceTemplate` objects with:
Expand All @@ -132,10 +132,10 @@ kubectl get servicetemplate -n hmc-system
The output should be similar to:

```sh
NAME VALID
ingress-nginx-4-11-0 true
ingress-nginx-4-11-3 true
kyverno-3-2-6 true
NAME VALID
ingress-nginx-X-Y-Z true
ingress-nginx-X-Y-Z true
kyverno-X-Y-Z true
```

### Next Step
Expand Down
6 changes: 5 additions & 1 deletion docs/template/main.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,11 @@ By default, 2A delivers a set of default `ProviderTemplate`, `ClusterTemplate` a
The template containing the configuration of the service to be installed on the managed cluster. Namespace-scoped.

All Templates are immutable. You can also build your own templates and use them for deployment along with the
templates shipped with 2A. Below are some examples for each of the templates.
templates shipped with 2A.

## Template Naming Convention

The templates can have any name. However, since they are immutable, we have adopted a naming convention that includes semver in the name, i.e., `template-<major>-<minor>-<patch>`. Below are some examples for each of the templates.

> EXAMPLE: An example of a `ProviderTemplate` with its status.
> ```yaml
Expand Down
4 changes: 2 additions & 2 deletions docs/usage/create-multiclusterservice.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,8 +129,8 @@ This scenario presents a conflict on both the clusters as the MultiClusterServic
on both whereas the ManagedCluster for each is attempting to deploy v4.11.0 of ingress-nginx.
This is where `.spec.servicesPriority` can be used to specify who gets the priority. Higher number means higer priority and vice versa. In this example:
1. ManagedCluster `dev-cluster-1` would lose and its ingress-nginx (v4.11.3) would be deployed on its cluster.
2. ManagedCluster `dev-cluster-2` would win and ingress-nginx (v4.11.0) would be deployed on its cluster.
1. MultiClusterService "global-ingress" will take precedence over ManagedCluster "dev-cluster-1" and ingress-nginx (v4.11.3) defined in MultiClusterService object will be deployed on the cluster.
2. ManagedCluster "dev-cluster-2" will take precedence over MultiClusterService "global-ingress" and ingress-nginx (v4.11.0) defined in ManagedCluster object will be deployed on the cluster.
> NOTE: If servicesPriority are equal, the first one to reach the cluster wins and deploys its beach-head services.
Expand Down

0 comments on commit d03b525

Please sign in to comment.