Skip to content

Commit

Permalink
chore: add CLI flags to auto-generated docs (#168)
Browse files Browse the repository at this point in the history
  • Loading branch information
@johnstcn
johnstcn authored May 1, 2024
1 parent c0738f3 commit be72259
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 39 deletions.
68 changes: 34 additions & 34 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -262,38 +262,38 @@ On MacOS or Windows systems, we recommend either using a VM or the provided `.de
<!--- START docsgen --->
## Environment Variables

| Environment variable | Default | Description |
| - | - | - |
| `SETUP_SCRIPT` | | The script to run before the init script. It runs as the root user regardless of the user specified in the devcontainer.json file. SetupScript is ran as the root user prior to the init script. It is used to configure envbuilder dynamically during the runtime. e.g. specifying whether to start systemd or tiny init for PID 1. |
| `INIT_SCRIPT` | `sleep infinity` | The script to run to initialize the workspace. |
| `INIT_COMMAND` | `/bin/sh` | The command to run to initialize the workspace. |
| `INIT_ARGS` | | The arguments to pass to the init command. They are split according to /bin/sh rules with https://github.com/kballard/go-shellquote. |
| `CACHE_REPO` | | The name of the container registry to push the cache image to. If this is empty, the cache will not be pushed. |
| `BASE_IMAGE_CACHE_DIR` | | The path to a directory where the base image can be found. This should be a read-only directory solely mounted for the purpose of caching the base image. |
| `LAYER_CACHE_DIR` | | The path to a directory where built layers will be stored. This spawns an in-memory registry to serve the layers from. |
| `DEVCONTAINER_DIR` | | The path to the folder containing the devcontainer.json file that will be used to build the workspace and can either be an absolute path or a path relative to the workspace folder. If not provided, defaults to `.devcontainer`. |
| `DEVCONTAINER_JSON_PATH` | | The path to a devcontainer.json file that is either an absolute path or a path relative to DevcontainerDir. This can be used in cases where one wants to substitute an edited devcontainer.json file for the one that exists in the repo. |
| `DOCKERFILE_PATH` | | The relative path to the Dockerfile that will be used to build the workspace. This is an alternative to using a devcontainer that some might find simpler. |
| `BUILD_CONTEXT_PATH` | | Can be specified when a DockerfilePath is specified outside the base WorkspaceFolder. This path MUST be relative to the WorkspaceFolder path into which the repo is cloned. |
| `CACHE_TTL_DAYS` | | The number of days to use cached layers before expiring them. Defaults to 7 days. |
| `DOCKER_CONFIG_BASE64` | | The base64 encoded Docker config file that will be used to pull images from private container registries. |
| `FALLBACK_IMAGE` | | Specifies an alternative image to use when neither an image is declared in the devcontainer.json file nor a Dockerfile is present. If there's a build failure (from a faulty Dockerfile) or a misconfiguration, this image will be the substitute. Set ExitOnBuildFailure to true to halt the container if the build faces an issue. |
| `EXIT_ON_BUILD_FAILURE` | | Terminates the container upon a build failure. This is handy when preferring the FALLBACK_IMAGE in cases where no devcontainer.json or image is provided. However, it ensures that the container stops if the build process encounters an error. |
| `FORCE_SAFE` | | Ignores any filesystem safety checks. This could cause serious harm to your system! This is used in cases where bypass is needed to unblock customers. |
| `INSECURE` | | Bypass TLS verification when cloning and pulling from container registries. |
| `IGNORE_PATHS` | `/var/run` | The comma separated list of paths to ignore when building the workspace. |
| `SKIP_REBUILD` | | Skip building if the MagicFile exists. This is used to skip building when a container is restarting. e.g. docker stop -> docker start This value can always be set to true - even if the container is being started for the first time. |
| `GIT_URL` | | The URL of the Git repository to clone. This is optional. |
| `GIT_CLONE_DEPTH` | | The depth to use when cloning the Git repository. |
| `GIT_CLONE_SINGLE_BRANCH` | | Clone only a single branch of the Git repository. |
| `GIT_USERNAME` | | The username to use for Git authentication. This is optional. |
| `GIT_PASSWORD` | | The password to use for Git authentication. This is optional. |
| `GIT_HTTP_PROXY_URL` | | The URL for the HTTP proxy. This is optional. |
| `WORKSPACE_FOLDER` | | The path to the workspace folder that will be built. This is optional. |
| `SSL_CERT_BASE64` | | The content of an SSL cert file. This is useful for self-signed certificates. |
| `EXPORT_ENV_FILE` | | Optional file path to a .env file where envbuilder will dump environment variables from devcontainer.json and the built container image. |
| `POST_START_SCRIPT_PATH` | | The path to a script that will be created by envbuilder based on the postStartCommand in devcontainer.json, if any is specified (otherwise the script is not created). If this is set, the specified InitCommand should check for the presence of this script and execute it after successful startup. |
| `CODER_AGENT_URL` | | URL of the Coder deployment. If CODER_AGENT_TOKEN is also set, logs from envbuilder will be forwarded here and will be visible in the workspace build logs. |
| `CODER_AGENT_TOKEN` | | Authentication token for a Coder agent. If this is set, then CODER_AGENT_URL must also be set. |
| `CODER_AGENT_SUBSYSTEM` | | Coder agent subsystems to report when forwarding logs. The envbuilder subsystem is always included. |
| Flag | Environment variable | Default | Description |
| - | - | - | - |
| `--setup-script` | `SETUP_SCRIPT` | | The script to run before the init script. It runs as the root user regardless of the user specified in the devcontainer.json file. SetupScript is ran as the root user prior to the init script. It is used to configure envbuilder dynamically during the runtime. e.g. specifying whether to start systemd or tiny init for PID 1. |
| `--init-script` | `INIT_SCRIPT` | `sleep infinity` | The script to run to initialize the workspace. |
| `--init-command` | `INIT_COMMAND` | `/bin/sh` | The command to run to initialize the workspace. |
| `--init-args` | `INIT_ARGS` | | The arguments to pass to the init command. They are split according to /bin/sh rules with https://github.com/kballard/go-shellquote. |
| `--cache-repo` | `CACHE_REPO` | | The name of the container registry to push the cache image to. If this is empty, the cache will not be pushed. |
| `--base-image-cache-dir` | `BASE_IMAGE_CACHE_DIR` | | The path to a directory where the base image can be found. This should be a read-only directory solely mounted for the purpose of caching the base image. |
| `--layer-cache-dir` | `LAYER_CACHE_DIR` | | The path to a directory where built layers will be stored. This spawns an in-memory registry to serve the layers from. |
| `--devcontainer-dir` | `DEVCONTAINER_DIR` | | The path to the folder containing the devcontainer.json file that will be used to build the workspace and can either be an absolute path or a path relative to the workspace folder. If not provided, defaults to `.devcontainer`. |
| `--devcontainer-json-path` | `DEVCONTAINER_JSON_PATH` | | The path to a devcontainer.json file that is either an absolute path or a path relative to DevcontainerDir. This can be used in cases where one wants to substitute an edited devcontainer.json file for the one that exists in the repo. |
| `--dockerfile-path` | `DOCKERFILE_PATH` | | The relative path to the Dockerfile that will be used to build the workspace. This is an alternative to using a devcontainer that some might find simpler. |
| `--build-context-path` | `BUILD_CONTEXT_PATH` | | Can be specified when a DockerfilePath is specified outside the base WorkspaceFolder. This path MUST be relative to the WorkspaceFolder path into which the repo is cloned. |
| `--cache-ttl-days` | `CACHE_TTL_DAYS` | | The number of days to use cached layers before expiring them. Defaults to 7 days. |
| `--docker-config-base64` | `DOCKER_CONFIG_BASE64` | | The base64 encoded Docker config file that will be used to pull images from private container registries. |
| `--fallback-image` | `FALLBACK_IMAGE` | | Specifies an alternative image to use when neither an image is declared in the devcontainer.json file nor a Dockerfile is present. If there's a build failure (from a faulty Dockerfile) or a misconfiguration, this image will be the substitute. Set ExitOnBuildFailure to true to halt the container if the build faces an issue. |
| `--exit-on-build-failure` | `EXIT_ON_BUILD_FAILURE` | | Terminates the container upon a build failure. This is handy when preferring the FALLBACK_IMAGE in cases where no devcontainer.json or image is provided. However, it ensures that the container stops if the build process encounters an error. |
| `--force-safe` | `FORCE_SAFE` | | Ignores any filesystem safety checks. This could cause serious harm to your system! This is used in cases where bypass is needed to unblock customers. |
| `--insecure` | `INSECURE` | | Bypass TLS verification when cloning and pulling from container registries. |
| `--ignore-paths` | `IGNORE_PATHS` | `/var/run` | The comma separated list of paths to ignore when building the workspace. |
| `--skip-rebuild` | `SKIP_REBUILD` | | Skip building if the MagicFile exists. This is used to skip building when a container is restarting. e.g. docker stop -> docker start This value can always be set to true - even if the container is being started for the first time. |
| `--git-url` | `GIT_URL` | | The URL of the Git repository to clone. This is optional. |
| `--git-clone-depth` | `GIT_CLONE_DEPTH` | | The depth to use when cloning the Git repository. |
| `--git-clone-single-branch` | `GIT_CLONE_SINGLE_BRANCH` | | Clone only a single branch of the Git repository. |
| `--git-username` | `GIT_USERNAME` | | The username to use for Git authentication. This is optional. |
| `--git-password` | `GIT_PASSWORD` | | The password to use for Git authentication. This is optional. |
| `--git-http-proxy-url` | `GIT_HTTP_PROXY_URL` | | The URL for the HTTP proxy. This is optional. |
| `--workspace-folder` | `WORKSPACE_FOLDER` | | The path to the workspace folder that will be built. This is optional. |
| `--ssl-cert-base64` | `SSL_CERT_BASE64` | | The content of an SSL cert file. This is useful for self-signed certificates. |
| `--export-env-file` | `EXPORT_ENV_FILE` | | Optional file path to a .env file where envbuilder will dump environment variables from devcontainer.json and the built container image. |
| `--post-start-script-path` | `POST_START_SCRIPT_PATH` | | The path to a script that will be created by envbuilder based on the postStartCommand in devcontainer.json, if any is specified (otherwise the script is not created). If this is set, the specified InitCommand should check for the presence of this script and execute it after successful startup. |
| `--coder-agent-url` | `CODER_AGENT_URL` | | URL of the Coder deployment. If CODER_AGENT_TOKEN is also set, logs from envbuilder will be forwarded here and will be visible in the workspace build logs. |
| `--coder-agent-token` | `CODER_AGENT_TOKEN` | | Authentication token for a Coder agent. If this is set, then CODER_AGENT_URL must also be set. |
| `--coder-agent-subsystem` | `CODER_AGENT_SUBSYSTEM` | | Coder agent subsystems to report when forwarding logs. The envbuilder subsystem is always included. |
<!--- END docsgen --->
19 changes: 14 additions & 5 deletions options.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package envbuilder

import (
"net/url"
"strings"

"github.com/coder/coder/v2/codersdk"
"github.com/coder/serpent"
Expand Down Expand Up @@ -306,17 +307,25 @@ func (o *Options) CLI() serpent.OptionSet {

func (o *Options) Markdown() string {
cliOptions := o.CLI()
mkd := "| Environment variable | Default | Description |\n" +
"| - | - | - |\n"
var sb strings.Builder
_, _ = sb.WriteString("| Flag | Environment variable | Default | Description |\n")
_, _ = sb.WriteString("| - | - | - | - |\n")

for _, opt := range cliOptions {
d := opt.Default
if d != "" {

d = "`" + d + "`"
}
mkd += "| `" + opt.Env + "` | " + d + " | " + opt.Description + " |\n"
_, _ = sb.WriteString("| `--")
_, _ = sb.WriteString(opt.Flag)
_, _ = sb.WriteString("` | `")
_, _ = sb.WriteString(opt.Env)
_, _ = sb.WriteString("` | ")
_, _ = sb.WriteString(d)
_, _ = sb.WriteString(" | ")
_, _ = sb.WriteString(opt.Description)
_, _ = sb.WriteString(" |\n")
}

return mkd
return sb.String()
}

0 comments on commit be72259

Please sign in to comment.