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.

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

Jump to bottom

[KRV-2878][KRV-2833]Update readme with install/uninstall operator without OLM steps #32

Closed
wants to merge 1 commit into from
Closed

[KRV-2878][KRV-2833]Update readme with install/uninstall operator without OLM steps #32

wants to merge 1 commit into from

Conversation

panigs7
Copy link
Collaborator

@panigs7 panigs7 commented Feb 15, 2022 •
edited by gallacher
Loading

Description

This PR updates the steps to install/uninstall operator and also steps to create operator.yaml manifest in Readme.

GitHub Issue #
dell/csm#159

Checklist:

  • I have performed a self-review of my own code to ensure there are no formatting, vetting, linting, or security issues
  • I have verified that new and existing unit tests pass locally with my changes
  • I have not allowed coverage numbers to degenerate
  • I have maintained at least 90% code coverage
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • I have maintained backward compatibility

rensyct
rensyct previously approved these changes Feb 15, 2022
View reviewed changes
karthikk92
karthikk92 previously approved these changes Feb 15, 2022
View reviewed changes
nb950
nb950 reviewed Feb 15, 2022
View reviewed changes
README.md Outdated
#### Generate operator.yaml manifest required for Operator installation

The installation of Operator without OLM uses an operator.yaml manifest that creates the objects for the Operator. To generate the operator.yaml manifest use the following make recipe:
1. Copy the CRDs to deploy folder by running the command `make static-crd`
Copy link
Contributor

Choose a reason for hiding this comment

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

make cmds should be internal or developer use only
customer should run kubectl create -f xxx to install operator , typicall one file that creates everything needed

Copy link
Contributor

Choose a reason for hiding this comment

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

Make recipe related documentation were made in README to address your review comment in #19. Agree that this is not of use to the customer and they should be using only the install script to install the operator

nb950
nb950 reviewed Feb 16, 2022
View reviewed changes
README.md Outdated
@@ -131,6 +133,13 @@ Run the command `make docker-build BUNDLE_IMG=<local/private/public docker regis

The above command will also push the images to the specified registry.

#### Generate operator.yaml manifest required for Operator installation
Copy link
Contributor

Choose a reason for hiding this comment

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

this topic on generate Operatoy.yaml is internal / developer only
please remove .
customer runs kubectl create -f on one or two readymade yamls --this is the only thing we document , mandatory
we also provide shell scritpts -this is a bonus / optional

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Done, removed the steps to generate operator.yaml.

@panigs7 panigs7 force-pushed the update-install-script-details-in-readme branch from b31a6fe to d8d6f22 Compare February 17, 2022 11:07
@panigs7 panigs7 force-pushed the update-install-script-details-in-readme branch from d8d6f22 to d8a08f9 Compare February 17, 2022 12:28
@panigs7
Copy link
Collaborator Author

panigs7 commented Feb 17, 2022

This will go in csm-docs repo. Hence closing the PR

@panigs7 panigs7 closed this Feb 17, 2022
@rensyct rensyct deleted the update-install-script-details-in-readme branch March 21, 2022 09:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rensyct rensyct rensyct left review comments

@nb950 nb950 nb950 left review comments

@karthikk92 karthikk92 karthikk92 left review comments

@rajendraindukuri rajendraindukuri rajendraindukuri left review comments

@abhi16394 abhi16394 Awaiting requested review from abhi16394 abhi16394 is a code owner

@alikdell alikdell Awaiting requested review from alikdell alikdell is a code owner

@bandak2 bandak2 Awaiting requested review from bandak2 bandak2 is a code owner

@bharathsreekanth bharathsreekanth Awaiting requested review from bharathsreekanth bharathsreekanth is a code owner

@gallacher gallacher Awaiting requested review from gallacher gallacher is a code owner

@JacobGros JacobGros Awaiting requested review from JacobGros JacobGros is a code owner

@jooseppi-luna jooseppi-luna Awaiting requested review from jooseppi-luna jooseppi-luna is a code owner

@mjsdell mjsdell Awaiting requested review from mjsdell mjsdell is a code owner

@medegw01 medegw01 Awaiting requested review from medegw01

@prasar6 prasar6 Awaiting requested review from prasar6

@tdawe tdawe Awaiting requested review from tdawe tdawe is a code owner

@yifeijin yifeijin Awaiting requested review from yifeijin

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@panigs7 @nb950 @rensyct @rajendraindukuri @karthikk92