Skip to content

Commit fd29104

Browse files
committed
Fix confusing use of "comprise"
The word "comprise" means "be composed of" or "contain" so "applications comprised of multiple containers" would mean "applications composed of of multiple containers" or "applications contained of multiple containers" which is confusing. I understand that this is nitpicking and that "comprise" has a new meaning which is the opposite of its original definition just like how "literally" now means "figuratively" to some people. However, I believe that clarity is of utmost importance in technical documentation which is why I'm proposing this change.
1 parent 901a5db commit fd29104

File tree

5 files changed

+6
-6
lines changed

5 files changed

+6
-6
lines changed

Diff for: DESIGN.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Is Kubernetes, then, a Docker "orchestration" system? Yes and no.
2424

2525
Kubernetes establishes robust declarative primitives for maintaining the desired state requested by the user. We see these primitives as the main value added by Kubernetes. Self-healing mechanisms, such as auto-restarting, re-scheduling, and replicating containers require active controllers, not just imperative orchestration.
2626

27-
Kubernetes is primarily targeted at applications comprised of multiple containers, such as elastic, distributed micro-services. It is also designed to facilitate migration of non-containerized application stacks to Kubernetes. It therefore includes abstractions for grouping containers in both loosely coupled and tightly coupled formations, and provides ways for containers to find and communicate with each other in relatively familiar ways.
27+
Kubernetes is primarily targeted at applications composed of multiple containers, such as elastic, distributed micro-services. It is also designed to facilitate migration of non-containerized application stacks to Kubernetes. It therefore includes abstractions for grouping containers in both loosely coupled and tightly coupled formations, and provides ways for containers to find and communicate with each other in relatively familiar ways.
2828

2929
Kubernetes enables users to ask a cluster to run a set of containers. The system automatically chooses hosts to run those containers on. While Kubernetes's scheduler is currently very simple, we expect it to grow in sophistication over time. Scheduling is a policy-rich, topology-aware, workload-specific function that significantly impacts availability, performance, and capacity. The scheduler needs to take into account individual and collective resource requirements, quality of service requirements, hardware/software/policy constraints, affinity and anti-affinity specifications, data locality, inter-workload interference, deadlines, and so on. Workload-specific requirements will be exposed through the API as necessary.
3030

@@ -72,7 +72,7 @@ For management convenience and consistency, `services` and `replicationControlle
7272

7373
## The Kubernetes Node
7474

75-
When looking at the architecture of the system, we'll break it down to services that run on the worker node and services that comprise the cluster-level control plane.
75+
When looking at the architecture of the system, we'll break it down to services that run on the worker node and services that compose the cluster-level control plane.
7676

7777
The Kubernetes node has the services necessary to run Docker containers and be managed from the master systems.
7878

Diff for: docs/design/access.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Each of these can act as normal users or attackers.
1515
- External Users: People who are accessing applications running on K8s (e.g. a web site served by webserver running in a container on K8s), but who do not have K8s API access.
1616
- K8s Users : People who access the K8s API (e.g. create K8s API objects like Pods)
1717
- K8s Project Admins: People who manage access for some K8s Users
18-
- K8s Cluster Admins: People who control the machines, networks, or binaries that comprise a K8s cluster.
18+
- K8s Cluster Admins: People who control the machines, networks, or binaries that make up a K8s cluster.
1919
- K8s Admin means K8s Cluster Admins and K8s Project Admins taken together.
2020

2121
### Threats

Diff for: docs/labels.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ These are just examples; you are free to develop your own conventions.
3232

3333
## Syntax and character set
3434

35-
As already mentioned, well formed _labels_ are key value pairs. Valid label keys are comprised of two segments - prefix and name - separated by a slash (`/`). The name segment is required and must be a DNS label: 63 characters or less, all lowercase, beginning and ending with an alphanumeric character (`[a-z0-9A-Z]`), with dashes (`-`) and alphanumerics between. The prefix and slash are optional. If specified, the prefix must be a DNS subdomain (a series of DNS labels separated by dots (`.`), not longer than 253 characters in total.
35+
As already mentioned, well formed _labels_ are key value pairs. Valid label keys have two segments - prefix and name - separated by a slash (`/`). The name segment is required and must be a DNS label: 63 characters or less, all lowercase, beginning and ending with an alphanumeric character (`[a-z0-9A-Z]`), with dashes (`-`) and alphanumerics between. The prefix and slash are optional. If specified, the prefix must be a DNS subdomain (a series of DNS labels separated by dots (`.`), not longer than 253 characters in total.
3636
If the prefix is omitted, the label key is presumed to be private to the user. System components which use labels must specify a prefix. The `kubernetes.io` prefix is reserved for kubernetes core components.
3737

3838
Valid label values must be shorter than 64 characters, accepted characters are (`[-A-Za-z0-9_.]`) but the first character must be (`[A-Za-z0-9]`).

Diff for: docs/replication-controller.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ A _replication controller_ ensures that a specified number of pod "replicas" are
66

77
As discussed in [life of a pod](pod-states.md), `replicationController` is *only* appropriate for pods with `RestartPolicy = Always`. `ReplicationController` should refuse to instantiate any pod that has a different restart policy. As discussed in [issue #503](https://github.com/GoogleCloudPlatform/kubernetes/issues/503#issuecomment-50169443), we expect other types of controllers to be added to Kubernetes to handle other types of workloads, such as build/test and batch workloads, in the future.
88

9-
A replication controller will never terminate on its own, but it isn't expected to be as long-lived as services. Services may be comprised of pods controlled by multiple replication controllers, and it is expected that many replication controllers may be created and destroyed over the lifetime of a service. Both services themselves and their clients should remain oblivious to the replication controllers that maintain the pods of the services.
9+
A replication controller will never terminate on its own, but it isn't expected to be as long-lived as services. Services may be composed of pods controlled by multiple replication controllers, and it is expected that many replication controllers may be created and destroyed over the lifetime of a service. Both services themselves and their clients should remain oblivious to the replication controllers that maintain the pods of the services.
1010

1111
## How does a replication controller work?
1212

Diff for: docs/services.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Selector`](labels.md).
2121

2222
As an example, consider an image-processing backend which is running with 3
2323
replicas. Those replicas are fungible - frontends do not care which backend
24-
they use. While the actual `Pods` that comprise the backend set may change, the
24+
they use. While the actual `Pods` that compose the backend set may change, the
2525
frontend clients should not need to manage that themselves. The `Service`
2626
abstraction enables this decoupling.
2727

0 commit comments

Comments
 (0)