Thanks to visit codestin.com
Credit goes to github.com

Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/about/contributing/templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@

# Infrastructure resources
resource "docker_image" "main" {
name = "codercom/enterprise-base:ubuntu"
name = "codercom/example-base:ubuntu"
}

resource "docker_container" "workspace" {
Expand Down Expand Up @@ -388,7 +388,7 @@
- Add troubleshooting guides
- Improve usage examples

### Making changes

Check warning on line 391 in docs/about/contributing/templates.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.GerundHeading

Heading starts with an -ing word ('Making'); prefer the imperative ('Install') or the noun ('Installation'). See capitalization-and-punctuation.md#no-gerund-leading-headings.

1. **Test thoroughly**: Always test template changes in a Coder instance
2. **Maintain compatibility**: Ensure existing workspaces continue to function
Expand Down
10 changes: 5 additions & 5 deletions docs/admin/templates/extending-templates/docker-in-workspaces.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
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)
Expand Down Expand Up @@ -105,7 +105,7 @@
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]
}
}
Expand Down Expand Up @@ -145,7 +145,7 @@
[starter template](../../../../examples/templates/kubernetes-envbox)
or visit the [repo](https://github.com/coder/envbox).

### Authenticating with a Private Registry

Check warning on line 148 in docs/admin/templates/extending-templates/docker-in-workspaces.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.GerundHeading

Heading starts with an -ing word ('Authenticating'); prefer the imperative ('Install') or the noun ('Installation'). See capitalization-and-punctuation.md#no-gerund-leading-headings.

Authenticating with a private container registry can be done by referencing the
credentials via the `CODER_IMAGE_PULL_SECRET` environment variable. It is
Expand Down Expand Up @@ -333,7 +333,7 @@

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 = [
Expand Down Expand Up @@ -391,7 +391,7 @@
}
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"
Expand Down Expand Up @@ -472,7 +472,7 @@
name = "CODER_AGENT_TOKEN"
value = coder_agent.main.token
}
image = "codercom/enterprise-base:ubuntu"
image = "codercom/example-base:ubuntu"
command = ["sh", "-c", <<EOF
# Start the Coder agent as the "coder" user
# once systemd has started up
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ resource "coder_agent" "main" {
If you are using Docker based workspaces, you can add the command to your Dockerfile:

```dockerfile
FROM codercom/enterprise-base:ubuntu
FROM codercom/example-base:ubuntu

# JetBrains IDE installation (configurable)
ARG IDE_CODE=IU
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Improving Agent Resiliency

Check warning on line 1 in docs/admin/templates/extending-templates/process-priority.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.GerundHeading

Heading starts with an -ing word ('Improving'); prefer the imperative ('Install') or the noun ('Installation'). See capitalization-and-punctuation.md#no-gerund-leading-headings.

Coder's agent can automatically lower the scheduling priority
and raise the OOM (out-of-memory) kill score of user processes
Expand Down Expand Up @@ -71,7 +71,7 @@
spec {
container {
name = "dev"
image = "codercom/enterprise-base:ubuntu"
image = "codercom/example-base:ubuntu"

env {
name = "CODER_AGENT_TOKEN"
Expand Down Expand Up @@ -133,7 +133,7 @@
"Coder on Coder" development scenarios where a workspace
runs another Coder agent.

### Verifying the feature is enabled

Check warning on line 136 in docs/admin/templates/extending-templates/process-priority.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.GerundHeading

Heading starts with an -ing word ('Verifying'); prefer the imperative ('Install') or the noun ('Installation'). See capitalization-and-punctuation.md#no-gerund-leading-headings.

The agent logs whether process priority management is active
at startup. Look for these lines in the agent log:
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/templates/extending-templates/web-ides.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ container image. Here's a Dockerfile which leverages some special
[code-server features](https://coder.com/docs/code-server):

```dockerfile
FROM codercom/enterprise-base:ubuntu
FROM codercom/example-base:ubuntu

# install the latest version
USER root
Expand Down
4 changes: 2 additions & 2 deletions docs/admin/templates/startup-coordination/example.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ data "coder_workspace_owner" "me" {}

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)}"
entrypoint = ["sh", "-c", coder_agent.main.init_script]
env = [
Expand Down Expand Up @@ -146,7 +146,7 @@ data "coder_workspace_owner" "me" {}

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)}"
entrypoint = ["sh", "-c", coder_agent.main.init_script]
env = [
Expand Down
4 changes: 2 additions & 2 deletions docs/get-started/customize-your-template/add-a-language.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ The script installs Ruby with `apt-get`, the package manager built into the work

> [!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:
Expand Down Expand Up @@ -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 = [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 = [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 = [
Expand Down
2 changes: 1 addition & 1 deletion docs/install/openshift.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/user-guides/workspace-access/vscode.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@
1. Installing extensions
[from a marketplace using the command line](#installing-from-a-marketplace-at-the-command-line)

### Using the public extensions marketplaces

Check warning on line 117 in docs/user-guides/workspace-access/vscode.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.GerundHeading

Heading starts with an -ing word ('Using'); prefer the imperative ('Install') or the noun ('Installation'). See capitalization-and-punctuation.md#no-gerund-leading-headings.

You can manually add an extension while you're working in the Code Web IDE. The
extensions can be from Coder's public marketplace, Eclipse Open VSX's public
Expand All @@ -126,7 +126,7 @@
> Microsoft does not allow any unofficial VS Code IDE to connect to the
> extension marketplace.

### Adding extensions to custom images

Check warning on line 129 in docs/user-guides/workspace-access/vscode.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.GerundHeading

Heading starts with an -ing word ('Adding'); prefer the imperative ('Install') or the noun ('Installation'). See capitalization-and-punctuation.md#no-gerund-leading-headings.

You can add extensions to a custom image and install them either through Code
Web or using the workspace's terminal.
Expand All @@ -148,7 +148,7 @@
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
Expand Down Expand Up @@ -195,7 +195,7 @@

You will now have access to the extension in your workspace.

### Installing extensions using its `vsix` file at the command line

Check warning on line 198 in docs/user-guides/workspace-access/vscode.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.GerundHeading

Heading starts with an -ing word ('Installing'); prefer the imperative ('Install') or the noun ('Installation'). See capitalization-and-punctuation.md#no-gerund-leading-headings.

Using the workspace's terminal or the terminal available inside `code-server`,
you can install an extension whose files you've downloaded from a marketplace:
Expand All @@ -204,7 +204,7 @@
/path/to/code-server --install-extension /vsix/GitHub.copilot.vsix
```

### Installing from a marketplace at the command line

Check warning on line 207 in docs/user-guides/workspace-access/vscode.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.GerundHeading

Heading starts with an -ing word ('Installing'); prefer the imperative ('Install') or the noun ('Installation'). See capitalization-and-punctuation.md#no-gerund-leading-headings.

Using the workspace's terminal or the terminal available inside Code Web (code
server), run the following to install an extension (be sure to update the
Expand All @@ -220,7 +220,7 @@
SERVICE_URL=https://open-vsx.org/vscode/gallery ITEM_URL=https://open-vsx.org/vscode/item /path/to/code-server --install-extension GitHub.copilot
```

### Using VS Code Desktop

Check warning on line 223 in docs/user-guides/workspace-access/vscode.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.GerundHeading

Heading starts with an -ing word ('Using'); prefer the imperative ('Install') or the noun ('Installation'). See capitalization-and-punctuation.md#no-gerund-leading-headings.

For your local VS Code to pickup extension files in your Coder workspace,
include this command in your `startup_script`, or run in manually in your
Expand Down
2 changes: 1 addition & 1 deletion examples/examples.gen.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion examples/templates/docker/main.tf
Original file line number Diff line number Diff line change
Expand Up @@ -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:~$
Expand Down
2 changes: 1 addition & 1 deletion examples/templates/kubernetes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion examples/templates/kubernetes/main.tf
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
Loading