Skip to content

Commit

Permalink
Add VolumeDevices to PodSpec (#2572) (#2573)
Browse files Browse the repository at this point in the history
* Add VolumeDevices to PodSpec (#2572)

* Update changelog to include schema_container

---------

Co-authored-by: Mauricio Alvarez Leon <65101411+BBBmau@users.noreply.github.com>
  • Loading branch information
jirislav and BBBmau authored Sep 20, 2024
1 parent afd774d commit 507da66
Show file tree
Hide file tree
Showing 19 changed files with 1,788 additions and 3 deletions.
3 changes: 3 additions & 0 deletions .changelog/2573.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```release-note:enhancement
`schema_container.go`: Add VolumeDevices
```
18 changes: 18 additions & 0 deletions docs/resources/cron_job.md
Original file line number Diff line number Diff line change
Expand Up @@ -466,6 +466,7 @@ Optional:
- `termination_message_policy` (String) Optional: Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.
- `tty` (Boolean) Whether this container should allocate a TTY for itself
- `volume_mount` (Block List) Pod volumes to mount into the container's filesystem. Cannot be updated. (see [below for nested schema](#nestedblock--spec--job_template--spec--template--spec--container--volume_mount))
- `volume_device` (Block List) Raw volume devices to attach into the container's filesystem as raw block devices. Cannot be updated. More info: https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#volumes-1 (see [below for nested schema](#nestedblock--spec--job_template--spec--template--spec--container--volume_device))
- `working_dir` (String) Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.

<a id="nestedblock--spec--job_template--spec--template--spec--container--env"></a>
Expand Down Expand Up @@ -949,6 +950,14 @@ Optional:
- `read_only` (Boolean) Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
- `sub_path` (String) Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).

<a id="nestedblock--spec--job_template--spec--template--spec--container--volume_device"></a>
### Nested Schema for `spec.job_template.spec.template.spec.container.volume_device`

Required:

- `device_path` (String) Path within the container at which the volume device should be attached. For example '/dev/xvda'.
- `name` (String) This must match the Name of a PersistentVolumeClaim.



<a id="nestedblock--spec--job_template--spec--template--spec--dns_config"></a>
Expand Down Expand Up @@ -1018,6 +1027,7 @@ Optional:
- `termination_message_policy` (String) Optional: Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.
- `tty` (Boolean) Whether this container should allocate a TTY for itself
- `volume_mount` (Block List) Pod volumes to mount into the container's filesystem. Cannot be updated. (see [below for nested schema](#nestedblock--spec--job_template--spec--template--spec--init_container--volume_mount))
- `volume_device` (Block List) Raw volume devices to attach into the container's filesystem as raw block devices. Cannot be updated. More info: https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#volumes-1 (see [below for nested schema](#nestedblock--spec--job_template--spec--template--spec--init_container--volume_device))
- `working_dir` (String) Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.

<a id="nestedblock--spec--job_template--spec--template--spec--init_container--env"></a>
Expand Down Expand Up @@ -1501,6 +1511,14 @@ Optional:
- `read_only` (Boolean) Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
- `sub_path` (String) Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).

<a id="nestedblock--spec--job_template--spec--template--spec--init_container--volume_device"></a>
### Nested Schema for `spec.job_template.spec.template.spec.init_container.volume_device`

Required:

- `device_path` (String) Path within the container at which the volume device should be attached. For example '/dev/xvda'.
- `name` (String) This must match the Name of a PersistentVolumeClaim.



<a id="nestedblock--spec--job_template--spec--template--spec--os"></a>
Expand Down
18 changes: 18 additions & 0 deletions docs/resources/cron_job_v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -461,6 +461,7 @@ Optional:
- `termination_message_policy` (String) Optional: Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.
- `tty` (Boolean) Whether this container should allocate a TTY for itself
- `volume_mount` (Block List) Pod volumes to mount into the container's filesystem. Cannot be updated. (see [below for nested schema](#nestedblock--spec--job_template--spec--template--spec--container--volume_mount))
- `volume_device` (Block List) Raw volume devices to attach into the container's filesystem as raw block devices. Cannot be updated. More info: https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#volumes-1 (see [below for nested schema](#nestedblock--spec--job_template--spec--template--spec--container--volume_device))
- `working_dir` (String) Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.

<a id="nestedblock--spec--job_template--spec--template--spec--container--env"></a>
Expand Down Expand Up @@ -944,6 +945,14 @@ Optional:
- `read_only` (Boolean) Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
- `sub_path` (String) Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).

<a id="nestedblock--spec--job_template--spec--template--spec--container--volume_device"></a>
### Nested Schema for `spec.job_template.spec.template.spec.container.volume_device`

Required:

- `device_path` (String) Path within the container at which the volume device should be attached. For example '/dev/xvda'.
- `name` (String) This must match the Name of a PersistentVolumeClaim.



<a id="nestedblock--spec--job_template--spec--template--spec--dns_config"></a>
Expand Down Expand Up @@ -1013,6 +1022,7 @@ Optional:
- `termination_message_policy` (String) Optional: Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.
- `tty` (Boolean) Whether this container should allocate a TTY for itself
- `volume_mount` (Block List) Pod volumes to mount into the container's filesystem. Cannot be updated. (see [below for nested schema](#nestedblock--spec--job_template--spec--template--spec--init_container--volume_mount))
- `volume_device` (Block List) Raw volume devices to attach into the container's filesystem as raw block devices. Cannot be updated. More info: https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#volumes-1 (see [below for nested schema](#nestedblock--spec--job_template--spec--template--spec--init_container--volume_device))
- `working_dir` (String) Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.

<a id="nestedblock--spec--job_template--spec--template--spec--init_container--env"></a>
Expand Down Expand Up @@ -1496,6 +1506,14 @@ Optional:
- `read_only` (Boolean) Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
- `sub_path` (String) Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).

<a id="nestedblock--spec--job_template--spec--template--spec--init_container--volume_device"></a>
### Nested Schema for `spec.job_template.spec.template.spec.init_container.volume_device`

Required:

- `device_path` (String) Path within the container at which the volume device should be attached. For example '/dev/xvda'.
- `name` (String) This must match the Name of a PersistentVolumeClaim.



<a id="nestedblock--spec--job_template--spec--template--spec--os"></a>
Expand Down
16 changes: 16 additions & 0 deletions docs/resources/daemon_set_v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -415,6 +415,7 @@ Optional:
- `termination_message_policy` (String) Optional: Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.
- `tty` (Boolean) Whether this container should allocate a TTY for itself
- `volume_mount` (Block List) Pod volumes to mount into the container's filesystem. Cannot be updated. (see [below for nested schema](#nestedblock--spec--template--spec--container--volume_mount))
- `volume_device` (Block List) Raw volume devices to attach into the container's filesystem as raw block devices. Cannot be updated. More info: https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#volumes-1 (see [below for nested schema](#nestedblock--spec--template--spec--container--volume_device))
- `working_dir` (String) Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.

<a id="nestedblock--spec--template--spec--container--env"></a>
Expand Down Expand Up @@ -898,6 +899,13 @@ Optional:
- `read_only` (Boolean) Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
- `sub_path` (String) Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).

<a id="nestedblock--spec--template--spec--container--volume_device"></a>
### Nested Schema for `spec.template.spec.container.volume_device`

Required:

- `device_path` (String) Path within the container at which the volume device should be attached. For example '/dev/xvda'.
- `name` (String) This must match the Name of a PersistentVolumeClaim.


<a id="nestedblock--spec--template--spec--dns_config"></a>
Expand Down Expand Up @@ -967,6 +975,7 @@ Optional:
- `termination_message_policy` (String) Optional: Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.
- `tty` (Boolean) Whether this container should allocate a TTY for itself
- `volume_mount` (Block List) Pod volumes to mount into the container's filesystem. Cannot be updated. (see [below for nested schema](#nestedblock--spec--template--spec--init_container--volume_mount))
- `volume_device` (Block List) Raw volume devices to attach into the container's filesystem as raw block devices. Cannot be updated. More info: https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#volumes-1 (see [below for nested schema](#nestedblock--spec--template--spec--init_container--volume_device))
- `working_dir` (String) Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.

<a id="nestedblock--spec--template--spec--init_container--env"></a>
Expand Down Expand Up @@ -1450,6 +1459,13 @@ Optional:
- `read_only` (Boolean) Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
- `sub_path` (String) Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).

<a id="nestedblock--spec--template--spec--init_container--volume_device"></a>
### Nested Schema for `spec.template.spec.init_container.volume_device`

Required:

- `device_path` (String) Path within the container at which the volume device should be attached. For example '/dev/xvda'.
- `name` (String) This must match the Name of a PersistentVolumeClaim.


<a id="nestedblock--spec--template--spec--os"></a>
Expand Down
16 changes: 16 additions & 0 deletions docs/resources/daemonset.md
Original file line number Diff line number Diff line change
Expand Up @@ -415,6 +415,7 @@ Optional:
- `termination_message_policy` (String) Optional: Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.
- `tty` (Boolean) Whether this container should allocate a TTY for itself
- `volume_mount` (Block List) Pod volumes to mount into the container's filesystem. Cannot be updated. (see [below for nested schema](#nestedblock--spec--template--spec--container--volume_mount))
- `volume_device` (Block List) Raw volume devices to attach into the container's filesystem as raw block devices. Cannot be updated. More info: https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#volumes-1 (see [below for nested schema](#nestedblock--spec--template--spec--container--volume_device))
- `working_dir` (String) Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.

<a id="nestedblock--spec--template--spec--container--env"></a>
Expand Down Expand Up @@ -898,6 +899,13 @@ Optional:
- `read_only` (Boolean) Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
- `sub_path` (String) Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).

<a id="nestedblock--spec--template--spec--container--volume_device"></a>
### Nested Schema for `spec.template.spec.container.volume_device`

Required:

- `device_path` (String) Path within the container at which the volume device should be attached. For example '/dev/xvda'.
- `name` (String) This must match the Name of a PersistentVolumeClaim.


<a id="nestedblock--spec--template--spec--dns_config"></a>
Expand Down Expand Up @@ -967,6 +975,7 @@ Optional:
- `termination_message_policy` (String) Optional: Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.
- `tty` (Boolean) Whether this container should allocate a TTY for itself
- `volume_mount` (Block List) Pod volumes to mount into the container's filesystem. Cannot be updated. (see [below for nested schema](#nestedblock--spec--template--spec--init_container--volume_mount))
- `volume_device` (Block List) Raw volume devices to attach into the container's filesystem as raw block devices. Cannot be updated. More info: https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#volumes-1 (see [below for nested schema](#nestedblock--spec--template--spec--init_container--volume_device))
- `working_dir` (String) Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.

<a id="nestedblock--spec--template--spec--init_container--env"></a>
Expand Down Expand Up @@ -1450,6 +1459,13 @@ Optional:
- `read_only` (Boolean) Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
- `sub_path` (String) Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).

<a id="nestedblock--spec--template--spec--init_container--volume_device"></a>
### Nested Schema for `spec.template.spec.init_container.volume_device`

Required:

- `device_path` (String) Path within the container at which the volume device should be attached. For example '/dev/xvda'.
- `name` (String) This must match the Name of a PersistentVolumeClaim.


<a id="nestedblock--spec--template--spec--os"></a>
Expand Down
Loading

0 comments on commit 507da66

Please sign in to comment.