From 6f7cf8db0e2b3360992bc532bcaac6a47905e298 Mon Sep 17 00:00:00 2001 From: G r e y Date: Thu, 30 Sep 2021 20:35:35 -0400 Subject: [PATCH 1/7] fix(workspaces): add and arrange missing env vars --- workspaces/variables.md | 29 +++++++++++++++++++++-------- 1 file changed, 21 insertions(+), 8 deletions(-) diff --git a/workspaces/variables.md b/workspaces/variables.md index df48d1aee..f4adf1cb7 100644 --- a/workspaces/variables.md +++ b/workspaces/variables.md @@ -33,6 +33,19 @@ env | grep CODER_ CODER_USERNAME Your user name + + CODER_URL + The base url of Coder + + + CODER_WP_NAME + The name of the workspace provider hosting the workspace + + + CODER_ASSETS_ROOT + The directory where coder adds coder-specific assets during + workspace creation, such as the coder-cli binary + CODER_CPU_LIMIT The CPU core limit given to your workspace @@ -41,6 +54,10 @@ env | grep CODER_ CODER_MEMORY_LIMIT The memory limit given to your workspace in GB + + CODER_SHELL + The default + CODER_IMAGE_TAG The image tag used to create your workspace @@ -49,18 +66,14 @@ env | grep CODER_ CODER_IMAGE_DIGEST The content-addressable identifier for your image - - CODER_IMAGE_URI - The URI for the image used to build the workspace - - - CODER_WP_NAME - The name of the workspace provider hosting the environment - CODER_RUNTIME The container runtime used to start the workspace (either `kubernetes/default` or `kubernetes/sysbox` if the workspace is a CVM + + CODER_IMAGE_URI + The URI for the image used to build the workspace + From 7ab85a30d494e44348bf3f1ccf2c4484384a52d6 Mon Sep 17 00:00:00 2001 From: G r e y Date: Mon, 18 Oct 2021 19:27:44 +0000 Subject: [PATCH 2/7] fixup! fix(workspaces): add and arrange missing env vars --- workspaces/variables.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/workspaces/variables.md b/workspaces/variables.md index f4adf1cb7..3f716457f 100644 --- a/workspaces/variables.md +++ b/workspaces/variables.md @@ -34,8 +34,8 @@ env | grep CODER_ Your user name - CODER_URL - The base url of Coder + CODER_URL + The base URL of Coder CODER_WP_NAME From 586ebcf4f7ac0750641231ee94a7aa4822aa26fb Mon Sep 17 00:00:00 2001 From: G r e y Date: Mon, 18 Oct 2021 19:38:33 +0000 Subject: [PATCH 3/7] remove CODER_SHELL for now --- workspaces/variables.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/workspaces/variables.md b/workspaces/variables.md index 3f716457f..d12b845cb 100644 --- a/workspaces/variables.md +++ b/workspaces/variables.md @@ -54,10 +54,6 @@ env | grep CODER_ CODER_MEMORY_LIMIT The memory limit given to your workspace in GB - - CODER_SHELL - The default - CODER_IMAGE_TAG The image tag used to create your workspace From 36505352f256c94ea3f6f2d50d5b35daa359d268 Mon Sep 17 00:00:00 2001 From: G r e y Date: Mon, 18 Oct 2021 16:10:40 -0400 Subject: [PATCH 4/7] Apply suggestions from code review Co-authored-by: Katie Horne --- workspaces/variables.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/workspaces/variables.md b/workspaces/variables.md index d12b845cb..c85f8a3b4 100644 --- a/workspaces/variables.md +++ b/workspaces/variables.md @@ -35,7 +35,7 @@ env | grep CODER_ CODER_URL - The base URL of Coder + The base URL of your Coder deployment CODER_WP_NAME @@ -43,7 +43,7 @@ env | grep CODER_ CODER_ASSETS_ROOT - The directory where coder adds coder-specific assets during + The directory where Coder adds Coder-specific assets during workspace creation, such as the coder-cli binary @@ -70,6 +70,6 @@ env | grep CODER_ CODER_IMAGE_URI - The URI for the image used to build the workspace + The URI of the image used to build the workspace From dc86f04babd66f9d8743a0d3f139248bfb6715bb Mon Sep 17 00:00:00 2001 From: G r e y Date: Mon, 18 Oct 2021 20:12:28 +0000 Subject: [PATCH 5/7] fixup! coder-cli styling --- workspaces/variables.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/workspaces/variables.md b/workspaces/variables.md index c85f8a3b4..948bd2db4 100644 --- a/workspaces/variables.md +++ b/workspaces/variables.md @@ -43,8 +43,8 @@ env | grep CODER_ CODER_ASSETS_ROOT - The directory where Coder adds Coder-specific assets during - workspace creation, such as the coder-cli binary + The directory where coder adds Coder-specific assets during + workspace creation, such as the coder-cli binary CODER_CPU_LIMIT From ae4bd7dcda341b763aa866c799c3011effec02c4 Mon Sep 17 00:00:00 2001 From: Katie Horne Date: Tue, 19 Oct 2021 10:34:01 -0500 Subject: [PATCH 6/7] fix code fencing --- workspaces/variables.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/workspaces/variables.md b/workspaces/variables.md index 948bd2db4..19e7d2a4d 100644 --- a/workspaces/variables.md +++ b/workspaces/variables.md @@ -65,8 +65,8 @@ env | grep CODER_ CODER_RUNTIME The container runtime used to start the workspace (either - `kubernetes/default` or `kubernetes/sysbox` if the workspace - is a CVM + kubernetes/default or kubernetes/sysbox + if the workspace is a CVM CODER_IMAGE_URI From f25e17cc2e2415da381f0f52f599d340359e769a Mon Sep 17 00:00:00 2001 From: Katie Horne Date: Tue, 19 Oct 2021 10:36:49 -0500 Subject: [PATCH 7/7] disable md lint rule for caps --- workspaces/variables.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/workspaces/variables.md b/workspaces/variables.md index 19e7d2a4d..c4d02feb1 100644 --- a/workspaces/variables.md +++ b/workspaces/variables.md @@ -15,7 +15,7 @@ env | grep CODER_ ``` ## Available environment variables - +
Environment variable