Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

docs: improve dev containers documentation for user start-up#15458

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
EdwardAngert merged 39 commits intomainfrombp-dev-containers
Dec 2, 2024
Merged
Show file tree
Hide file tree
Changes fromall commits
Commits
Show all changes
39 commits
Select commitHold shift + click to select a range
d741460
add definitions to admin/index
EdwardAngertNov 8, 2024
3ed5c3e
init devcontainers best practice doc
EdwardAngertNov 8, 2024
dcf901c
s/definition list/bullets
EdwardAngertNov 8, 2024
16cce07
Merge remote-tracking branch 'origin' into bp-dev-containers
EdwardAngertNov 12, 2024
e96b1bc
admin/index glossary section
EdwardAngertNov 13, 2024
22e399d
when to use a dev container
EdwardAngertNov 13, 2024
4f91cd0
Merge remote-tracking branch 'origin' into bp-dev-containers
EdwardAngertNov 13, 2024
8e37e58
admin/index glossary; devcontainer known issues
EdwardAngertNov 13, 2024
985233a
devcontainer lifecycle scripts
EdwardAngertNov 13, 2024
f2c59be
devcontainers directory
EdwardAngertNov 13, 2024
b24f615
fix typo
EdwardAngertNov 13, 2024
4c28411
make fmt
EdwardAngertNov 13, 2024
fc20dc3
suggestions from review
EdwardAngertNov 20, 2024
197cfa7
add steps in tabs to add-devcontainer
EdwardAngertNov 20, 2024
5a93ff2
fix links; list templates
EdwardAngertNov 20, 2024
8e53735
make fmt + copy review addition
EdwardAngertNov 20, 2024
80bf5da
fix link
EdwardAngertNov 21, 2024
ca56186
typo fix
EdwardAngertNov 21, 2024
1491680
copy edit devcontainer/index
EdwardAngertNov 21, 2024
7f8b079
edit add-devcontainer
EdwardAngertNov 22, 2024
547cfe0
Apply suggestions from code review
EdwardAngertNov 22, 2024
d22f76f
add screenshot
EdwardAngertNov 22, 2024
ce0d2be
make fmt; copy tweaks
EdwardAngertNov 22, 2024
66fcca0
edit example
EdwardAngertNov 22, 2024
de58159
link typo
EdwardAngertNov 22, 2024
69415d4
adjust image size
EdwardAngertNov 22, 2024
ae543de
Apply suggestions from code review
EdwardAngertNov 25, 2024
ca0da6d
Apply suggestions from code review
EdwardAngertNov 25, 2024
381bb73
make fmt
EdwardAngertNov 25, 2024
ade54e9
close codeblock; edit starter template steps
EdwardAngertNov 25, 2024
e46fc13
code review
Nov 26, 2024
9982af4
make fmt
Nov 26, 2024
182d69a
rename to dev containers
Nov 26, 2024
bf2e0fa
2-col table
EdwardAngertNov 26, 2024
cd99937
make fmt
Nov 26, 2024
d17dbea
un-double bullet def list
Nov 26, 2024
2c3ca6d
s/devcontainer/dev container
Nov 26, 2024
c28f16d
comma typo
Nov 26, 2024
f344dff
Merge remote-tracking branch 'origin' into bp-dev-containers
Nov 27, 2024
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
52 changes: 52 additions & 0 deletionsdocs/admin/index.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,4 +15,56 @@ and [API](../reference/api/index.md) docs.
For any information not strictly contained in these sections, check out our
[Tutorials](../tutorials/index.md) and [FAQs](../tutorials/faqs.md).

## What is an image, template, dev container, or workspace

**Image**

- A [base image](./templates/managing-templates/image-management.md) contains
OS-level packages and utilities that the Coder workspace is built on. It can
be an [example image](https://github.com/coder/images), custom image in your
registry, or one from [Docker Hub](https://hub.docker.com/search). It is
defined in each template.
- Managed by: Externally to Coder.

**Template**

- [Templates](./templates/index.md) include infrastructure-level dependencies
for the workspace. For example, a template can include Kubernetes
PersistentVolumeClaims, Docker containers, or EC2 VMs.
- Managed by: Template administrators from within the Coder deployment.

**Startup scripts**

- Agent startup scripts apply to all users of a template. This is an
intentionally flexible area that template authors have at their disposal to
manage the "last mile" of workspace creation.
- Managed by: Coder template administrators.

**Workspace**

- A [workspace](../user-guides/workspace-management.md) is the environment that
a developer works in. Developers on a team each work from their own workspace
and can use [multiple IDEs](../user-guides/workspace-access/index.md).
- Managed by: Developers

**Development containers (dev containers)**

- A
[Development Container](./templates/managing-templates/devcontainers/index.md)
is an open-source specification for defining development environments (called
dev containers). It is generally stored in VCS alongside associated source
code. It can reference an existing base image, or a custom Dockerfile that
will be built on-demand.
- Managed by: Dev Teams

**Dotfiles / personalization**

- Users may have their own specific preferences relating to shell prompt, custom
keybindings, color schemes, and more. Users can leverage Coder's
[dotfiles support](../user-guides/workspace-dotfiles.md) or create their own
script to personalize their workspace. Be aware that users with root
permissions in their workspace can override almost all of the previous
configuration.
- Managed by: Individual Users

<children></children>
4 changes: 2 additions & 2 deletionsdocs/admin/templates/index.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -48,8 +48,8 @@ needs of different teams.

- [Image management](./managing-templates/image-management.md): Learn how to
create and publish images for use within Coder workspaces & templates.
- [Dev Container support](./managing-templates/devcontainers.md): Enable dev
containers to allow teams to bring their own tools into Coder workspaces.
- [Dev Container support](./managing-templates/devcontainers/index.md): Enable
devcontainers to allow teams to bring their own tools into Coder workspaces.
- [Template hardening](./extending-templates/resource-persistence.md#-bulletproofing):
Configure your template to prevent certain resources from being destroyed
(e.g. user disks).
Expand Down
112 changes: 0 additions & 112 deletionsdocs/admin/templates/managing-templates/devcontainers.md
View file
Open in desktop

This file was deleted.

View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,150 @@
# Add a dev container template to Coder

A Coder administrator adds a dev container-compatible template to Coder
(Envbuilder). This allows the template to prompt for the developer for their dev
container repository's URL as a
[parameter](../../extending-templates/parameters.md) when they create their
workspace. Envbuilder clones the repo and builds a container from the
`devcontainer.json` specified in the repo.

You can create template files through the Coder dashboard, CLI, or you can
choose a template from the
[Coder registry](https://registry.coder.com/templates):

<div class="tabs">

## Dashboard

1. In the Coder dashboard, select **Templates** then **Create Template**.
1. Use a
[starter template](https://github.com/coder/coder/tree/main/examples/templates)
or create a new template:

- Starter template:

1. Select **Choose a starter template**.
1. Choose a template from the list or select **Devcontainer** from the
sidebar to display only dev container-compatible templates.
1. Select **Use template**, enter the details, then select **Create
template**.

- To create a new template, select **From scratch** and enter the templates
details, then select **Create template**.

1. Edit the template files to fit your deployment.

## CLI

1. Use the `template init` command to initialize your choice of image:

```shell
coder template init --id devcontainer-kubernetes
```

A list of available templates is shown in the
[templates_init](../../../../reference/cli/templates.md) reference.

1. `cd` into the directory and push the template to your Coder deployment:

```shell
cd devcontainer-kubernetes && coder templates push
```

You can also edit the files or make changes to the files before you push them
to Coder.

## Registry

1. Go to the [Coder registry](https://registry.coder.com/templates) and select a
dev container-compatible template.

1. Copy the files to your local device, then edit them to fit your needs.

1. Upload them to Coder through the CLI or dashboard:

- CLI:

```shell
coder templates push <template-name> -d <path to folder containing main.tf>
```

- Dashboard:

1. Create a `.zip` of the template files:

- On Mac or Windows, highlight the files and then right click. A
"compress" option is available through the right-click context menu.

- To zip the files through the command line:

```shell
zip templates.zip Dockerfile main.tf
```

1. Select **Templates**.
1. Select **Create Template**, then **Upload template**:

![Upload template](../../../../images/templates/upload-create-your-first-template.png)

1. Drag the `.zip` file into the **Upload template** section and fill out the
details, then select **Create template**.

![Upload the template files](../../../../images/templates/upload-create-template-form.png)

</div>

To set variables such as the namespace, go to the template in your Coder
dashboard and select **Settings** from the **⋮** (vertical ellipsis) menu:

<Image height="255px" src="../../../../images/templates/template-menu-settings.png" alt="Choose Settings from the template's menu" align="center" />

## Envbuilder Terraform provider

When using the
[Envbuilder Terraform provider](https://registry.terraform.io/providers/coder/envbuilder/latest/docs),
a previously built and cached image can be reused directly, allowing dev
containers to start instantaneously.

Developers can edit the `devcontainer.json` in their workspace to customize
their development environments:

```json
# …
{
"features": {
"ghcr.io/devcontainers/features/common-utils:2": {}
}
}
# …
```

## Example templates

| Template | Description |
| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Docker dev containers](https://github.com/coder/coder/tree/main/examples/templates/devcontainer-docker) | Docker provisions a development container. |
| [Kubernetes dev containers](https://github.com/coder/coder/tree/main/examples/templates/devcontainer-kubernetes) | Provisions a development container on the Kubernetes cluster. |
| [Google Compute Engine dev container](https://github.com/coder/coder/tree/main/examples/templates/gcp-devcontainer) | Runs a development container inside a single GCP instance. It also mounts the Docker socket from the VM inside the container to enable Docker inside the workspace. |
| [AWS EC2 dev container](https://github.com/coder/coder/tree/main/examples/templates/aws-devcontainer) | Runs a development container inside a single EC2 instance. It also mounts the Docker socket from the VM inside the container to enable Docker inside the workspace. |

Your template can prompt the user for a repo URL with
[parameters](../../extending-templates/parameters.md):
Comment on lines +130 to +131
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

May also mention to use thegit-clone module from the registry.


![Dev container parameter screen](../../../../images/templates/devcontainers.png)

## Dev container lifecycle scripts

The `onCreateCommand`, `updateContentCommand`, `postCreateCommand`, and
`postStartCommand` lifecycle scripts are run each time the container is started.
This could be used, for example, to fetch or update project dependencies before
a user begins using the workspace.

Lifecycle scripts are managed by project developers.

## Next steps

- [Dev container security and caching](./devcontainer-security-caching.md)

```

```
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
# Dev container releases and known issues

## Release channels

Envbuilder provides two release channels:

- **Stable**
- Available at
[`ghcr.io/coder/envbuilder`](https://github.com/coder/envbuilder/pkgs/container/envbuilder).
Tags `>=1.0.0` are considered stable.
- **Preview**
- Available at
[`ghcr.io/coder/envbuilder-preview`](https://github.com/coder/envbuilder/pkgs/container/envbuilder-preview).
Built from the tip of `main`, and should be considered experimental and
prone to breaking changes.
Comment on lines +7 to +15
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I have this above, but let's avoid this double-bullet-point formatting


Refer to the
[Envbuilder GitHub repository](https://github.com/coder/envbuilder/) for more
information and to submit feature requests or bug reports.

## Known issues

Visit the
[Envbuilder repository](https://github.com/coder/envbuilder/blob/main/docs/devcontainer-spec-support.md)
for a full list of supported features and known issues.
Loading
Loading
[8]ページ先頭
©2009-2025 Movatter.jp