advanced audit beta features #5300

CaoShuFeng · 2017-09-05T11:48:36Z

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
For 1.8 Features: set Milestone to 1.8 and Base Branch to release-1.8
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

NOTE: Please check the “Allow edits from maintainers” box (see image below) to
allow reviewers to fix problems on your patch and speed up the review process.

Please delete this note before submitting the pull request.

This change is

k8sio-netlify-preview-bot · 2017-09-05T11:50:12Z

Deploy preview ready!

Built with commit af2a287

https://deploy-preview-5300--kubernetes-io-vnext-staging.netlify.com

crassirostris · 2017-09-05T12:02:12Z

/cc

tengqm · 2017-09-05T13:19:21Z

docs/tasks/debug-application-cluster/audit.md

+Some new fields are supported in beta version, like `resourceNames` and `omitStages`.
+
+In Kubernetes 1.8 `kind` and `apiVersion` along with `rules` __must__ be supplied to
+the the audit policy file. A policy file with 0 rules, or a policy file doesn't provide


be provided in the policy file?

.. file that doesn't provide a valid apiVersion or kind value will ...

tengqm · 2017-09-05T13:21:26Z

docs/tasks/debug-application-cluster/audit.md


 ```yaml
+apiVersion: audit.k8s.io/v1beta1  #this is necessary in Kubernetes 1.8


necessary -> required?

tengqm · 2017-09-05T13:22:17Z

docs/tasks/debug-application-cluster/audit.md

@@ -155,10 +161,46 @@ rules:
  - level: Metadata
 ```

+The next audit policy file shows new features Kubernetes 1.8:


... features introduced in Kubernetes 1.8:

tengqm · 2017-09-05T13:24:00Z

docs/tasks/debug-application-cluster/audit.md

+    - group: ""
+      resources: ["pods/log", "pods/status"]
+
+  # Not log requests to a configmap called "controller-leader"


Not -> Don't

tengqm · 2017-09-05T13:24:50Z

docs/tasks/debug-application-cluster/audit.md

+
+  # A catch-all rule to log all other requests at the Metadata level.
+  # For this rule we use "omitStages" to omit events at "ReqeustReceived" stage.
+  # events in this stage will not be sent to backend.


events -> Events

tengqm · 2017-09-05T13:26:37Z

docs/tasks/debug-application-cluster/audit.md

@@ -183,31 +225,34 @@ API can be found [here][audit-api] with more details about the exact fields capt
 The behavior of the `--audit-log-path` flag changes when enabling the `AdvancedAuditing`
 feature flag. This includes the cleanups discussed above, such as changes to the `method`
 values and the introduction of a "stage" for each event. As before, the `id` field of


it reads to me that the id field is renamed to auditID, based on the sample pasted below?

In legacy format it is called "id".
In json format it is called "auditID".

Yes. The problem is that when it says "As before, ...", a careful reader will start comparison, and he/she will find the difference.

You are right.
These sentences are used to describe the "Legacy format". Moved them to another place.

tengqm · 2017-09-05T13:27:52Z

docs/tasks/debug-application-cluster/audit.md


-Since Kubernetes 1.8, structed json fromat is supported for log backend.
-Use the following option to switch log to json format:
+Since Kubernetes 1.8, structed json fromat is used for log backend by default.


Since -> Starting from
structed -> structured
fromat -> format

CaoShuFeng · 2017-09-06T05:23:20Z

@tengqm Thanks very much for your comments.
Addressed all your comments.

tengqm

generally looks good, some nits for consideration.

tengqm · 2017-09-06T05:37:04Z

docs/tasks/debug-application-cluster/audit.md

+
+Audit-Id is a unique ID for each http request to kube-apiserver. The ID of events will be the
+same if they were generated from the same request. Starting from Kubernetes 1.8, if an audit
+event is generated for the request, kube-apiserver will respond the the Audit-Id in http header.


respond with an Audit-Id in the HTTP header ?

tengqm · 2017-09-06T05:38:30Z

docs/tasks/debug-application-cluster/audit.md

+Audit-Id is a unique ID for each http request to kube-apiserver. The ID of events will be the
+same if they were generated from the same request. Starting from Kubernetes 1.8, if an audit
+event is generated for the request, kube-apiserver will respond the the Audit-Id in http header.
+We can see Audit-Id in debug info with command like `kubectl get pods --v=8`. Note that for some


We can see Audit-Id in debug info with command like kubectl get pods --v=8.

Do we really want this level of details documented?

tengqm · 2017-09-06T05:38:53Z

docs/tasks/debug-application-cluster/audit.md

+same if they were generated from the same request. Starting from Kubernetes 1.8, if an audit
+event is generated for the request, kube-apiserver will respond the the Audit-Id in http header.
+We can see Audit-Id in debug info with command like `kubectl get pods --v=8`. Note that for some
+specil requests like `kubectl exec`, `kubectl attach`, kube-apiserver works like a proxy, no Audit-Id


typo: specil -> special

@chenopis

* GC now supports non-core resources * Add two examples about how to analysis audits of kube-apiserver (#4264) * Deprecate system:nodes binding * [1.8] StatefulSet `initialized` annotation is now ignored. * inits the kubeadm upgrade docs addresses /issues/4689 * adds kubeadm upgrade cmd to ToC addresses /issues/4689 * add workload placement docs * ScaleIO - document udpate for 1.8 * Add documentation on storageClass.mountOptions and PV.mountOptions (#5254) * Add documentation on storageClass.mountOptions and PV.mountOptions * convert notes into callouts * Add docs for CustomResource validation add info about supported fields * advanced audit beta features (#5300) * Update job workload doc with backoff failure policy (#5319) Add to the Jobs documentation how to use the new backoffLimit field that limit the number of Pod failure before considering the Job as failed. * Documented additional AWS Service annotations (#4864) * Add device plugin doc under concepts/cluster-administration. (#5261) * Add device plugin doc under concepts/cluster-administration. * Update device-plugins.md * Update device-plugins.md Add meta description. Fix typo. Change bare metal deployment to manual deployment. * Update device-plugins.md Fix typo again. * Update page.version. (#5341) * Add documentation on storageClass.reclaimPolicy (#5171) * [Advanced audit] use new herf for audit-api (#5349) This tag contains all the changes in v1beta1 version. Update it now. * Added documentation around creating the InitializerConfiguration for the persistent volume label controller in the cloud-controller-manager (#5255) * Documentation for kubectl plugins (#5294) * Documentation for kubectl plugins * Update kubectl-plugins.md * Update kubectl-plugins.md * Updated CPU manager docs to match implementation. (#5332) * Noted limitation of alpha static cpumanager. * Updated CPU manager docs to match implementation. - Removed references to CPU pressure node condition and evictions. - Added note about new --cpu-manager-reconcile-period flag. - Added note about node allocatable requirements for static policy. - Noted limitation of alpha static cpumanager. * Move cpu-manager task link to rsc mgmt section. * init containers annotation removed in 1.8 (#5390) * Add documentation for TaintNodesByCondition (#5352) * Add documentation for TaintNodesByCondition * Update nodes.md * Update taint-and-toleration.md * Update daemonset.md * Update nodes.md * Update taint-and-toleration.md * Update daemonset.md * Fix deployments (#5421) * Document extended resources and OIR deprecation. (#5399) * Document extended resources and OIR deprecation. * Updated extended resources doc per reviews. * reverts extra spacing in _data/tasks.yml * addresses `kubeadm upgrade` review comments Feedback from @chenopis, @luxas, and @steveperry-53 addressed with this commit * HugePages documentation (#5419) * Update cpu-management-policies.md (#5407) Fixed the bad link. Modified "cpu" to "CPU". Added more 'yaml' as supplement. * Update RBAC docs for v1 (#5445) * Add user docs for pod priority and preemption (#5328) * Add user docs for pod priority and preemption * Update pod-priority-preemption.md * More updates * Update docs/admin/kubeadm.md for 1.8 (#5440) - Made a couple of minor wording changes (not strictly 1.8 related). - Did some reformatting (not strictly 1.8 related). - Updated references to the default token TTL (was infinite, now 24 hours). - Documented the new `--discovery-token-ca-cert-hash` and `--discovery-token-unsafe-skip-ca-verification` flags for `kubeadm join`. - Added references to the new `--discovery-token-ca-cert-hash` flag in all the default examples. - Added a new _Security model_ section that describes the security tradeoffs of the various discovery modes. - Documented the new `--groups` flag for `kubeadm token create`. - Added a note of caution under _Automating kubeadm_ that references the _Security model_ section. - Updated the component version table to drop 1.6 and add 1.8. - Update `_data/reference.yml` to try to get the sidebar fixed up and more consistent with `kubefed`. * Update StatefulSet Basics for 1.8 release (#5398) * addresses `kubeadm upgrade` review comments 2nd iteration review comments by @luxas * adds kubelet upgrade section to kubeadm upgrade * Fix a bulleted list on docs/admin/kubeadm.md. (#5458) I updated this doc yesterday and I was absolutely sure I fixed this, but I just saw that this commit got lost somehow. This was introduced recently in #5440. * Clarify the API to check for device plugins * Moving Flexvolume to separate out-of-tree section * addresses `kubeadm upgrade` review comments CC: @luxas * fixes kubeadm upgrade index * Update Stackdriver Logging documentation (#5495) * Re-update WordPress and MySQL PV doc to use apps/v1beta2 APIs (#5526) * Update statefulset concepts doc to use apps/v1beta2 APIs (#5420) * add document on kubectl's behavior regarding initializers (#5505) * Update docs/admin/kubeadm.md to cover self-hosting in 1.8. (#5497) This is a new beta feature in 1.8. * Update kubectl patch doc to use apps/v1beta2 APIs (#5422) * [1.8] Update "Run Applications" tasks to apps/v1beta2. (#5525) * Update replicated stateful application task for 1.8. * Update single instance stateful app task for 1.8. * Update stateless app task for 1.8. * Update kubectl patch task for 1.8. * fix the link of persistent storage (#5515) * update the admission-controllers.md index.md what-is-kubernetes.md link * fix the link of persistent storage * Add quota support for local ephemeral storage (#5493) * Add quota support for local ephemeral storage update the doc to this alpha feature * Update resource-quotas.md * Updated Deployments concepts doc (#5491) * Updated Deployments concepts doc * Addressed comments * Addressed more comments * Modify allocatable storage to ephemeral-storage (#5490) Update the doc to use ephemeral-storage instead of storage * Revamped concepts doc for ReplicaSet (#5463) * Revamped concepts doc for ReplicaSet * Minor changes to call out specific versions for selector defaulting and immutability * Addressed doc review comments * Remove petset documentations (#5395) * Update docs to use batch/v1beta1 cronjobs (#5475) * add federation job doc (#5485) * add federation job doc * Update job.md Edits for clarity and consistency * Update job.md Fixed a typo * update DaemonSet concept for 1.8 release (#5397) * update DaemonSet concept for 1.8 release * Update daemonset.md Fix typo. than -> then * Update bootstrap tokens doc for 1.8. (#5479) * Update bootstrap tokens doc for 1.8. This has some changes I missed when I was updating the main kubeadm documention: - Bootstrap tokens are now beta, not alpha (kubernetes/enhancements#130) - The apiserver flag to enable the authenticator changedin 1.8 (kubernetes/kubernetes#51198) - Added `auth-extra-groups` documentaion (kubernetes/kubernetes#50933) - Updated the _Token Management with `kubeadm`_ section to link to the main kubeadm docs, since it was just duplicated information. * Update bootstrap-tokens.md * Updated the Cassandra tutorial to use apps/v1beta2 (#5548) * add docs for AllowPrivilegeEscalation (#5448) Signed-off-by: Jess Frazelle <[email protected]> * Add local ephemeral storage alpha feature in managing compute resource (#5522) * Add local ephemeral storage alpha feature in managing compute resource Since 1.8, we add the local ephemeral storage alpha feature as one resource type to manage. Add this feature into the doc. * Update manage-compute-resources-container.md * Update manage-compute-resources-container.md * Update manage-compute-resources-container.md * Update manage-compute-resources-container.md * Update manage-compute-resources-container.md * Update manage-compute-resources-container.md * Added documentation for Metrics Server (#5560) * authorization: improve authorization debugging docs (#5549) * Document mount propagation (#5544) * Update /docs/setup/independent/create-cluster-kubeadm.md for 1.8. (#5524) This introduction needed a couple of small tweaks to cover the `--discovery-token-ca-cert-hash` flag added in kubernetes/kubernetes#49520 and some version bumps. * Add task doc for alpha dynamic kubelet configuration (#5523) * Fix input/output of selfsubjectaccess review (#5593) * Add docs for implementing resize (#5528) * Add docs for implementing resize * Update admission-controllers.md * Added link to PVC section * minor typo fixes * Update NetworkPolicy concept guide with egress and CIDR changes (#5529) * update zookeeper tutorial for 1.8 release * add doc for hostpath type (#5503) * Federated Hpa feature doc (#5487) * Federated Hpa feature doc * Federated Hpa feature doc review fixes * Update hpa.md * Update hpa.md * update cloud controller manager docs for v1.8 * Update cronjob with defaults information (#5556) * Kubernetes 1.8 reference docs (#5632) * Kubernetes 1.8 reference docs * Kubectl reference docs for 1.8 * Update side bar with 1.8 kubectl and api ref docs links * remove petset.md * update on state of HostAlias in 1.8 with hostNetwork Pod support (#5644) * Fix cron job deletion section (#5655) * update imported docs (#5656) * Add documentation for certificate rotation. (#5639) * Link to using kubeadm page * fix the command output fix the command output * fix typo in api/resources reference: "Worloads" * Add documentation for certificate rotation. * Create TOC entry for cloud controller manager. (#5662) * Updates for new versions of API types * Followup 5655: fix link to garbage collection (#5666) * Temporarily redirect resources-reference to api-reference. (#5668) * Update config for 1.8 release. (#5661) * Update config for 1.8 release. * Address reviewer comments. * Switch references in HPA docs from alpha to beta (#5671) The HPA docs still referenced the alpha version. This switches them to talk about v2beta1, which is the appropriate version for Kubernetes 1.8 * Deprecate openstack heat (#5670) * Fix typo in pod preset conflict example Move container port definition to the correct line. * Highlight openstack-heat provider deprecation The openstack-heat provider for kube-up is being deprecated and will be removed in a future release. * Temporarily fix broken links by redirecting. (#5672) * Fix broken links. (#5675) * Fix render of code block (#5674) * Fix broken links. (#5677) * Add a small note about auto-bootstrapped CSR ClusterRoles (#5660) * Update kubeadm install doc for v1.8 (#5676) * add draft workloads api content for 1.8 (#5650) * add draft workloads api content for 1.8 * edits per review, add tables, for 1.8 workloads api doc * fix typo * Minor fixes to kubeadm 1.8 upgrade guide. (#5678) - The kubelet upgrade instructions should be done on every host, not just worker nodes. - We should just upgrade all packages, instead of calling out kubelet specifically. This will also upgrade kubectl, kubeadm, and kubernetes-cni, if installed. - Draining nodes should also ignore daemonsets, and master errors can be ignored. - Make sure that the new kubeadm download is chmoded correctly. - Add a step to run `kubeadm version` to verify after downloading. - Manually approve new kubelet CSRs if rotation is enabled (known issue). * Release 1.8 (#5680) * Fix versions for 1.8 API ref docs * Updates for 1.8 kubectl reference docs * Kubeadm /docs/admin/kubeadm.md cleanup, editing. (#5681) * Update docs/admin/kubeadm.md (mostly 1.8 related). This is Fabrizio's work, which I'm committing along with my edits (in a commit on top of this). * A few of my own edits to clarify and clean up some Markdown.

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Sep 5, 2017

k8s-github-robot assigned Bradamant3 Sep 5, 2017

CaoShuFeng force-pushed the advanced_audit_beta branch from 364079e to 7e8c8d0 Compare September 5, 2017 11:56

k8s-ci-robot requested a review from crassirostris September 5, 2017 12:02

tengqm mentioned this pull request Sep 5, 2017

Doc for audit-log-format #5298

Closed

tengqm requested changes Sep 5, 2017

View reviewed changes

chenopis added this to the 1.8 milestone Sep 5, 2017

chenopis added Needs Docs Review labels Sep 5, 2017

CaoShuFeng force-pushed the advanced_audit_beta branch from 7e8c8d0 to 7b9ba61 Compare September 6, 2017 04:08

tengqm requested changes Sep 6, 2017

View reviewed changes

advanced audit beta features

af2a287

CaoShuFeng force-pushed the advanced_audit_beta branch from 7b9ba61 to af2a287 Compare September 6, 2017 08:23

steveperry-53 removed Needs Docs Review labels Sep 6, 2017

steveperry-53 merged commit 4807ff0 into kubernetes:release-1.8 Sep 6, 2017

crassirostris mentioned this pull request Sep 7, 2017

Advanced Auditing Beta Changes kubernetes/kubernetes#48561

Closed

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

advanced audit beta features #5300

advanced audit beta features #5300

CaoShuFeng commented Sep 5, 2017 •

edited by k8s-reviewable

Loading

k8sio-netlify-preview-bot commented Sep 5, 2017 •

edited

Loading

crassirostris commented Sep 5, 2017

tengqm Sep 5, 2017

tengqm Sep 5, 2017

tengqm Sep 5, 2017

tengqm Sep 5, 2017

tengqm Sep 5, 2017

tengqm Sep 5, 2017

tengqm Sep 5, 2017

CaoShuFeng Sep 5, 2017

tengqm Sep 6, 2017

CaoShuFeng Sep 6, 2017

tengqm Sep 5, 2017

CaoShuFeng commented Sep 6, 2017

tengqm left a comment

tengqm Sep 6, 2017

CaoShuFeng Sep 6, 2017

tengqm Sep 6, 2017

CaoShuFeng Sep 6, 2017

tengqm Sep 6, 2017

CaoShuFeng Sep 6, 2017


		```yaml
		apiVersion: audit.k8s.io/v1beta1 #this is necessary in Kubernetes 1.8

advanced audit beta features #5300

advanced audit beta features #5300

Conversation

CaoShuFeng commented Sep 5, 2017 • edited by k8s-reviewable Loading

k8sio-netlify-preview-bot commented Sep 5, 2017 • edited Loading

crassirostris commented Sep 5, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

CaoShuFeng commented Sep 6, 2017

tengqm left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

CaoShuFeng commented Sep 5, 2017 •

edited by k8s-reviewable

Loading

k8sio-netlify-preview-bot commented Sep 5, 2017 •

edited

Loading