Skip to content

custom images: clarify building CVM images #452

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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 2, 2021
Merged

custom images: clarify building CVM images #452

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0acd2fa
custom images: clarify building CVM images
bpmct Jun 29, 2021
9e3b5bd
Edit text
Jun 30, 2021
4193ed1
Update links
Jun 30, 2021
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
28 changes: 19 additions & 9 deletions images/writing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,12 @@ description: Learn how to write custom images for use with Coder.
Custom images allow you to define workspaces that include the dependencies,
scripts, and user preferences helpful for your project.

> If you're unfamiliar with how to create, build, and push Docker Images, please
> review [this tutorial by
> Docker](http://blog.shippable.com/build-a-docker-image-and-push-it-to-docker-hub)
> before proceeding.
This guide assumes that you're familiar with:

- [Dockerfiles](https://docs.docker.com/engine/reference/builder/)
- [docker login](https://docs.docker.com/engine/reference/commandline/login/)
- [docker build](https://docs.docker.com/engine/reference/commandline/build/)
- [docker push](https://docs.docker.com/engine/reference/commandline/push/)

## Creating a custom image

Expand All @@ -32,11 +34,19 @@ Please note:
[image minimum requirements](https://github.com/cdr/enterprise-images/#image-minimums)
to make sure that your image will work with all of Coder's features.

- You can build images inside a Coder workspace using the
[Docker Sandbox](https://github.com/bpmct/cdr-images/tree/master/docker-sandbox).
If, however, you're using [CVMs](../admin/workspace-management/cvms.md),
you'll need to have the [sysbox runtime](https://github.com/nestybox/sysbox)
on your machine.
- You can build images inside a
[CVM](../admin/workspace-management/cvms.md)-enabled Coder workspace with
Docker installed (see our [base
image](https://github.com/cdr/enterprise-images/tree/main/images/base) for an
example of how you can do this).

- If you're using CVM-only features during an image's build time (e.g., you're
[pre-loading
images](https://github.com/nestybox/sysbox/blob/master/docs/quickstart/images.md#building-a-system-container-that-includes-inner-container-images--v012-)
in workspaces), you will need to install the [sysbox
runtime](https://github.com/nestybox/sysbox) onto your local machine and build
images locally. Note that this isn't usually necessary, even if your image
installs and enables Docker.

## Example: Installing an IntelliJ IDE

Expand Down