Skip to content

Commit d2e7f4a

Browse files
authored
Merge pull request #26352 from kbhawkey/fixup-remove-word-easy
clean up use of word: easy
2 parents 8a8f87f + c4ef1d4 commit d2e7f4a

File tree

28 files changed

+74
-71
lines changed

28 files changed

+74
-71
lines changed

content/en/docs/concepts/cluster-administration/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,12 @@ See the guides in [Setup](/docs/setup/) for examples of how to plan, set up, and
2626

2727
Before choosing a guide, here are some considerations:
2828

29-
- Do you just want to try out Kubernetes on your computer, or do you want to build a high-availability, multi-node cluster? Choose distros best suited for your needs.
29+
- Do you want to try out Kubernetes on your computer, or do you want to build a high-availability, multi-node cluster? Choose distros best suited for your needs.
3030
- Will you be using **a hosted Kubernetes cluster**, such as [Google Kubernetes Engine](https://cloud.google.com/kubernetes-engine/), or **hosting your own cluster**?
3131
- Will your cluster be **on-premises**, or **in the cloud (IaaS)**? Kubernetes does not directly support hybrid clusters. Instead, you can set up multiple clusters.
3232
- **If you are configuring Kubernetes on-premises**, consider which [networking model](/docs/concepts/cluster-administration/networking/) fits best.
3333
- Will you be running Kubernetes on **"bare metal" hardware** or on **virtual machines (VMs)**?
34-
- Do you **just want to run a cluster**, or do you expect to do **active development of Kubernetes project code**? If the
34+
- Do you **want to run a cluster**, or do you expect to do **active development of Kubernetes project code**? If the
3535
latter, choose an actively-developed distro. Some distros only use binary releases, but
3636
offer a greater variety of choices.
3737
- Familiarize yourself with the [components](/docs/concepts/overview/components/) needed to run a cluster.

content/en/docs/concepts/cluster-administration/manage-deployment.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ deployment.apps "my-nginx" deleted
7070
service "my-nginx-svc" deleted
7171
```
7272

73-
In the case of just two resources, it's also easy to specify both on the command line using the resource/name syntax:
73+
In the case of two resources, you can specify both resources on the command line using the resource/name syntax:
7474

7575
```shell
7676
kubectl delete deployments/my-nginx services/my-nginx-svc
@@ -87,7 +87,7 @@ deployment.apps "my-nginx" deleted
8787
service "my-nginx-svc" deleted
8888
```
8989

90-
Because `kubectl` outputs resource names in the same syntax it accepts, it's easy to chain operations using `$()` or `xargs`:
90+
Because `kubectl` outputs resource names in the same syntax it accepts, you can chain operations using `$()` or `xargs`:
9191

9292
```shell
9393
kubectl get $(kubectl create -f docs/concepts/cluster-administration/nginx/ -o name | grep service)
@@ -302,6 +302,7 @@ Sometimes you would want to attach annotations to resources. Annotations are arb
302302
kubectl annotate pods my-nginx-v4-9gw19 description='my frontend running nginx'
303303
kubectl get pods my-nginx-v4-9gw19 -o yaml
304304
```
305+
305306
```shell
306307
apiVersion: v1
307308
kind: pod
@@ -315,11 +316,12 @@ For more information, please see [annotations](/docs/concepts/overview/working-w
315316

316317
## Scaling your application
317318

318-
When load on your application grows or shrinks, it's easy to scale with `kubectl`. For instance, to decrease the number of nginx replicas from 3 to 1, do:
319+
When load on your application grows or shrinks, use `kubectl` to scale your application. For instance, to decrease the number of nginx replicas from 3 to 1, do:
319320

320321
```shell
321322
kubectl scale deployment/my-nginx --replicas=1
322323
```
324+
323325
```shell
324326
deployment.apps/my-nginx scaled
325327
```
@@ -329,6 +331,7 @@ Now you only have one pod managed by the deployment.
329331
```shell
330332
kubectl get pods -l app=nginx
331333
```
334+
332335
```shell
333336
NAME READY STATUS RESTARTS AGE
334337
my-nginx-2035384211-j5fhi 1/1 Running 0 30m
@@ -339,6 +342,7 @@ To have the system automatically choose the number of nginx replicas as needed,
339342
```shell
340343
kubectl autoscale deployment/my-nginx --min=1 --max=3
341344
```
345+
342346
```shell
343347
horizontalpodautoscaler.autoscaling/my-nginx autoscaled
344348
```
@@ -412,6 +416,7 @@ In some cases, you may need to update resource fields that cannot be updated onc
412416
```shell
413417
kubectl replace -f https://k8s.io/examples/application/nginx/nginx-deployment.yaml --force
414418
```
419+
415420
```shell
416421
deployment.apps/my-nginx deleted
417422
deployment.apps/my-nginx replaced
@@ -428,14 +433,17 @@ Let's say you were running version 1.14.2 of nginx:
428433
```shell
429434
kubectl create deployment my-nginx --image=nginx:1.14.2
430435
```
436+
431437
```shell
432438
deployment.apps/my-nginx created
433439
```
434440

435441
with 3 replicas (so the old and new revisions can coexist):
442+
436443
```shell
437444
kubectl scale deployment my-nginx --current-replicas=1 --replicas=3
438445
```
446+
439447
```
440448
deployment.apps/my-nginx scaled
441449
```

content/en/docs/concepts/cluster-administration/system-logs.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,22 +31,24 @@ I1025 00:15:15.525108 1 httplog.go:79] GET /api/v1/namespaces/kube-system/
3131

3232
{{< feature-state for_k8s_version="v1.19" state="alpha" >}}
3333

34-
{{<warning>}}
34+
{{< warning >}}
3535
Migration to structured log messages is an ongoing process. Not all log messages are structured in this version. When parsing log files, you must also handle unstructured log messages.
3636

3737
Log formatting and value serialization are subject to change.
3838
{{< /warning>}}
3939

40-
Structured logging is a effort to introduce a uniform structure in log messages allowing for easy extraction of information, making logs easier and cheaper to store and process.
40+
Structured logging introduces a uniform structure in log messages allowing for programmatic extraction of information. You can store and process structured logs with less effort and cost.
4141
New message format is backward compatible and enabled by default.
4242

4343
Format of structured logs:
44-
```
44+
45+
```ini
4546
<klog header> "<message>" <key1>="<value1>" <key2>="<value2>" ...
4647
```
4748

4849
Example:
49-
```
50+
51+
```ini
5052
I1025 00:15:15.525108 1 controller_utils.go:116] "Pod status updated" pod="kube-system/kubedns" status="ready"
5153
```
5254

content/en/docs/concepts/configuration/overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,13 +59,13 @@ DNS server watches the Kubernetes API for new `Services` and creates a set of DN
5959

6060
- Avoid using `hostNetwork`, for the same reasons as `hostPort`.
6161

62-
- Use [headless Services](/docs/concepts/services-networking/service/#headless-services) (which have a `ClusterIP` of `None`) for easy service discovery when you don't need `kube-proxy` load balancing.
62+
- Use [headless Services](/docs/concepts/services-networking/service/#headless-services) (which have a `ClusterIP` of `None`) for service discovery when you don't need `kube-proxy` load balancing.
6363

6464
## Using Labels
6565

6666
- Define and use [labels](/docs/concepts/overview/working-with-objects/labels/) that identify __semantic attributes__ of your application or Deployment, such as `{ app: myapp, tier: frontend, phase: test, deployment: v3 }`. You can use these labels to select the appropriate Pods for other resources; for example, a Service that selects all `tier: frontend` Pods, or all `phase: test` components of `app: myapp`. See the [guestbook](https://github.com/kubernetes/examples/tree/{{< param "githubbranch" >}}/guestbook/) app for examples of this approach.
6767

68-
A Service can be made to span multiple Deployments by omitting release-specific labels from its selector. [Deployments](/docs/concepts/workloads/controllers/deployment/) make it easy to update a running service without downtime.
68+
A Service can be made to span multiple Deployments by omitting release-specific labels from its selector. When you need to update a running service without downtime, use a [Deployment](/docs/concepts/workloads/controllers/deployment/).
6969

7070
A desired state of an object is described by a Deployment, and if changes to that spec are _applied_, the deployment controller changes the actual state to the desired state at a controlled rate.
7171

content/en/docs/concepts/overview/what-is-kubernetes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Each VM is a full machine running all the components, including its own operatin
4343
Containers have become popular because they provide extra benefits, such as:
4444

4545
* Agile application creation and deployment: increased ease and efficiency of container image creation compared to VM image use.
46-
* Continuous development, integration, and deployment: provides for reliable and frequent container image build and deployment with quick and easy rollbacks (due to image immutability).
46+
* Continuous development, integration, and deployment: provides for reliable and frequent container image build and deployment with quick and efficient rollbacks (due to image immutability).
4747
* Dev and Ops separation of concerns: create application container images at build/release time rather than deployment time, thereby decoupling applications from infrastructure.
4848
* Observability not only surfaces OS-level information and metrics, but also application health and other signals.
4949
* Environmental consistency across development, testing, and production: Runs the same on a laptop as it does in the cloud.

content/en/docs/concepts/overview/working-with-objects/labels.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Example labels:
4242
* `"partition" : "customerA"`, `"partition" : "customerB"`
4343
* `"track" : "daily"`, `"track" : "weekly"`
4444

45-
These are just examples of commonly used labels; you are free to develop your own conventions. Keep in mind that label Key must be unique for a given object.
45+
These are examples of commonly used labels; you are free to develop your own conventions. Keep in mind that label Key must be unique for a given object.
4646

4747
## Syntax and character set
4848

content/en/docs/concepts/overview/working-with-objects/object-management.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ When using imperative commands, a user operates directly on live objects
3131
in a cluster. The user provides operations to
3232
the `kubectl` command as arguments or flags.
3333

34-
This is the simplest way to get started or to run a one-off task in
34+
This is the recommended way to get started or to run a one-off task in
3535
a cluster. Because this technique operates directly on live
3636
objects, it provides no history of previous configurations.
3737

@@ -47,7 +47,7 @@ kubectl create deployment nginx --image nginx
4747

4848
Advantages compared to object configuration:
4949

50-
- Commands are simple, easy to learn and easy to remember.
50+
- Commands are expressed as a single action word.
5151
- Commands require only a single step to make changes to the cluster.
5252

5353
Disadvantages compared to object configuration:

content/en/docs/concepts/scheduling-eviction/scheduling-framework.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,9 @@ weight: 70
1010

1111
{{< feature-state for_k8s_version="v1.15" state="alpha" >}}
1212

13-
The scheduling framework is a pluggable architecture for Kubernetes Scheduler
14-
that makes scheduler customizations easy. It adds a new set of "plugin" APIs to
15-
the existing scheduler. Plugins are compiled into the scheduler. The APIs
16-
allow most scheduling features to be implemented as plugins, while keeping the
17-
scheduling "core" simple and maintainable. Refer to the [design proposal of the
13+
The scheduling framework is a pluggable architecture for the Kubernetes scheduler.
14+
It adds a new set of "plugin" APIs to the existing scheduler. Plugins are compiled into the scheduler. The APIs allow most scheduling features to be implemented as plugins, while keeping the
15+
scheduling "core" lightweight and maintainable. Refer to the [design proposal of the
1816
scheduling framework][kep] for more technical information on the design of the
1917
framework.
2018

content/en/docs/concepts/workloads/controllers/replicationcontroller.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,8 @@ As mentioned above, whether you have 1 pod you want to keep running, or 1000, a
208208

209209
### Scaling
210210

211-
The ReplicationController makes it easy to scale the number of replicas up or down, either manually or by an auto-scaling control agent, by simply updating the `replicas` field.
211+
The ReplicationController scales the number of replicas up or down by setting the `replicas` field.
212+
You can configure the ReplicationController to manage the replicas manually or by an auto-scaling control agent.
212213

213214
### Rolling updates
214215

content/en/docs/reference/access-authn-authz/authentication.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,8 @@ when interpreted by an [authorizer](/docs/reference/access-authn-authz/authoriza
6868

6969
You can enable multiple authentication methods at once. You should usually use at least two methods:
7070

71-
- service account tokens for service accounts
72-
- at least one other method for user authentication.
71+
- service account tokens for service accounts
72+
- at least one other method for user authentication.
7373

7474
When multiple authenticator modules are enabled, the first module
7575
to successfully authenticate the request short-circuits evaluation.
@@ -321,13 +321,11 @@ sequenceDiagram
321321
9. `kubectl` provides feedback to the user
322322

323323
Since all of the data needed to validate who you are is in the `id_token`, Kubernetes doesn't need to
324-
"phone home" to the identity provider. In a model where every request is stateless this provides a very scalable
325-
solution for authentication. It does offer a few challenges:
326-
327-
1. Kubernetes has no "web interface" to trigger the authentication process. There is no browser or interface to collect credentials which is why you need to authenticate to your identity provider first.
328-
2. The `id_token` can't be revoked, it's like a certificate so it should be short-lived (only a few minutes) so it can be very annoying to have to get a new token every few minutes.
329-
3. There's no easy way to authenticate to the Kubernetes dashboard without using the `kubectl proxy` command or a reverse proxy that injects the `id_token`.
324+
"phone home" to the identity provider. In a model where every request is stateless this provides a very scalable solution for authentication. It does offer a few challenges:
330325

326+
1. Kubernetes has no "web interface" to trigger the authentication process. There is no browser or interface to collect credentials which is why you need to authenticate to your identity provider first.
327+
2. The `id_token` can't be revoked, it's like a certificate so it should be short-lived (only a few minutes) so it can be very annoying to have to get a new token every few minutes.
328+
3. To authenticate to the Kubernetes dashboard, you must the `kubectl proxy` command or a reverse proxy that injects the `id_token`.
331329

332330
#### Configuring the API Server
333331

0 commit comments

Comments
 (0)