Skip to content

Commit 002194f

Browse files
committed
docs/concepts/policy/pod-security-policy: list all available PSP fields.
This also adds a couple of improvements: - rename SELinuxContext to SELinux - improve options displaying
1 parent 6aed52c commit 002194f

File tree

1 file changed

+26
-19
lines changed

1 file changed

+26
-19
lines changed

docs/concepts/policy/pod-security-policy.md

+26-19
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,22 @@ actions that a pod can perform and what it has the ability to access. The
2121
run with in order to be accepted into the system. They allow an
2222
administrator to control the following:
2323

24-
1. Running of privileged containers.
25-
1. Capabilities a container can request to be added.
26-
1. The SELinux context of the container.
27-
1. The user ID.
28-
1. The use of host namespaces and networking.
29-
1. Allocating an FSGroup that owns the pod's volumes
30-
1. Configuring allowable supplemental groups
31-
1. Requiring the use of a read only root file system
32-
1. Controlling the usage of volume types
24+
| Control Aspect | Field Name |
25+
| ------------------------------------------------------------- | --------------------------------- |
26+
| Running of privileged containers | `privileged` |
27+
| Default set of capabilities that will be added to a container | `defaultAddCapabilities` |
28+
| Capabilities that will be dropped from a container | `requiredDropCapabilities` |
29+
| Capabilities a container can request to be added | `allowedCapabilities` |
30+
| Controlling the usage of volume types | [`volumes`](#controlling-volumes) |
31+
| The use of host networking | [`hostNetwork`](#host-network) |
32+
| The use of host ports | `hostPorts` |
33+
| The use of host's PID namespace | `hostPID` |
34+
| The use of host's IPC namespace | `hostIPC` |
35+
| The SELinux context of the container | [`seLinux`](#selinux) |
36+
| The user ID | [`runAsUser`](#runasuser) |
37+
| Configuring allowable supplemental groups | [`supplementalGroups`](#supplementalgroups) |
38+
| Allocating an FSGroup that owns the pod's volumes | [`fsGroup`](#fsgroup) |
39+
| Requiring the use of a read only root file system | `readOnlyRootFilesystem` |
3340

3441
_Pod Security Policies_ are comprised of settings and strategies that
3542
control the security features a pod has access to. These settings fall
@@ -48,34 +55,34 @@ specified value falls into the set of allowable values.
4855

4956
### RunAsUser
5057

51-
- *MustRunAs* - Requires a `*range*` to be configured. Uses the first value
58+
- *MustRunAs* - Requires a `range` to be configured. Uses the first value
5259
of the range as the default. Validates against the configured range.
5360
- *MustRunAsNonRoot* - Requires that the pod be submitted with a non-zero
54-
`*runAsUser*` or have the `USER` directive defined in the image. No default
61+
`runAsUser` or have the `USER` directive defined in the image. No default
5562
provided.
56-
- *RunAsAny* - No default provided. Allows any `*runAsUser*` to be specified.
63+
- *RunAsAny* - No default provided. Allows any `runAsUser` to be specified.
5764

58-
### SELinuxContext
65+
### SELinux
5966

60-
- *MustRunAs* - Requires `*seLinuxOptions*` to be configured if not using
61-
pre-allocated values. Uses `*seLinuxOptions*` as the default. Validates against
62-
`*seLinuxOptions*`.
63-
- *RunAsAny* - No default provided. Allows any `*seLinuxOptions*` to be
67+
- *MustRunAs* - Requires `seLinuxOptions` to be configured if not using
68+
pre-allocated values. Uses `seLinuxOptions` as the default. Validates against
69+
`seLinuxOptions`.
70+
- *RunAsAny* - No default provided. Allows any `seLinuxOptions` to be
6471
specified.
6572

6673
### SupplementalGroups
6774

6875
- *MustRunAs* - Requires at least one range to be specified. Uses the
6976
minimum value of the first range as the default. Validates against all ranges.
70-
- *RunAsAny* - No default provided. Allows any `*supplementalGroups*` to be
77+
- *RunAsAny* - No default provided. Allows any `supplementalGroups` to be
7178
specified.
7279

7380
### FSGroup
7481

7582
- *MustRunAs* - Requires at least one range to be specified. Uses the
7683
minimum value of the first range as the default. Validates against the
7784
first ID in the first range.
78-
- *RunAsAny* - No default provided. Allows any `*fsGroup*` ID to be specified.
85+
- *RunAsAny* - No default provided. Allows any `fsGroup` ID to be specified.
7986

8087
### Controlling Volumes
8188

0 commit comments

Comments
 (0)