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

Closed
5 of 6 tasks
Tracked by #737
everettraven opened this issue Jun 25, 2024 · 3 comments · Fixed by #1232
Closed
5 of 6 tasks
Tracked by #737

Write Provided ServiceAccount Documentation #977

everettraven opened this issue Jun 25, 2024 · 3 comments · Fixed by #1232
Assignees
Labels
documentation Improvements or additions to documentation epic/provided-sa kind/documentation Categorizes issue or PR as related to documentation. v1.0 Issues related to the initial stable release of OLMv1
Milestone

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

Documentation should be contributed to the docs/drafts/ directory

@everettraven everettraven added the kind/documentation Categorizes issue or PR as related to documentation. label Jun 25, 2024
@everettraven everettraven added this to the v1.0.0 milestone Aug 20, 2024
@everettraven everettraven added the v1.0 Issues related to the initial stable release of OLMv1 label Aug 27, 2024
@perdasilva perdasilva added the documentation Improvements or additions to documentation label Sep 3, 2024
@trgeiger
Copy link
Contributor

trgeiger commented Sep 4, 2024

/assign

@trgeiger
Copy link
Contributor

trgeiger commented Sep 6, 2024

I think this might effectively be a duplicate of #1130 ? The bulk of the information that would be in the docs for this ticket 977 would be the derivation of required permissions so I'm not sure if it's necessary to separate these 2 issues?

@LalatenduMohanty
Copy link
Member

PR under #1232

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation epic/provided-sa kind/documentation Categorizes issue or PR as related to documentation. v1.0 Issues related to the initial stable release of OLMv1
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

4 participants