-
Notifications
You must be signed in to change notification settings - Fork 6k
#914 - New helm chart for v1 #917
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 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
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
apiVersion: v1 | ||
appVersion: "1.0" | ||
description: A Helm chart for code-server | ||
name: code-server | ||
version: 1.0.0 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,115 @@ | ||
# code-server | ||
|
||
[code-server](https://github.com/cdr/code-server) code-server is VS Code running | ||
on a remote server, accessible through the browser. | ||
|
||
## TL;DR; | ||
|
||
```console | ||
$ git clone https://github.com/cdr/code-server.git | ||
$ helm install deployment/chart | ||
``` | ||
|
||
## Introduction | ||
|
||
This chart bootstraps a code-server deployment on a | ||
[Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) | ||
package manager. | ||
|
||
## Prerequisites | ||
|
||
- Kubernetes 1.6+ | ||
|
||
## Installing the Chart | ||
|
||
To install the chart with the release name `my-release`: | ||
|
||
```console | ||
$ helm install --name my-release deployment/chart | ||
``` | ||
|
||
The command deploys code-server on the Kubernetes cluster in the default | ||
configuration. The [configuration](#configuration) section lists the parameters | ||
that can be configured during installation. | ||
|
||
> **Tip**: List all releases using `helm list` | ||
|
||
## Uninstalling the Chart | ||
|
||
To uninstall/delete the `my-release` deployment: | ||
|
||
```console | ||
$ helm delete my-release | ||
``` | ||
|
||
The command removes all the Kubernetes components associated with the chart and | ||
deletes the release. | ||
|
||
## Configuration | ||
|
||
The following table lists the configurable parameters of the nginx-ingress chart | ||
and their default values. | ||
|
||
|
||
The following table lists the configurable parameters of the code-server chart | ||
and their default values. | ||
|
||
| Parameter | Description | Default | | ||
| --------------------------------- | ------------------------------------------ | --------------------------------------------------------- | | ||
| `image.registry` | Code-server image registry | `docker.io` | | ||
| `image.repository` | Code-server Image name | `codercom/code-server` | | ||
| `image.tag` | Code-server Image tag | `{TAG_NAME}` | | ||
| `image.pullPolicy` | Code-server image pull policy | `IfNotPresent` | | ||
| `nameOverride` | String to partially override code-server.fullname template with a string (will prepend the release name) | `nil` | | ||
| `fullnameOverride` | String to fully override code-server.fullname template with a string | | ||
| `hostnameOverride` | String to fully override code-server container hostname | | ||
| `service.type` | Kubernetes Service type | `NodePort` | | ||
| `service.port` | Service HTTP port | `8443` | | ||
| `ingress.enabled` | Enable ingress controller resource | `false` | | ||
| `ingress.hosts[0].name` | Hostname to your code-server installation | `code-server.local` | | ||
| `ingress.hosts[0].path` | Path within the url structure | `/` | | ||
| `ingress.hosts[0].tls` | Utilize TLS backend in ingress | `false` | | ||
| `ingress.hosts[0].certManager` | Add annotations for cert-manager | `false` | | ||
| `ingress.hosts[0].tlsSecret` | TLS Secret (certificates) | `code-server.local-tls-secret` | | ||
| `ingress.hosts[0].annotations` | Annotations for this host's ingress record | `[]` | | ||
| `ingress.secrets[0].name` | TLS Secret Name | `nil` | | ||
| `ingress.secrets[0].certificate` | TLS Secret Certificate | `nil` | | ||
| `ingress.secrets[0].key` | TLS Secret Key | `nil` | | ||
| `extraArgs` | Additional code-server container arguments | `{}` | | ||
| `extraVars` | Optional environment variables for code-server | `{}` | | ||
| `volumePermissions.enabled` | Enable volume permissions init container | `true` | | ||
| `volumePermissions.securityContext.runAsUser` | User ID for the init container | `0` | | ||
| `securityContext.enabled` | Enable security context | `true` | | ||
| `securityContext.fsGroup` | Group ID for the container | `1000` | | ||
| `securityContext.runAsUser` | User ID for the container | `1000` | | ||
| `resources` | CPU/Memory resource requests/limits | `{}` | | ||
| `persistence.enabled` | Enable persistence using PVC | `true` | | ||
| `persistence.storageClass` | PVC Storage Class for code-server volume | `nil` | | ||
| `persistence.accessMode` | PVC Access Mode for code-server volume | `ReadWriteOnce` | | ||
| `persistence.size` | PVC Storage Request for code-server volume | `8Gi` | | ||
| `extraContainers` | Sidecar containers to add to the code-server pod | `{}` | | ||
| `extraSecretMounts` | Additional code-server server secret mounts | `[]` | | ||
| `extraVolumeMounts` | Additional code-server server volume mounts | `[]` | | ||
| `extraConfigmapMounts` | Additional code-server server configMap volume mounts | `[]` | | ||
|
||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm | ||
install`. For example, | ||
|
||
```console | ||
$ helm install --name my-release \ | ||
--set persistence.enabled=false \ | ||
deployment/chart | ||
``` | ||
|
||
The above command sets the the persistence storage to false. | ||
|
||
Alternatively, a YAML file that specifies the values for the above parameters | ||
can be provided while installing the chart. For example, | ||
|
||
```console | ||
$ helm install --name my-release -f values.yaml deployment/chart | ||
``` | ||
|
||
> **Tip**: You can use the default [values.yaml](values.yaml) | ||
|
||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
1. Get the application URL by running these commands: | ||
{{- if .Values.ingress.enabled }} | ||
{{- range $host := .Values.ingress.hosts }} | ||
{{- range .paths }} | ||
http{{ if $.Values.ingress.tls }}s{{ end }}://{{ $host.host }}{{ . }} | ||
{{- end }} | ||
{{- end }} | ||
{{- else if contains "NodePort" .Values.service.type }} | ||
export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "code-server.fullname" . }}) | ||
export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}") | ||
echo http://$NODE_IP:$NODE_PORT | ||
{{- else if contains "LoadBalancer" .Values.service.type }} | ||
NOTE: It may take a few minutes for the LoadBalancer IP to be available. | ||
You can watch the status of by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "code-server.fullname" . }}' | ||
export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "code-server.fullname" . }} -o jsonpath='{.status.loadBalancer.ingress[0].ip}') | ||
echo http://$SERVICE_IP:{{ .Values.service.port }} | ||
{{- else if contains "ClusterIP" .Values.service.type }} | ||
export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "code-server.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}") | ||
echo "Visit http://127.0.0.1:8080 to use your application" | ||
kubectl port-forward $POD_NAME 8080:80 | ||
{{- end }} | ||
|
||
Administrator credentials: | ||
|
||
Password : $(kubectl get secret --namespace {{ .Release.Namespace }} {{ template "code-server.fullname" . }} -o jsonpath="{.data.password}" | base64 --decode) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
{{/* vim: set filetype=mustache: */}} | ||
{{/* | ||
Expand the name of the chart. | ||
*/}} | ||
{{- define "code-server.name" -}} | ||
{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" -}} | ||
{{- end -}} | ||
|
||
{{/* | ||
Create a default fully qualified app name. | ||
We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec). | ||
If release name contains chart name it will be used as a full name. | ||
*/}} | ||
{{- define "code-server.fullname" -}} | ||
{{- if .Values.fullnameOverride -}} | ||
{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" -}} | ||
{{- else -}} | ||
{{- $name := default .Chart.Name .Values.nameOverride -}} | ||
{{- if contains $name .Release.Name -}} | ||
{{- .Release.Name | trunc 63 | trimSuffix "-" -}} | ||
{{- else -}} | ||
{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" -}} | ||
{{- end -}} | ||
{{- end -}} | ||
{{- end -}} | ||
|
||
{{/* | ||
Create chart name and version as used by the chart label. | ||
*/}} | ||
{{- define "code-server.chart" -}} | ||
{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" -}} | ||
{{- end -}} | ||
|
||
{{/* | ||
Create the name of the service account to use | ||
*/}} | ||
{{- define "code-server.serviceAccountName" -}} | ||
{{- if .Values.serviceAccount.create -}} | ||
{{ default (include "code-server.fullname" .) .Values.serviceAccount.name }} | ||
{{- else -}} | ||
{{ default "default" .Values.serviceAccount.name }} | ||
{{- end -}} | ||
{{- end -}} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,144 @@ | ||
apiVersion: apps/v1 | ||
kind: Deployment | ||
metadata: | ||
name: {{ include "code-server.fullname" . }} | ||
labels: | ||
app.kubernetes.io/name: {{ include "code-server.name" . }} | ||
helm.sh/chart: {{ include "code-server.chart" . }} | ||
app.kubernetes.io/instance: {{ .Release.Name }} | ||
app.kubernetes.io/managed-by: {{ .Release.Service }} | ||
spec: | ||
replicas: 1 | ||
strategy: | ||
type: Recreate | ||
deansheather marked this conversation as resolved.
Show resolved
Hide resolved
|
||
selector: | ||
matchLabels: | ||
app.kubernetes.io/name: {{ include "code-server.name" . }} | ||
app.kubernetes.io/instance: {{ .Release.Name }} | ||
template: | ||
metadata: | ||
labels: | ||
app.kubernetes.io/name: {{ include "code-server.name" . }} | ||
app.kubernetes.io/instance: {{ .Release.Name }} | ||
spec: | ||
{{- if .Values.hostnameOverride }} | ||
hostname: {{ .Values.hostnameOverride }} | ||
{{- end }} | ||
{{- if .Values.securityContext.enabled }} | ||
securityContext: | ||
fsGroup: {{ .Values.securityContext.fsGroup }} | ||
{{- end }} | ||
{{- if and .Values.volumePermissions.enabled .Values.persistence.enabled }} | ||
initContainers: | ||
- name: init-chmod-data | ||
image: busybox:latest | ||
imagePullPolicy: IfNotPresent | ||
command: | ||
- sh | ||
- -c | ||
- | | ||
chown -R {{ .Values.securityContext.runAsUser }}:{{ .Values.securityContext.fsGroup }} /home/coder | ||
securityContext: | ||
runAsUser: {{ .Values.volumePermissions.securityContext.runAsUser }} | ||
volumeMounts: | ||
- name: data | ||
mountPath: /home/coder | ||
deansheather marked this conversation as resolved.
Show resolved
Hide resolved
|
||
{{- end }} | ||
containers: | ||
{{- if .Values.extraContainers }} | ||
{{ toYaml .Values.extraContainers | indent 8}} | ||
{{- end }} | ||
- name: {{ .Chart.Name }} | ||
image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}" | ||
imagePullPolicy: {{ .Values.image.pullPolicy }} | ||
{{- if .Values.securityContext.enabled }} | ||
securityContext: | ||
runAsUser: {{ .Values.securityContext.runAsUser }} | ||
{{- end }} | ||
env: | ||
{{- if .Values.extraVars }} | ||
{{ toYaml .Values.extraVars | indent 10 }} | ||
{{- end }} | ||
- name: PASSWORD | ||
valueFrom: | ||
secretKeyRef: | ||
{{- if .Values.existingSecret }} | ||
name: {{ .Values.existingSecret }} | ||
{{- else }} | ||
name: {{ template "code-server.fullname" . }} | ||
{{- end }} | ||
key: password | ||
{{- if .Values.extraArgs }} | ||
args: | ||
{{ toYaml .Values.extraArgs | indent 10 }} | ||
{{- end }} | ||
volumeMounts: | ||
- name: data | ||
mountPath: /home/coder/project | ||
subPath: project | ||
- name: data | ||
mountPath: /home/coder/.local/share/code-server | ||
subPath: code-server | ||
{{- range .Values.extraConfigmapMounts }} | ||
- name: {{ .name }} | ||
mountPath: {{ .mountPath }} | ||
subPath: {{ .subPath | default "" }} | ||
readOnly: {{ .readOnly }} | ||
{{- end }} | ||
{{- range .Values.extraSecretMounts }} | ||
- name: {{ .name }} | ||
mountPath: {{ .mountPath }} | ||
readOnly: {{ .readOnly }} | ||
{{- end }} | ||
{{- range .Values.extraVolumeMounts }} | ||
- name: {{ .name }} | ||
mountPath: {{ .mountPath }} | ||
subPath: {{ .subPath | default "" }} | ||
readOnly: {{ .readOnly }} | ||
{{- end }} | ||
ports: | ||
- name: http | ||
containerPort: 8443 | ||
protocol: TCP | ||
livenessProbe: | ||
httpGet: | ||
path: / | ||
port: http | ||
readinessProbe: | ||
httpGet: | ||
path: / | ||
port: http | ||
resources: | ||
{{- toYaml .Values.resources | nindent 12 }} | ||
{{- with .Values.nodeSelector }} | ||
nodeSelector: | ||
{{- toYaml . | nindent 8 }} | ||
{{- end }} | ||
{{- with .Values.affinity }} | ||
affinity: | ||
{{- toYaml . | nindent 8 }} | ||
{{- end }} | ||
{{- with .Values.tolerations }} | ||
tolerations: | ||
{{- toYaml . | nindent 8 }} | ||
{{- end }} | ||
serviceAccountName: {{ template "code-server.serviceAccountName" . }} | ||
volumes: | ||
- name: data | ||
{{- if .Values.persistence.enabled }} | ||
persistentVolumeClaim: | ||
claimName: {{ .Values.persistence.existingClaim | default (include "code-server.fullname" .) }} | ||
{{- else }} | ||
emptyDir: {} | ||
{{- end -}} | ||
{{- range .Values.extraSecretMounts }} | ||
- name: {{ .name }} | ||
secret: | ||
secretName: {{ .secretName }} | ||
defaultMode: {{ .defaultMode }} | ||
{{- end }} | ||
{{- range .Values.extraVolumeMounts }} | ||
- name: {{ .name }} | ||
persistentVolumeClaim: | ||
claimName: {{ .existingClaim }} | ||
{{- end }} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
{{- if .Values.ingress.enabled -}} | ||
{{- $fullName := include "code-server.fullname" . -}} | ||
apiVersion: extensions/v1beta1 | ||
kind: Ingress | ||
metadata: | ||
name: {{ $fullName }} | ||
labels: | ||
app.kubernetes.io/name: {{ include "code-server.name" . }} | ||
helm.sh/chart: {{ include "code-server.chart" . }} | ||
app.kubernetes.io/instance: {{ .Release.Name }} | ||
app.kubernetes.io/managed-by: {{ .Release.Service }} | ||
{{- with .Values.ingress.annotations }} | ||
annotations: | ||
{{- toYaml . | nindent 4 }} | ||
{{- end }} | ||
spec: | ||
{{- if .Values.ingress.tls }} | ||
tls: | ||
{{- range .Values.ingress.tls }} | ||
- hosts: | ||
{{- range .hosts }} | ||
- {{ . | quote }} | ||
{{- end }} | ||
secretName: {{ .secretName }} | ||
{{- end }} | ||
{{- end }} | ||
rules: | ||
{{- range .Values.ingress.hosts }} | ||
- host: {{ .host | quote }} | ||
http: | ||
paths: | ||
{{- range .paths }} | ||
- path: {{ . }} | ||
backend: | ||
serviceName: {{ $fullName }} | ||
servicePort: http | ||
{{- end }} | ||
{{- end }} | ||
{{- end }} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.