sigs.k8s.io/kueue@v0.6.2/charts/kueue/README.md (about)

     1  # Kueue's helm chart
     2  
     3  ## Table of Contents
     4  
     5  <!-- toc -->
     6  - [Installation](#installation)
     7    - [Prerequisites](#prerequisites)
     8    - [Installing the chart](#installing-the-chart)
     9      - [Install chart using Helm v3.0+](#install-chart-using-helm-v30)
    10      - [Verify that controller pods are running properly.](#verify-that-controller-pods-are-running-properly)
    11    - [Configuration](#configuration)
    12  <!-- /toc -->
    13  
    14  ### Installation
    15  
    16  Quick start instructions for the setup and configuration of kueue using Helm.
    17  
    18  #### Prerequisites
    19  
    20  - [Helm](https://helm.sh/docs/intro/quickstart/#install-helm)
    21  - (Optional) [Cert-manager](https://cert-manager.io/docs/installation/)
    22  
    23  #### Installing the chart
    24  
    25  ##### Install chart using Helm v3.0+
    26  
    27  ```bash
    28  $ git clone git@github.com:kubernetes-sigs/kueue.git
    29  $ cd kueue/charts
    30  $ helm install kueue kueue/ --create-namespace --namespace kueue-system
    31  ```
    32  
    33  ##### Verify that controller pods are running properly.
    34  
    35  ```bash
    36  $ kubectl get deploy -n kueue-system
    37  NAME                           READY   UP-TO-DATE   AVAILABLE   AGE
    38  kueue-controller-manager       1/1     1            1           7s
    39  ```
    40  
    41  ### Configuration
    42  
    43  The following table lists the configurable parameters of the kueue chart and their default values.
    44  
    45  | Parameter                                              | Description                                            | Default                                     |
    46  |--------------------------------------------------------|--------------------------------------------------------|---------------------------------------------|
    47  | `nameOverride`                                         | override the resource name                             | ``                                          |
    48  | `fullnameOverride`                                     | override the resource name                             | ``                                          |
    49  | `enablePrometheus`                                     | enable Prometheus                                      | `false`                                     |
    50  | `enableCertManager`                                    | enable CertManager                                     | `false`                                     |
    51  | `controllerManager.kubeRbacProxy.image`                | controllerManager.kubeRbacProxy's image                | `gcr.io/kubebuilder/kube-rbac-proxy:v0.8.0` |
    52  | `controllerManager.manager.image`                      | controllerManager.manager's image                      | `gcr.io/k8s-staging-kueue/kueue:main`       |
    53  | `controllerManager.manager.resources`                  | controllerManager.manager's resources                  | abbr.                                       |
    54  | `controllerManager.replicas`                           | ControllerManager's replicaCount                       | `1`                                         |
    55  | `controllerManager.imagePullSecrets`                   | ControllerManager's imagePullSecrets                   | `[]`                                        |
    56  | `controllerManager.readinessProbe.initialDelaySeconds` | ControllerManager's readinessProbe initialDelaySeconds | `5`                                         |
    57  | `controllerManager.readinessProbe.periodSeconds`       | ControllerManager's readinessProbe periodSeconds       | `10`                                        |
    58  | `controllerManager.readinessProbe.timeoutSeconds`      | ControllerManager's readinessProbe timeoutSeconds      | `1`                                         |
    59  | `controllerManager.readinessProbe.failureThreshold`    | ControllerManager's readinessProbe failureThreshold    | `3`                                         |
    60  | `controllerManager.readinessProbe.successThreshold`    | ControllerManager's readinessProbe successThreshold    | `1`                                         |
    61  | `controllerManager.livenessProbe.initialDelaySeconds`  | ControllerManager's livenessProbe initialDelaySeconds  | `15`                                        |
    62  | `controllerManager.livenessProbe.periodSeconds`        | ControllerManager's livenessProbe periodSeconds        | `20`                                        |
    63  | `controllerManager.livenessProbe.timeoutSeconds`       | ControllerManager's livenessProbe timeoutSeconds       | `1`                                         |
    64  | `controllerManager.livenessProbe.failureThreshold`     | ControllerManager's livenessProbe failureThreshold     | `3`                                         |
    65  | `controllerManager.livenessProbe.successThreshold`     | ControllerManager's livenessProbe successThreshold     | `1`                                         |
    66  | `kubernetesClusterDomain`                              | kubernetesCluster's Domain                             | `cluster.local`                             |
    67  | `managerConfig.controllerManagerConfigYaml`            | controllerManagerConfigYaml                            | abbr.                                       |
    68  | `metricsService`                                       | metricsService's ports                                 | abbr.                                       |
    69  | `webhookService`                                       | webhookService's ports                                 | abbr.                                       |