Skip to content

Latest commit

 

History

History
101 lines (78 loc) · 4.66 KB

readme.md

File metadata and controls

101 lines (78 loc) · 4.66 KB
Raw

ORIGINAL: https://github.com/eclipse/che/tree/master/deploy/kubernetes/helm/che

Deploy single user Che to Kubernetes using Helm

Prerequisites

  • Start minikube with sufficient resources and RBAC enabled
    • for minikube 0.26.0 and greater minikube start --cpus 2 --memory 4096 --extra-config=apiserver.authorization-mode=RBAC
    • for minikube 0.25.2 and lower minikube start --cpus 2 --memory 4096 --extra-config=apiserver.Authorization.Mode=RBAC
  • Add cluster-admin role for kube-system:default account
    • kubectl create clusterrolebinding add-on-cluster-admin --clusterrole=cluster-admin --serviceaccount=kube-system:default
  • Install the Helm CLI
  • Set your default Kubernetes context (this is required to use helm):
    • In Minikube this is set for you automatically
    • Otherwise, you may have to modify the KUBECONFIG environment variable and then type kubectl config use-context <my-context>
  • Install tiller on your cluster:
    • Create a tiller serviceAccount: kubectl create serviceaccount tiller --namespace kube-system
    • Bind it to the almighty cluster-admin role: kubectl apply -f ./tiller-rbac.yaml
    • Install tiller itself: helm init --service-account tiller
  • Ensure that you have an NGINX-based ingress controller. Note: This is the default ingress controller on Minikube. You can start it with minikube addons enable ingress
  • DNS discovery should be enabled. Note: It is enabled by default in minikube.

Deployment Process

Obtain the Address of your Kubernetes Cluser

  • If your cluster is running on Minikube, simply type minikube ip at your terminal
  • If yourr cluster is in the cloud, obtain the hostname or ip address from your cloud provider

In production, you should specify a hostname (see here why). In case you don't have a hostname (e.g. during development), and would still want to use a host-based configuration, you can use services such as nip.io or xip.io.

In case you're specifying a hostname, simply pass it as the value of the ingressDomain parameter below.

If you must use an ip address (e.g. your corporate policy prevents you from using nip.io), you would also have to set isHostBased to false.

Deploying with Helm

The context of the commands below is the directory in which this readme file resides

  • Override default values by changing the values.yaml file and then typing:

    helm upgrade --install <my-che-installation> --namespace <my-che-namespace> ./

  • Or, you can override default values during installation, using the --set flag:

    helm upgrade --install <my-che-installation> --namespace <my-che-namespace> --set global.ingressDomain=<my-hostname> --set cheImage=<my-image> ./

Deployment Options

Single User

Only Che will be deployed.

helm upgrade --install <che-release-name> --namespace <che-namespace> --set global.ingressDomain=<domain> ./
  • Master: https://che-<che-namespace>.domain
  • Workspaces servers: https://server-host.domain
Multi User

Che, KeyCloak and Postgres will be deployed.

helm upgrade --install <che-release-name> --namespace <che-namespace> -f ./values/multi-user.yaml --set global.ingressDomain=<domain> ./
  • Master: https://che-<che-namespace>.domain
  • Keycloak: https://keycloak-<che-namespace>.domain
  • Workspaces servers: https://server-host.domain
Default Host

All Ingress specs are created without a host attribute (defaults to *). Path based routing to all components. Multi User configuration is enabled.

helm upgrade --install <che-release-name> --namespace <che-namespace> -f ./values/default-host.yaml --set global.ingressDomain=<domain> ./
  • Master: http://<domain>/
  • Keycloak: http://<domain>/auth/
  • Workspaces servers: http://<domain>/<path-to-server>
TLS-enabled

Cert-Manager is used to issue LetsEncrypt certificates. To avoid rate-limit issues, we use a single hostname for all ingresses. Path based routing to all components. Multi User configuration is enabled.

helm install --name <cert-manager-release-name> stable/cert-manager
helm upgrade --install <che-release-name> --namespace <che-namespace> -f ./values/tls.yaml --set global.ingressDomain=<domain> ./
  • Master: https://che-<che-namespace>.domain/
  • Keycloak: https://che-<che-namespace>.domain/auth/
  • Workspaces servers: https://che-<che-namespace>.domain/<path-to-server>

Deleting a Deployment

You can delete a deployment using the following command:

helm delete <che-release-name>