Add two examples about how to analysis audits of kube-apiserver #4264

CaoShuFeng · 2017-07-04T11:07:17Z

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

sttts · 2017-07-04T13:02:11Z

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

+    # audit log path of kube-apiserver
+    path /var/log/kube-audit
+    pos_file /var/log/audit.pos
+    format /^(?<time>[^\]]*) AUDIT: id=\"(?<id>[^ ]*)\" stage=\"(?<stage>[^ ]*)\" ip=\"(?<ip>[^ ]*)\" method=\"(?<method>[^ ]*)\" user=\"(?<user>[^ ]*)\" groups=\"(?<groups>[^ ]*)\" as=\"(?<as>[^ ]*)\" asgroups=\"(?<asgroups>[^ ]*)\" namespace=\"(?<namespace>[^ ]*)\" uri=\"(?<uri>[^ ]*)\" response=\"(?<response>[^ ]*)\"$/


Seeing this hardcoded regex makes me 😢. It will break the next time we add a field. We really need structured output, e.g. json.

We could just dump the json of the audit event. How would that look like with logstash?

@sttts Simple

@sttts For fluentd also

@CaoShuFeng would this be something you would like to implement? Thinking about --audit-log-format <legacy|json>, i.e. the flag must be added and json marshaling must be done at vendor/k8s.io/apiserver/plugin/pkg/audit/log/backend.go:46, if the format is json.

OK!
I will work it out in this week.

+1 for json format, it would also make e2e testing easier. I meant to add this before 1.7, but didn't get to it. I agree that we should just dump the audit.Event (versioned) into the log, with 1 event per line.

Hi, all:
kubernetes/kubernetes#48605

ericchiang · 2017-07-10T16:06:33Z

@CaoShuFeng can you update this now that kubernetes/kubernetes#48605 is in? (also thanks for that!)

chenopis · 2017-07-10T22:21:05Z

Deploy preview ready!

Built with commit 026a2f4

https://deploy-preview-4264--kubernetes-io-master-staging.netlify.com

CaoShuFeng · 2017-07-12T12:21:15Z

@ericchiang
Very sorry for the late replay.

I have updated the doc.
I looks normal in github page:
https://github.com/CaoShuFeng/kubernetes.github.io/blob/logstash_fluentd/docs/tasks/debug-application-cluster/audit.md

But in the preview page it cann't work well:
https://deploy-preview-4264--kubernetes-io-master-staging.netlify.com/docs/tasks/debug-application-cluster/audit/

I will continue learning markdown tomrrow.

Maybe someone can point out where the mistake is, thanks!

CaoShuFeng · 2017-07-13T02:45:51Z

Finally, both pages looks normal.
Please take a look again.
Thanks very much!

sttts · 2017-07-13T06:55:47Z

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

+          EOF
+1. start kube-apiserver with the following options:
+
+          --feature-gates=AdvancedAuditing=true --audit-policy-file=/etc/kubernetes/audit-policy.yaml --audit-webhook-config-file=/etc/kubernetes/audit-webhook-kubeconfig


I guess this feature gate will go away with 1.8. /cc @timstclair @ericchiang we should put that onto the beta TODO list.

Added. The feature gate should stay around until GA, but should default to enabled in 1.8 (and can be removed from the documentation here).

sttts · 2017-07-13T06:56:53Z

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

+          $ fluentd -c /etc/fluentd/config  -vv
+1. start kube-apiserver with the following options:
+
+          --feature-gates=AdvancedAuditing=true --audit-policy-file=/etc/kubernetes/audit-policy.yaml --audit-log-path=/var/log/kube-audit --audit-log-format=json


much better now with json format 👍

Should we make json the default when we go to beta?

CaoShuFeng · 2017-07-13T07:00:39Z

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

+          </filter>
+
+          <match audit>
+              # route audit according to user section in context


s/user section/namespace section/
I will update it.

sttts · 2017-07-17T09:31:55Z

lgtm as far as I can judge. If somebody has more logstash/fluentd background, taking another look wouldn't harm.

crassirostris

Overall sgtm, but do you really need this tag rewriting with namespaces in the fluentd config?

crassirostris · 2017-07-17T09:39:24Z

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

+              type record_transformer
+              enable_ruby
+              <record>
+              	namespace ${record["objectRef"].nil? ? "<none>":(record["objectRef"]["namespace"].nil? ?  "<none>":record["objectRef"]["namespace"])}


If you're adding this value to the tag later, it's highly encouraged to avoid non-alphanum character

Done. Changed to none.
The namespace itself is a DNS compatible label, so it will not contain non-alphanum character itself.

crassirostris · 2017-07-17T09:40:34Z

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

+          $ cat <<EOF > /etc/logstash/config
+          input{
+              http{
+                  #TODO, does logstash support https input?


Yes, but it's disabled by default: https://www.elastic.co/guide/en/logstash/current/plugins-inputs-http.html#plugins-inputs-http-ssl

Updated the TODO comment.
In fact, I have spent quit a lot of time on how two configure https in logstash with kubeconfig.
But I failed.

crassirostris · 2017-07-17T11:04:12Z

lgtm

sttts · 2017-07-17T11:36:29Z

/lgtm

sttts · 2017-07-17T11:36:47Z

thanks @crassirostris for the additional review!

chenopis · 2017-07-27T20:57:32Z

@CaoShuFeng This looks like it's for the 1.8 release. Consequently, I'm going to move it to the release-1.8 branch.

chenopis · 2017-07-27T21:02:12Z

@CaoShuFeng If this is meant for 1.8, please confirm, then I will merge this into the release-1.8 branch.

chenopis · 2017-07-27T21:13:12Z

Deploy preview ready!

Built with commit 09750de

https://deploy-preview-4264--kubernetes-io-master-staging.netlify.com

CaoShuFeng · 2017-07-28T01:10:52Z

@chenopis
Yes, this is meant for 1.8.
Thanks!

…rnetes#4264)

@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 <acidburn@microsoft.com> * 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 the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jul 4, 2017

k8s-github-robot assigned ericchiang and sttts Jul 4, 2017

sttts reviewed Jul 4, 2017

View reviewed changes

chenopis self-assigned this Jul 5, 2017

chenopis added the Tech Review: Open Issues label Jul 5, 2017

chenopis added the Needs Tech Review label Jul 10, 2017

CaoShuFeng force-pushed the logstash_fluentd branch 10 times, most recently from a012472 to 4b5556a Compare July 12, 2017 12:03

CaoShuFeng force-pushed the logstash_fluentd branch 2 times, most recently from 91343db to 013acc4 Compare July 13, 2017 02:41

sttts reviewed Jul 13, 2017

View reviewed changes

CaoShuFeng commented Jul 13, 2017

View reviewed changes

CaoShuFeng force-pushed the logstash_fluentd branch from 013acc4 to ddb66f1 Compare July 17, 2017 08:15

crassirostris reviewed Jul 17, 2017

View reviewed changes

Add two examples about how to analysis audits of kube-apiserver

8e40fde

CaoShuFeng force-pushed the logstash_fluentd branch from ddb66f1 to 8e40fde Compare July 17, 2017 10:27

k8s-ci-robot added the lgtm label Jul 17, 2017

chenopis added Tech Review LGTM and removed Needs Tech Review labels Jul 27, 2017

chenopis added this to the 1.8 milestone Jul 27, 2017

Merge branch 'master' into logstash_fluentd

09750de

chenopis changed the base branch from master to release-1.8 July 27, 2017 20:57

chenopis added the Docs LGTM label Jul 27, 2017

chenopis merged commit c377b46 into kubernetes:release-1.8 Jul 28, 2017

micahhausler pushed a commit to micahhausler/kubernetes.github.io that referenced this pull request Sep 7, 2017

Add two examples about how to analysis audits of kube-apiserver (kube…

f498954

…rnetes#4264)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add two examples about how to analysis audits of kube-apiserver #4264

Add two examples about how to analysis audits of kube-apiserver #4264

CaoShuFeng commented Jul 4, 2017 •

edited by k8s-reviewable

Loading

sttts Jul 4, 2017

sttts Jul 4, 2017

sttts Jul 4, 2017

crassirostris Jul 4, 2017

crassirostris Jul 4, 2017

sttts Jul 5, 2017

CaoShuFeng Jul 5, 2017

sttts Jul 5, 2017

timstclair Jul 5, 2017

CaoShuFeng Jul 7, 2017

ericchiang commented Jul 10, 2017

chenopis commented Jul 10, 2017

CaoShuFeng commented Jul 12, 2017

CaoShuFeng commented Jul 13, 2017

sttts Jul 13, 2017

tallclair Jul 13, 2017

CaoShuFeng Jul 17, 2017

sttts Jul 13, 2017

tallclair Jul 13, 2017

CaoShuFeng Jul 13, 2017

CaoShuFeng Jul 17, 2017

sttts commented Jul 17, 2017

crassirostris left a comment

crassirostris Jul 17, 2017

CaoShuFeng Jul 17, 2017 •

edited

Loading

crassirostris Jul 17, 2017

CaoShuFeng Jul 17, 2017

crassirostris commented Jul 17, 2017

sttts commented Jul 17, 2017

sttts commented Jul 17, 2017

chenopis commented Jul 27, 2017

chenopis commented Jul 27, 2017

chenopis commented Jul 27, 2017

CaoShuFeng commented Jul 28, 2017

Add two examples about how to analysis audits of kube-apiserver #4264

Add two examples about how to analysis audits of kube-apiserver #4264

Conversation

CaoShuFeng commented Jul 4, 2017 • edited by k8s-reviewable Loading

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

ericchiang commented Jul 10, 2017

chenopis commented Jul 10, 2017

CaoShuFeng commented Jul 12, 2017

CaoShuFeng commented Jul 13, 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

sttts commented Jul 17, 2017

crassirostris left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

CaoShuFeng Jul 17, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

crassirostris commented Jul 17, 2017

sttts commented Jul 17, 2017

sttts commented Jul 17, 2017

chenopis commented Jul 27, 2017

chenopis commented Jul 27, 2017

chenopis commented Jul 27, 2017

CaoShuFeng commented Jul 28, 2017

CaoShuFeng commented Jul 4, 2017 •

edited by k8s-reviewable

Loading

CaoShuFeng Jul 17, 2017 •

edited

Loading