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

kube apiserver documentation enhancement #316

Open
RaunakShah opened this issue Feb 25, 2025 · 1 comment
Open

kube apiserver documentation enhancement #316

RaunakShah opened this issue Feb 25, 2025 · 1 comment
Labels
Docs-B Should Do

Comments

@RaunakShah
Copy link
Contributor

There are some changes going in to enhance the audit logging features of the kube-apiserver. Changes need to be made in https://mirantis.github.io/mke-docs/docs/configuration/kubernetes/kube-apiserver/

There are two new configuration parameters:

spec:
  apiServer:
    audit:
      enabled: false
      logPath: /var/lib/k0s/audit.log
      maxAge: 30
      maxBackup: 10
      maxSize: 10
      webhookConfigPath: <path to webhook backend>           <---- new option
      policyFile: <path to audit policy>                                        <---- new option
...
  • webhookConfigPath: backend sends audit events to a remote web API, which is assumed to be a form of the Kubernetes API. More information can be found here - https://kubernetes.io/docs/tasks/debug/debug-cluster/audit/#webhook-backend
  • policyFile: rules about what events should be recorded and what data they should include. If kube-apiserver auditing was enabled in MKE3, then the same audit policy is migrated to MKE4. For fresh installs, if kube-apiserver auditing is enabled and no policy file is specified, then it defaults to a None policy at the path /var/lib/k0s/mke4_audit_policy.yaml. This means that no events will be audited. More information can be found here - https://kubernetes.io/docs/tasks/debug/debug-cluster/audit/#audit-policy
@KoryKessel-Mirantis
Copy link
Collaborator

@RaunakShah, as of now we do not define any of the apiServer.audit parameters in the topic. In you opinion, should we create a table that defines the parameters, or is the ask simply for including the parameters in the code-block?

@KoryKessel-Mirantis KoryKessel-Mirantis added the Docs-B Should Do label Feb 26, 2025
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

2 participants