Skip to content

Commit a995de8

Browse files
committed
Change all references from whitelist to allowed
We want to move to more enclusive names/terms in our code, and remove problematic language from code and comments. We want to change reference for whitelist/blacklist to allowlist/denylist. https://www.redhat.com/en/blog/making-open-source-more-inclusive-eradicating-problematic-language We also want to fix slave references to pty for pseutoterminals. We will change the slave refererences to whatever the kernel specifies, once the kernel fixes it's references. Signed-off-by: Daniel J Walsh <[email protected]>
1 parent 8e2f17c commit a995de8

File tree

3 files changed

+10
-8
lines changed

3 files changed

+10
-8
lines changed

config-linux.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ Each entry has the following structure:
120120
If a [file][] already exists at `path` that does not match the requested device, the runtime MUST generate an error.
121121
* **`major, minor`** *(int64, REQUIRED unless `type` is `p`)* - [major, minor numbers][devices] for the device.
122122
* **`fileMode`** *(uint32, OPTIONAL)* - file mode for the device.
123-
You can also control access to devices [with cgroups](#device-whitelist).
123+
You can also control access to devices [with cgroups](#device-allowedlist).
124124
* **`uid`** *(uint32, OPTIONAL)* - id of device owner in the [container namespace](glossary.md#container-namespace).
125125
* **`gid`** *(uint32, OPTIONAL)* - id of device group in the [container namespace](glossary.md#container-namespace).
126126

@@ -161,7 +161,7 @@ In addition to any devices configured with this setting, the runtime MUST also s
161161
* [`/dev/random`][random.4]
162162
* [`/dev/urandom`][random.4]
163163
* [`/dev/tty`][tty.4]
164-
* `/dev/console` is set up if [`terminal`](config.md#process) is enabled in the config by bind mounting the pseudoterminal slave to `/dev/console`.
164+
* `/dev/console` is set up if [`terminal`](config.md#process) is enabled in the config by bind mounting the pseudoterminal pty to `/dev/console`.
165165
* [`/dev/ptmx`][pts.4].
166166
A [bind-mount or symlink of the container's `/dev/pts/ptmx`][devpts].
167167

@@ -214,9 +214,9 @@ Runtimes MAY attach the container process to additional cgroup controllers beyon
214214
}
215215
```
216216

217-
### <a name="configLinuxDeviceWhitelist" />Device whitelist
217+
### <a name="configLinuxDeviceAllowedlist" />Allowed Device list
218218

219-
**`devices`** (array of objects, OPTIONAL) configures the [device whitelist][cgroup-v1-devices].
219+
**`devices`** (array of objects, OPTIONAL) configures the [allowed device list][cgroup-v1-devices].
220220
The runtime MUST apply entries in the listed order.
221221

222222
Each entry has the following structure:

config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ For POSIX platforms the `mounts` structure has the following fields:
145145
This property is REQUIRED when [`start`](runtime.md#start) is called.
146146

147147
* **`terminal`** (bool, OPTIONAL) specifies whether a terminal is attached to the process, defaults to false.
148-
As an example, if set to true on Linux a pseudoterminal pair is allocated for the process and the pseudoterminal slave is duplicated on the process's [standard streams][stdin.3].
148+
As an example, if set to true on Linux a pseudoterminal pair is allocated for the process and the pseudoterminal pty is duplicated on the process's [standard streams][stdin.3].
149149
* **`consoleSize`** (object, OPTIONAL) specifies the console size in characters of the terminal.
150150
Runtimes MUST ignore `consoleSize` if `terminal` is `false` or unset.
151151
* **`height`** (uint, REQUIRED)

specs-go/config.go

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ type Process struct {
6060
SelinuxLabel string `json:"selinuxLabel,omitempty" platform:"linux"`
6161
}
6262

63-
// LinuxCapabilities specifies the whitelist of capabilities that are kept for a process.
63+
// LinuxCapabilities specifies the list of allowed capabilities that are kept for a process.
6464
// http://man7.org/linux/man-pages/man7/capabilities.7.html
6565
type LinuxCapabilities struct {
6666
// Bounding is the set of capabilities checked by the kernel.
@@ -354,7 +354,8 @@ type LinuxRdma struct {
354354

355355
// LinuxResources has container runtime resource constraints
356356
type LinuxResources struct {
357-
// Devices configures the device whitelist.
357+
// Devices configures the only devices allowed to be used within
358+
// the container.
358359
Devices []LinuxDeviceCgroup `json:"devices,omitempty"`
359360
// Memory restriction configuration
360361
Memory *LinuxMemory `json:"memory,omitempty"`
@@ -392,7 +393,8 @@ type LinuxDevice struct {
392393
GID *uint32 `json:"gid,omitempty"`
393394
}
394395

395-
// LinuxDeviceCgroup represents a device rule for the whitelist controller
396+
// LinuxDeviceCgroup represents a device rule for the devices specified to
397+
// the device controller
396398
type LinuxDeviceCgroup struct {
397399
// Allow or deny
398400
Allow bool `json:"allow"`

0 commit comments

Comments
 (0)