github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-07-28 22:17:14 +00:00
Code Issues Projects Releases Wiki Activity

Fix doc strings for kubelet config APIs

Browse Source
This commit is contained in:
Qiming Teng 2022-03-21 16:35:21 +08:00
parent 9d18c761af
commit 4567032b5f
2 changed files with 20 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -340,9 +340,10 @@ type KubeletConfiguration struct {
ContainerLogMaxFiles int32 ContainerLogMaxFiles int32
// ConfigMapAndSecretChangeDetectionStrategy is a mode in which config map and secret managers are running. // ConfigMapAndSecretChangeDetectionStrategy is a mode in which config map and secret managers are running.
ConfigMapAndSecretChangeDetectionStrategy ResourceChangeDetectionStrategy ConfigMapAndSecretChangeDetectionStrategy ResourceChangeDetectionStrategy
// A comma separated allowlist of unsafe sysctls or sysctl patterns (ending in *). // A comma separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`).
// Unsafe sysctl groups are kernel.shm*, kernel.msg*, kernel.sem, fs.mqueue.*, and net.*. // Unsafe sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`.
// These sysctls are namespaced but not allowed by default. For example: "kernel.msg*,net.ipv4.route.min_pmtu" // These sysctls are namespaced but not allowed by default.
// For example: "`kernel.msg*,net.ipv4.route.min_pmtu`"
// +optional // +optional
AllowedUnsafeSysctls []string AllowedUnsafeSysctls []string
// kernelMemcgNotification if enabled, the kubelet will integrate with the kernel memcg // kernelMemcgNotification if enabled, the kubelet will integrate with the kernel memcg
@ -554,9 +555,9 @@ type CredentialProvider struct {
// //
// Each entry in matchImages is a pattern which can optionally contain a port and a path. // Each entry in matchImages is a pattern which can optionally contain a port and a path.
// Globs can be used in the domain, but not in the port or the path. Globs are supported // Globs can be used in the domain, but not in the port or the path. Globs are supported
// as subdomains like '*.k8s.io' or 'k8s.*.io', and top-level-domains such as 'k8s.*'. // as subdomains like `*.k8s.io` or `k8s.*.io`, and top-level-domains such as `k8s.*`.
// Matching partial subdomains like 'app*.k8s.io' is also supported. Each glob can only match // Matching partial subdomains like `app*.k8s.io` is also supported. Each glob can only match
// a single subdomain segment, so *.io does not match *.k8s.io. // a single subdomain segment, so `*.io` does not match *.k8s.io.
// //
// A match exists between an image and a matchImage when all of the below are true: // A match exists between an image and a matchImage when all of the below are true:
// - Both contain the same number of domain parts and each part matches. // - Both contain the same number of domain parts and each part matches.
@ -564,11 +565,11 @@ type CredentialProvider struct {
// - If the imageMatch contains a port, then the port must match in the image as well. // - If the imageMatch contains a port, then the port must match in the image as well.
// //
// Example values of matchImages: // Example values of matchImages:
// - 123456789.dkr.ecr.us-east-1.amazonaws.com // - `123456789.dkr.ecr.us-east-1.amazonaws.com`
// - *.azurecr.io // - `*.azurecr.io`
// - gcr.io // - `gcr.io`
// - *.*.registry.io // - `*.*.registry.io`
// - registry.io:8080/path // - `registry.io:8080/path`
MatchImages []string MatchImages []string
// defaultCacheDuration is the default duration the plugin will cache credentials in-memory // defaultCacheDuration is the default duration the plugin will cache credentials in-memory

16
staging/src/k8s.io/kubelet/config/v1alpha1/types.go
View File

@ -52,9 +52,9 @@ type CredentialProvider struct {
// //
// Each entry in matchImages is a pattern which can optionally contain a port and a path. // Each entry in matchImages is a pattern which can optionally contain a port and a path.
// Globs can be used in the domain, but not in the port or the path. Globs are supported // Globs can be used in the domain, but not in the port or the path. Globs are supported
// as subdomains like '*.k8s.io' or 'k8s.*.io', and top-level-domains such as 'k8s.*'. // as subdomains like `*.k8s.io` or `k8s.*.io`, and top-level-domains such as `k8s.*`.
// Matching partial subdomains like 'app*.k8s.io' is also supported. Each glob can only match // Matching partial subdomains like `app*.k8s.io` is also supported. Each glob can only match
// a single subdomain segment, so *.io does not match *.k8s.io. // a single subdomain segment, so `*.io` does not match `*.k8s.io`.
// //
// A match exists between an image and a matchImage when all of the below are true: // A match exists between an image and a matchImage when all of the below are true:
// - Both contain the same number of domain parts and each part matches. // - Both contain the same number of domain parts and each part matches.
@ -62,11 +62,11 @@ type CredentialProvider struct {
// - If the imageMatch contains a port, then the port must match in the image as well. // - If the imageMatch contains a port, then the port must match in the image as well.
// //
// Example values of matchImages: // Example values of matchImages:
// - 123456789.dkr.ecr.us-east-1.amazonaws.com // - `123456789.dkr.ecr.us-east-1.amazonaws.com`
// - *.azurecr.io // - `*.azurecr.io`
// - gcr.io // - `gcr.io`
// - *.*.registry.io // - `*.*.registry.io`
// - registry.io:8080/path // - `registry.io:8080/path`
MatchImages []string `json:"matchImages"` MatchImages []string `json:"matchImages"`
// defaultCacheDuration is the default duration the plugin will cache credentials in-memory // defaultCacheDuration is the default duration the plugin will cache credentials in-memory