github/kubernetes
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add public documentation for kubelet/apis/config

Browse Source 
The `kubelet/apis/config` package had golint failures. This change-set
removes the `kubelet/apis/config` package from the `.golint_failures`
and fixes the golint errors. In particular, this change-set adds
documentation to the public types in the package.

This change-set works towards issue#68026
This commit is contained in:
Ian Bull 2019-11-18 15:30:46 -08:00
parent 3c5dad61f7
commit a232971d73
2 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
hack/.golint_failures
View File

@ -103,7 +103,6 @@ pkg/features
pkg/kubeapiserver pkg/kubeapiserver
pkg/kubeapiserver/options pkg/kubeapiserver/options
pkg/kubectl/cmd/convert pkg/kubectl/cmd/convert
pkg/kubelet/apis/config
pkg/kubelet/apis/config/v1beta1 pkg/kubelet/apis/config/v1beta1
pkg/kubelet/checkpointmanager/testing/example_checkpoint_formats/v1 pkg/kubelet/checkpointmanager/testing/example_checkpoint_formats/v1
pkg/kubelet/cm pkg/kubelet/cm

8
pkg/kubelet/apis/config/types.go
View File

@ -337,6 +337,7 @@ type KubeletConfiguration struct {
ReservedSystemCPUs string ReservedSystemCPUs string
} }
// KubeletAuthorizationMode denotes the authorization mode for the kubelet
type KubeletAuthorizationMode string type KubeletAuthorizationMode string
const ( const (
@ -346,6 +347,7 @@ const (
KubeletAuthorizationModeWebhook KubeletAuthorizationMode = "Webhook" KubeletAuthorizationModeWebhook KubeletAuthorizationMode = "Webhook"
) )
// KubeletAuthorization holds the state related to the authorization in the kublet.
type KubeletAuthorization struct { type KubeletAuthorization struct {
// mode is the authorization mode to apply to requests to the kubelet server. // mode is the authorization mode to apply to requests to the kubelet server.
// Valid values are AlwaysAllow and Webhook. // Valid values are AlwaysAllow and Webhook.
@ -356,6 +358,8 @@ type KubeletAuthorization struct {
Webhook KubeletWebhookAuthorization Webhook KubeletWebhookAuthorization
} }
// KubeletWebhookAuthorization holds the state related to the Webhook
// Authorization in the Kubelet.
type KubeletWebhookAuthorization struct { type KubeletWebhookAuthorization struct {
// cacheAuthorizedTTL is the duration to cache 'authorized' responses from the webhook authorizer. // cacheAuthorizedTTL is the duration to cache 'authorized' responses from the webhook authorizer.
CacheAuthorizedTTL metav1.Duration CacheAuthorizedTTL metav1.Duration
@ -363,6 +367,7 @@ type KubeletWebhookAuthorization struct {
CacheUnauthorizedTTL metav1.Duration CacheUnauthorizedTTL metav1.Duration
} }
// KubeletAuthentication holds the Kubetlet Authentication setttings.
type KubeletAuthentication struct { type KubeletAuthentication struct {
// x509 contains settings related to x509 client certificate authentication // x509 contains settings related to x509 client certificate authentication
X509 KubeletX509Authentication X509 KubeletX509Authentication
@ -372,6 +377,7 @@ type KubeletAuthentication struct {
Anonymous KubeletAnonymousAuthentication Anonymous KubeletAnonymousAuthentication
} }
// KubeletX509Authentication contains settings related to x509 client certificate authentication
type KubeletX509Authentication struct { type KubeletX509Authentication struct {
// clientCAFile is the path to a PEM-encoded certificate bundle. If set, any request presenting a client certificate // clientCAFile is the path to a PEM-encoded certificate bundle. If set, any request presenting a client certificate
// signed by one of the authorities in the bundle is authenticated with a username corresponding to the CommonName, // signed by one of the authorities in the bundle is authenticated with a username corresponding to the CommonName,
@ -379,6 +385,7 @@ type KubeletX509Authentication struct {
ClientCAFile string ClientCAFile string
} }
// KubeletWebhookAuthentication contains settings related to webhook authentication
type KubeletWebhookAuthentication struct { type KubeletWebhookAuthentication struct {
// enabled allows bearer token authentication backed by the tokenreviews.authentication.k8s.io API // enabled allows bearer token authentication backed by the tokenreviews.authentication.k8s.io API
Enabled bool Enabled bool
@ -386,6 +393,7 @@ type KubeletWebhookAuthentication struct {
CacheTTL metav1.Duration CacheTTL metav1.Duration
} }
// KubeletAnonymousAuthentication enables anonymous requests to the kubetlet server.
type KubeletAnonymousAuthentication struct { type KubeletAnonymousAuthentication struct {
// enabled allows anonymous requests to the kubelet server. // enabled allows anonymous requests to the kubelet server.
// Requests that are not rejected by another authentication method are treated as anonymous requests. // Requests that are not rejected by another authentication method are treated as anonymous requests.