kubernetes
/
apiserver
mirror of https://github.com/kubernetes/apiserver.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #120976 from tengqm/fix-audit-apidoc 

Fix API docs for audit APIs

Kubernetes-commit: d4a6a674de061ef57558f0a5996fc5f2106c52a6
This commit is contained in:
Kubernetes Publisher 2023-10-12 20:00:58 +02:00
parent a98816fb0a e014cf25b9
commit c453b3b056
5 changed files with 32 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
go.mod
View File

@ -41,9 +41,9 @@ require (
google.golang.org/protobuf v1.31.0 google.golang.org/protobuf v1.31.0
gopkg.in/natefinch/lumberjack.v2 v2.2.1 gopkg.in/natefinch/lumberjack.v2 v2.2.1
gopkg.in/square/go-jose.v2 v2.6.0 gopkg.in/square/go-jose.v2 v2.6.0
k8s.io/api v0.0.0-20231011070906-133964c1133a k8s.io/api v0.0.0-20231012030921-012f0adb0d62
k8s.io/apimachinery v0.0.0-20231011070637-1ca6c696c8e4 k8s.io/apimachinery v0.0.0-20231011070637-1ca6c696c8e4
k8s.io/client-go v0.0.0-20231011071243-cf4002bbbf85 k8s.io/client-go v0.0.0-20231012031300-d02858f5197d
k8s.io/component-base v0.0.0-20231011071914-d2d2799059b6 k8s.io/component-base v0.0.0-20231011071914-d2d2799059b6
k8s.io/klog/v2 v2.100.1 k8s.io/klog/v2 v2.100.1
k8s.io/kms v0.0.0-20231011072148-a60393ee51c8 k8s.io/kms v0.0.0-20231011072148-a60393ee51c8
@ -126,9 +126,9 @@ require (
) )
replace ( replace (
k8s.io/api => k8s.io/api v0.0.0-20231011070906-133964c1133a k8s.io/api => k8s.io/api v0.0.0-20231012030921-012f0adb0d62
k8s.io/apimachinery => k8s.io/apimachinery v0.0.0-20231011070637-1ca6c696c8e4 k8s.io/apimachinery => k8s.io/apimachinery v0.0.0-20231011070637-1ca6c696c8e4
k8s.io/client-go => k8s.io/client-go v0.0.0-20231011071243-cf4002bbbf85 k8s.io/client-go => k8s.io/client-go v0.0.0-20231012031300-d02858f5197d
k8s.io/component-base => k8s.io/component-base v0.0.0-20231011071914-d2d2799059b6 k8s.io/component-base => k8s.io/component-base v0.0.0-20231011071914-d2d2799059b6
k8s.io/kms => k8s.io/kms v0.0.0-20231011072148-a60393ee51c8 k8s.io/kms => k8s.io/kms v0.0.0-20231011072148-a60393ee51c8
) )

8
go.sum
View File

@ -671,12 +671,12 @@ honnef.co/go/tools v0.0.0-20190523083050-ea95bdfd59fc/go.mod h1:rf3lG4BRIbNafJWh
honnef.co/go/tools v0.0.1-2019.2.3/go.mod h1:a3bituU0lyd329TUQxRnasdCoJDkEUEAqEt0JzvZhAg= honnef.co/go/tools v0.0.1-2019.2.3/go.mod h1:a3bituU0lyd329TUQxRnasdCoJDkEUEAqEt0JzvZhAg=
honnef.co/go/tools v0.0.1-2020.1.3/go.mod h1:X/FiERA/W4tHapMX5mGpAtMSVEeEUOyHaw9vFzvIQ3k= honnef.co/go/tools v0.0.1-2020.1.3/go.mod h1:X/FiERA/W4tHapMX5mGpAtMSVEeEUOyHaw9vFzvIQ3k=
honnef.co/go/tools v0.0.1-2020.1.4/go.mod h1:X/FiERA/W4tHapMX5mGpAtMSVEeEUOyHaw9vFzvIQ3k= honnef.co/go/tools v0.0.1-2020.1.4/go.mod h1:X/FiERA/W4tHapMX5mGpAtMSVEeEUOyHaw9vFzvIQ3k=
k8s.io/api v0.0.0-20231011070906-133964c1133a h1:ewt1Wxw8kmOLVJfAatcAQhH1e8p/RrQGvwZzWhndWIs= k8s.io/api v0.0.0-20231012030921-012f0adb0d62 h1:MdBY0DIozFuPf2IXOGBkpo2XelUqIPv9WgDpTRwpmqU=
k8s.io/api v0.0.0-20231011070906-133964c1133a/go.mod h1:fu7/5TpQZY/iFHh5+Ss8NiQgwuMNFajKRNuU00g+a6U= k8s.io/api v0.0.0-20231012030921-012f0adb0d62/go.mod h1:fu7/5TpQZY/iFHh5+Ss8NiQgwuMNFajKRNuU00g+a6U=
k8s.io/apimachinery v0.0.0-20231011070637-1ca6c696c8e4 h1:B+3yeqV++bsLepyIyjsMGN4EJOxwykKC/vT5aGQjYjk= k8s.io/apimachinery v0.0.0-20231011070637-1ca6c696c8e4 h1:B+3yeqV++bsLepyIyjsMGN4EJOxwykKC/vT5aGQjYjk=
k8s.io/apimachinery v0.0.0-20231011070637-1ca6c696c8e4/go.mod h1:CaWZ0SJfeNC59+1gyc+rnythykg+OHqDPEGPQmVnTiE= k8s.io/apimachinery v0.0.0-20231011070637-1ca6c696c8e4/go.mod h1:CaWZ0SJfeNC59+1gyc+rnythykg+OHqDPEGPQmVnTiE=
k8s.io/client-go v0.0.0-20231011071243-cf4002bbbf85 h1:PeBqhcj2ZCn4f0IQVkxdE/4x2ySX2nE5ljkyOS1PmmU= k8s.io/client-go v0.0.0-20231012031300-d02858f5197d h1:FFDrvDEd9uVYCbvsmFJjj+apanVgWMUUi0VBso0+Eyo=
k8s.io/client-go v0.0.0-20231011071243-cf4002bbbf85/go.mod h1:4zPB+NUOQERJBGKdq7X91PGpvAI/jiK0NZEmq5c8wx4= k8s.io/client-go v0.0.0-20231012031300-d02858f5197d/go.mod h1:vtjzldTFMeBQFt3R4QmwbwddWAIHun2SgsQKhpxkbOA=
k8s.io/component-base v0.0.0-20231011071914-d2d2799059b6 h1:DaLh50HBfqyagz99VKlApWGGTQjwTZYneZh309zm40M= k8s.io/component-base v0.0.0-20231011071914-d2d2799059b6 h1:DaLh50HBfqyagz99VKlApWGGTQjwTZYneZh309zm40M=
k8s.io/component-base v0.0.0-20231011071914-d2d2799059b6/go.mod h1:4eHXzsEQqrbZP52drXln0tPwtwp0YyajVy/n8vp6VGI= k8s.io/component-base v0.0.0-20231011071914-d2d2799059b6/go.mod h1:4eHXzsEQqrbZP52drXln0tPwtwp0YyajVy/n8vp6VGI=
k8s.io/klog/v2 v2.100.1 h1:7WCHKK6K8fNhTqfBhISHQ97KrnJNFZMcQvKp7gP/tmg= k8s.io/klog/v2 v2.100.1 h1:7WCHKK6K8fNhTqfBhISHQ97KrnJNFZMcQvKp7gP/tmg=

16
pkg/apis/audit/types.go
View File

@ -235,10 +235,10 @@ type PolicyRule struct {
Namespaces []string Namespaces []string
// NonResourceURLs is a set of URL paths that should be audited. // NonResourceURLs is a set of URL paths that should be audited.
// *s are allowed, but only as the full, final step in the path. // `*`s are allowed, but only as the full, final step in the path.
// Examples: // Examples:
// "/metrics" - Log requests for apiserver metrics // `/metrics` - Log requests for apiserver metrics
// "/healthz*" - Log all health checks // `/healthz*` - Log all health checks
// +optional // +optional
NonResourceURLs []string NonResourceURLs []string
@ -269,11 +269,11 @@ type GroupResources struct {
// Resources is a list of resources this rule applies to. // Resources is a list of resources this rule applies to.
// //
// For example: // For example:
// 'pods' matches pods. // - `pods` matches pods.
// 'pods/log' matches the log subresource of pods. // - `pods/log` matches the log subresource of pods.
// '*' matches all resources and their subresources. // - `*` matches all resources and their subresources.
// 'pods/*' matches all subresources of pods. // - `pods/*` matches all subresources of pods.
// '*/scale' matches all scale subresources. // - `*/scale` matches all scale subresources.
// //
// If wildcard is present, the validation rule will ensure resources do not // If wildcard is present, the validation rule will ensure resources do not
// overlap with each other. // overlap with each other.

16
pkg/apis/audit/v1/generated.proto
View File

@ -129,11 +129,11 @@ message GroupResources {
// Resources is a list of resources this rule applies to. // Resources is a list of resources this rule applies to.
// //
// For example: // For example:
// 'pods' matches pods. // - `pods` matches pods.
// 'pods/log' matches the log subresource of pods. // - `pods/log` matches the log subresource of pods.
// '*' matches all resources and their subresources. // - `*` matches all resources and their subresources.
// 'pods/*' matches all subresources of pods. // - `pods/*` matches all subresources of pods.
// '*/scale' matches all scale subresources. // - `*/scale` matches all scale subresources.
// //
// If wildcard is present, the validation rule will ensure resources do not // If wildcard is present, the validation rule will ensure resources do not
// overlap with each other. // overlap with each other.
@ -248,10 +248,10 @@ message PolicyRule {
repeated string namespaces = 6; repeated string namespaces = 6;
// NonResourceURLs is a set of URL paths that should be audited. // NonResourceURLs is a set of URL paths that should be audited.
// *s are allowed, but only as the full, final step in the path. // `*`s are allowed, but only as the full, final step in the path.
// Examples: // Examples:
// "/metrics" - Log requests for apiserver metrics // - `/metrics` - Log requests for apiserver metrics
// "/healthz*" - Log all health checks // - `/healthz*` - Log all health checks
// +optional // +optional
repeated string nonResourceURLs = 7; repeated string nonResourceURLs = 7;

16
pkg/apis/audit/v1/types.go
View File

@ -229,10 +229,10 @@ type PolicyRule struct {
Namespaces []string `json:"namespaces,omitempty" protobuf:"bytes,6,rep,name=namespaces"` Namespaces []string `json:"namespaces,omitempty" protobuf:"bytes,6,rep,name=namespaces"`
// NonResourceURLs is a set of URL paths that should be audited. // NonResourceURLs is a set of URL paths that should be audited.
// *s are allowed, but only as the full, final step in the path. // `*`s are allowed, but only as the full, final step in the path.
// Examples: // Examples:
// "/metrics" - Log requests for apiserver metrics // - `/metrics` - Log requests for apiserver metrics
// "/healthz*" - Log all health checks // - `/healthz*` - Log all health checks
// +optional // +optional
NonResourceURLs []string `json:"nonResourceURLs,omitempty" protobuf:"bytes,7,rep,name=nonResourceURLs"` NonResourceURLs []string `json:"nonResourceURLs,omitempty" protobuf:"bytes,7,rep,name=nonResourceURLs"`
@ -263,11 +263,11 @@ type GroupResources struct {
// Resources is a list of resources this rule applies to. // Resources is a list of resources this rule applies to.
// //
// For example: // For example:
// 'pods' matches pods. // - `pods` matches pods.
// 'pods/log' matches the log subresource of pods. // - `pods/log` matches the log subresource of pods.
// '*' matches all resources and their subresources. // - `*` matches all resources and their subresources.
// 'pods/*' matches all subresources of pods. // - `pods/*` matches all subresources of pods.
// '*/scale' matches all scale subresources. // - `*/scale` matches all scale subresources.
// //
// If wildcard is present, the validation rule will ensure resources do not // If wildcard is present, the validation rule will ensure resources do not
// overlap with each other. // overlap with each other.