code-server-2/ci/helm-chart/README.md

3.6 KiB

code-server

Version: 1.0.0 Type: application AppVersion: 3.6.2

code-server code-server is VS Code running on a remote server, accessible through the browser.

This chart is community maintained by @Matthew-Beckett and @alexgorbatchev

TL;DR;

$ git clone https://github.com/cdr/code-server.git
$ helm install code-server charts/code-server

Introduction

This chart bootstraps a code-server deployment on a Kubernetes cluster using the Helm package manager.

Prerequisites

  • Kubernetes 1.6+

Installing the Chart

To install the chart with the release name my-release:

$ helm install --name my-release charts/code-server

The command deploys code-server on the Kubernetes cluster in the default configuration. The 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:

$ 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 code-server chart and their default values.

Values

Key Type Default Description
affinity object {}
extraArgs list []
extraConfigmapMounts list []
extraContainers string ""
extraSecretMounts list []
extraVars list []
extraVolumeMounts list []
fullnameOverride string ""
hostnameOverride string ""
image.pullPolicy string "Always"
image.repository string "codercom/code-server"
image.tag string "3.5.0"
imagePullSecrets list []
ingress.enabled bool false
nameOverride string ""
nodeSelector object {}
persistence.accessMode string "ReadWriteOnce"
persistence.annotations object {}
persistence.enabled bool true
persistence.size string "1Gi"
podAnnotations object {}
podSecurityContext object {}
replicaCount int 1
resources object {}
securityContext.enabled bool true
securityContext.fsGroup int 1000
securityContext.runAsUser int 1000
service.port int 8443
service.type string "ClusterIP"
serviceAccount.create bool true
serviceAccount.name string nil
tolerations list []
volumePermissions.enabled bool true
volumePermissions.securityContext.runAsUser int 0

Specify each parameter using the --set key=value[,key=value] argument to helm install. For example,

$ 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,

$ helm install --name my-release -f values.yaml deployment/chart

Tip: You can use the default values.yaml