From 295d83779179cc32013bf801de63f9b93271006d Mon Sep 17 00:00:00 2001 From: Stephen Goeddel Date: Tue, 9 Nov 2021 15:31:04 -0500 Subject: [PATCH] reorganize the doc to list commands and resources as sub-levels of step --- content/en/docs/architecture/step-registry.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/content/en/docs/architecture/step-registry.md b/content/en/docs/architecture/step-registry.md index ab2f3367..9d8783e2 100644 --- a/content/en/docs/architecture/step-registry.md +++ b/content/en/docs/architecture/step-registry.md @@ -81,17 +81,23 @@ ref: The IPI configure step generates the install-config.yaml file based on the cluster profile and optional input files. {{< / highlight >}} -##### Commands +### Commands The commands file must contain shell script in a shell language supported by the `shellcheck` program used to validate the commands. However, regardless of the shell language used for the commands, the web UI will syntax highlight all commands as bash. Note: the shell script file must follow the [naming convention](#registry-layout-and-naming-convention) described later in this help page. -### Configuring a Custom shm-size +### Resources + +A step accepts resource `requests` and `limits` for its container's configuration. +There is more information about resources [here](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/). + +#### Configuring a Custom shm-size If it is necessary to increase the shared memory size (the default is 64m) of a Multi-Stage test, then the `resources` can be modified to add -the `ci-operator.openshift.io/shm` resource size. +the `ci-operator.openshift.io/shm` resource size. Note that this will not be propagated to the container itself, +but will simply resize the `dshm` volume. {{< highlight yaml >}} resources: