update mentions of templates create command

f0ssel · f0ssel · commit 2f2911a59e84 · 2024-01-05T20:48:24.000Z
diff --git a/.github/workflows/pr-deploy.yaml b/.github/workflows/pr-deploy.yaml
@@ -416,7 +416,7 @@ jobs:
 
           # Create template
           cd ./.github/pr-deployments/template
-          coder templates create -y --variable namespace=pr${{ env.PR_NUMBER }} kubernetes
+          coder templates push -y --variable namespace=pr${{ env.PR_NUMBER }} kubernetes
 
           # Create workspace
           coder create --template="kubernetes" kube --parameter cpu=2 --parameter memory=4 --parameter home_disk_size=2 -y
diff --git a/cli/templateinit.go b/cli/templateinit.go
@@ -113,7 +113,7 @@ func (*RootCmd) templateInit() *clibase.Cmd {
 				inv.Stdout,
 				pretty.Sprint(
 					cliui.DefaultStyles.Code,
-					"cd "+relPath+" && coder templates create"),
+					"cd "+relPath+" && coder templates push"),
 			)
 			_, _ = fmt.Fprintln(inv.Stdout, pretty.Sprint(cliui.DefaultStyles.Wrap, "\nExamples provide a starting point and are expected to be edited! 🎨"))
 			return nil
diff --git a/cli/templatelist.go b/cli/templatelist.go
@@ -36,7 +36,7 @@ func (r *RootCmd) templateList() *clibase.Cmd {
 
 			if len(templates) == 0 {
 				_, _ = fmt.Fprintf(inv.Stderr, "%s No templates found in %s! Create one:\n\n", Caret, color.HiWhiteString(organization.Name))
-				_, _ = fmt.Fprintln(inv.Stderr, color.HiMagentaString("  $ coder templates create <directory>\n"))
+				_, _ = fmt.Fprintln(inv.Stderr, color.HiMagentaString("  $ coder templates push <directory>\n"))
 				return nil
 			}
 
diff --git a/cli/templates.go b/cli/templates.go
@@ -17,16 +17,12 @@ func (r *RootCmd) templates() *clibase.Cmd {
 		Use:   "templates",
 		Short: "Manage templates",
 		Long: "Templates are written in standard Terraform and describe the infrastructure for workspaces\n" + formatExamples(
-			example{
-				Description: "Create a template for developers to create workspaces",
-				Command:     "coder templates create",
-			},
 			example{
 				Description: "Make changes to your template, and plan the changes",
 				Command:     "coder templates plan my-template",
 			},
 			example{
-				Description: "Push an update to the template. Your developers can update their workspaces",
+				Description: "Create or push an update to the template. Your developers can update their workspaces",
 				Command:     "coder templates push my-template",
 			},
 		),
diff --git a/docs/admin/provisioners.md b/docs/admin/provisioners.md
@@ -64,11 +64,11 @@ the [Helm example](#example-running-an-external-provisioner-with-helm) below.
 
   # In another terminal, create/push
   # a template that requires this provisioner
-  coder templates create on-prem \
+  coder templates push on-prem \
     --provisioner-tag environment=on_prem
 
   # Or, match the provisioner exactly
-  coder templates create on-prem-chicago \
+  coder templates push on-prem-chicago \
     --provisioner-tag environment=on_prem \
     --provisioner-tag data_center=chicago
   ```
@@ -88,7 +88,7 @@ the [Helm example](#example-running-an-external-provisioner-with-helm) below.
 
   # In another terminal, create/push
   # a template that requires user provisioners
-  coder templates create on-prem \
+  coder templates push on-prem \
     --provisioner-tag scope=user
   ```
 
diff --git a/docs/cli/templates.md b/docs/cli/templates.md
diff --git a/docs/install/openshift.md b/docs/install/openshift.md
@@ -322,7 +322,7 @@ Edit `main.tf` and update the following fields of the Kubernetes pod resource:
 Finally, create the template:
 
 ```console
-coder template create kubernetes -d .
+coder template push kubernetes -d .
 ```
 
 This template should be ready to use straight away.
diff --git a/docs/platforms/azure.md b/docs/platforms/azure.md
@@ -128,7 +128,7 @@ Navigate to the `./azure-linux` folder where you created your template and run
 the following command to put the template on your Coder instance.
 
 ```shell
-coder templates create
+coder templates push
 ```
 
 Congrats! You can now navigate to your Coder dashboard and use this Linux on
diff --git a/docs/platforms/docker.md b/docs/platforms/docker.md
@@ -52,7 +52,7 @@ Coder with Docker has the following advantages:
    cd docker
    ```
 
-1. Push up the template with `coder templates create`
+1. Push up the template with `coder templates push`
 
 1. Open the dashboard in your browser to create your first workspace:
 
diff --git a/docs/platforms/kubernetes/additional-clusters.md b/docs/platforms/kubernetes/additional-clusters.md
@@ -211,7 +211,7 @@ export CLUSTER_SERVICEACCOUNT_TOKEN=$(kubectl get secrets coder-v2 -n coder-work
 Create the template with these values:
 
 ```shell
-coder templates create \
+coder templates push \
     --variable host=$CLUSTER_ADDRESS \
     --variable cluster_ca_certificate=$CLUSTER_CA_CERTIFICATE \
     --variable token=$CLUSTER_SERVICEACCOUNT_TOKEN \
@@ -228,7 +228,7 @@ kubectl cluster-info
 # Get cluster CA and token (base64 encoded)
 kubectl get secrets coder-service-account-token -n coder-workspaces -o jsonpath="{.data}"
 
-coder templates create \
+coder templates push \
     --variable host=API_ADDRESS \
     --variable cluster_ca_certificate=CLUSTER_CA_CERTIFICATE \
     --variable token=CLUSTER_SERVICEACCOUNT_TOKEN \
diff --git a/enterprise/cli/templatecreate_test.go b/enterprise/cli/templatecreate_test.go
diff --git a/examples/examples.gen.json b/examples/examples.gen.json
@@ -155,6 +155,6 @@
       "nomad",
       "container"
     ],
-    "markdown": "\n# Remote Development on Nomad\n\nProvision Nomad Jobs as [Coder workspaces](https://coder.com/docs/coder-v2/latest) with this example template. This example shows how to use Nomad service tasks to be used as a development environment using docker and host csi volumes.\n\n\u003c!-- TODO: Add screenshot --\u003e\n\n\u003e **Note**\n\u003e This template is designed to be a starting point! Edit the Terraform to extend the template to support your use case.\n\n## Prerequisites\n\n- [Nomad](https://www.nomadproject.io/downloads)\n- [Docker](https://docs.docker.com/get-docker/)\n\n## Setup\n\n### 1. Start the CSI Host Volume Plugin\n\nThe CSI Host Volume plugin is used to mount host volumes into Nomad tasks. This is useful for development environments where you want to mount persistent volumes into your container workspace.\n\n1. Login to the Nomad server using SSH.\n\n2. Append the following stanza to your Nomad server configuration file and restart the nomad service.\n\n   ```hcl\n   plugin \"docker\" {\n     config {\n       allow_privileged = true\n     }\n   }\n   ```\n\n   ```shell\n   sudo systemctl restart nomad\n   ```\n\n3. Create a file `hostpath.nomad` with following content:\n\n   ```hcl\n   job \"hostpath-csi-plugin\" {\n     datacenters = [\"dc1\"]\n     type = \"system\"\n\n     group \"csi\" {\n       task \"plugin\" {\n         driver = \"docker\"\n\n         config {\n           image = \"registry.k8s.io/sig-storage/hostpathplugin:v1.10.0\"\n\n           args = [\n             \"--drivername=csi-hostpath\",\n             \"--v=5\",\n             \"--endpoint=${CSI_ENDPOINT}\",\n             \"--nodeid=node-${NOMAD_ALLOC_INDEX}\",\n           ]\n\n           privileged = true\n         }\n\n         csi_plugin {\n           id   = \"hostpath\"\n           type = \"monolith\"\n           mount_dir = \"/csi\"\n         }\n\n         resources {\n           cpu    = 256\n           memory = 128\n         }\n       }\n     }\n   }\n   ```\n\n4. Run the job:\n\n   ```shell\n   nomad job run hostpath.nomad\n   ```\n\n### 2. Setup the Nomad Template\n\n1. Create the template by running the following command:\n\n   ```shell\n   coder template init nomad-docker\n   cd nomad-docker\n   coder template create\n   ```\n\n2. Set up Nomad server address and optional authentication:\n\n3. Create a new workspace and start developing.\n"
+    "markdown": "\n# Remote Development on Nomad\n\nProvision Nomad Jobs as [Coder workspaces](https://coder.com/docs/coder-v2/latest) with this example template. This example shows how to use Nomad service tasks to be used as a development environment using docker and host csi volumes.\n\n\u003c!-- TODO: Add screenshot --\u003e\n\n\u003e **Note**\n\u003e This template is designed to be a starting point! Edit the Terraform to extend the template to support your use case.\n\n## Prerequisites\n\n- [Nomad](https://www.nomadproject.io/downloads)\n- [Docker](https://docs.docker.com/get-docker/)\n\n## Setup\n\n### 1. Start the CSI Host Volume Plugin\n\nThe CSI Host Volume plugin is used to mount host volumes into Nomad tasks. This is useful for development environments where you want to mount persistent volumes into your container workspace.\n\n1. Login to the Nomad server using SSH.\n\n2. Append the following stanza to your Nomad server configuration file and restart the nomad service.\n\n   ```hcl\n   plugin \"docker\" {\n     config {\n       allow_privileged = true\n     }\n   }\n   ```\n\n   ```shell\n   sudo systemctl restart nomad\n   ```\n\n3. Create a file `hostpath.nomad` with following content:\n\n   ```hcl\n   job \"hostpath-csi-plugin\" {\n     datacenters = [\"dc1\"]\n     type = \"system\"\n\n     group \"csi\" {\n       task \"plugin\" {\n         driver = \"docker\"\n\n         config {\n           image = \"registry.k8s.io/sig-storage/hostpathplugin:v1.10.0\"\n\n           args = [\n             \"--drivername=csi-hostpath\",\n             \"--v=5\",\n             \"--endpoint=${CSI_ENDPOINT}\",\n             \"--nodeid=node-${NOMAD_ALLOC_INDEX}\",\n           ]\n\n           privileged = true\n         }\n\n         csi_plugin {\n           id   = \"hostpath\"\n           type = \"monolith\"\n           mount_dir = \"/csi\"\n         }\n\n         resources {\n           cpu    = 256\n           memory = 128\n         }\n       }\n     }\n   }\n   ```\n\n4. Run the job:\n\n   ```shell\n   nomad job run hostpath.nomad\n   ```\n\n### 2. Setup the Nomad Template\n\n1. Create the template by running the following command:\n\n   ```shell\n   coder template init nomad-docker\n   cd nomad-docker\n   coder template push\n   ```\n\n2. Set up Nomad server address and optional authentication:\n\n3. Create a new workspace and start developing.\n"
   }
 ]
diff --git a/examples/lima/coder.yaml b/examples/lima/coder.yaml
@@ -103,7 +103,7 @@ provision:
       fi
       DOCKER_HOST=$(docker context inspect --format '{{.Endpoints.docker.Host}}')
       printf 'docker_arch: "%s"\ndocker_host: "%s"\n' "${DOCKER_ARCH}" "${DOCKER_HOST}" | tee "${temp_template_dir}/params.yaml"
-      coder templates create "docker-${DOCKER_ARCH}" --directory "${temp_template_dir}" --variables-file "${temp_template_dir}/params.yaml" --yes
+      coder templates push "docker-${DOCKER_ARCH}" --directory "${temp_template_dir}" --variables-file "${temp_template_dir}/params.yaml" --yes
       rm -rfv "${temp_template_dir}"
 probes:
   - description: "docker to be installed"
diff --git a/examples/templates/README.md b/examples/templates/README.md
@@ -11,7 +11,7 @@ Clone this repository to create a template from any example listed here:
 ```console
 git clone https://github.com/coder/coder
 cd examples/templates/aws-linux
-coder templates create
+coder templates push
 ```
 
 ## Community Templates
diff --git a/examples/templates/envbox/README.md b/examples/templates/envbox/README.md
@@ -47,7 +47,7 @@ To supply values to existing existing Terraform variables you can specify the
 `-V` flag. For example
 
 ```bash
-coder templates create envbox --var namespace="mynamespace" --var max_cpus=2 --var min_cpus=1 --var max_memory=4 --var min_memory=1
+coder templates push envbox --var namespace="mynamespace" --var max_cpus=2 --var min_cpus=1 --var max_memory=4 --var min_memory=1
 ```
 
 ## Contributions
diff --git a/examples/templates/nomad-docker/README.md b/examples/templates/nomad-docker/README.md
@@ -95,7 +95,7 @@ The CSI Host Volume plugin is used to mount host volumes into Nomad tasks. This
    ```shell
    coder template init nomad-docker
    cd nomad-docker
-   coder template create
+   coder template push
    ```
 
 2. Set up Nomad server address and optional authentication:
diff --git a/scaletest/lib/coder_init.sh b/scaletest/lib/coder_init.sh
@@ -68,7 +68,7 @@ CODER_FIRST_USER_TRIAL="${CODER_FIRST_USER_TRIAL}"
 EOF
 
 echo "Importing kubernetes template"
-DRY_RUN="$DRY_RUN" "$PROJECT_ROOT/scaletest/lib/coder_shim.sh" templates create \
+DRY_RUN="$DRY_RUN" "$PROJECT_ROOT/scaletest/lib/coder_shim.sh" templates push \
 	--global-config="${CONFIG_DIR}" \
 	--directory "${CONFIG_DIR}/templates/kubernetes" \
 	--yes kubernetes
diff --git a/scripts/develop.sh b/scripts/develop.sh
@@ -177,7 +177,7 @@ fatal() {
 		DOCKER_HOST="$(docker context inspect --format '{{ .Endpoints.docker.Host }}')"
 		printf 'docker_arch: "%s"\ndocker_host: "%s"\n' "${GOARCH}" "${DOCKER_HOST}" >"${temp_template_dir}/params.yaml"
 		(
-			"${CODER_DEV_SHIM}" templates create "${template_name}" --directory "${temp_template_dir}" --variables-file "${temp_template_dir}/params.yaml" --yes
+			"${CODER_DEV_SHIM}" templates push "${template_name}" --directory "${temp_template_dir}" --variables-file "${temp_template_dir}/params.yaml" --yes
 			rm -rfv "${temp_template_dir}" # Only delete template dir if template creation succeeds
 		) || echo "Failed to create a template. The template files are in ${temp_template_dir}"
 	fi

Original file line number	Diff line number	Diff line change
`@@ -113,7 +113,7 @@ func (RootCmd) templateInit() clibase.Cmd {`
`113`	`113`	`inv.Stdout,`
`114`	`114`	`pretty.Sprint(`
`115`	`115`	`cliui.DefaultStyles.Code,`
`116`		`- "cd "+relPath+" && coder templates create"),`
	`116`	`+ "cd "+relPath+" && coder templates push"),`
`117`	`117`	`)`
`118`	`118`	`_, _ = fmt.Fprintln(inv.Stdout, pretty.Sprint(cliui.DefaultStyles.Wrap, "\nExamples provide a starting point and are expected to be edited! 🎨"))`
`119`	`119`	`return nil`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ func (r RootCmd) templateList() clibase.Cmd {`
`36`	`36`
`37`	`37`	`if len(templates) == 0 {`
`38`	`38`	`_, _ = fmt.Fprintf(inv.Stderr, "%s No templates found in %s! Create one:\n\n", Caret, color.HiWhiteString(organization.Name))`
`39`		`- _, _ = fmt.Fprintln(inv.Stderr, color.HiMagentaString(" $ coder templates create <directory>\n"))`
	`39`	`+ _, _ = fmt.Fprintln(inv.Stderr, color.HiMagentaString(" $ coder templates push <directory>\n"))`
`40`	`40`	`return nil`
`41`	`41`	`}`
`42`	`42`