Add documentation for OpenShift #470
Conversation
* hotfix: Templates language [ch14098] This implements task 2 (documentation) for normalizing the language around workspace templates. Details: * Rename workspaces-as-code directory to workspace-templates * Replace WAC and Workspaces as code with workspace templates Co-authored-by: Katie Horne <katie@coder.com>
*Total -- 195.86kb -> 172.63kb (11.86%) /assets/workspaces/workspace-overview.png -- 134.26kb -> 116.30kb (13.37%) /assets/workspaces/status-chip.png -- 61.60kb -> 56.33kb (8.56%) Signed-off-by: ImgBotApp <ImgBotHelp@gmail.com> Co-authored-by: ImgBotApp <ImgBotHelp@gmail.com>
|
✨ Coder.com for PR #470 deployed! It will be updated on every commit.
|
|
[ch3540] |
|
This pull request has been linked to Clubhouse Story #3540: Support running Coder control plane containers with OpenShift's restricted SCC. |
Bumps [husky](https://github.com/typicode/husky) from 7.0.0 to 7.0.1. - [Release notes](https://github.com/typicode/husky/releases) - [Commits](typicode/husky@v7.0.0...v7.0.1) --- updated-dependencies: - dependency-name: husky dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Bumps [@types/minimist](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/minimist) from 1.2.1 to 1.2.2. - [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases) - [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/minimist) --- updated-dependencies: - dependency-name: "@types/minimist" dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
chore: document special case re: GitHub and callback/dev URLs Co-authored-by: Ben Potter <me@bpmct.net>
* Open pull requests for major version updates for GitHub Actions * Ignore version updates for Node.js types
Bumps [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node) from 12.20.15 to 12.20.16. - [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases) - [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/node) --- updated-dependencies: - dependency-name: "@types/node" dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Recommend that users track supported Kubernetes versions, and remove the reference to version 1.13. Co-authored-by: Katie Horne <katie@coder.com>
Document openshift image tweaks required. Omit docs on how to use openshift registry
|
@Emyrk I can't tag you as reviewer since you opened the PR, please take a look at these changes, and then we'll ask Katie to review. |
setup/kubernetes/openshift.md
Outdated
| ## Prerequisites | ||
|
|
||
| - An OpenShift cluster with a Project (Kubernetes namespace) for Coder | ||
| - OpenShift command-line tools (`oc` and `kubectl`) |
There was a problem hiding this comment.
Should we add Postgres here? Do we need to include docs on how to spin up postgres on openshift?
There was a problem hiding this comment.
This is a great point -- Our other guides don't mention PostgreSQL, I think we just expect users to find their own 🤔
There was a problem hiding this comment.
I am ok with that personally, if anyone ends up needing those docs, I'm sure we will hear about it.
Maybe we should mention it in the prereqs though?
There was a problem hiding this comment.
Well, if we mention it for OpenShift, we should mention it for Azure/EKS/GKE, too, for consistency... and then I suppose it's best to do that as a separate PR
|
@khorne3 I think this is ready for your review now. This requires some changes to our Helm chart that are only available after 1.21 is released, so I'm not sure exactly how to handle this - maybe as a pull request into a release branch? Can you advise? |
|
@jawnsy I started a 1.21 branch so we can merge this into that, instead of main, when ready |
|
@Emyrk just some clarification questions: to use Openshift, they should:
where both steps are required? |
Document openshift image tweaks required. Omit docs on how to use openshift registry
|
@khorne3 Yup, your understanding is correct! I've re-targeted this change to the release branch and re-based, so everything should be ready to go now |
Preview: https://codercom-em5j7gns3-codercom.vercel.app/docs/coder/v1.20/setup/kubernetes/openshift