doc: add quick-start guide #148
Conversation
Madhu-1
force-pushed
the
add-quick-guide
branch
from
7749fa1 to
88ea73c
Compare
|
@nb-ohad PTAL |
Madhu-1
force-pushed
the
add-quick-guide
branch
from
88ea73c to
916fbc4
Compare
|
@nb-ohad PTAL |
Madhu-1
force-pushed
the
add-quick-guide
branch
from
916fbc4 to
5b606ab
Compare
That will be a follow-up to add/update the document on how to test the local changes. |
There was a problem hiding this comment.
@Madhu-1 thanks for adding quickstart guide. Very useful!
A general suggestion:
Instead of the echo and using kubectl create -f -, wouldn't it be convenient to have example yaml files for these items (rbd driver, cephfs driver, client connection, client profile, etc)? this would probably be as follow-up PR.
There was a problem hiding this comment.
I tried the steps in the guide and they all work with one exception:
Creation of the clientProfile fails like this:
Error from server (BadRequest): error when creating "STDIN": ClientProfile in version "v1alpha1" cannot be handled as a ClientProfile: strict decoding error: unknown field "spec.cephFs.subvolumeGroup"
Madhu-1
force-pushed
the
add-quick-guide
branch
from
5b606ab to
554a5b3
Compare
Thats for catching it, it was a typo from my side, its fixed now |
|
@nb-ohad PTAL |
added a quick start guide for the minimal installation Signed-off-by: Madhu Rajanna <[email protected]>
Madhu-1
force-pushed
the
add-quick-guide
branch
from
554a5b3 to
282fc54
Compare
Describe what this PR does
added a quick start guide for the minimal installation
Is there anything that requires special attention
List items that are not part of the PR and do not impact it's
functionality, but are work items that can be taken up subsequently.
Checklist:
Commit Message Formatting: Commit titles and messages follow
guidelines in the developer
guide.
Reviewed the developer guide on Submitting a Pull
Request
Pending release
notes
updated with breaking and/or notable changes for the next major release.
Documentation has been updated, if necessary.
Unit tests have been added, if necessary.
Integration tests have been added, if necessary.