Skip to content

Latest commit

 

History

History
98 lines (72 loc) · 2.65 KB

install.md

File metadata and controls

98 lines (72 loc) · 2.65 KB
Raw

Installation

Before you begin

Make sure the following conditions are met:

  • A Kubernetes cluster with version 1.21 or newer is running. Learn how to install the Kubernetes tools.
  • The SuspendJob feature gate is enabled. In Kubernetes 1.22 or newer, the feature gate is enabled by default.
  • The kubectl command-line tool has communication with your cluster.

Install a released version

To install a released version of Kueue in your cluster, run the following command:

VERSION=v0.1.0
kubectl apply -f https://github.com/kubernetes-sigs/kueue/releases/download/$VERSION/manifests.yaml

Install a custom-configured released version

To install a custom-configured released version of Kueue in your cluster, execute the following steps:

  1. Download the release's manifests.yaml file:
VERSION=v0.1.0
wget https://github.com/kubernetes-sigs/kueue/releases/download/$VERSION/manifests.yaml
  1. With an editor of your preference, open manifests.yaml.
  2. In the kueue-manager-config ConfigMap manifest, edit the controller_manager_config.yaml data entry. The entry represents the default Kueue Configuration struct (v1alpha1@v0.1.0). The contents of the ConfigMap are similar to the following:
apiVersion: v1
kind: ConfigMap
metadata:
  name: kueue-manager-config
  namespace: kueue-system
data:
  controller_manager_config.yaml: |
    apiVersion: config.kueue.x-k8s.io/v1alpha1
    kind: Configuration
    health:
      healthProbeBindAddress: :8081
    metrics:
      bindAddress: :8080
    webhook:
      port: 9443
    manageJobsWithoutQueueName: true
  1. Apply the customized manifests to the cluster:
kubectl apply -f manifests.yaml

Install the latest development version

To install the latest development version of Kueue in your cluster, run the following command:

kubectl apply -k github.com/kubernetes-sigs/kueue/config/default?ref=main

The controller runs in the kueue-system namespace.

Uninstall

To uninstall Kueue, run the following command:

kubectl delete -k github.com/kubernetes-sigs/kueue/config/default

Build and install from source

To build Kueue from source and install Kueue in your cluster, run the following commands:

git clone https://github.com/kubernetes-sigs/kueue.git
cd kueue
IMAGE_REGISTRY=registry.example.com/my-user make image-build image-push deploy

Uninstall

To uninstall Kueue, run the following command:

make undeploy