Skip to content

docs: add installation instructions to README (#96) #704

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
iacker wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add installation instructions to README (#96) #704

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,38 @@ CodeFlare Stack Compatibility Matrix
| Kueue | [v0.11.6](https://github.com/kubernetes-sigs/kueue/releases/tag/v0.11.6) |
<!-- Compatibility Matrix end -->

## Installation

The CodeFlare Operator can be installed on its own, without the wider Open Data Hub stack.
It expects [KubeRay](https://github.com/ray-project/kuberay) and
[Kueue](https://github.com/kubernetes-sigs/kueue) to be installed and configured in the
cluster first (see the compatibility matrix above for the versions validated with each
release).

### OpenShift

Install the operator from OperatorHub. In the OpenShift console, go to
**Operators → OperatorHub**, search for **CodeFlare Operator**, and follow the guided
installation. This creates a `Subscription` that keeps the operator up to date via OLM.

### Kubernetes

Deploy the operator with the release manifests using `kustomize` (bundled via the
Makefile). From a checkout of the tag you want to install:

```sh
# Deploy the controller using the default overlay (config/default)
make deploy IMG=quay.io/project-codeflare/codeflare-operator:stable
```

Pin `IMG` to a specific released tag (for example
`quay.io/project-codeflare/codeflare-operator:v1.16.0`) instead of `stable` to install a
fixed version. To remove the operator again:

```sh
make undeploy
```

## Development

Requirements:
Expand Down