Skip to content
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.

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

Add make install Procedure to README for Installation #2978

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

OdedViner
Copy link
Contributor

@OdedViner OdedViner commented Jan 26, 2025

#2972
This PR enhances the Installation section of the ocs-operator README by adding a new installation option using the make install command. The make install method provides a streamlined way to deploy the OCS operator in development environments or with private images.

Copy link
Contributor

openshift-ci bot commented Jan 26, 2025

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: OdedViner
Once this PR has been reviewed and has the lgtm label, please assign jarrpa for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@OdedViner OdedViner force-pushed the improve_readme branch 2 times, most recently from 3cb0a3c to ad4ad26 Compare January 26, 2025 11:32
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated
- [Debugging Functional Test Failures](#debugging-functional-test-failures)
- [Functional test stdout log](#functional-test-stdout-log)
- [PROW artifacts](#prow-artifacts)
- [Table of Contents](#table-of-contents)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Table of contents is duplicated as it is already a header above.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please just add to the Installation section without changing anything else in the contents section, so the git diff remains clean.

README.md Outdated
#### Option 1: Using `make install`
If you have a development environment or private image and want to install the OCS operator, follow the steps below:

1.Label Worker Nodes:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of numbered steps please use bullted steps which can help in inserting new steps in future without ordering change.

Signed-off-by: Oded Viner <[email protected]>
Signed-off-by: Oded Viner <[email protected]>
Signed-off-by: Oded Viner <[email protected]>
Copy link
Contributor

openshift-ci bot commented Feb 12, 2025

@OdedViner: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
ci/prow/ocs-operator-bundle-e2e-aws 87acea3 link true /test ocs-operator-bundle-e2e-aws

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants