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

Clarify add-ons installation instructions #47

Closed
p-null opened this issue Aug 10, 2021 · 4 comments
Closed

Clarify add-ons installation instructions #47

p-null opened this issue Aug 10, 2021 · 4 comments
Assignees
Labels
doc affected PR: improvements or additions to documentation

Comments

@p-null
Copy link

p-null commented Aug 10, 2021

Summary

here, it says users can install add-ons, but it's unclear what should happen after the installation. do i need to configure anything for nebula to work with these add-ons?

Add more detailed documentation on how to configure Nebula to work with these add-ons, how these add-ons work with Nebula, what each of them is for?

@wey-gu
Copy link
Contributor

wey-gu commented Aug 10, 2021

Dear @p-null ,
Thank you! Sorry for confusing you on the add-ons doc, we for sure will polish it to avoid any confusion.

"do I need to configure anything for nebula to work with these add-ons":

Apart from the volume provider, which should be reflected in CRD: nebulaCluster::<graph_or_meta_or_storage>:: storageClaim:: storageClassName, the other ones now requires no configurations(and they are mandatory actually, we should have put this clear).

Add more detailed documentation on how to configure Nebula to work with these add-ons, how these add-ons work with Nebula, what each of them is for?

Thank you, Peterson, now maybe CRD sample is somewhat self-explanation but we will for sure do revisit and make things more clear for users to a quick start and remove the confusion on add-ons(at least which are mandatory, which are optional)

cc @MegaByte875 @veezhang @kqzh

@p-null
Copy link
Author

p-null commented Aug 10, 2021

Thanks for following up on this.

I understand examples are helpful but that just brings too much frictions by reading these examples to understand what I want.

I would suggest provide a api like readme for each of the parameters.

Regarding the specific examples you gave, I still don't have answers for following questions:
"What should I configure for Nebula to use a existing component, like cert-manager?"
"What is each of the component used for?"

I don't need the answer right here, I am just suggesting a better way to document things.

Love to see improvements on the documentation. Thanks!

@MegaByte875
Copy link
Contributor

@p-null Thanks for your suggestions. I will update docs recently.

@MegaByte875
Copy link
Contributor

https://github.com/vesoft-inc/nebula-operator/blob/v0.8.0/doc/user/add-ons.md @p-null

@MegaByte875 MegaByte875 added the doc affected PR: improvements or additions to documentation label Sep 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc affected PR: improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants