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

Docs improvements #3714

Closed
11 of 12 tasks
matthchr opened this issue Jan 17, 2024 · 3 comments
Closed
11 of 12 tasks

Docs improvements #3714

matthchr opened this issue Jan 17, 2024 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@matthchr
Copy link
Member

matthchr commented Jan 17, 2024

  • Add to diagnosing issues, section about diagnosing issues with free tier API server. "Error from server (InternalError): error when creating "/tmp/asd": Internal error occurred: failed calling webhook "
  • Add documentation about how to compose on top of ASO (Common architectures?)
  • Details about how "owner" works + examples. When should you use Kubernetes ownership, versus raw ARM IDs?
  • Adoption, how does it work?
  • Security best practices - warning about RoleAssignment
  • Security best practices - discussion of how to structure namespace/secret management. Recommendation to avoid global secret.
  • Security best practices - How to safely scope a namespace to manage only a single RG.
  • Experimental release best practices
  • How to run your local copy of ASO in your AKS cluster (This is sorta a developers guide thing rather than an end user thing)
  • How to add a handcrafted resource (i.e. how to deal with POST)
  • https://azure.github.io/azure-service-operator/guide/installing-from-yaml/ doesn't mention crdPattern
  • Discuss "what we are not" - at least with respect to templating. We are not trying to generically solve templating - use Kustomize or Helm or insert your favorite Kuberentes templating engine here. Helping to answer the issue here: Add support for reading name or armId in all KnownResourceReference fields from Secrets and ConfigMaps #3827
@matthchr
Copy link
Member Author

Thinking it might be nice to do a doc hack for 2-3 days and get all of us working on documentation improvements from either the above list or other issues.

@matthchr matthchr modified the milestones: v2.6.0, v2.7.0 Feb 22, 2024
@matthchr matthchr self-assigned this Feb 23, 2024
@matthchr matthchr modified the milestones: v2.7.0, v2.8.0 Feb 23, 2024
@matthchr matthchr modified the milestones: v2.8.0, v2.7.0 Mar 9, 2024
@matthchr
Copy link
Member Author

Not doing this one here:

Instead will track it via #3719

@matthchr
Copy link
Member Author

Closing this, will make a new issue for the one remaining item: " How to add a handcrafted resource (i.e. how to deal with POST)"

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
Projects
Development

No branches or pull requests

1 participant