diff --git a/docs/about/contributing/templates.md b/docs/about/contributing/templates.md index c5bff9caff343..3be4f9aa266f3 100644 --- a/docs/about/contributing/templates.md +++ b/docs/about/contributing/templates.md @@ -151,7 +151,7 @@ module "git-clone" { # Infrastructure resources resource "docker_image" "main" { - name = "codercom/enterprise-base:ubuntu" + name = "codercom/example-base:ubuntu" } resource "docker_container" "workspace" { diff --git a/docs/admin/templates/extending-templates/docker-in-workspaces.md b/docs/admin/templates/extending-templates/docker-in-workspaces.md index cd683b81b810c..22f7ad709fcb7 100644 --- a/docs/admin/templates/extending-templates/docker-in-workspaces.md +++ b/docs/admin/templates/extending-templates/docker-in-workspaces.md @@ -27,7 +27,7 @@ the Coder host, modify your template to use the sysbox-runc runtime: resource "docker_container" "workspace" { # ... name = "coder-${data.coder_workspace.me.owner}-${lower(data.coder_workspace.me.name)}" - image = "codercom/enterprise-base:ubuntu" + image = "codercom/example-base:ubuntu" env = ["CODER_AGENT_TOKEN=${coder_agent.main.token}"] command = ["sh", "-c", coder_agent.main.init_script] # Use the Sysbox container runtime (required) @@ -105,7 +105,7 @@ resource "kubernetes_pod" "dev" { name = "CODER_AGENT_TOKEN" value = coder_agent.main.token } - image = "codercom/enterprise-base:ubuntu" + image = "codercom/example-base:ubuntu" command = ["sh", "-c", coder_agent.main.init_script] } } @@ -333,7 +333,7 @@ resource "docker_container" "dind" { resource "docker_container" "workspace" { count = data.coder_workspace.me.start_count - image = "codercom/enterprise-base:ubuntu" + image = "codercom/example-base:ubuntu" name = "dev-${data.coder_workspace.me.id}" command = ["sh", "-c", coder_agent.main.init_script] env = [ @@ -391,7 +391,7 @@ resource "kubernetes_pod" "main" { } container { name = "dev" - image = "codercom/enterprise-base:ubuntu" + image = "codercom/example-base:ubuntu" command = ["sh", "-c", coder_agent.main.init_script] security_context { run_as_user = "1000" @@ -472,7 +472,7 @@ resource "kubernetes_pod" "dev" { name = "CODER_AGENT_TOKEN" value = coder_agent.main.token } - image = "codercom/enterprise-base:ubuntu" + image = "codercom/example-base:ubuntu" command = ["sh", "-c", < [!WARNING] > Use the package manager the workspace image provides, not a personal one. -> If you replace the `apt-get` line with `brew install ruby`, the build fails: the `codercom/enterprise-base:ubuntu` image doesn't include Homebrew, so the workspace logs `brew: command not found` and Ruby never installs. +> If you replace the `apt-get` line with `brew install ruby`, the build fails: the `codercom/example-base:ubuntu` image doesn't include Homebrew, so the workspace logs `brew: command not found` and Ruby never installs. > To install a personal tool like a Homebrew formula in your own workspace, refer to [Install your own command-line tools](./install-command-line-tools.md). Publish the change, then update your workspace again: @@ -710,7 +710,7 @@ resource "docker_volume" "home_volume" { resource "docker_container" "workspace" { count = data.coder_workspace.me.start_count - image = "codercom/enterprise-base:ubuntu" + image = "codercom/example-base:ubuntu" name = "coder-${data.coder_workspace_owner.me.name}-${lower(data.coder_workspace.me.name)}" hostname = data.coder_workspace.me.name entrypoint = [ diff --git a/docs/get-started/customize-your-template/authenticate-to-github.md b/docs/get-started/customize-your-template/authenticate-to-github.md index d783a0a11616c..aa0e811985b71 100644 --- a/docs/get-started/customize-your-template/authenticate-to-github.md +++ b/docs/get-started/customize-your-template/authenticate-to-github.md @@ -548,7 +548,7 @@ resource "docker_volume" "home_volume" { resource "docker_container" "workspace" { count = data.coder_workspace.me.start_count - image = "codercom/enterprise-base:ubuntu" + image = "codercom/example-base:ubuntu" name = "coder-${data.coder_workspace_owner.me.name}-${lower(data.coder_workspace.me.name)}" hostname = data.coder_workspace.me.name entrypoint = [ diff --git a/docs/get-started/customize-your-template/install-command-line-tools.md b/docs/get-started/customize-your-template/install-command-line-tools.md index 62b3b09badf2b..449756527d2ce 100644 --- a/docs/get-started/customize-your-template/install-command-line-tools.md +++ b/docs/get-started/customize-your-template/install-command-line-tools.md @@ -831,7 +831,7 @@ resource "docker_volume" "homebrew_volume" { resource "docker_container" "workspace" { count = data.coder_workspace.me.start_count - image = "codercom/enterprise-base:ubuntu" + image = "codercom/example-base:ubuntu" name = "coder-${data.coder_workspace_owner.me.name}-${lower(data.coder_workspace.me.name)}" hostname = data.coder_workspace.me.name entrypoint = [ diff --git a/docs/install/openshift.md b/docs/install/openshift.md index 2506e1cd08278..1216c41ecb38b 100644 --- a/docs/install/openshift.md +++ b/docs/install/openshift.md @@ -267,7 +267,7 @@ Security Context Constraints (SCCs) in OpenShift. type: Dockerfile dockerfile: | # Specify the source image. - FROM docker.io/codercom/enterprise-base:ubuntu + FROM docker.io/codercom/example-base:ubuntu # Switch to root USER root diff --git a/docs/user-guides/workspace-access/vscode.md b/docs/user-guides/workspace-access/vscode.md index cb26628321339..b98a919fff145 100644 --- a/docs/user-guides/workspace-access/vscode.md +++ b/docs/user-guides/workspace-access/vscode.md @@ -148,7 +148,7 @@ Web or using the workspace's terminal. files into the newly created folder. ```dockerfile - FROM codercom/enterprise-base:ubuntu + FROM codercom/example-base:ubuntu # Run below commands as root user USER root diff --git a/examples/examples.gen.json b/examples/examples.gen.json index e4da0305c3c9d..f00d83d55be7a 100644 --- a/examples/examples.gen.json +++ b/examples/examples.gen.json @@ -183,7 +183,7 @@ "kubernetes", "container" ], - "markdown": "\n# Remote Development on Kubernetes Pods\n\nProvision Kubernetes Pods as [Coder workspaces](https://coder.com/docs/user-guides/workspace-management) with this example template.\n\n\u003c!-- TODO: Add screenshot --\u003e\n\n## Prerequisites\n\n### Infrastructure\n\n**Cluster**: This template requires an existing Kubernetes cluster\n\n**Container Image**: This template uses the [codercom/enterprise-base:ubuntu image](https://github.com/coder/enterprise-images/tree/main/images/base) with some dev tools preinstalled. To add additional tools, extend this image or build it yourself.\n\n### Authentication\n\nThis template authenticates using a `~/.kube/config`, if present on the server, or via built-in authentication if the Coder provisioner is running on Kubernetes with an authorized ServiceAccount. To use another [authentication method](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs#authentication), edit the template.\n\n## Architecture\n\nThis template provisions the following resources:\n\n- Kubernetes pod (ephemeral)\n- Kubernetes persistent volume claim (persistent on `/home/coder`)\n\nThis means, when the workspace restarts, any tools or files outside of the home directory are not persisted. To pre-bake tools into the workspace (e.g. `python3`), modify the container image. Alternatively, individual developers can [personalize](https://coder.com/docs/user-guides/workspace-dotfiles) their workspaces with dotfiles.\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" + "markdown": "\n# Remote Development on Kubernetes Pods\n\nProvision Kubernetes Pods as [Coder workspaces](https://coder.com/docs/user-guides/workspace-management) with this example template.\n\n\u003c!-- TODO: Add screenshot --\u003e\n\n## Prerequisites\n\n### Infrastructure\n\n**Cluster**: This template requires an existing Kubernetes cluster\n\n**Container Image**: This template uses the [codercom/example-base:ubuntu image](https://github.com/coder/images/tree/main/images/base) with some dev tools preinstalled. To add additional tools, extend this image or build it yourself.\n\n### Authentication\n\nThis template authenticates using a `~/.kube/config`, if present on the server, or via built-in authentication if the Coder provisioner is running on Kubernetes with an authorized ServiceAccount. To use another [authentication method](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs#authentication), edit the template.\n\n## Architecture\n\nThis template provisions the following resources:\n\n- Kubernetes pod (ephemeral)\n- Kubernetes persistent volume claim (persistent on `/home/coder`)\n\nThis means, when the workspace restarts, any tools or files outside of the home directory are not persisted. To pre-bake tools into the workspace (e.g. `python3`), modify the container image. Alternatively, individual developers can [personalize](https://coder.com/docs/user-guides/workspace-dotfiles) their workspaces with dotfiles.\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" }, { "id": "kubernetes-devcontainer", diff --git a/examples/templates/docker/main.tf b/examples/templates/docker/main.tf index 7bb580e514920..918668e5b50a8 100644 --- a/examples/templates/docker/main.tf +++ b/examples/templates/docker/main.tf @@ -173,7 +173,7 @@ resource "docker_volume" "home_volume" { resource "docker_container" "workspace" { count = data.coder_workspace.me.start_count - image = "codercom/enterprise-base:ubuntu" + image = "codercom/example-base:ubuntu" # Uses lower() to avoid Docker restriction on container names. name = "coder-${data.coder_workspace_owner.me.name}-${lower(data.coder_workspace.me.name)}" # Hostname makes the shell more user friendly: coder@my-workspace:~$ diff --git a/examples/templates/kubernetes/README.md b/examples/templates/kubernetes/README.md index a12147987544e..0bcd22a744a31 100644 --- a/examples/templates/kubernetes/README.md +++ b/examples/templates/kubernetes/README.md @@ -19,7 +19,7 @@ Provision Kubernetes Pods as [Coder workspaces](https://coder.com/docs/user-guid **Cluster**: This template requires an existing Kubernetes cluster -**Container Image**: This template uses the [codercom/enterprise-base:ubuntu image](https://github.com/coder/enterprise-images/tree/main/images/base) with some dev tools preinstalled. To add additional tools, extend this image or build it yourself. +**Container Image**: This template uses the [codercom/example-base:ubuntu image](https://github.com/coder/images/tree/main/images/base) with some dev tools preinstalled. To add additional tools, extend this image or build it yourself. ### Authentication diff --git a/examples/templates/kubernetes/main.tf b/examples/templates/kubernetes/main.tf index 1d882f001b1c5..ba7c998404e50 100644 --- a/examples/templates/kubernetes/main.tf +++ b/examples/templates/kubernetes/main.tf @@ -285,7 +285,7 @@ resource "kubernetes_deployment_v1" "main" { container { name = "dev" - image = "codercom/enterprise-base:ubuntu" + image = "codercom/example-base:ubuntu" image_pull_policy = "Always" command = ["sh", "-c", coder_agent.main.init_script] security_context {