Skip to content

Commit ca154ad

Browse files
committed
fix review findings
1 parent ec5f9ca commit ca154ad

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

docs/book/src/tasks/experimental-features/cluster-class/write-clusterclass.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11

22
# Writing a ClusterClass
33

4-
While a ClusterClass can be also used for a single Cluster, usually a ClusterClass is used across many
5-
clusters. Therefore a ClusterClass becomes more useful when it's flexible enough to support a wide
6-
range of use cases. The goal of this document is to explain how ClusterClasses can be written in
7-
general and how they can be written in a way that they are flexible enough to support many use cases.
4+
A ClusterClass becomes more useful and valuable when it can be used to create many Cluster of a similar
5+
shape. The goal of this document is to explain how ClusterClasses can be written in a way that they are
6+
flexible enough to be used in as many Cluster as possible by supporting variants of the same base Cluster shape.
87

98
**Table of Contents**
109

@@ -113,15 +112,16 @@ Best practices:
113112
of a ClusterClass to another, consider including a version suffix in the ClusterClass name.
114113
For more information about changing a ClusterClass please see: [Changing a ClusterClass].
115114
* Prefix the templates used in a ClusterClass with the name of the ClusterClass.
116-
* Don't use templates with the same name in multiple ClusterClasses. This is automatically taken care
115+
* Don't reuse the same template in multiple ClusterClasses. This is automatically taken care
117116
of by prefixing the templates with the name of the ClusterClass.
118117

119118
<aside class="note">
120119

121120
<h1>Tip: clusterctl alpha topology plan</h1>
122121

123-
`clusterctl alpha topology plan` can be used to render objects of a managed topology without having to create or update
124-
a Cluster or a ClusterClass in Kubernetes. For more details please see: [clusterctl alpha topology plan].
122+
The `clusterctl alpha topology plan` command can be used to test ClusterClasses; the output will show
123+
you how the resulting Cluster will look like, but without actually creating it.
124+
For more details please see: [clusterctl alpha topology plan].
125125

126126
</aside>
127127

@@ -243,7 +243,8 @@ spec:
243243

244244
**Setting variable values in the Cluster**
245245

246-
The user can now provide a value for the variable in the Cluster.
246+
After creating a ClusterClass with a variable definition, the user can now provide a value for
247+
the variable in the Cluster as in the example below.
247248

248249
```yaml
249250
apiVersion: cluster.x-k8s.io/v1beta1

0 commit comments

Comments
 (0)