-
Notifications
You must be signed in to change notification settings - Fork 42
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
docs: add usage guide for lvmo [skip ci] #100
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You might consider breaking this up into multiple docs and have a main doc that links to the others, just a suggestion for a future PR.
sh-4.4# lvs | ||
``` | ||
|
||
Here LVMO is installed in `lvm-operator-system` namespace via `make deploy` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Instead of make
commands, upstream users generally appreciate either kubectl
or helm
commands for install. The make
is just a black box to them. make
works well during development, just not for production.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- ack, this'll be a change in repo readme, you might want to have a look at docs: update readme and documents layout [skip ci] #99 as well 🤔
- the change more or less translates to push an image to the registry on every release and update yaml manifest for the same like
IMG=<pushed-image> make deploy > examples/lvmo.yaml
, at bestkubectl -f
,helm
is a stretch atm - will take a note of it and update the instructions when we push image to upstream accessible registry
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Will be taken up in a separate PR
# Contents
The user-guide describes alternate installation methods and usage.
1. [Deploy Operator via OLM][alt-deploy]
2. [Alternate Usage][alt-install]
[alt-deploy]: ./alt-deploy.md
[alt-install]: ./alt-install.md |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Minor comments.
Signed-off-by: Leela Venkaiah G <[email protected]>
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: leelavg, nbalacha, travisn The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Signed-off-by: Leela Venkaiah G [email protected]