Skip to content

Commit 0df45a7

Browse files
authored
Merge pull request #29154 from cslauritsen/patch-1
mark adjectival phrases with hyphens
2 parents 3b7a561 + abeaf3e commit 0df45a7

File tree

1 file changed

+15
-13
lines changed

1 file changed

+15
-13
lines changed

content/en/docs/tasks/administer-cluster/securing-a-cluster.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ and provides recommendations on overall security.
2626

2727
## Controlling access to the Kubernetes API
2828

29-
As Kubernetes is entirely API driven, controlling and limiting who can access the cluster and what actions
29+
As Kubernetes is entirely API-driven, controlling and limiting who can access the cluster and what actions
3030
they are allowed to perform is the first line of defense.
3131

3232
### Use Transport Layer Security (TLS) for all API traffic
@@ -40,7 +40,7 @@ potentially unsecured traffic.
4040
### API Authentication
4141

4242
Choose an authentication mechanism for the API servers to use that matches the common access patterns
43-
when you install a cluster. For instance, small single user clusters may wish to use a simple certificate
43+
when you install a cluster. For instance, small, single-user clusters may wish to use a simple certificate
4444
or static Bearer token approach. Larger clusters may wish to integrate an existing OIDC or LDAP server that
4545
allow users to be subdivided into groups.
4646

@@ -54,7 +54,7 @@ Consult the [authentication reference document](/docs/reference/access-authn-aut
5454
Once authenticated, every API call is also expected to pass an authorization check. Kubernetes ships
5555
an integrated [Role-Based Access Control (RBAC)](/docs/reference/access-authn-authz/rbac/) component that matches an incoming user or group to a
5656
set of permissions bundled into roles. These permissions combine verbs (get, create, delete) with
57-
resources (pods, services, nodes) and can be namespace or cluster scoped. A set of out of the box
57+
resources (pods, services, nodes) and can be namespace-scoped or cluster-scoped. A set of out-of-the-box
5858
roles are provided that offer reasonable default separation of responsibility depending on what
5959
actions a client might want to perform. It is recommended that you use the
6060
[Node](/docs/reference/access-authn-authz/node/) and
@@ -69,8 +69,8 @@ With authorization, it is important to understand how updates on one object may
6969
other places. For instance, a user may not be able to create pods directly, but allowing them to
7070
create a deployment, which creates pods on their behalf, will let them create those pods
7171
indirectly. Likewise, deleting a node from the API will result in the pods scheduled to that node
72-
being terminated and recreated on other nodes. The out of the box roles represent a balance
73-
between flexibility and the common use cases, but more limited roles should be carefully reviewed
72+
being terminated and recreated on other nodes. The out-of-the box roles represent a balance
73+
between flexibility and common use cases, but more limited roles should be carefully reviewed
7474
to prevent accidental escalation. You can make roles specific to your use case if the out-of-box ones don't meet your needs.
7575

7676
Consult the [authorization reference section](/docs/reference/access-authn-authz/authorization/) for more information.
@@ -104,7 +104,7 @@ reserved resources like memory, or to provide default limits when none are speci
104104
### Controlling what privileges containers run with
105105

106106
A pod definition contains a [security context](/docs/tasks/configure-pod-container/security-context/)
107-
that allows it to request access to running as a specific Linux user on a node (like root),
107+
that allows it to request access to run as a specific Linux user on a node (like root),
108108
access to run privileged or access the host network, and other controls that would otherwise
109109
allow it to run unfettered on a hosting node. [Pod security policies](/docs/concepts/policy/pod-security-policy/)
110110
can limit which users or service accounts can provide dangerous security context settings. For example, pod security policies can limit volume mounts, especially `hostPath`, which are aspects of a pod that should be controlled.
@@ -155,10 +155,10 @@ within their namespaces. Many of the supported [Kubernetes networking providers]
155155
now respect network policy.
156156

157157
Quota and limit ranges can also be used to control whether users may request node ports or
158-
load balanced services, which on many clusters can control whether those users applications
158+
load-balanced services, which on many clusters can control whether those users applications
159159
are visible outside of the cluster.
160160

161-
Additional protections may be available that control network rules on a per plugin or per
161+
Additional protections may be available that control network rules on a per-plugin or per-
162162
environment basis, such as per-node firewalls, physically separating cluster nodes to
163163
prevent cross talk, or advanced networking policy.
164164

@@ -169,15 +169,15 @@ By default these APIs are accessible by pods running on an instance and can cont
169169
credentials for that node, or provisioning data such as kubelet credentials. These credentials
170170
can be used to escalate within the cluster or to other cloud services under the same account.
171171

172-
When running Kubernetes on a cloud platform limit permissions given to instance credentials, use
172+
When running Kubernetes on a cloud platform, limit permissions given to instance credentials, use
173173
[network policies](/docs/tasks/administer-cluster/declare-network-policy/) to restrict pod access
174174
to the metadata API, and avoid using provisioning data to deliver secrets.
175175

176176
### Controlling which nodes pods may access
177177

178178
By default, there are no restrictions on which nodes may run a pod. Kubernetes offers a
179179
[rich set of policies for controlling placement of pods onto nodes](/docs/concepts/scheduling-eviction/assign-pod-node/)
180-
and the [taint based pod placement and eviction](/docs/concepts/scheduling-eviction/taint-and-toleration/)
180+
and the [taint-based pod placement and eviction](/docs/concepts/scheduling-eviction/taint-and-toleration/)
181181
that are available to end users. For many clusters use of these policies to separate workloads
182182
can be a convention that authors adopt or enforce via tooling.
183183

@@ -223,8 +223,9 @@ do not use.
223223
The shorter the lifetime of a secret or credential the harder it is for an attacker to make
224224
use of that credential. Set short lifetimes on certificates and automate their rotation. Use
225225
an authentication provider that can control how long issued tokens are available and use short
226-
lifetimes where possible. If you use service account tokens in external integrations, plan to
227-
rotate those tokens frequently. For example, once the bootstrap phase is complete, a bootstrap token used for setting up nodes should be revoked or its authorization removed.
226+
lifetimes where possible. If you use service-account tokens in external integrations, plan to
227+
rotate those tokens frequently. For example, once the bootstrap phase is complete, a bootstrap
228+
token used for setting up nodes should be revoked or its authorization removed.
228229

229230
### Review third party integrations before enabling them
230231

@@ -246,7 +247,8 @@ and may grant an attacker significant visibility into the state of your cluster.
246247
your backups using a well reviewed backup and encryption solution, and consider using full disk
247248
encryption where possible.
248249

249-
Kubernetes supports [encryption at rest](/docs/tasks/administer-cluster/encrypt-data/), a feature introduced in 1.7, and beta since 1.13. This will encrypt `Secret` resources in etcd, preventing
250+
Kubernetes supports [encryption at rest](/docs/tasks/administer-cluster/encrypt-data/), a feature
251+
introduced in 1.7, and beta since 1.13. This will encrypt `Secret` resources in etcd, preventing
250252
parties that gain access to your etcd backups from viewing the content of those secrets. While
251253
this feature is currently beta, it offers an additional level of defense when backups
252254
are not encrypted or an attacker gains read access to etcd.

0 commit comments

Comments
 (0)