add autopilot

minor typo fixes

Signed-off-by: Claudia <[email protected]>

last typo

Signed-off-by: Claudia <[email protected]>

Author: Claudia

setup.RHOAI-v2.13/CLUSTER-SETUP.md

@@ -88,6 +88,31 @@ kueue-controller-manager's log:
 
 ```
 
+## Autopilot
+
+Helm charts values and how-to for customization can be found [here](helm-charts/autopilot/README.md). As-is, Autopilot will run on GPU nodes.
+
+- Add the Autopilot Helm repository
+
+```bash
+helm repo add autopilot https://ibm.github.io/autopilot/
+```
+
+- Install the chart (idempotent command). The config file is for customizing the helm values and it is optional.
+
+```bash
+helm upgrade autopilot autopilot/autopilot --install --namespace=autopilot --create-namespace -f your-config.yml
+```
+
+### Enabling Prometheus metrics
+
+After completing the installation, manually label the namespace to enable metrics to be scraped by Prometheus with the following command:
+The `ServiceMonitor` labeling is not required.
+
+```bash
+oc label ns autopilot openshift.io/cluster-monitoring=true
+```
+
 ## Kueue Configuration
 
 Create Kueue's default flavor:

setup.RHOAI-v2.16/CLUSTER-SETUP.md

@@ -76,6 +76,31 @@ AI configuration as follows:
 
 
 
+## Autopilot
+
+Helm charts values and how-to for customization can be found [here](helm-charts/autopilot/README.md). As-is, Autopilot will run on GPU nodes.
+
+- Add the Autopilot Helm repository
+
+```bash
+helm repo add autopilot https://ibm.github.io/autopilot/
+```
+
+- Install the chart (idempotent command). The config file is for customizing the helm values and it is optional.
+
+```bash
+helm upgrade autopilot autopilot/autopilot --install --namespace=autopilot --create-namespace -f your-config.yml
+```
+
+### Enabling Prometheus metrics
+
+After completing the installation, manually label the namespace to enable metrics to be scraped by Prometheus with the following command:
+The `ServiceMonitor` labeling is not required.
+
+```bash
+oc label ns autopilot openshift.io/cluster-monitoring=true
+```
+
 ## Kueue Configuration
 
 Create Kueue's default flavor:

setup.RHOAI-v2.17/CLUSTER-SETUP.md

@@ -76,6 +76,31 @@ AI configuration as follows:
 
 
 
+## Autopilot
+
+Helm charts values and how-to for customization can be found [here](helm-charts/autopilot/README.md). As-is, Autopilot will run on GPU nodes.
+
+- Add the Autopilot Helm repository
+
+```bash
+helm repo add autopilot https://ibm.github.io/autopilot/
+```
+
+- Install the chart (idempotent command). The config file is for customizing the helm values and it is optional.
+
+```bash
+helm upgrade autopilot autopilot/autopilot --install --namespace=autopilot --create-namespace -f your-config.yml
+```
+
+### Enabling Prometheus metrics
+
+After completing the installation, manually label the namespace to enable metrics to be scraped by Prometheus with the following command:
+The `ServiceMonitor` labeling is not required.
+
+```bash
+oc label ns autopilot openshift.io/cluster-monitoring=true
+```
+
 ## Kueue Configuration
 
 Create Kueue's default flavor:

setup.k8s/CLUSTER-SETUP.md

@@ -7,6 +7,7 @@ The cluster setup installs and configures the following components:
 + Kueue
 + AppWrappers
 + Cluster roles and priority classes
++ Autopilot
 
 ## Priorities
 
@@ -73,6 +74,33 @@ operators as follows:
   - `queueName` is set to `default-queue`,
 - pod priorities, resource requests and limits have been adjusted.
 
+## Autopilot
+
+Helm charts values and how-to for customization can be found [here](helm-charts/autopilot/README.md). As-is, Autopilot will run on GPU nodes.
+
+- Add the Autopilot Helm repository
+
+```bash
+helm repo add autopilot https://ibm.github.io/autopilot/
+```
+
+- Install the chart (idempotent command). The config file is for customizing the helm values and it is optional.
+
+```bash
+helm upgrade autopilot autopilot/autopilot --install --namespace=autopilot --create-namespace -f your-config.yml
+```
+
+### Enabling Prometheus metrics
+
+The `ServiceMonitor` object is the one that enables Prometheus to scrape the metrics produced by Autopilot.
+In order for Prometheus to find the right objects, the `ServiceMonitor` needs to be annotated with the Prometheus' release name. It is usually `prometheus`, and that's the default added in the Autopilot release.
+If that is not the case in your cluster, the correct release label can be found by checking in the `ServiceMonitor` of Prometheus itself, or the name of Prometheus helm chart.
+Then, Autopilot's `ServiceMonitor` can be labeled with the following command
+
+```bash
+kubectl label servicemonitors.monitoring.coreos.com -n autopilot autopilot-metrics-monitor release=<prometheus-release-name>
+```
+
 ## Kueue Configuration
 
 Create Kueue's default flavor:

setup.tmpl/CLUSTER-SETUP.md.tmpl

@@ -12,6 +12,7 @@ The cluster setup installs and configures the following components:
 + Kueue
 + AppWrappers
 + Cluster roles and priority classes
++ Autopilot
 
 {{- end }}
 
@@ -154,6 +155,42 @@ operators as follows:
 
 {{- end }}
 
+## Autopilot
+
+Helm charts values and how-to for customization can be found [here](helm-charts/autopilot/README.md). As-is, Autopilot will run on GPU nodes.
+
+- Add the Autopilot Helm repository
+
+```bash
+helm repo add autopilot https://ibm.github.io/autopilot/
+```
+
+- Install the chart (idempotent command). The config file is for customizing the helm values and it is optional.
+
+```bash
+helm upgrade autopilot autopilot/autopilot --install --namespace=autopilot --create-namespace -f your-config.yml
+```
+
+### Enabling Prometheus metrics
+
+{{ if .OPENSHIFT -}}
+After completing the installation, manually label the namespace to enable metrics to be scraped by Prometheus with the following command:
+The `ServiceMonitor` labeling is not required.
+
+```bash
+{{ .KUBECTL }} label ns autopilot openshift.io/cluster-monitoring=true
+```
+{{- else -}}
+The `ServiceMonitor` object is the one that enables Prometheus to scrape the metrics produced by Autopilot.
+In order for Prometheus to find the right objects, the `ServiceMonitor` needs to be annotated with the Prometheus' release name. It is usually `prometheus`, and that's the default added in the Autopilot release.
+If that is not the case in your cluster, the correct release label can be found by checking in the `ServiceMonitor` of Prometheus itself, or the name of Prometheus helm chart.
+Then, Autopilot's `ServiceMonitor` can be labeled with the following command
+
+```bash
+{{ .KUBECTL }} label servicemonitors.monitoring.coreos.com -n autopilot autopilot-metrics-monitor release=<prometheus-release-name>
+```
+{{- end }}
+
 ## Kueue Configuration
 
 Create Kueue's default flavor: