From 3ea2c4fd9c6986a0fe010414906e924e4ee71e50 Mon Sep 17 00:00:00 2001 From: Hussein Awala Date: Mon, 6 May 2024 00:52:33 +0200 Subject: [PATCH] chore(helm): Improve the chart doc and migrate to SemVer versioning (#58) --- chart/Chart.yaml | 16 ++++++++--- chart/values.yaml | 69 +++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 82 insertions(+), 3 deletions(-) diff --git a/chart/Chart.yaml b/chart/Chart.yaml index b92f466..ba3cbd5 100644 --- a/chart/Chart.yaml +++ b/chart/Chart.yaml @@ -1,6 +1,16 @@ apiVersion: v2 name: spark-on-k8s -description: A Helm chart for spark-on-k8s API and Web UI. +description: | + A Helm chart for spark-on-k8s API and Web UI. + + To deploy the spark-on-k8s API and Web UI, use the following command: + + ```bash + helm repo add spark-on-k8s https://hussein.awala.fr/spark-on-k8s-chart + helm repo update + helm install spark-on-k8s/spark-on-k8s --values + ``` + type: application -version: 0.1.0 -appVersion: "0.0.1" +version: 0.3.0 +appVersion: 0.6.0 diff --git a/chart/values.yaml b/chart/values.yaml index 07e2001..8a8bf21 100644 --- a/chart/values.yaml +++ b/chart/values.yaml @@ -1,60 +1,101 @@ +# Number of replicas for the Spark-on-K8S deployment if autoscaling is disabled replicaCount: 1 +# Docker image configuration for the Spark-on-K8S deployment image: + # The Docker image repository repository: ghcr.io/hussein-awala/spark-on-k8s + # The deployment docker image pull policy pullPolicy: IfNotPresent + # The Docker image tag tag: latest +# List of imagePullSecrets to be used imagePullSecrets: [] + +# Override the chart name in the release resources nameOverride: "" + +# Override the fullname of the release resources fullnameOverride: "" +# The service account configuration for the Spark-on-K8S deployment serviceAccount: + # Specifies whether a service account should be created create: true + # Specifies whether the service account token should be auto mounted automount: true + # Annotations to add to the service account annotations: {} + # The name of the service account to use. name: "" +# Annotations to be added to the Spark-on-K8S deployment pods podAnnotations: {} + +# Labels to be added to the Spark-on-K8S deployment pods podLabels: {} +# The pod security context for the Spark-on-K8S deployment podSecurityContext: {} +# The security context for the Spark-on-K8S deployment securityContext: {} +# The configuration for the Spark-on-K8S service service: + # The type of service to create type: ClusterIP + # The port to expose the service on port: 8000 +# The configuration for the Spark-on-K8S ingress ingress: + # Specifies whether an ingress should be created enabled: false + # The ingress class to use className: "" + # The list of ingress annotations annotations: {} + # The list of hosts to be added to the ingress hosts: - host: chart-example.local paths: - path: / pathType: ImplementationSpecific + # The list of tls to be added to the ingress tls: [] +# The resource configuration for the Spark-on-K8S deployment resources: {} +# The autoscaling configuration for the Spark-on-K8S deployment autoscaling: + # Specifies whether autoscaling should be enabled enabled: false + # The minimum number of replicas minReplicas: 1 + # The maximum number of replicas maxReplicas: 100 + # The target CPU utilization percentage targetCPUUtilizationPercentage: 80 +# The list of volumes to be added to the Spark-on-K8S deployment pods volumes: [] +# The list of volume mounts to be added to the Spark-on-K8S deployment pods volumeMounts: [] +# The node selector for the Spark-on-K8S deployment nodeSelector: {} +# The tolerations for the Spark-on-K8S deployment tolerations: [] +# The affinity for the Spark-on-K8S deployment affinity: {} +# A list of environment variables to be added to the Spark-on-K8S deployment env: [] # List of namespaces to be managed by the Spark-on-K8S service @@ -70,31 +111,59 @@ readOnly: true # Configuration for the Spark History Server sparkHistory: + # Specifies whether the Spark History Server should be enabled enabled: false + # The number of replicas for the Spark History Server if autoscaling is disabled replicaCount: 1 + # The autoscaling configuration for the Spark History Server autoscaling: + # Specifies whether autoscaling should be enabled enabled: false + # The minimum number of replicas minReplicas: 1 + # The maximum number of replicas maxReplicas: 100 + # The target CPU utilization percentage targetCPUUtilizationPercentage: 80 + # Docker image configuration for the Spark History Server image: + # The Docker image repository repository: ghcr.io/hussein-awala/spark-history + # The deployment docker image pull policy pullPolicy: IfNotPresent + # The Docker image tag tag: latest + # Annotations to be added to the Spark History Server pods env: [] + # The resource configuration for the Spark History Server resources: {} + # A list of volume mounts to be added to the Spark History Server pods volumeMounts: [] + # A list of volumes to be added to the Spark History Server pods volumes: [] + # Annotations to be added to the Spark History Server pods podAnnotations: {} + # Labels to be added to the Spark History Server pods podLabels: {} + # The pod security context for the Spark History Server podSecurityContext: {} + # The security context for the Spark History Server securityContext: {} + # The service account configuration for the Spark History Server serviceAccount: + # Specifies whether a service account should be created create: true + # Specifies whether the service account token should be auto mounted automount: true + # Annotations to add to the service account annotations: {} + # The name of the service account to use. name: "" + # The configuration for the Spark History Server service service: + # The type of service to create type: ClusterIP + # The port to expose the service on port: 18080 + # The Spark configuration for the Spark History Server configuration: ""