Skip to content

Commit

Permalink
update: docs
Browse files Browse the repository at this point in the history
  • Loading branch information
codekow committed Jul 26, 2024
1 parent 7928492 commit 523f63d
Show file tree
Hide file tree
Showing 10 changed files with 19 additions and 15 deletions.
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# components-distributed-compute

## Purpose

This component is designed help configure the the authentication endpoint for RHOAI with KServe using Authorino with ServiceMesh

The Authorino auth is available in RHOAI 2.9 and later.
Expand All @@ -9,7 +10,7 @@ The Authorino auth is available in RHOAI 2.9 and later.

This component can be added to a base by adding the `components` section to your overlay `kustomization.yaml` file:

```
```yaml
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# components-distributed-compute

## Purpose

This component is designed help configure the distributed compute specific components including the following items:

CodeFlare
Expand All @@ -12,7 +13,7 @@ The Distributed Compute Components are Generally Available as of RHOAI 2.9.

This component can be added to a base by adding the `components` section to your overlay `kustomization.yaml` file:

```
```yaml
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# components-training

## Purpose

This component is designed help configure the training specific components including the following items:

DataSciencePipelines
Expand All @@ -10,7 +11,7 @@ Workbenches

This component can be added to a base by adding the `components` section to your overlay `kustomization.yaml` file:

```
```yaml
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization

Expand Down
Original file line number Diff line number Diff line change
@@ -1,17 +1,16 @@
# default-notebook-pvc-size

## Purpose
This component is designed help admins configure the default PVC size that users are presented with when creating new Workbenches.

This component is designed help admins configure the default PVC size that users are presented with when creating new Workbenches.

For more information see the official docs for [Configuring Default PVC size](https://access.redhat.com/documentation/en-us/red_hat_openshift_ai_self-managed/2-latest/html/managing_resources/managing-cluster-resources_cluster-mgmt#configuring-the-default-pvc-size-for-your-cluster_cluster-mgmt)


## Usage

This component can be added to a base by adding the `components` section to your overlay `kustomization.yaml` file:

```
```yaml
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,13 @@ For more information, see [this](https://github.com/opendatahub-io/odh-dashboard

This component can be added to a base by adding the `components` section to your overlay `kustomization.yaml` file:

```
```yaml
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization

resources:
- ../../base

components:
- ../../components/idle-notebook-culling
- ../../components/fix-kubeadmin-cluster-admin
```

You can customize the time notebooks can remain running while inactive by updating the [culler-config.yaml](./culler-config.yaml) file.
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# idle-notebook-culling

## Purpose

This component is designed help admins configure the default PVC size that users are presented with when creating new Workbenches.

For more information see the official docs for [Stopping Idle Notebooks](https://access.redhat.com/documentation/en-us/red_hat_openshift_ai_self-managed/2-latest/html/managing_resources/managing-notebook-servers_notebook-mgmt#stopping-idle-notebooks_notebook-mgmt)
Expand All @@ -9,7 +10,7 @@ For more information see the official docs for [Stopping Idle Notebooks](https:/

This component can be added to a base by adding the `components` section to your overlay `kustomization.yaml` file:

```
```yaml
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# nvidia-gpu-accelerator-profile

## Purpose

This component is designed help admins configure an accelerator profile with NVIDIA GPUs.

For more information on accelerators, please see the [Working with accelerators](https://access.redhat.com/documentation/en-us/red_hat_openshift_ai_self-managed/2-latest/html/working_on_data_science_projects/working-with-accelerators_accelerators) documentation.
Expand All @@ -9,7 +10,7 @@ For more information on accelerators, please see the [Working with accelerators]

This component can be added to a base by adding the `components` section to your overlay `kustomization.yaml` file:

```
```yaml
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization

Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
# rhoai-dashboard-access

## Purpose

This component is designed help admins configure the default access to the RHOAI Dashboard.

## Usage

This component can be added to a base by adding the `components` section to your overlay `kustomization.yaml` file:

```
```yaml
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# runtime-template-triton

## Purpose

This component is designed configure the Triton Serving Runtime Template.

For more information on the Triton Serving Runtime, refer to the [Custom Runtime Triton](https://ai-on-openshift.io/odh-rhoai/custom-runtime-triton/) documentation.
Expand All @@ -9,7 +10,7 @@ For more information on the Triton Serving Runtime, refer to the [Custom Runtime

This component can be added to a base by adding the `components` section to your overlay `kustomization.yaml` file:

```
```yaml
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This component is designed prevent OpenShift AI before the ServiceMesh resources

This component can be added to a base by adding the `components` section to your overlay `kustomization.yaml` file:

```sh
```yaml
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization

Expand Down

0 comments on commit 523f63d

Please sign in to comment.