Skip to content

Commit 5ea0c5d

Browse files
authored
docs: Add undocumented environment variables to build-container-image manual (#129)
Motivation ---------- Where command line options also have corresponding environment variables, the variables should be documented. This PR documents a few variables which had been overlooked. Modifications ------------- Add descriptions of previously undocumented environment variables: * `CONTAINERTOOL_ARCHITECTURE` * `CONTAINERTOOL_DEFAULT_USERNAME` * `CONTAINERTOOL_DEFAULT_PASSWORD` Result ------ * All current configuration variables are documented. Test Plan --------- * No functional change. * All existing tests continue to pass.
1 parent de7bef0 commit 5ea0c5d

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

Sources/swift-container-plugin/Documentation.docc/build-container-image.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,21 @@ Wrap a binary in a container image and publish it.
9191
Base image on which to layer the application.
9292
(default: `swift:slim`)
9393

94+
- term `CONTAINERTOOL_ARCHITECTURE`:
95+
CPU architecture.
96+
9497
- term `CONTAINERTOOL_OS`:
9598
Operating system to encode in the container image.
9699
(default: `Linux`)
100+
101+
- term `CONTAINERTOOL_DEFAULT_USERNAME`:
102+
Default username to use when logging into the registry.
103+
104+
This username is used if there is no matching `.netrc` entry for the registry, there is no `.netrc` file, or the `--disable-netrc` option is set.
105+
The same username is used for the source and destination registries.
106+
107+
- term `CONTAINERTOOL_DEFAULT_PASSWORD`:
108+
Default password to use when logging into the registry.
109+
110+
This password is used if there is no matching `.netrc` entry for the registry, there is no `.netrc` file, or the `--disable-netrc` option is set.
111+
The same password is used for the source and destination registries.

0 commit comments

Comments
 (0)