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

Rewrite Audit section #182

Open
sergeymirantis opened this issue Nov 9, 2024 · 1 comment
Open

Rewrite Audit section #182

sergeymirantis opened this issue Nov 9, 2024 · 1 comment
Assignees
Labels
Docs-B Should Do

Comments

@sergeymirantis
Copy link
Collaborator

We need to re-write the following section on the Audit: https://mirantis.github.io/mke-docs/docs/configuration/kubernetes/kube-apiserver/

I think it requires crosslinks to k8s upstream docs and ellaboration on the precedence of the extraargs

Please apply a SME review.

@quadespresso
Copy link
Collaborator

More generally, the improvements should address each of all 4 subsections of this section: https://mirantis.github.io/mke-docs/docs/configuration/kubernetes/

For consideration:

  • link to upstream source references
  • emphasize using kebab-case (per the upstream refs); do not attempt to convert to camelCase
  • call out precedence of using extraArgs, eg, in the event that the user specifies something already explicitly defined in the config YAML
  • that extraArgs is intended to be a child of apiServer in the case of kube-apiserver (change as appropriate for each of the other subsections) and not, for example, of audit
  • a trivial example (YAML block) to illustrate how one would use extraArgs

@KoryKessel-Mirantis KoryKessel-Mirantis changed the title More detailed explanation is needed Rewrite Audit section Dec 11, 2024
@KoryKessel-Mirantis KoryKessel-Mirantis added the Docs-B Should Do label Dec 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs-B Should Do
Projects
None yet
Development

No branches or pull requests

4 participants