Skip to content

Commit 7c89f56

Browse files
authored
consistency for capitalization of term operator in documentation (#35753)
* Because operators are not kubernetes objects, the word operators should only be capitlized at the start of sentences, URLs where the external source has done so, abbreviations, or start of headers. * only changing en initially for the pr process * text styling on line 18 for operator pattern
1 parent 9084afa commit 7c89f56

File tree

1 file changed

+20
-20
lines changed

1 file changed

+20
-20
lines changed

content/en/docs/concepts/extend-kubernetes/operator.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@ Kubernetes principles, notably the [control loop](/docs/concepts/architecture/co
1515

1616
## Motivation
1717

18-
The Operator pattern aims to capture the key aim of a human operator who
18+
The _operator pattern_ aims to capture the key aim of a human operator who
1919
is managing a service or set of services. Human operators who look after
2020
specific applications and services have deep knowledge of how the system
2121
ought to behave, how to deploy it, and how to react if there are problems.
2222

2323
People who run workloads on Kubernetes often like to use automation to take
24-
care of repeatable tasks. The Operator pattern captures how you can write
24+
care of repeatable tasks. The operator pattern captures how you can write
2525
code to automate a task beyond what Kubernetes itself provides.
2626

2727
## Operators in Kubernetes
@@ -35,7 +35,7 @@ Kubernetes' {{< glossary_tooltip text="operator pattern" term_id="operator-patte
3535
Operators are clients of the Kubernetes API that act as controllers for
3636
a [Custom Resource](/docs/concepts/extend-kubernetes/api-extension/custom-resources/).
3737

38-
## An example Operator {#example}
38+
## An example operator {#example}
3939

4040
Some of the things that you can use an operator to automate include:
4141

@@ -49,64 +49,64 @@ Some of the things that you can use an operator to automate include:
4949
* choosing a leader for a distributed application without an internal
5050
member election process
5151

52-
What might an Operator look like in more detail? Here's an example:
52+
What might an operator look like in more detail? Here's an example:
5353

5454
1. A custom resource named SampleDB, that you can configure into the cluster.
5555
2. A Deployment that makes sure a Pod is running that contains the
5656
controller part of the operator.
5757
3. A container image of the operator code.
5858
4. Controller code that queries the control plane to find out what SampleDB
5959
resources are configured.
60-
5. The core of the Operator is code to tell the API server how to make
60+
5. The core of the operator is code to tell the API server how to make
6161
reality match the configured resources.
6262
* If you add a new SampleDB, the operator sets up PersistentVolumeClaims
6363
to provide durable database storage, a StatefulSet to run SampleDB and
6464
a Job to handle initial configuration.
65-
* If you delete it, the Operator takes a snapshot, then makes sure that
65+
* If you delete it, the operator takes a snapshot, then makes sure that
6666
the StatefulSet and Volumes are also removed.
6767
6. The operator also manages regular database backups. For each SampleDB
6868
resource, the operator determines when to create a Pod that can connect
6969
to the database and take backups. These Pods would rely on a ConfigMap
7070
and / or a Secret that has database connection details and credentials.
71-
7. Because the Operator aims to provide robust automation for the resource
71+
7. Because the operator aims to provide robust automation for the resource
7272
it manages, there would be additional supporting code. For this example,
7373
code checks to see if the database is running an old version and, if so,
7474
creates Job objects that upgrade it for you.
7575

76-
## Deploying Operators
76+
## Deploying operators
7777

78-
The most common way to deploy an Operator is to add the
78+
The most common way to deploy an operator is to add the
7979
Custom Resource Definition and its associated Controller to your cluster.
8080
The Controller will normally run outside of the
8181
{{< glossary_tooltip text="control plane" term_id="control-plane" >}},
8282
much as you would run any containerized application.
8383
For example, you can run the controller in your cluster as a Deployment.
8484

85-
## Using an Operator {#using-operators}
85+
## Using an operator {#using-operators}
8686

87-
Once you have an Operator deployed, you'd use it by adding, modifying or
88-
deleting the kind of resource that the Operator uses. Following the above
89-
example, you would set up a Deployment for the Operator itself, and then:
87+
Once you have an operator deployed, you'd use it by adding, modifying or
88+
deleting the kind of resource that the operator uses. Following the above
89+
example, you would set up a Deployment for the operator itself, and then:
9090

9191
```shell
9292
kubectl get SampleDB # find configured databases
9393

9494
kubectl edit SampleDB/example-database # manually change some settings
9595
```
9696

97-
&hellip;and that's it! The Operator will take care of applying the changes
97+
&hellip;and that's it! The operator will take care of applying the changes
9898
as well as keeping the existing service in good shape.
9999

100-
## Writing your own Operator {#writing-operator}
100+
## Writing your own operator {#writing-operator}
101101

102-
If there isn't an Operator in the ecosystem that implements the behavior you
102+
If there isn't an operator in the ecosystem that implements the behavior you
103103
want, you can code your own.
104104

105-
You also implement an Operator (that is, a Controller) using any language / runtime
105+
You also implement an operator (that is, a Controller) using any language / runtime
106106
that can act as a [client for the Kubernetes API](/docs/reference/using-api/client-libraries/).
107107

108108
Following are a few libraries and tools you can use to write your own cloud native
109-
Operator.
109+
operator.
110110

111111
{{% thirdparty-content %}}
112112

@@ -129,6 +129,6 @@ Operator.
129129
* Learn more about [Custom Resources](/docs/concepts/extend-kubernetes/api-extension/custom-resources/)
130130
* Find ready-made operators on [OperatorHub.io](https://operatorhub.io/) to suit your use case
131131
* [Publish](https://operatorhub.io/) your operator for other people to use
132-
* Read [CoreOS' original article](https://web.archive.org/web/20170129131616/https://coreos.com/blog/introducing-operators.html) that introduced the Operator pattern (this is an archived version of the original article).
133-
* Read an [article](https://cloud.google.com/blog/products/containers-kubernetes/best-practices-for-building-kubernetes-operators-and-stateful-apps) from Google Cloud about best practices for building Operators
132+
* Read [CoreOS' original article](https://web.archive.org/web/20170129131616/https://coreos.com/blog/introducing-operators.html) that introduced the operator pattern (this is an archived version of the original article).
133+
* Read an [article](https://cloud.google.com/blog/products/containers-kubernetes/best-practices-for-building-kubernetes-operators-and-stateful-apps) from Google Cloud about best practices for building operators
134134

0 commit comments

Comments
 (0)