From 0acd2faec8e34396aaf8eba0fed32872acaa7634 Mon Sep 17 00:00:00 2001 From: Ben Potter Date: Tue, 29 Jun 2021 12:35:51 -0400 Subject: [PATCH 1/3] custom images: clarify building CVM images --- images/writing.md | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/images/writing.md b/images/writing.md index e3a079eb6..087e0cc48 100644 --- a/images/writing.md +++ b/images/writing.md @@ -7,8 +7,8 @@ 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) +> review +> [this tutorial by Docker](http://blog.shippable.com/build-a-docker-image-and-push-it-to-docker-hub) > before proceeding. ## Creating a custom image @@ -32,11 +32,17 @@ 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, such as our + [base image](https://github.com/cdr/enterprise-images/tree/main/images/base). + +- If you're using CVM-only features during an image's build time, such as + [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) on your local machine and + build images there. This is usually not necessary, even if your image installs + and enables Docker. ## Example: Installing an IntelliJ IDE From 9e3b5bd18302efdedf59e62e089b32e3feeff10f Mon Sep 17 00:00:00 2001 From: Katie Horne Date: Wed, 30 Jun 2021 10:11:06 -0500 Subject: [PATCH 2/3] Edit text --- images/writing.md | 26 ++++++++++++++------------ 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/images/writing.md b/images/writing.md index 087e0cc48..dba7c18ce 100644 --- a/images/writing.md +++ b/images/writing.md @@ -7,8 +7,8 @@ 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) +> review [this tutorial by +> Docker](http://blog.shippable.com/build-a-docker-image-and-push-it-to-docker-hub) > before proceeding. ## Creating a custom image @@ -33,16 +33,18 @@ Please note: to make sure that your image will work with all of Coder's features. - You can build images inside a - ([CVM](../admin/workspace-management/cvms.md)-enabled) Coder workspace with - Docker installed, such as our - [base image](https://github.com/cdr/enterprise-images/tree/main/images/base). - -- If you're using CVM-only features during an image's build time, such as - [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) on your local machine and - build images there. This is usually not necessary, even if your image installs - and enables Docker. + [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 From 4193ed1ff8a8adaadb59333f6a903ac43abc14fa Mon Sep 17 00:00:00 2001 From: Katie Horne Date: Wed, 30 Jun 2021 15:01:11 -0500 Subject: [PATCH 3/3] Update links --- images/writing.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/images/writing.md b/images/writing.md index dba7c18ce..a70e790c2 100644 --- a/images/writing.md +++ b/images/writing.md @@ -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