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

Documentation: request flow #60

Open
JohnStrunk opened this issue Sep 24, 2018 · 0 comments
Open

Documentation: request flow #60

JohnStrunk opened this issue Sep 24, 2018 · 0 comments
Labels

Comments

@JohnStrunk
Copy link
Member

Describe the feature you'd like to have.
The repo should have a document describing:

  • the request flow for all CSI calls
  • how API endpoints are located for volume ops and mounting

What is the value to the end user? (why is it a priority?)
This is primarily for the benefit of new developers or those not familiar with the code. It will allow them to understand the motivation for the various Services used and how they permit the gluster servers to be located. This will be helpful for extending the existing driver, adding new drivers, and for troubleshooting.

How will we know we have a good solution? (acceptance criteria)

  • Each CSI call should be enumerated with the other entities that are contacted and the general request flow for servicing that type of request.
  • All Services, Deployments, and other kube objects that are recommended when deploying the CSI driver should be described with their purpose.
@JohnStrunk JohnStrunk added this to the GCS-1.0 milestone Sep 24, 2018
@JohnStrunk JohnStrunk removed this from the GCS-1.0 milestone Oct 3, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant