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

Write Provided ServiceAccount Documentation #977

Open
5 of 6 tasks
Tracked by #737
everettraven opened this issue Jun 25, 2024 · 0 comments
Open
5 of 6 tasks
Tracked by #737

Write Provided ServiceAccount Documentation #977

everettraven opened this issue Jun 25, 2024 · 0 comments
Labels
epic/provided-sa kind/documentation Categorizes issue or PR as related to documentation.

Comments

@everettraven
Copy link
Contributor

everettraven commented Jun 25, 2024

User story

Describe the user story or stories for this epic:

  • As a user, I expect to be able to define a ServiceAccount that OLM v1 uses to manage content
  • As a user, I expect the ClusterExtension installation to fail if the provided ServiceAccount has insufficient permissions
  • As a user, I expect the ClusterExtension to be rejected if a ServiceAccount is not provided
  • As a user, I expect to be able to identify the permissions required to install a bundle so that I can create a ServiceAccount with all the permissions necessary to install an extension

List the user-facing issues in the epic that require documentation.

Does this epic require new content or updates to existing content?

  • Net-new content
  • Update existing content

Note

Preemptively setting that this will need both. I'm not 100% sure, but I think it is likely that both existing content will need to be updated and that new content will need to be written

What type of documentation is required for this epic?

  • Release note
  • Concept
  • Procedure
  • Reference

Is there prior art or reference materials that would help write the documentation?

  • Once the feature is complete and in place, there will likely be some unit and e2e tests that could be used as reference
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
epic/provided-sa kind/documentation Categorizes issue or PR as related to documentation.
Projects
Status: No status
Development

No branches or pull requests

1 participant