Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Small fixes to some names and YAMLs #54

Merged
merged 1 commit into from
Feb 6, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/admin-creating-clusters.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ Follow these steps to deploy a standalone Kubernetes cluster tailored to your sp
apiVersion: k0rdent.mirantis.com/v1alpha1
kind: ClusterDeployment
metadata:
name: my-managed-cluster
name: my-cluster-deployment
namespace: kcm-system
spec:
template: aws-standalone-cp-0-1-0
Expand Down
22 changes: 11 additions & 11 deletions docs/admin-service-templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,12 +46,12 @@ The basic sequence looks like this:
interval: 10m0s
sourceRef:
kind: HelmRepository
name: k0rdent-templates
name: k0rdent-catalog
```

In this case, we're creating a `ServiceTemplate` called `ingress-nginx-4.11.3` in the
`my-target-namespace` namespace. It references version 4.11.3 of the `ingress-nginx` chart
located in the `k0rdent-templates` Helm repository.
located in the `k0rdent-catalog` Helm repository.

For more information on creating templates, see the [Template Guide](template-intro.md).

Expand Down Expand Up @@ -93,26 +93,26 @@ The basic sequence looks like this:
apiVersion: k0rdent.mirantis.com/v1alpha1
kind: ClusterDeployment
metadata:
name: my-managed-cluster
name: my-cluster-deployment
namespace: tenant42
spec:
config:
clusterLabels: {}
template: aws-standalone-cp-0-1-0
credential: aws-credential
services:
- template: project-ingress-nginx-4.11.3
name: ingress-nginx
namespace: my-target-namespace
servicesPriority: 100
stopOnConflict: false
serviceSpec:
services:
- template: project-ingress-nginx-4.11.3
name: ingress-nginx
namespace: my-target-namespace
priority: 100
```
As you can see, you're simply referencing the template in the `.spec.services.template` field of the `ClusterDeployment`
As you can see, you're simply referencing the template in the `.spec.serviceSpec.services[].template` field of the `ClusterDeployment`
to tell k0rdent that you want this service to be part of this cluster.

If you wanted to add this service to an existing cluster, you would simply patch the definition of the `ClusterDeployment`, as in:

```shell
kubectl patch clusterdeployment my-managed-cluster -n my-target-namespace --type='merge' -p '{"spec":{"services":[{"template":"project-ingress-nginx-4.11.3","name":"ingress-nginx","namespace":"my-target-namespace"}]}}'
kubectl patch clusterdeployment my-cluster-deployment -n my-target-namespace --type='merge' -p '{"spec":{"services":[{"template":"project-ingress-nginx-4.11.3","name":"ingress-nginx","namespace":"my-target-namespace"}]}}'
```
For more information on creating and using `ServiceTemplate` objects, see the [User Guide](user-create-service.md).
4 changes: 2 additions & 2 deletions docs/appendix-dryrun.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Note that if no configuration (`.spec.config`) is provided, default values from
apiVersion: k0rdent.mirantis.com/v1alpha1
kind: ClusterDeployment
metadata:
name: my-managed-cluster
name: my-cluster-deployment
namespace: kcm-system
spec:
template: aws-standalone-cp-0-0-3
Expand All @@ -26,7 +26,7 @@ After validation (this is, you see `TemplateReady` as a condition in `.status.co
apiVersion: k0rdent.mirantis.com/v1alpha1
kind: ClusterDeployment
metadata:
name: my-managed-cluster
name: my-cluster-deployment
namespace: kcm-system
spec:
template: aws-standalone-cp-0-0-3
Expand Down
4 changes: 2 additions & 2 deletions docs/template-byo.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ For example, this YAML describes a custom `Source` object of `kind` `HelmReposit
apiVersion: source.toolkit.fluxcd.io/v1
kind: HelmRepository
metadata:
name: k0rdent-templates
name: k0rdent-catalog
namespace: kcm-system
labels:
k0rdent.mirantis.com/managed: "true"
Expand Down Expand Up @@ -101,7 +101,7 @@ spec:
chart: os-k0sproject-k0smotron
sourceRef:
kind: HelmRepository
name: k0rdent-templates
name: k0rdent-catalog
```

> EXAMPLE:
Expand Down
6 changes: 3 additions & 3 deletions docs/template-intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ spec:
reconcileStrategy: ChartVersion
sourceRef:
kind: HelmRepository
name: k0rdent-templates
name: k0rdent-catalog
version: 0.0.4
status:
capiContracts:
Expand Down Expand Up @@ -69,7 +69,7 @@ spec:
reconcileStrategy: ChartVersion
sourceRef:
kind: HelmRepository
name: k0rdent-templates
name: k0rdent-catalog
version: 0.0.3
status:
chartRef:
Expand Down Expand Up @@ -150,7 +150,7 @@ spec:
reconcileStrategy: ChartVersion
sourceRef:
kind: HelmRepository
name: k0rdent-templates
name: k0rdent-catalog
version: 3.2.6
status:
chartRef:
Expand Down
2 changes: 1 addition & 1 deletion docs/user-create-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ Follow these steps to deploy a standalone Kubernetes cluster:
apiVersion: k0rdent.mirantis.com/v1alpha1
kind: ClusterDeployment
metadata:
name: my-managed-cluster
name: my-cluster-deployment
namespace: kcm-system
spec:
template: aws-standalone-cp-0-0-3
Expand Down
40 changes: 19 additions & 21 deletions docs/user-create-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,32 +56,33 @@ when you create it, as in:
apiVersion: k0rdent.mirantis.com/v1alpha1
kind: ClusterDeployment
metadata:
name: my-managed-cluster
name: my-cluster-deployment
namespace: tenant42
spec:
config:
clusterLabels: {}
template: aws-standalone-cp-0-0-3
credential: aws-credential
services:
- template: project-ingress-nginx-4.11.0
name: ingress-nginx
namespace: tenant42
servicesPriority: 100
stopOnConflict: false
serviceSpec:
services:
- template: project-ingress-nginx-4.11.0
name: ingress-nginx
namespace: tenant42
priority: 100
```
As you can see, you're simply referencing the template in the `.spec.services.template` field of the `ClusterDeployment`
As you can see, you're simply referencing the template in the `.spec.serviceSpec.services[].template` field of the `ClusterDeployment`
to tell k0rdent that you want this service to be part of this cluster.

If you wanted to add this serice to an existing cluster, you would simply patch the definition of the `ClusterDeployment`, as in:
If you wanted to add this service to an existing cluster, you would simply patch the definition of the `ClusterDeployment`, as in:

```yaml
kubectl patch clusterdeployment my-managed-cluster -n tenant42 --type='merge' -p '
kubectl patch clusterdeployment my-cluster-deployment -n tenant42 --type='merge' -p '
spec:
services:
- template: project-ingress-nginx-4.11.0
name: ingress-nginx
namespace: tenant42
serviceSpec:
services:
- template: project-ingress-nginx-4.11.0
name: ingress-nginx
namespace: tenant42
```

Let's look at a more complex case, involving deploying beach-head services on a single cluster.
Expand All @@ -94,7 +95,7 @@ Beach-head services can be installed on a cluster deployment (that is, a target
apiVersion: k0rdent.mirantis.com/v1alpha1
kind: ClusterDeployment
metadata:
name: my-managed-cluster
name: my-cluster-deployment
namespace: kcm-system
spec:
config:
Expand Down Expand Up @@ -148,15 +149,12 @@ spec:
chart: kyverno
version: 3.2.6
interval: 10m0s
reconcileStrategy: ChartVersion
sourceRef:
kind: HelmRepository
name: kcm-templates
version: 3.2.6
name: k0rdent-templates
name: k0rdent-catalog
```

The `k0rdent-templates` helm repository hosts the actual kyverno chart version 3.2.6.
The `k0rdent-catalog` helm repository hosts the actual kyverno chart version 3.2.6.
For more details see the [Bring your own Templates](template-byo.md) guide.

### Configuring Custom Values
Expand Down Expand Up @@ -266,7 +264,7 @@ status:
. . .
observedGeneration: 1
services:
- clusterName: my-managed-cluster
- clusterName: my-cluster-deployment
clusterNamespace: kcm-system
conditions:
- lastTransitionTime: "2024-12-11T23:03:05Z"
Expand Down