docs: add installation instructions to README (#96) - #704
Open
iacker wants to merge 1 commit into
Open
Conversation
The README covered development, testing and release flows but never documented how to install the operator on its own (without the wider Open Data Hub stack), which is the question raised in project-codeflare#96. Add an Installation section with: - the KubeRay + Kueue prerequisite, - OpenShift install via OperatorHub (OLM Subscription), - Kubernetes install via 'make deploy IMG=...' with the config/default kustomize overlay, plus 'make undeploy'. Fixes project-codeflare#96 Signed-off-by: iacker <iacker@users.noreply.github.com>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
The README documents development, testing and release workflows, but it never explains how to actually install the operator — the gap tracked in #96 ("can we use codeflare operator without ODH? Answer is yes. We may want to write down the instruction").
This adds an Installation section (between the compatibility matrix and Development) covering the paths raised in the issue:
Subscription).make deploy IMG=quay.io/project-codeflare/codeflare-operator:stableusing the existingconfig/defaultkustomize overlay, withmake undeployto remove it.Docs-only change.
Fixes #96
How Has This Been Tested?
Instructions cross-checked against the repo, not invented:
make deploybuildsconfig/${ENV}(ENV ?= default) and honoursIMG—Makefiledeploy/undeploy targets.config/default/kustomization.yamlexists.quay.io/project-codeflare/codeflare-operatorpublishes thestabletag (and per-release tags likev1.16.0).AI disclosure: drafted with AI assistance and verified against the Makefile, kustomize overlays and the published image tags by the author.