Skip to content

Commit fe04fcb

Browse files
committed
Clean up bootstrap token and authn type secret sections
1 parent 13c1c46 commit fe04fcb

File tree

1 file changed

+11
-13
lines changed
  • content/en/docs/concepts/configuration

1 file changed

+11
-13
lines changed

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

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -363,9 +363,9 @@ Secret must contain one of the following two keys:
363363
- `username`: the user name for authentication
364364
- `password`: the password or token for authentication
365365

366-
Both values for the above two keys are base64 encoded strings. You can, of
367-
course, provide the clear text content using the `stringData` for Secret
368-
creation.
366+
Both values for the above two keys are base64 encoded strings. You can
367+
alternatively provide the clear text content using the `stringData` field in the
368+
Secret manifest.
369369

370370
The following manifest is an example of a basic authentication Secret:
371371

@@ -409,12 +409,12 @@ data:
409409
MIIEpQIBAAKCAQEAulqb/Y ...
410410
```
411411

412-
The SSH authentication Secret type is provided only for user's convenience.
413-
You could instead create an `Opaque` type Secret for credentials used for SSH authentication.
412+
The SSH authentication Secret type is provided only for convenience.
413+
You can create an `Opaque` type for credentials used for SSH authentication.
414414
However, using the defined and public Secret type (`kubernetes.io/ssh-auth`) helps other
415415
people to understand the purpose of your Secret, and sets a convention for what key names
416416
to expect.
417-
and the API server does verify if the required keys are provided in a Secret configuration.
417+
The Kubernetes API verifies that the required keys are set for a Secret of this type.
418418

419419
{{< caution >}}
420420
SSH private keys do not establish trusted communication between an SSH client and
@@ -424,10 +424,10 @@ mitigate "man in the middle" attacks, such as a `known_hosts` file added to a Co
424424

425425
### TLS Secrets
426426

427-
Kubernetes provides a builtin Secret type `kubernetes.io/tls` for storing
427+
The `kubernetes.io/tls` Secret type is for storing
428428
a certificate and its associated key that are typically used for TLS.
429429

430-
One common use for TLS secrets is to configure encryption in transit for
430+
One common use for TLS Secrets is to configure encryption in transit for
431431
an [Ingress](/docs/concepts/services-networking/ingress/), but you can also use it
432432
with other resources or directly in your workload.
433433
When using this type of Secret, the `tls.key` and the `tls.crt` key must be provided
@@ -462,8 +462,7 @@ However, using the defined and public Secret type (`kubernetes.io/ssh-auth`)
462462
helps ensure the consistency of Secret format in your project. The API server
463463
verifies if the required keys are set for a Secret of this type.
464464

465-
When creating a TLS Secret using `kubectl`, you can use the `tls` subcommand
466-
as shown in the following example:
465+
To create a TLS Secret using `kubectl`, use the `tls` subcommand:
467466

468467
```shell
469468
kubectl create secret tls my-tls-secret \
@@ -476,8 +475,7 @@ and must match the given private key for `--key`.
476475

477476
### Bootstrap token Secrets
478477

479-
A bootstrap token Secret can be created by explicitly specifying the Secret
480-
`type` to `bootstrap.kubernetes.io/token`. This type of Secret is designed for
478+
The `bootstrap.kubernetes.io/token` Secret type is for
481479
tokens used during the node bootstrap process. It stores tokens used to sign
482480
well-known ConfigMaps.
483481

@@ -504,7 +502,7 @@ data:
504502
usage-bootstrap-signing: dHJ1ZQ==
505503
```
506504

507-
A bootstrap type Secret has the following keys specified under `data`:
505+
A bootstrap token Secret has the following keys specified under `data`:
508506

509507
- `token-id`: A random 6 character string as the token identifier. Required.
510508
- `token-secret`: A random 16 character string as the actual token secret. Required.

0 commit comments

Comments
 (0)