docs: Add "How to setup storage using Rook Ceph?" #494

surajssd · 2020-05-28T09:40:47Z

This document enlists steps that will help user setup storage using Rook Ceph component

docs/how-to-guides/access-ceph-dashboard.md

johananl

Thanks for the PR.

I'm wondering whether "Accessing the Ceph dashboard" makes sense as a how-to topic. I agree it shouldn't sit in a config reference guide, however it seems a rather narrow topic for a how-to guide.

Ideally I would have liked to see a how-to guide such as "Using Rook/Ceph for persistent storage" or something similar. I realize this is out of scope for this PR, however I'm wondering whether you could create the structure for such a document with TODO placeholders for "unimplemented" sections, then fill in just the "Accessing the Ceph dashboard" section. Does that make sense?

Nits:

There are capitalization problems throughout the PR. Could you please fix them?
There are missing articles in multiple places. Could you please fix these, too?

surajssd · 2020-06-03T14:42:25Z

I'm wondering whether "Accessing the Ceph dashboard" makes sense as a how-to topic. I agree it shouldn't sit in a config reference guide, however it seems a rather narrow topic for a how-to guide.

Ideally I would have liked to see a how-to guide such as "Using Rook/Ceph for persistent storage" or something similar. I realize this is out of scope for this PR, however I'm wondering whether you could create the structure for such a document with TODO placeholders for "unimplemented" sections, then fill in just the "Accessing the Ceph dashboard" section. Does that make sense?

I can't say right now looking forward if this is right way to go. Our "How to guides" are modeled on the Kubernetes Tasks/Tutorials for e.g. take a look at this https://kubernetes.io/docs/tasks/run-application/run-stateless-application-deployment/

This is only concerned about running application and does not go into the depths and all the features that Deployment has or all the things you can do with a Deployment.

All I can say is that lets us have some how to guide before we start grouping them. And this can happen only later i.e. looking backwards.

johananl · 2020-06-05T12:02:34Z

I can't say right now looking forward if this is right way to go. Our "How to guides" are modeled on the Kubernetes Tasks/Tutorials for e.g. take a look at this https://kubernetes.io/docs/tasks/run-application/run-stateless-application-deployment/

I wasn't aware we are using the k8s docs as a "template". Is this the case?
Anyway, "how to deploy a stateless application" is IMO a fine topic for a self-contained guide, however "how to open the Ceph UI" is arguably too small and possibly not useful on its own, namely without a guide which tells me how to deploy Ceph.

Anyway, this is my view on this. I will let other people chime in.

iaguis · 2020-06-05T15:37:30Z

I agree with @johananl, I think a good topic is "How to deploy Rook/Ceph for persistent storage" or similar, with a section on how to access the dashboard.

Also, I think a "Next steps" section doesn't belong to a configuration reference.

I'd do what's suggested in #494 (review)

surajssd · 2020-06-09T12:19:19Z

How to deploy Rook Ceph is already taken care of in following doc?

https://github.com/kinvolk/lokomotive/blob/master/docs/configuration-reference/components/rook-ceph.md#applying

What is the point of repeating it again? I could just point to it, saying if you want to deploy take a look at the above link.

I agree it is small. Just because the markdown file fits in one page without scroll, it does not mean we should cram in more information. The doc serves its purpose.

PS: Also this issue #585 could be a part of this PR, because it is a gotcha and needs a mention.

invidian · 2020-06-09T12:24:43Z

https://github.com/kinvolk/lokomotive/blob/master/docs/configuration-reference/components/rook-ceph.md#applying

IMO reference docs should only have knobs explained and nothing else. All components are being installed in the same way. I suggest we remove this section from this doc and create How to deploy Rook/Ceph for persistent storage guide.

surajssd · 2020-06-23T08:07:26Z

TODOs:

Add "How to install rook and rook-ceph"?
Add contents from this PR.
Add instructions on usage of rook toolbox.

surajssd · 2020-08-03T09:48:45Z

This is up for review cc: @johananl @iaguis @invidian

invidian · 2020-08-03T10:14:26Z

I'll have a look.

invidian

Nice guide @surajssd. Clearly written. I added some comments/nits I'd fix, but otherwise looks very good to me 👍

docs/how-to-guides/rook-ceph-storage.md

invidian

Except pending comments, LGTM. Thank for addressing the feedback quickly @surajssd.

ipochi

Thanks for the patience and updates on this PR.

Largely looks good to me.

Couple of issues w.r.t usage of variable as opposed to attribute and the contents structure differs from other guides.

docs/how-to-guides/rook-ceph-storage.md

This document enlists steps that will help user setup storage using Rook Ceph component. Signed-off-by: Suraj Deshmukh <suraj@kinvolk.io>

ipochi

Thanks for addressing the feedback 🎉

LGTM

invidian

LGTM

surajssd · 2020-08-04T10:32:09Z

Thanks for the reviews folks 👍 🎉

surajssd requested a review from johananl as a code owner May 28, 2020 09:40

surajssd requested review from iaguis, invidian and ipochi May 28, 2020 09:41

ipochi suggested changes Jun 2, 2020

View reviewed changes

surajssd force-pushed the surajssd/how-to-access-ceph-dashboard branch from 6d8d807 to e403681 Compare June 3, 2020 11:39

surajssd requested a review from ipochi June 3, 2020 11:41

johananl reviewed Jun 3, 2020

View reviewed changes

johananl mentioned this pull request Jun 3, 2020

docs: How to setup monitoring stack? #480

Merged

surajssd force-pushed the surajssd/how-to-access-ceph-dashboard branch 6 times, most recently from a613d06 to 6d0816c Compare June 5, 2020 11:28

surajssd mentioned this pull request Jun 23, 2020

rook-ceph: Add toolbox configs #649

Merged

invidian removed their request for review June 23, 2020 08:09

surajssd force-pushed the surajssd/how-to-access-ceph-dashboard branch 7 times, most recently from 2bc42e8 to 4fda817 Compare June 25, 2020 15:00

surajssd changed the title ~~docs: Add "How to access Ceph dashboard?"~~ docs: Add "How to setup storage using Rook Ceph?" Jun 25, 2020

surajssd force-pushed the surajssd/how-to-access-ceph-dashboard branch 7 times, most recently from c742420 to e2fd123 Compare June 26, 2020 09:28

surajssd requested a review from johananl June 26, 2020 09:29

invidian suggested changes Aug 3, 2020

View reviewed changes

surajssd force-pushed the surajssd/how-to-access-ceph-dashboard branch from e2fd123 to 3c23974 Compare August 3, 2020 10:52

invidian mentioned this pull request Aug 3, 2020

Consider consolidating labels, taints and tolerations format between components and worker pools #758

Open

invidian reviewed Aug 3, 2020

View reviewed changes

surajssd force-pushed the surajssd/how-to-access-ceph-dashboard branch from 3c23974 to a9fe873 Compare August 4, 2020 07:11

surajssd requested a review from invidian August 4, 2020 07:11

invidian previously approved these changes Aug 4, 2020

View reviewed changes

ipochi suggested changes Aug 4, 2020

View reviewed changes

surajssd dismissed invidian’s stale review via d9a2498 August 4, 2020 08:51

surajssd force-pushed the surajssd/how-to-access-ceph-dashboard branch 2 times, most recently from d9a2498 to 7e854f2 Compare August 4, 2020 08:54

docs: Add "How to setup storage using Rook Ceph?"

4082311

This document enlists steps that will help user setup storage using Rook Ceph component. Signed-off-by: Suraj Deshmukh <suraj@kinvolk.io>

surajssd force-pushed the surajssd/how-to-access-ceph-dashboard branch from 7e854f2 to 4082311 Compare August 4, 2020 09:52

ipochi approved these changes Aug 4, 2020

View reviewed changes

invidian approved these changes Aug 4, 2020

View reviewed changes

surajssd merged commit a8798ae into master Aug 4, 2020

surajssd deleted the surajssd/how-to-access-ceph-dashboard branch August 4, 2020 10:32

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Add "How to setup storage using Rook Ceph?" #494

docs: Add "How to setup storage using Rook Ceph?" #494

surajssd commented May 28, 2020 •

edited

Loading

johananl left a comment •

edited

Loading

surajssd commented Jun 3, 2020

johananl commented Jun 5, 2020 •

edited

Loading

iaguis commented Jun 5, 2020

surajssd commented Jun 9, 2020

invidian commented Jun 9, 2020

surajssd commented Jun 23, 2020 •

edited

Loading

surajssd commented Aug 3, 2020

invidian commented Aug 3, 2020

invidian left a comment

invidian left a comment

ipochi left a comment

ipochi left a comment

invidian left a comment

surajssd commented Aug 4, 2020

docs: Add "How to setup storage using Rook Ceph?" #494

docs: Add "How to setup storage using Rook Ceph?" #494

Conversation

surajssd commented May 28, 2020 • edited Loading

johananl left a comment • edited Loading

Choose a reason for hiding this comment

surajssd commented Jun 3, 2020

johananl commented Jun 5, 2020 • edited Loading

iaguis commented Jun 5, 2020

surajssd commented Jun 9, 2020

invidian commented Jun 9, 2020

surajssd commented Jun 23, 2020 • edited Loading

surajssd commented Aug 3, 2020

invidian commented Aug 3, 2020

invidian left a comment

Choose a reason for hiding this comment

invidian left a comment

Choose a reason for hiding this comment

ipochi left a comment

Choose a reason for hiding this comment

ipochi left a comment

Choose a reason for hiding this comment

invidian left a comment

Choose a reason for hiding this comment

surajssd commented Aug 4, 2020

surajssd commented May 28, 2020 •

edited

Loading

johananl left a comment •

edited

Loading

johananl commented Jun 5, 2020 •

edited

Loading

surajssd commented Jun 23, 2020 •

edited

Loading