Skip to content

Commit 9ba92ac

Browse files
authored
Merge pull request #34759 from sftim/20220701_wording_tweaks_extend_kubernetes
Tweak custom resources concept
2 parents 0fac402 + dd61562 commit 9ba92ac

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

content/en/docs/concepts/extend-kubernetes/api-extension/custom-resources.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ many core Kubernetes functions are now built using custom resources, making Kube
2626
Custom resources can appear and disappear in a running cluster through dynamic registration,
2727
and cluster admins can update custom resources independently of the cluster itself.
2828
Once a custom resource is installed, users can create and access its objects using
29-
[kubectl](/docs/reference/kubectl/), just as they do for built-in resources like
30-
*Pods*.
29+
{{< glossary_tooltip text="kubectl" term_id="kubectl" >}}, just as they do for built-in resources
30+
like *Pods*.
3131

3232
## Custom controllers
3333

@@ -48,7 +48,7 @@ but they are especially effective when combined with custom resources. The
4848
resources and custom controllers. You can use custom controllers to encode domain knowledge
4949
for specific applications into an extension of the Kubernetes API.
5050

51-
## Should I add a custom resource to my Kubernetes Cluster?
51+
## Should I add a custom resource to my Kubernetes cluster?
5252

5353
When creating a new API, consider whether to
5454
[aggregate your API with the Kubernetes cluster APIs](/docs/concepts/extend-kubernetes/api-extension/apiserver-aggregation/)
@@ -88,18 +88,18 @@ Signs that your API might not be declarative include:
8888
- The API is not easily modeled as objects.
8989
- You chose to represent pending operations with an operation ID or an operation object.
9090

91-
## Should I use a configMap or a custom resource?
91+
## Should I use a ConfigMap or a custom resource?
9292

9393
Use a ConfigMap if any of the following apply:
9494

95-
* There is an existing, well-documented config file format, such as a `mysql.cnf` or `pom.xml`.
96-
* You want to put the entire config file into one key of a configMap.
97-
* The main use of the config file is for a program running in a Pod on your cluster to consume the file to configure itself.
95+
* There is an existing, well-documented configuration file format, such as a `mysql.cnf` or `pom.xml`.
96+
* You want to put the entire configuration into one key of a ConfigMap.
97+
* The main use of the configuration file is for a program running in a Pod on your cluster to consume the file to configure itself.
9898
* Consumers of the file prefer to consume via file in a Pod or environment variable in a pod, rather than the Kubernetes API.
9999
* You want to perform rolling updates via Deployment, etc., when the file is updated.
100100

101101
{{< note >}}
102-
Use a [secret](/docs/concepts/configuration/secret/) for sensitive data, which is similar to a configMap but more secure.
102+
Use a {{< glossary_tooltip text="Secret" term_id="secret" >}} for sensitive data, which is similar to a ConfigMap but more secure.
103103
{{< /note >}}
104104

105105
Use a custom resource (CRD or Aggregated API) if most of the following apply:
@@ -242,7 +242,7 @@ Kubernetes [client libraries](/docs/reference/using-api/client-libraries/) can b
242242
When you add a custom resource, you can access it using:
243243

244244
- `kubectl`
245-
- The kubernetes dynamic client.
245+
- The Kubernetes dynamic client.
246246
- A REST client that you write.
247247
- A client generated using [Kubernetes client generation tools](https://github.com/kubernetes/code-generator) (generating one is an advanced undertaking, but some projects may provide a client along with the CRD or AA).
248248

0 commit comments

Comments
 (0)