Skip to content

Commit c68395a

Browse files
authored
Merge pull request #1855 from stgraber/main
doc: Fix missing OCI section
2 parents 9371a0c + cadb201 commit c68395a

File tree

4 files changed

+18
-6
lines changed

4 files changed

+18
-6
lines changed

doc/config_options.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -677,9 +677,9 @@ Override the working directory of an OCI container.
677677
```{config:option} oci.entrypoint instance-oci
678678
:condition: "OCI container"
679679
:liveupdate: "no"
680-
:shortdesc: "OCI container entrypoint"
680+
:shortdesc: "OCI container entry point"
681681
:type: "string"
682-
Override the entrypoint of an OCI container.
682+
Override the entry point of an OCI container.
683683
```
684684

685685
```{config:option} oci.gid instance-oci

doc/reference/instance_options.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ The following options are available:
1414
- {ref}`instance-options-limits`
1515
- {ref}`instance-options-migration`
1616
- {ref}`instance-options-nvidia`
17+
- {ref}`instance-options-oci`
1718
- {ref}`instance-options-raw`
1819
- {ref}`instance-options-security`
1920
- {ref}`instance-options-snapshots`
@@ -222,6 +223,17 @@ The following instance options specify the NVIDIA and CUDA configuration of the
222223
:end-before: <!-- config group instance-nvidia end -->
223224
```
224225

226+
(instance-options-oci)=
227+
## OCI configuration
228+
229+
The following instance options specify the OCI configuration of the instance:
230+
231+
% Include content from [../config_options.txt](../config_options.txt)
232+
```{include} ../config_options.txt
233+
:start-after: <!-- config group instance-oci start -->
234+
:end-before: <!-- config group instance-oci end -->
235+
```
236+
225237
(instance-options-raw)=
226238
## Raw instance configuration overrides
227239

internal/instance/config.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -653,12 +653,12 @@ var InstanceConfigKeysContainer = map[string]func(value string) error{
653653
"nvidia.require.driver": validate.IsAny,
654654

655655
// gendoc:generate(entity=instance, group=oci, key=oci.entrypoint)
656-
// Override the entrypoint of an OCI container.
656+
// Override the entry point of an OCI container.
657657
// ---
658658
// type: string
659659
// liveupdate: no
660660
// condition: OCI container
661-
// shortdesc: OCI container entrypoint
661+
// shortdesc: OCI container entry point
662662
"oci.entrypoint": validate.IsAny,
663663

664664
// gendoc:generate(entity=instance, group=oci, key=oci.cwd)

internal/server/metadata/configuration.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -745,8 +745,8 @@
745745
"oci.entrypoint": {
746746
"condition": "OCI container",
747747
"liveupdate": "no",
748-
"longdesc": "Override the entrypoint of an OCI container.",
749-
"shortdesc": "OCI container entrypoint",
748+
"longdesc": "Override the entry point of an OCI container.",
749+
"shortdesc": "OCI container entry point",
750750
"type": "string"
751751
}
752752
},

0 commit comments

Comments
 (0)