Begin Openshift docs

Emyrk · Emyrk · commit f2a40eb9db65 · 2021-07-07T12:51:52.000-05:00
Document openshift image tweaks required.
Omit docs on how to use openshift registry
diff --git a/manifest.json b/manifest.json
@@ -142,6 +142,14 @@
             },
             {
               "path": "./setup/kubernetes/google.md"
+            },
+            {
+              "path": "./setup/kubernetes/openshift/index.md",
+              "children": [
+                {
+                  "path": "./setup/kubernetes/openshift/images.md"
+                }
+              ]
             }
           ]
         },
diff --git a/setup/kubernetes/openshift/images.md b/setup/kubernetes/openshift/images.md
@@ -0,0 +1,38 @@
+---
+title: "Openshift Image"
+description: Learn how to make your Coder images compatible with Openshift.
+---
+
+> This is required if running with 'restricted' pods. Giving the `builder` service account in your project [anyuid](https://www.openshift.com/blog/managing-sccs-in-openshift) permissions makes these steps unnecessary.
+
+First, you should be familiar with [creating an image for your coder workspace](../../../images/writing.md). Openshift by default will not allow the default `coder` user in the base image. To create a good experience in Coder, we recommend creating a new image specific for your Openshift namespace.
+
+## Openshift Dockerfile
+
+This dockerfile should extend your Coder image for a specific project. This allows the `coder` user to be used in the image within the project.
+
+First we need to get the allowed uid range for the project. Select the project in which Coder was installed.
+
+```bash
+$ oc describe project coder | grep uid-range
+openshift.io/sa.scc.uid-range=1000670000/10000
+```
+
+Knowing the allowed uid range, we can change the uid of the `coder` user in our image.
+
+```dockerfile
+# Change this to your docker image. 
+FROM docker.io/codercom/enterprise-base:ubuntu
+
+# Switch to root
+USER root 
+# As root, change the coder user id
+RUN usermod -u 1000670000 coder
+
+# Go back to the user 'coder'
+USER coder
+```
+
+## Builtin Registry
+
+This Dockerfile can be placed in the `openshift-image-registry` project's [build configs](https://docs.openshift.com/container-platform/4.7/cicd/builds/understanding-buildconfigs.html) to automatically build this project specific dockerfile each time the underlying image is updated.
diff --git a/setup/kubernetes/openshift/index.md b/setup/kubernetes/openshift/index.md
@@ -0,0 +1,5 @@
+---
+title: "Openshift"
+description: Learn about deploying Coder in Openshift
+---
+

Original file line number	Diff line number	Diff line change
`@@ -142,6 +142,14 @@`
`142`	`142`	`},`
`143`	`143`	`{`
`144`	`144`	`"path": "./setup/kubernetes/google.md"`
	`145`	`+ },`
	`146`	`+ {`
	`147`	`+ "path": "./setup/kubernetes/openshift/index.md",`
	`148`	`+ "children": [`
	`149`	`+ {`
	`150`	`+ "path": "./setup/kubernetes/openshift/images.md"`
	`151`	`+ }`
	`152`	`+ ]`
`145`	`153`	`}`
`146`	`154`	`]`
`147`	`155`	`},`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +title: "Openshift"
 +description: Learn about deploying Coder in Openshift
 +---
++