Skip to content

Latest commit

 

History

History
101 lines (69 loc) · 6.7 KB

README.md

File metadata and controls

101 lines (69 loc) · 6.7 KB

Helm configuration

Main configuration to setup your k8s cluster and the services that this project uses. The helm configuration contains 5 charts: jupyter, kuberay-operator, ray-cluster, redis, and keycloak.

Installation

helm repo add bitnami https://charts.bitnami.com/bitnami
helm repo add kuberay https://ray-project.github.io/kuberay-helm
helm repo add prometheus-community https://prometheus-community.github.io/helm-charts
helm repo add grafana https://grafana.github.io/helm-charts
helm dependency build

Update values.yaml file. Find and replace the following strings

  • GATEWAY-CHANGEME: string used as the secret for a OIDC protocol
  • GRAFANASECRET-CHANGEME: string used as the secret for a OIDC protocol for Grafana

Install from the default values file

helm -n quantum-serverless install quantum-serverless --create-namespace .

Install from specific values file

 helm -n quantum-serverless install quantum-serverless -f <PATH_TO_VALUES_FILE> --create-namespace .

Helm chart versions

The Quantum Serverless Chart has several internal and external dependencies. If you are interested to know what versions the project is using you can check them in the Chart.lock file.

Helm chart values

Redis & Nginx Ingress controller

For our Redis and Nginx Ingress controller dependencies we are using the configuration created by Bitnami. To simplify the configuration we offered you with a straigh-forward initial parameters setup. But if you are interested in more complex configurations you have access to all the parameters that Bitnami added in the chart specified in their READMEs:

For our keycloak dependencies we are using the configuration created by Bitnami. To simplify the configuration we offered you with a straigh-forward initial parameters setup. But if you are interested in more complex configurations you have access to all the parameters that Bitnami added in the chart specified in their READMEs:

Jupyter notebook

Name Description
jupyterEnable Specify if helm will execute the jupyter configuration.
jupyter.jupyterToken Password for jupyter notebook.
jupyter.image Docker image configuration to deploy the notebook.
jupyter.imagePullSecrets Secrets to pull the image from a private registry.
jupyter.container.port Port number that the pod will use in the cluster.
jupyter.service.port Port number that service will be exposed externally.
jupyter.ingress.enabled Specifies if you are going to use ingress to expose the service.

Ray cluster, Kuberay operator, and Kuberay api server

For our Ray Charts dependencies we are using the configuration created by the Ray Project. To simplify the configuration we offered you with a straigh-forward initial parameters setup. But if you are interested in more complex configurations you have access to their Helm project in GitHub to analyze the different variables:

  • For Kuberay Operator you can read their values.yaml.

  • For Ray Cluster they provide you with a commented initial setup in their values.yaml.

  • For Ray Api Server you can read their values.yaml.

TLS is enabled for the gRPC communication among Ray components. It uses a self-signed certificate by derault. It can optionally use certificates signed by the cert manager in the environment that has the cert manager installed. The option is gateway.useCertManager: ture

Keycloak

  • The initial user ID and password for both keycload console(adminUser/adminPassword) and Ray dashboard(keycloakUserID/keycloakPassword) can be changed in the values.yaml file. It is good to change them before apply the helm.
  • Keycloak console can be accessed at http://LOCAL-IP:31059/. Its initial user ID and password are "admin" and "passw0rd".
  • Ray dashboard can be accessed at http://localhost/. Its initial user ID and password are "user" and "passw0rd".

Optional components (monitoring and logging)

Prometheus

For our Prometheus dependency we are using the charts managed by the Prometheus community. To simplify the configuration we offered you with a straigh-forward initial parameters setup. But if you are interested in more complex configurations you have access to all the parameters in the chart's values.yaml.

loki

  • For our loki charts dependencies, we are using the single binary configuration created by Grafana project. To simplify the configuration we offered you with a straigh-forward initial parameters setup. But if you are interested in more complex configurations, you have access to all the parameters documented here and source code of the helm charts are here.

Grafana

  • For our Grafana charts dependencies, we are configuring authentication by Keycloak and providing some predefined dashboards. If you are interested in more complex configurations, you have access to all the parameters documented here.
  • The initial user ID and password for Grafana console(keycloakAdminID/keycloakAdminPassword) can be changed in the values.yaml file. It is good to change them before apply the helm.
  • Grafana console can be accessed at http://LOCAL-IP:32294/. Its initial user ID and password are "admin" and "passw0rd".

promtail

  • For our promtail charts dependencies, we are using the default configuration created by Grafana project. To simplify the configuration we offered you with a straigh-forward initial parameters setup. But if you are interested in more complex configurations, you have access to all the parameters documented here.