From 4dd1c4b14c6681527c85d139df4813b24379efff Mon Sep 17 00:00:00 2001 From: Jesse Glick Date: Mon, 14 Jun 2021 17:42:59 -0400 Subject: [PATCH] Clarify docs regarding `command` and `args` --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8abc200e2..ec43b7bcc 100644 --- a/README.md +++ b/README.md @@ -218,8 +218,8 @@ The `containerTemplate` is a template of container that will be added to the pod * **envVars** Environment variables that are applied to the container **(supplementing and overriding env vars that are set on pod level)**. * **envVar** An environment variable whose value is defined inline. * **secretEnvVar** An environment variable whose value is derived from a Kubernetes secret. -* **command** The command the container will execute, will overwrite the docker entrypoint, default value is `sleep`. -* **args** The arguments passed to the command, default value is `99999999`. +* **command** The command the container will execute. Will overwrite the Docker entrypoint. A typical value is `sleep`. +* **args** The arguments passed to the command. A typical value is `99999999`. * **ttyEnabled** Flag to mark that tty should be enabled. * **livenessProbe** Parameters to be added to a exec liveness probe in the container (does not support httpGet liveness probes) * **ports** Expose ports on the container.