text
stringlengths 1
1k
| id
int64 0
8.58k
|
---|---|
iguration
InitConfiguration
JoinConfiguration
BootstrapToken
Appears in:
InitConfiguration
BootstrapToken describes one bootstrap token, stored as a Secret in the cluster
Field Description
token [Required]
BootstrapTokenStringtoken is used for establishing bidirectional trust between nodes and
control-planes. Used for joining nodes in the cluster.
description
stringdescription sets a human-friendly message why this token exists and
what it's used for, so other administrators can know its purpose.•
•
•
•
•
| 7,600 |
Field Description
ttl
meta/v1.Durationttl defines the time to live for this token. Defaults to 24h. expires and ttl
are mutually exclusive.
expires
meta/v1.Timeexpires specifies the timestamp when this token expires. Defaults to
being set dynamically at runtime based on the ttl. expires and ttl are
mutually exclusive.
usages
[]stringusages describes the ways in which this token can be used. Can by
default be used for establishing bidirectional trust, but that can be
changed here.
groups
[]stringgroups specifies the extra groups that this token will authenticate as
when/if used for authentication
BootstrapTokenString
Appears in:
BootstrapToken
BootstrapTokenString is a token of the format abcdef.abcdef0123456789 that is used for both
validation of the practically of the API server from a joining node's point of view and as an
authentication method for the node in the bootstrap phase of "kubeadm join". This token is and
should be short-lived.
Field Description
- [Required]
stringNo | 7,601 |
description provided.
- [Required]
stringNo description provided.
ClusterConfiguration
ClusterConfiguration contains cluster-wide configuration for a kubeadm cluster.
Field Description
apiVersion
stringkubeadm.k8s.io/v1beta3
kind
stringClusterConfiguration
etcd
Etcdetcd holds the configuration for etcd.
networking
Networking | 7,602 |
Field Description
networking holds configuration for the networking topology of the
cluster.
kubernetesVersion
stringkubernetesVersion is the target version of the control plane.
controlPlaneEndpoint
stringcontrolPlaneEndpoint sets a stable IP address or DNS name for the
control plane. It can be a valid IP address or a RFC-1123 DNS
subdomain, both with optional TCP port. In case the
controlPlaneEndpoint is not specified, the advertiseAddress +
bindPort are used; in case the controlPlaneEndpoint is specified but
without a TCP port, the bindPort is used. Possible usages are:
In a cluster with more than one control plane instances, this
field should be assigned the address of the external load
balancer in front of the control plane instances.
In environments with enforced node recycling, the
controlPlaneEndpoint could be used for assigning a stable DNS
to the control plane.
apiServer
APIServerapiServer contains extra settings for the API server.
controllerManager
ControlPlane | 7,603 |
ComponentcontrollerManager contains extra settings for the controller manager.
scheduler
ControlPlaneComponentscheduler contains extra settings for the scheduler.
dns
DNSdns defines the options for the DNS add-on installed in the cluster.
certificatesDir
stringcertificatesDir specifies where to store or look for all required
certificates.
imageRepository
stringimageRepository sets the container registry to pull images from. If
empty, registry.k8s.io will be used by default. In case of kubernetes
version is a CI build (kubernetes version starts with ci/) gcr.io/k8s-
staging-ci-images will be used as a default for control plane
components and for kube-proxy, while registry.k8s.io will be used for
all the other images.
featureGates
map[string]boolfeatureGates contains the feature gates enabled by the user.
clusterName
stringThe cluster name.•
| 7,604 |
InitConfiguration
InitConfiguration contains a list of elements that is specific "kubeadm init"-only runtime
information. kubeadm init -only information. These fields are solely used the first time
kubeadm init runs. After that, the information in the fields IS NOT uploaded to the kubeadm-
config ConfigMap that is used by kubeadm upgrade for instance. These fields must be
omitempty.
Field Description
apiVersion
stringkubeadm.k8s.io/v1beta3
kind
stringInitConfiguration
bootstrapTokens
[]BootstrapTokenbootstrapTokens is respected at kubeadm init time and describes a set
of Bootstrap Tokens to create. This information IS NOT uploaded to
the kubeadm cluster configmap, partly because of its sensitive nature
nodeRegistration
NodeRegistrationOptionsnodeRegistration holds fields that relate to registering the new
control-plane node to the cluster.
localAPIEndpoint
APIEndpointlocalAPIEndpoint represents the endpoint of the API server instance
that's deployed on this control plane node. | 7,605 |
In HA setups, this differs
from ClusterConfiguration.controlPlaneEndpoint in the sense that
controlPlaneEndpoint is the global endpoint for the cluster, which
then load-balances the requests to each individual API server. This
configuration object lets you customize what IP/DNS name and port
the local API server advertises it's accessible on. By default, kubeadm
tries to auto-detect the IP of the default interface and use that, but in
case that process fails you may set the desired value here.
certificateKey
stringcertificateKey sets the key with which certificates and keys are
encrypted prior to being uploaded in a Secret in the cluster during
the uploadcerts init phase. The certificate key is a hex encoded string
that is an AES key of size 32 bytes.
skipPhases
[]stringskipPhases is a list of phases to skip during command execution. The
list of phases can be obtained with the kubeadm init --help
command. The flag "--skip-phases" takes precedence over this field.
patches
Patchesp | 7,606 |
atches contains options related to applying patches to components
deployed by kubeadm during kubeadm init .
JoinConfiguration
JoinConfiguration contains elements describing a particular node | 7,607 |
Field Description
apiVersion
stringkubeadm.k8s.io/v1beta3
kind
stringJoinConfiguration
nodeRegistration
NodeRegistrationOptionsnodeRegistration holds fields that relate to registering the new
control-plane node to the cluster.
caCertPath
stringcaCertPath is the path to the SSL certificate authority used to secure
comunications between a node and the control-plane. Defaults to "/
etc/kubernetes/pki/ca.crt".
discovery [Required]
Discoverydiscovery specifies the options for the kubelet to use during the TLS
bootstrap process.
controlPlane
JoinControlPlanecontrolPlane defines the additional control plane instance to be
deployed on the joining node. If nil, no additional control plane
instance will be deployed.
skipPhases
[]stringskipPhases is a list of phases to skip during command execution. The
list of phases can be obtained with the kubeadm join --help
command. The flag --skip-phases takes precedence over this field.
patches
Patchespatches contains options related to applying pa | 7,608 |
tches to components
deployed by kubeadm during kubeadm join .
APIEndpoint
Appears in:
InitConfiguration
JoinControlPlane
APIEndpoint struct contains elements of API server instance deployed on a node.
Field Description
advertiseAddress
stringadvertiseAddress sets the IP address for the API server to advertise.
bindPort
int32bindPort sets the secure port for the API Server to bind to. Defaults to 6443.•
| 7,609 |
APIServer
Appears in:
ClusterConfiguration
APIServer holds settings necessary for API server deployments in the cluster
Field Description
ControlPlaneComponent
[Required]
ControlPlaneComponent(Members of ControlPlaneComponent are embedded into this
type.) No description provided.
certSANs
[]stringcertSANs sets extra Subject Alternative Names (SANs) for the
API Server signing certificate.
timeoutForControlPlane
meta/v1.DurationtimeoutForControlPlane controls the timeout that we wait for
API server to appear.
BootstrapTokenDiscovery
Appears in:
Discovery
BootstrapTokenDiscovery is used to set the options for bootstrap token based discovery.
Field Description
token [Required]
stringtoken is a token used to validate cluster information fetched from the
control-plane.
apiServerEndpoint
stringapiServerEndpoint is an IP or domain name to the API server from
which information will be fetched.
caCertHashes
[]stringcaCertHashes specifies a set of public key pins to verify when token-
ba | 7,610 |
sed discovery is used. The root CA found during discovery must
match one of these values. Specifying an empty set disables root CA
pinning, which can be unsafe. Each hash is specified as
<type>:<value> , where the only currently supported type is "sha256".
This is a hex-encoded SHA-256 hash of the Subject Public Key Info
(SPKI) object in DER-encoded ASN.1. These hashes can be calculated
using, for example, OpenSSL.•
| 7,611 |
Field Description
unsafeSkipCAVerification
boolunsafeSkipCAVerification allows token-based discovery without CA
verification via caCertHashes . This can weaken the security of
kubeadm since other nodes can impersonate the control-plane.
ControlPlaneComponent
Appears in:
ClusterConfiguration
APIServer
ControlPlaneComponent holds settings common to control plane component of the cluster
Field Description
extraArgs
map[string]stringextraArgs is an extra set of flags to pass to the control plane component. A
key in this map is the flag name as it appears on the command line except
without leading dash(es).
extraVolumes
[]HostPathMountextraVolumes is an extra set of host volumes, mounted to the control plane
component.
DNS
Appears in:
ClusterConfiguration
DNS defines the DNS addon that should be used in the cluster
Field Description
ImageMeta
[Required]
ImageMeta(Members of ImageMeta are embedded into this type.)
imageMeta allows to customize the image used for the DNS
component.
Dis | 7,612 |
covery
Appears in:
JoinConfiguration
Discovery specifies the options for the kubelet to use during the TLS Bootstrap process.•
•
•
| 7,613 |
Field Description
bootstrapToken
BootstrapTokenDiscoverybootstrapToken is used to set the options for bootstrap token based
discovery. bootstrapToken and file are mutually exclusive.
file
FileDiscoveryfile is used to specify a file or URL to a kubeconfig file from which to
load cluster information. bootstrapToken and file are mutually
exclusive.
tlsBootstrapToken
stringtlsBootstrapToken is a token used for TLS bootstrapping. If
bootstrapToken is set, this field is defaulted
to .bootstrapToken.token , but can be overridden. If file is set, this
field must be set in case the KubeConfigFile does not contain any
other authentication information
timeout
meta/v1.Durationtimeout modifies the discovery timeout.
Etcd
Appears in:
ClusterConfiguration
Etcd contains elements describing Etcd configuration.
Field Description
local
LocalEtcdlocal provides configuration knobs for configuring the local etcd instance. local
and external are mutually exclusive.
external
ExternalEtcdexternal de | 7,614 |
scribes how to connect to an external etcd cluster. local and external
are mutually exclusive.
ExternalEtcd
Appears in:
Etcd
ExternalEtcd describes an external etcd cluster. Kubeadm has no knowledge of where certificate
files live and they must be supplied.
Field Description
endpoints
[Required]
[]stringendpoints contains the list of etcd members.•
| 7,615 |
Field Description
caFile
[Required]
stringcaFile is an SSL Certificate Authority (CA) file used to secure etcd
communication. Required if using a TLS connection.
certFile
[Required]
stringcertFile is an SSL certification file used to secure etcd communication.
Required if using a TLS connection.
keyFile
[Required]
stringkeyFile is an SSL key file used to secure etcd communication. Required if
using a TLS connection.
FileDiscovery
Appears in:
Discovery
FileDiscovery is used to specify a file or URL to a kubeconfig file from which to load cluster
information.
Field Description
kubeConfigPath
[Required]
stringkubeConfigPath is used to specify the actual file path or URL to the
kubeconfig file from which to load cluster information.
HostPathMount
Appears in:
ControlPlaneComponent
HostPathMount contains elements describing volumes that are mounted from the host.
Field Description
name [Required]
stringname is the name of the volume inside the Pod template.
hostPath [Required] | 7,616 |
stringhostPath is the path in the host that will be mounted inside the Pod.
mountPath [Required]
stringmountPath is the path inside the Pod where hostPath will be mounted.
readOnly
boolreadOnly controls write access to the volume.•
| 7,617 |
Field Description
pathType
core/v1.HostPathTypepathType is the type of the hostPath .
ImageMeta
Appears in:
DNS
LocalEtcd
ImageMeta allows to customize the image used for components that are not originated from the
Kubernetes/Kubernetes release process
Field Description
imageRepository
stringimageRepository sets the container registry to pull images from. If not set,
the imageRepository defined in ClusterConfiguration will be used instead.
imageTag
stringimageTag allows to specify a tag for the image. In case this value is set,
kubeadm does not change automatically the version of the above components
during upgrades.
JoinControlPlane
Appears in:
JoinConfiguration
JoinControlPlane contains elements describing an additional control plane instance to be
deployed on the joining node.
Field Description
localAPIEndpoint
APIEndpointlocalAPIEndpoint represents the endpoint of the API server instance to be
deployed on this node.
certificateKey
stringcertificateKey is the key that is used | 7,618 |
for decryption of certificates after they
are downloaded from the secret upon joining a new control plane node. The
corresponding encryption key is in the InitConfiguration. The certificate key
is a hex encoded string that is an AES key of size 32 bytes.•
•
| 7,619 |
LocalEtcd
Appears in:
Etcd
LocalEtcd describes that kubeadm should run an etcd cluster locally.
Field Description
ImageMeta
[Required]
ImageMeta(Members of ImageMeta are embedded into this type.)
ImageMeta allows to customize the container used for etcd.
dataDir
[Required]
stringdataDir is the directory etcd will place its data. Defaults to "/var/lib/etcd".
extraArgs
map[string]stringextraArgs are extra arguments provided to the etcd binary when run
inside a static Pod. A key in this map is the flag name as it appears on the
command line except without leading dash(es).
serverCertSANs
[]stringserverCertSANs sets extra Subject Alternative Names (SANs) for the etcd
server signing certificate.
peerCertSANs
[]stringpeerCertSANs sets extra Subject Alternative Names (SANs) for the etcd
peer signing certificate.
Networking
Appears in:
ClusterConfiguration
Networking contains elements describing cluster's networking configuration.
Field Description
serviceSubnet
stringserviceSubnet i | 7,620 |
s the subnet used by Kubernetes Services. Defaults to
"10.96.0.0/12".
podSubnet
stringpodSubnet is the subnet used by Pods.
dnsDomain
stringdnsDomain is the DNS domain used by Kubernetes Services. Defaults to
"cluster.local".•
| 7,621 |
NodeRegistrationOptions
Appears in:
InitConfiguration
JoinConfiguration
NodeRegistrationOptions holds fields that relate to registering a new control-plane or node to
the cluster, either via kubeadm init or kubeadm join .
Field Description
name
stringname is the .metadata.name field of the Node API object that will be
created in this kubeadm init or kubeadm join operation. This field is also
used in the CommonName field of the kubelet's client certificate to the
API server. Defaults to the hostname of the node if not provided.
criSocket
stringcriSocket is used to retrieve container runtime info. This information will
be annotated to the Node API object, for later re-use.
taints [Required]
[]core/v1.Tainttaints specifies the taints the Node API object should be registered with.
If this field is unset, i.e. nil, it will be defaulted with a control-plane taint
for control-plane nodes. If you don't want to taint your control-plane
node, set this field to an empty list, i.e. taints | 7,622 |
: [] in the YAML file. This
field is solely used for Node registration.
kubeletExtraArgs
map[string]stringkubeletExtraArgs passes through extra arguments to the kubelet. The
arguments here are passed to the kubelet command line via the
environment file kubeadm writes at runtime for the kubelet to source.
This overrides the generic base-level configuration in the kubelet-config
ConfigMap. Flags have higher priority when parsing. These values are
local and specific to the node kubeadm is executing on. A key in this map
is the flag name as it appears on the command line except without
leading dash(es).
ignorePreflightErrors
[]stringignorePreflightErrors provides a list of pre-flight errors to be ignored
when the current node is registered, e.g. IsPrevilegedUser,Swap . Value all
ignores errors from all checks.
imagePullPolicy
core/v1.PullPolicyimagePullPolicy specifies the policy for image pulling during kubeadm
"init" and "join" operations. The value of this field must be one of
"Alwa | 7,623 |
ys", "IfNotPresent" or "Never". If this field is not set, kubeadm will
default it to "IfNotPresent", or pull the required images if not present on
the host.•
| 7,624 |
Patches
Appears in:
InitConfiguration
JoinConfiguration
Patches contains options related to applying patches to components deployed by kubeadm.
Field Description
directory
stringdirectory is a path to a directory that contains files named "target[suffix]
[+patchtype].extension". For example, "kube-apiserver0+merge.yaml" or just
"etcd.json". "target" can be one of "kube-apiserver", "kube-controller-manager", "kube-
scheduler", "etcd". "patchtype" can be one of "strategic" "merge" or "json" and they
match the patch formats supported by kubectl. The default "patchtype" is "strategic".
"extension" must be either "json" or "yaml". "suffix" is an optional string that can be
used to determine which patches are applied first alpha-numerically.
kubeadm Configuration (v1beta4)
Overview
Package v1beta4 defines the v1beta4 version of the kubeadm configuration file format. This
version improves on the v1beta3 format by fixing some minor issues and adding a few new
fields.
A list of changes since v | 7,625 |
1beta3:
TODO https://github.com/kubernetes/kubeadm/issues/2890
Support custom environment variables in control plane components under
ClusterConfiguration . Use APIServer.ExtraEnvs , ControllerManager.ExtraEnvs ,
Scheduler.ExtraEnvs , Etcd.Local.ExtraEnvs .
The ResetConfiguration API type is now supported in v1beta4. Users are able to reset a
node by passing a --config file to kubeadm reset .
dry-run mode is now configureable in InitConfiguration and JoinConfiguration config
files.
Replace the existing string/string extra argument maps with structured extra arguments
that support duplicates. The change applies to ClusterConfiguration -
APIServer.ExtraArgs , ControllerManager.ExtraArgs , Scheduler.ExtraArgs . Also to
NodeRegistrationOptions.KubeletExtraArgs .
Add ClusterConfiguration.EncryptionAlgorithm that can be used to set the asymmetric
encryption algorithm used for this cluster's keys and certificates. Can be "RSA" (default
algorithm, key size is 2048) or "ECDSA" (uses | 7,626 |
the P-256 elliptic curve).
Add ClusterConfiguration.DNS.Disabled and ClusterConfiguration.Proxy.Disabled that
can be used to disable the CoreDNS and kube-proxy addons during cluster initialization.
Skipping the related addons phases, during cluster creation will set the same fields to
false.•
•
•
•
•
•
•
•
| 7,627 |
Migration from old kubeadm config
versions
kubeadm v1.15.x and newer can be used to migrate from v1beta1 to v1beta2.
kubeadm v1.22.x and newer no longer support v1beta1 and older APIs, but can be used to
migrate v1beta2 to v1beta3.
kubeadm v1.27.x and newer no longer support v1beta2 and older APIs.
TODO: https://github.com/kubernetes/kubeadm/issues/2890 add version that can be used
to convert to v1beta4
Basics
The preferred way to configure kubeadm is to pass an YAML configuration file with the `--
config“ option. Some of the configuration options defined in the kubeadm config file are also
available as command line flags, but only the most common/simple use case are supported with
this approach.
A kubeadm config file could contain multiple configuration types separated using three dashes
(---).
kubeadm supports the following configuration types:
apiVersion: kubeadm.k8s.io/v1beta4
kind: InitConfiguration
apiVersion: kubeadm.k8s.io/v1beta4
kind: ClusterConfiguration
apiVersion: kubelet. | 7,628 |
config.k8s.io/v1beta1
kind: KubeletConfiguration
apiVersion: kubeproxy.config.k8s.io/v1alpha1
kind: KubeProxyConfiguration
apiVersion: kubeadm.k8s.io/v1beta4
kind: JoinConfiguration
To print the defaults for "init" and "join" actions use the following commands:
kubeadm config print init-defaults
kubeadm config print join-defaults
The list of configuration types that must be included in a configuration file depends by the
action you are performing ( init or join`) and by the configuration options you are going to use
(defaults or advanced customization).•
•
•
| 7,629 |
If some configuration types are not provided, or provided only partially, kubeadm will use
default values; defaults provided by kubeadm includes also enforcing consistency of values
across components when required (e.g. --cluster-cidr flag on controller manager and
clusterCIDR on kube-proxy).
Users are always allowed to override default values, with the only exception of a small subset of
setting with relevance for security (e.g. enforce authorization-mode Node and RBAC on api
server).
If the user provides a configuration types that is not expected for the action you are performing,
kubeadm will ignore those types and print a warning.
Kubeadm init configuration types
When executing kubeadm init with the `--config“ option, the following configuration types
could be used: InitConfiguration, ClusterConfiguration, KubeProxyConfiguration,
KubeletConfiguration, but only one between InitConfiguration and ClusterConfiguration is
mandatory.
apiVersion : kubeadm.k8s.io/v1beta4
kind: InitConfi | 7,630 |
guration
bootstrapTokens :
...
nodeRegistration :
...
The InitConfiguration type should be used to configure runtime settings, that in case of
kubeadm init are the configuration of the bootstrap token and all the setting which are specific
to the node where kubeadm is executed, including:
NodeRegistration, that holds fields that relate to registering the new node to the cluster;
use it to customize the node name, the CRI socket to use or any other settings that should
apply to this node only (e.g. the node ip).
LocalAPIEndpoint, that represents the endpoint of the instance of the API server to be
deployed on this node; use it e.g. to customize the API server advertise address.
apiVersion : kubeadm.k8s.io/v1beta4
kind: ClusterConfiguration
networking :
...
etcd:
...
apiServer :•
| 7,631 |
extraArgs :
...
extraVolumes :
...
...
The ClusterConfiguration type should be used to configure cluster-wide settings, including
settings for:
networking that holds configuration for the networking topology of the cluster; use it e.g.
to customize Pod subnet or services subnet.
etcd: use it e.g. to customize the local etcd or to configure the API server for using an
external etcd cluster.
kube-apiserver, kube-scheduler, kube-controller-manager configurations; use it to
customize control-plane components by adding customized setting or overriding
kubeadm default settings.
apiVersion : kubeproxy.config.k8s.io/v1alpha1
kind: KubeProxyConfiguration
...
The KubeProxyConfiguration type should be used to change the configuration passed to kube-
proxy instances deployed in the cluster. If this object is not provided or provided only partially,
kubeadm applies defaults.
See https://kubernetes.io/docs/reference/command-line-tools-reference/kube-proxy/ or https://
pkg.go.dev/k8s.io/kube-p | 7,632 |
roxy/config/v1alpha1#KubeProxyConfiguration for kube-proxy official
documentation.
apiVersion : kubelet.config.k8s.io/v1beta1
kind: KubeletConfiguration
...
The KubeletConfiguration type should be used to change the configurations that will be passed
to all kubelet instances deployed in the cluster. If this object is not provided or provided only
partially, kubeadm applies defaults.
See https://kubernetes.io/docs/reference/command-line-tools-reference/kubelet/ or https://
pkg.go.dev/k8s.io/kubelet/config/v1beta1#KubeletConfiguration for kubelet official
documentation.
Here is a fully populated example of a single YAML file containing multiple configuration types
to be used during a kubeadm init run.
apiVersion : kubeadm.k8s.io/v1beta4
kind: InitConfiguration
bootstrapTokens :•
•
| 7,633 |
- token : "9a08jv.c0izixklcxtmnze7"
description : "kubeadm bootstrap token"
ttl: "24h"
- token : "783bde.3f89s0fje9f38fhf"
description : "another bootstrap token"
usages :
- authentication
- signing
groups :
- system:bootstrappers:kubeadm:default-node-token
nodeRegistration :
name : "ec2-10-100-0-1"
criSocket : "unix:///var/run/containerd/containerd.sock"
taints :
- key: "kubeadmNode"
value : "someValue"
effect : "NoSchedule"
kubeletExtraArgs :
v: 4
ignorePreflightErrors :
- IsPrivilegedUser
imagePullPolicy : "IfNotPresent"
localAPIEndpoint :
advertiseAddress : "10.100.0.1"
bindPort : 6443
certificateKey : "e6a2eb8581237ab72a4f494f30285ec12a9694d750b9785706a83bfcbbbd2204"
skipPhases :
- addon/kube-proxy
---
apiVersion : kubeadm.k8s.io/v1beta4
kind: ClusterConfiguration
etcd:
# one of local or external
local :
imageRepository : "registry.k8s.io"
imageTag : "3.2.24"
dataDir : "/var/lib/etcd"
extraArgs :
listen-client-urls | 7,634 |
: "http://10.100.0.1:2379"
serverCertSANs :
- "ec2-10-100-0-1.compute-1.amazonaws.com"
peerCertSANs :
- "10.100.0.1"
# external:
# endpoints:
# - "10.100.0.1:2379 | 7,635 |
# - "10.100.0.2:2379"
# caFile: "/etcd/kubernetes/pki/etcd/etcd-ca.crt"
# certFile: "/etcd/kubernetes/pki/etcd/etcd.crt"
# keyFile: "/etcd/kubernetes/pki/etcd/etcd.key"
networking :
serviceSubnet : "10.96.0.0/16"
podSubnet : "10.244.0.0/24"
dnsDomain : "cluster.local"
kubernetesVersion : "v1.21.0"
controlPlaneEndpoint : "10.100.0.1:6443"
apiServer :
extraArgs :
authorization-mode : "Node,RBAC"
extraVolumes :
- name : "some-volume"
hostPath : "/etc/some-path"
mountPath : "/etc/some-pod-path"
readOnly : false
pathType : File
certSANs :
- "10.100.1.1"
- "ec2-10-100-0-1.compute-1.amazonaws.com"
timeoutForControlPlane : 4m0s
controllerManager :
extraArgs :
"node-cidr-mask-size": "20"
extraVolumes :
- name : "some-volume"
hostPath : "/etc/some-path"
mountPath : "/etc/some-pod-path"
readOnly : false
pathType : File
scheduler :
extraArgs :
address : "10.100.0.1"
extraVolumes :
- name : "some-volume"
hostPath : "/etc/some-path | 7,636 |
"
mountPath : "/etc/some-pod-path"
readOnly : false
pathType : File
certificatesDir : "/etc/kubernetes/pki"
imageRepository : "registry.k8s.io"
clusterName : "example-cluster | 7,637 |
---
apiVersion : kubelet.config.k8s.io/v1beta1
kind: KubeletConfiguration
# kubelet specific options here
---
apiVersion : kubeproxy.config.k8s.io/v1alpha1
kind: KubeProxyConfiguration
# kube-proxy specific options here
Kubeadm join configuration types
When executing kubeadm join with the --config option, the JoinConfiguration type should be
provided.
apiVersion : kubeadm.k8s.io/v1beta4
kind: JoinConfiguration
...
The JoinConfiguration type should be used to configure runtime settings, that in case of
kubeadm join are the discovery method used for accessing the cluster info and all the setting
which are specific to the node where kubeadm is executed, including:
nodeRegistration , that holds fields that relate to registering the new node to the cluster;
use it to customize the node name, the CRI socket to use or any other settings that should
apply to this node only (e.g. the node ip).
`apiEndpoint“, that represents the endpoint of the instance of the API server to be
eventually deploy | 7,638 |
ed on this node.
Resource Types
ClusterConfiguration
InitConfiguration
JoinConfiguration
ResetConfiguration
BootstrapToken
Appears in:
InitConfiguration
InitConfiguration
BootstrapToken describes one bootstrap token, stored as a Secret in the cluster•
•
•
•
•
•
•
| 7,639 |
Field Description
token [Required]
BootstrapTokenStringtoken is used for establishing bidirectional trust between nodes and
control-planes. Used for joining nodes in the cluster.
description
stringdescription sets a human-friendly message why this token exists and
what it's used for, so other administrators can know its purpose.
ttl
meta/v1.Durationttl defines the time to live for this token. Defaults to 24h. expires and ttl
are mutually exclusive.
expires
meta/v1.Timeexpires specifies the timestamp when this token expires. Defaults to
being set dynamically at runtime based on the ttl. expires and ttl are
mutually exclusive.
usages
[]stringusages describes the ways in which this token can be used. Can by
default be used for establishing bidirectional trust, but that can be
changed here.
groups
[]stringgroups specifies the extra groups that this token will authenticate as
when/if used for authentication
BootstrapTokenString
Appears in:
BootstrapToken
BootstrapTokenString is a to | 7,640 |
ken of the format abcdef.abcdef0123456789 that is used for both
validation of the practically of the API server from a joining node's point of view and as an
authentication method for the node in the bootstrap phase of "kubeadm join". This token is and
should be short-lived.
Field Description
- [Required]
stringNo description provided.
- [Required]
stringNo description provided.
ClusterConfiguration
ClusterConfiguration contains cluster-wide configuration for a kubeadm cluster.
Field Description
kubeadm.k8s.io/v1beta4 | 7,641 |
Field Description
apiVersion
string
kind
stringClusterConfiguration
etcd
Etcdetcd holds the configuration for etcd.
networking
Networkingnetworking holds configuration for the networking topology of the
cluster.
kubernetesVersion
stringkubernetesVersion is the target version of the control plane.
controlPlaneEndpoint
stringontrolPlaneEndpoint sets a stable IP address or DNS name for the
control plane; It can be a valid IP address or a RFC-1123 DNS
subdomain, both with optional TCP port. In case the
controlPlaneEndpoint is not specified, the advertiseAddress +
bindPort are used; in case the controlPlaneEndpoint is specified but
without a TCP port, the bindPort is used. Possible usages are:
In a cluster with more than one control plane instances, this
field should be assigned the address of the external load
balancer in front of the control plane instances.
In environments with enforced node recycling, the
controlPlaneEndpoint could be used for assigning a stable
DNS to the c | 7,642 |
ontrol plane.
apiServer
APIServerapiServer contains extra settings for the API server.
controllerManager
ControlPlaneComponentcontrollerManager contains extra settings for the controller
manager.
scheduler
ControlPlaneComponentscheduler contains extra settings for the scheduler.
dns
DNSdns defines the options for the DNS add-on installed in the cluster.
proxy [Required]
Proxyproxy defines the options for the proxy add-on installed in the
cluster.
certificatesDir
stringcertificatesDir specifies where to store or look for all required
certificates.
imageRepository
string•
| 7,643 |
Field Description
imageRepository sets the container registry to pull images from. If
empty, registry.k8s.io will be used by default. In case of kubernetes
version is a CI build (kubernetes version starts with ci/) gcr.io/k8s-
staging-ci-images will be used as a default for control plane
components and for kube-proxy, while registry.k8s.io will be used
for all the other images.
featureGates
map[string]boolfeatureGates contains the feature gates enabled by the user.
clusterName
stringThe cluster name.
encryptionAlgorithm
EncryptionAlgorithmTypeencryptionAlgorithm holds the type of asymmetric encryption
algorithm used for keys and certificates. Can be "RSA" (default
algorithm, key size is 2048) or "ECDSA" (uses the P-256 elliptic
curve).
InitConfiguration
InitConfiguration contains a list of elements that is specific "kubeadm init"-only runtime
information. kubeadm init -only information. These fields are solely used the first time
kubeadm init runs. After that, the information | 7,644 |
in the fields IS NOT uploaded to the kubeadm-
config ConfigMap that is used by kubeadm upgrade for instance. These fields must be
omitempty.
Field Description
apiVersion
stringkubeadm.k8s.io/v1beta4
kind
stringInitConfiguration
bootstrapTokens
[]BootstrapTokenbootstrapTokens is respected at kubeadm init time and describes a set
of Bootstrap Tokens to create. This information IS NOT uploaded to
the kubeadm cluster configmap, partly because of its sensitive nature
dryRun [Required]
booldryRun tells if the dry run mode is enabled, don't apply any change
in dry run mode, just out put what would be done.
nodeRegistration
NodeRegistrationOptionsnodeRegistration holds fields that relate to registering the new
control-plane node to the cluster.
localAPIEndpoint
APIEndpointlocalAPIEndpoint represents the endpoint of the API server instance
that's deployed on this control plane node. In HA setups, this differs
from ClusterConfiguration.controlPlaneEndpoint in the sense tha | 7,645 |
Field Description
ontrolPlaneEndpoint is the global endpoint for the cluster, which
then loadbalances the requests to each individual API server. This
configuration object lets you customize what IP/DNS name and port
the local API server advertises it's accessible on. By default, kubeadm
tries to auto-detect the IP of the default interface and use that, but in
case that process fails you may set the desired value here.
certificateKey
stringcertificateKey sets the key with which certificates and keys are
encrypted prior to being uploaded in a Secret in the cluster during
the uploadcerts init phase. The certificate key is a hex encoded string
that is an AES key of size 32 bytes.
skipPhases
[]stringskipPhases is a list of phases to skip during command execution. The
list of phases can be obtained with the kubeadm init --help
command. The flag --skip-phases takes precedence over this field.
patches
Patchespatches contains options related to applying patches to components
deployed by | 7,646 |
kubeadm during kubeadm init .
JoinConfiguration
JoinConfiguration contains elements describing a particular node.
Field Description
apiVersion
stringkubeadm.k8s.io/v1beta4
kind
stringJoinConfiguration
dryRun
booldryRun tells if the dry run mode is enabled, don't apply any change if
it is set, just output what would be done.
nodeRegistration
NodeRegistrationOptionsnodeRegistration holds fields that relate to registering the new
control-plane node to the cluster
caCertPath
stringcaCertPath is the path to the SSL certificate authority used to secure
comunications between node and control-plane. Defaults to "/etc/
kubernetes/pki/ca.crt".
discovery [Required]
Discoverydiscovery specifies the options for the kubelet to use during the TLS
bootstrap process.
controlPlane
JoinControlPlan | 7,647 |
Field Description
controlPlane defines the additional control plane instance to be
deployed on the joining node. If nil, no additional control plane
instance will be deployed.
skipPhases
[]stringskipPhases is a list of phases to skip during command execution. The
list of phases can be obtained with the kubeadm join --help
command. The flag --skip-phases takes precedence over this field.
patches
Patchespatches contains options related to applying patches to components
deployed by kubeadm during kubeadm join .
ResetConfiguration
ResetConfiguration contains a list of fields that are specifically kubeadm reset -only runtime
information.
Field Description
apiVersion
stringkubeadm.k8s.io/v1beta4
kind
stringResetConfiguration
cleanupTmpDir
boolcleanupTmpDir specifies whether the "/etc/kubernetes/tmp" directory
should be cleaned during the reset process.
certificatesDir
stringcertificatesDir specifies the directory where the certificates are stored. If
specified, it will be cleaned durin | 7,648 |
g the reset process.
criSocket
stringcriSocket is used to retrieve container runtime inforomation and used for
the removal of the containers. If criSocket is not specified by flag or
config file, kubeadm will try to detect one valid CRI socket instead.
dryRun
booldryRun tells if the dry run mode is enabled, don't apply any change if it
is set and just output what would be done.
force
boolThe force flag instructs kubeadm to reset the node without prompting for
confirmation.
ignorePreflightErrors
[]stringignorePreflightErrors provides a list of pre-flight errors to be ignored
during the reset process, e.g. IsPrivilegedUser,Swap . Value all ignores
errors from all checks | 7,649 |
Field Description
skipPhases
[]stringskipPhases is a list of phases to skip during command execution. The list
of phases can be obtained with the kubeadm reset phase --help
command.
APIEndpoint
Appears in:
InitConfiguration
JoinControlPlane
APIEndpoint struct contains elements of API server instance deployed on a node.
Field Description
advertiseAddress
stringdvertiseAddress sets the IP address for the API server to advertise.
bindPort
int32bindPort sets the secure port for the API Server to bind to. Defaults to 6443.
APIServer
Appears in:
ClusterConfiguration
APIServer holds settings necessary for API server deployments in the cluster
Field Description
ControlPlaneComponent
[Required]
ControlPlaneComponent(Members of ControlPlaneComponent are embedded into this
type.) No description provided.
certSANs
[]stringcertSANs sets extra Subject Alternative Names (SANs) for the
API Server signing certificate.
timeoutForControlPlane
meta/v1.DurationtimeoutForControlPlane controls the ti | 7,650 |
meout that we use for
API server to appear.
Arg
Appears in:
ControlPlaneComponent•
•
•
| 7,651 |
LocalEtcd
NodeRegistrationOptions
Arg represents an argument with a name and a value.
Field Description
name [Required]
stringThe name of the argument.
value [Required]
stringThe value of the argument.
BootstrapTokenDiscovery
Appears in:
Discovery
BootstrapTokenDiscovery is used to set the options for bootstrap token based discovery.
Field Description
token [Required]
stringtoken is a token used to validate cluster information fetched from the
control-plane.
apiServerEndpoint
stringapiServerEndpoint is an IP or domain name to the API server from
which information will be fetched.
caCertHashes
[]stringcaCertHashes specifies a set of public key pins to verify when token-
based discovery is used. The root CA found during discovery must
match one of these values. Specifying an empty set disables root CA
pinning, which can be unsafe. Each hash is specified as
<type>:<value> , where the only currently supported type is "sha256".
This is a hex-encoded SHA-256 hash of the Subject Public | 7,652 |
Key Info
(SPKI) object in DER-encoded ASN.1. These hashes can be //
calculated using, for example, OpenSSL.
unsafeSkipCAVerification
boolunsafeSkipCAVerification allows token-based discovery without CA
verification via caCertHashes . This can weaken the security of
kubeadm since other nodes can impersonate the control-plane.
ControlPlaneComponent
Appears in:
ClusterConfiguration•
•
•
| 7,653 |
APIServer
ControlPlaneComponent holds settings common to control plane component of the cluster
Field Description
extraArgs
[]ArgextraArgs is an extra set of flags to pass to the control plane component. An
argument name in this list is the flag name as it appears on the command
line except without leading dash(es). Extra arguments will override existing
default arguments. Duplicate extra arguments are allowed.
extraVolumes
[]HostPathMountextraVolumes is an extra set of host volumes, mounted to the control plane
component.
extraEnvs
[]EnvVarextraEnvs is an extra set of environment variables to pass to the control
plane component. Environment variables passed using extraEnvs will
override any existing environment variables, or *_proxy environment
variables that kubeadm adds by default.
DNS
Appears in:
ClusterConfiguration
DNS defines the DNS addon that should be used in the cluster
Field Description
ImageMeta [Required]
ImageMeta(Members of ImageMeta are embedded into this type.) | 7,654 |
imageMeta allows to customize the image used for the DNS addon.
disabled [Required]
booldisabled specifies whether to disable this addon in the cluster.
Discovery
Appears in:
JoinConfiguration
Discovery specifies the options for the kubelet to use during the TLS Bootstrap process
Field Description
bootstrapToken
BootstrapTokenDiscoverybootstrapToken is used to set the options for bootstrap token based
discovery. bootstrapToken and file are mutually exclusive.•
•
| 7,655 |
Field Description
file
FileDiscoveryfile is used to specify a file or URL to a kubeconfig file from which to
load cluster information. bootstrapToken and file are mutually
exclusive.
tlsBootstrapToken
stringtlsBootstrapToken is a token used for TLS bootstrapping. If
bootstrapToken is set, this field is defaulted to bootstrapToken.token ,
but can be overridden. If file is set, this field must be set in case the
KubeConfigFile does not contain any other authentication
information.
timeout
meta/v1.Durationtimeout modifies the discovery timeout.
EncryptionAlgorithmType
(Alias of string )
Appears in:
ClusterConfiguration
EncryptionAlgorithmType can define an asymmetric encryption algorithm type.
EnvVar
Appears in:
ControlPlaneComponent
LocalEtcd
EnvVar represents an environment variable present in a Container.
Field Description
EnvVar
[Required]
core/v1.EnvVar(Members of EnvVar are embedded into this type.) No description
provided.
Etcd
Appears in:
ClusterConfiguration
Etcd contain | 7,656 |
s elements describing Etcd configuration.•
•
•
| 7,657 |
Field Description
local
LocalEtcdlocal provides configuration knobs for configuring the local etcd instance. local
and external are mutually exclusive.
external
ExternalEtcdexternal describes how to connect to an external etcd cluster. local and external
are mutually exclusive.
ExternalEtcd
Appears in:
Etcd
ExternalEtcd describes an external etcd cluster. Kubeadm has no knowledge of where certificate
files live and they must be supplied.
Field Description
endpoints
[Required]
[]stringendpoints contains the list of etcd members.
caFile
[Required]
stringcaFile is an SSL Certificate Authority (CA) file used to secure etcd
communication. Required if using a TLS connection.
certFile
[Required]
stringcertFile is an SSL certification file used to secure etcd communication.
Required if using a TLS connection.
keyFile
[Required]
stringkeyFile is an SSL key file used to secure etcd communication. Required if
using a TLS connection.
FileDiscovery
Appears in:
Discovery
FileDiscover | 7,658 |
y is used to specify a file or URL to a kubeconfig file from which to load cluster
information.
Field Description
kubeConfigPath
[Required]
stringkubeConfigPath is used to specify the actual file path or URL to the
kubeconfig file from which to load cluster information.•
| 7,659 |
HostPathMount
Appears in:
ControlPlaneComponent
HostPathMount contains elements describing volumes that are mounted from the host.
Field Description
name [Required]
stringname is the name of the volume inside the Pod template.
hostPath [Required]
stringhostPath is the path in the host that will be mounted inside the Pod.
mountPath [Required]
stringmountPath is the path inside the Pod where hostPath will be mounted.
readOnly
boolreadOnly controls write access to the volume.
pathType
core/v1.HostPathTypepathType is the type of the hostPath .
ImageMeta
Appears in:
DNS
LocalEtcd
ImageMeta allows to customize the image used for components that are not originated from the
Kubernetes/Kubernetes release process
Field Description
imageRepository
stringimageRepository sets the container registry to pull images from. if not set, the
imageRepository defined in ClusterConfiguration will be used instead.
imageTag
stringimageTag allows to specify a tag for the image. In case this value i | 7,660 |
s set,
kubeadm does not change automatically the version of the above components
during upgrades.
JoinControlPlane
Appears in:
JoinConfiguration•
•
•
| 7,661 |
JoinControlPlane contains elements describing an additional control plane instance to be
deployed on the joining node.
Field Description
localAPIEndpoint
APIEndpointlocalAPIEndpoint represents the endpoint of the API server instance to be
deployed on this node.
certificateKey
stringcertificateKey is the key that is used for decryption of certificates after they
are downloaded from the Secret upon joining a new control plane node. The
corresponding encryption key is in the InitConfiguration. The certificate key
is a hex encoded string that is an AES key of size 32 bytes.
LocalEtcd
Appears in:
Etcd
LocalEtcd describes that kubeadm should run an etcd cluster locally.
Field Description
ImageMeta
[Required]
ImageMeta(Members of ImageMeta are embedded into this type.)
ImageMeta allows to customize the container used for etcd
dataDir
[Required]
stringdataDir is the directory etcd will place its data. Defaults to "/var/lib/etcd".
extraArgs
[Required]
[]ArgextraArgs are extra argumen | 7,662 |
ts provided to the etcd binary when run inside a
static Pod. An argument name in this list is the flag name as it appears on
the command line except without leading dash(es). Extra arguments will
override existing default arguments. Duplicate extra arguments are allowed.
extraEnvs
[]EnvVarextraEnvs is an extra set of environment variables to pass to the control
plane component. Environment variables passed using extraEnvs will
override any existing environment variables, or *_proxy environment
variables that kubeadm adds by default.
serverCertSANs
[]stringserverCertSANs sets extra Subject Alternative Names (SANs) for the etcd
server signing certificate.
peerCertSANs
[]stringpeerCertSANs sets extra Subject Alternative Names (SANs) for the etcd peer
signing certificate. | 7,663 |
Networking
Appears in:
ClusterConfiguration
Networking contains elements describing cluster's networking configuration.
Field Description
serviceSubnet
stringserviceSubnet is the subnet used by Kubernetes Services. Defaults to
"10.96.0.0/12".
podSubnet
stringpodSubnet is the subnet used by Pods.
dnsDomain
stringdnsDomain is the dns domain used by Kubernetes Services. Defaults to
"cluster.local".
NodeRegistrationOptions
Appears in:
InitConfiguration
JoinConfiguration
NodeRegistrationOptions holds fields that relate to registering a new control-plane or node to
the cluster, either via kubeadm init or kubeadm join .
Field Description
name
stringname is the .Metadata.Name field of the Node API object that will be
created in this kubeadm init or kubeadm join operation. This field is also
used in the CommonName field of the kubelet's client certificate to the
API server. Defaults to the hostname of the node if not provided.
criSocket
stringcriSocket is used to retrieve container ru | 7,664 |
ntime info. This information will
be annotated to the Node API object, for later re-use.
taints [Required]
[]core/v1.Tainttaints specifies the taints the Node API object should be registered with.
If this field is unset, i.e. nil, it will be defaulted with a control-plane taint
for control-plane nodes. If you don't want to taint your control-plane
node, set this field to an empty list, i.e. taints: [] in the YAML file. This
field is solely used for Node registration.
kubeletExtraArgs
[]ArgkubeletExtraArgs passes through extra arguments to the kubelet. The
arguments here are passed to the kubelet command line via the•
•
| 7,665 |
Field Description
environment file kubeadm writes at runtime for the kubelet to source.
This overrides the generic base-level configuration in the kubelet-config
ConfigMap. Flags have higher priority when parsing. These values are
local and specific to the node kubeadm is executing on. An argument
name in this list is the flag name as it appears on the command line
except without leading dash(es). Extra arguments will override existing
default arguments. Duplicate extra arguments are allowed.
ignorePreflightErrors
[]stringignorePreflightErrors provides a slice of pre-flight errors to be ignored
when the current node is registered, e.g. 'IsPrivilegedUser,Swap'. Value
'all' ignores errors from all checks.
imagePullPolicy
core/v1.PullPolicyimagePullPolicy specifies the policy for image pulling during kubeadm
init and join operations. The value of this field must be one of "Always",
"IfNotPresent" or "Never". If this field is unset kubeadm will default it to
"IfNotPresent", or pull the | 7,666 |
required images if not present on the host.
Patches
Appears in:
InitConfiguration
JoinConfiguration
Patches contains options related to applying patches to components deployed by kubeadm.
Field Description
directory
stringdirectory is a path to a directory that contains files named "target[suffix]
[+patchtype].extension". For example, "kube-apiserver0+merge.yaml" or just
"etcd.json". "target" can be one of "kube-apiserver", "kube-controller-manager", "kube-
scheduler", "etcd", "kubeletconfiguration". "patchtype" can be one of "strategic",
"merge" or "json" and they match the patch formats supported by kubectl. The default
"patchtype" is "strategic". "extension" must be either "json" or "yaml". "suffix" is an
optional string that can be used to determine which patches are applied first alpha-
numerically.
Proxy
Appears in:
ClusterConfiguration
Proxy defines the proxy addon that should be used in the cluster.•
•
| 7,667 |
Field Description
disabled [Required]
booldisabled specifies whether to disable this addon in the cluster.
kubeconfig (v1)
Resource Types
Config
Config
Config holds the information needed to build connect to remote kubernetes clusters as a given
user
Field Description
apiVersion
string/v1
kind
stringConfig
kind
stringLegacy field from pkg/api/types.go TypeMeta. TODO(jlowdermilk):
remove this after eliminating downstream dependencies.
apiVersion
stringLegacy field from pkg/api/types.go TypeMeta. TODO(jlowdermilk):
remove this after eliminating downstream dependencies.
preferences
[Required]
PreferencesPreferences holds general information to be use for cli interactions
clusters [Required]
[]NamedClusterClusters is a map of referencable names to cluster configs
users [Required]
[]NamedAuthInfoAuthInfos is a map of referencable names to user configs
contexts [Required]
[]NamedContextContexts is a map of referencable names to context configs
current-context
[Required]
stringCurren | 7,668 |
tContext is the name of the context that you would like to use
by default
extensions
[]NamedExtensionExtensions holds additional information. This is useful for extenders so
that reads and writes don't clobber unknown fields | 7,669 |
AuthInfo
Appears in:
NamedAuthInfo
AuthInfo contains information that describes identity information. This is use to tell the
kubernetes cluster who you are.
Field Description
client-certificate
stringClientCertificate is the path to a client cert file for TLS.
client-certificate-
data
[]byteClientCertificateData contains PEM-encoded data from a client cert file
for TLS. Overrides ClientCertificate
client-key
stringClientKey is the path to a client key file for TLS.
client-key-data
[]byteClientKeyData contains PEM-encoded data from a client key file for TLS.
Overrides ClientKey
token
stringToken is the bearer token for authentication to the kubernetes cluster.
tokenFile
stringTokenFile is a pointer to a file that contains a bearer token (as described
above). If both Token and TokenFile are present, Token takes precedence.
as
stringImpersonate is the username to impersonate. The name matches the flag.
as-uid
stringImpersonateUID is the uid to impersonate.
as-groups
[]stringImpersonateGr | 7,670 |
oups is the groups to impersonate.
as-user-extra
map[string][]stringImpersonateUserExtra contains additional information for impersonated
user.
username
stringUsername is the username for basic authentication to the kubernetes
cluster.
password
stringPassword is the password for basic authentication to the kubernetes
cluster. | 7,671 |
Field Description
auth-provider
AuthProviderConfigAuthProvider specifies a custom authentication plugin for the kubernetes
cluster.
exec
ExecConfigExec specifies a custom exec-based authentication plugin for the
kubernetes cluster.
extensions
[]NamedExtensionExtensions holds additional information. This is useful for extenders so
that reads and writes don't clobber unknown fields
AuthProviderConfig
Appears in:
AuthInfo
AuthProviderConfig holds the configuration for a specified auth provider.
Field Description
name [Required]
stringNo description provided.
config [Required]
map[string]stringNo description provided.
Cluster
Appears in:
NamedCluster
Cluster contains information about how to communicate with a kubernetes cluster
Field Description
server [Required]
stringServer is the address of the kubernetes cluster (https://hostname:port).
tls-server-name
stringTLSServerName is used to check server certificate. If TLSServerName is
empty, the hostname used to contact the server is used | 7,672 |
.
insecure-skip-tls-
verify
boolInsecureSkipTLSVerify skips the validity check for the server's certificate.
This will make your HTTPS connections insecure.
certificate-
authority
stringCertificateAuthority is the path to a cert file for the certificate authority.•
| 7,673 |
Field Description
certificate-
authority-data
[]byteCertificateAuthorityData contains PEM-encoded certificate authority
certificates. Overrides CertificateAuthority
proxy-url
stringProxyURL is the URL to the proxy to be used for all requests made by this
client. URLs with "http", "https", and "socks5" schemes are supported. If this
configuration is not provided or the empty string, the client attempts to
construct a proxy configuration from http_proxy and https_proxy
environment variables. If these environment variables are not set, the
client does not attempt to proxy requests.
socks5 proxying does not currently support spdy streaming endpoints
(exec, attach, port forward).
disable-
compression
boolDisableCompression allows client to opt-out of response compression for
all requests to the server. This is useful to speed up requests (specifically
lists) when client-server network bandwidth is ample, by saving time on
compression (server-side) and decompression (client-side): https://
g | 7,674 |
ithub.com/kubernetes/kubernetes/issues/112296.
extensions
[]NamedExtensionExtensions holds additional information. This is useful for extenders so
that reads and writes don't clobber unknown fields
Context
Appears in:
NamedContext
Context is a tuple of references to a cluster (how do I communicate with a kubernetes cluster), a
user (how do I identify myself), and a namespace (what subset of resources do I want to work
with)
Field Description
cluster
[Required]
stringCluster is the name of the cluster for this context
user [Required]
stringAuthInfo is the name of the authInfo for this context
namespace
stringNamespace is the default namespace to use on unspecified requests
extensions
[]NamedExtensionExtensions holds additional information. This is useful for extenders so that
reads and writes don't clobber unknown fields | 7,675 |
ExecConfig
Appears in:
AuthInfo
ExecConfig specifies a command to provide client credentials. The command is exec'd and
outputs structured stdout holding credentials.
See the client.authentication.k8s.io API group for specifications of the exact input and output
format
Field Description
command
[Required]
stringCommand to execute.
args
[]stringArguments to pass to the command when executing it.
env
[]ExecEnvVarEnv defines additional environment variables to expose to the process.
These are unioned with the host's environment, as well as variables
client-go uses to pass argument to the plugin.
apiVersion
[Required]
stringPreferred input version of the ExecInfo. The returned ExecCredentials
MUST use the same encoding version as the input.
installHint
[Required]
stringThis text is shown to the user when the executable doesn't seem to be
present. For example, brew install foo-cli might be a good InstallHint for
foo-cli on Mac OS systems.
provideClusterInfo
[Required]
boolProvideCl | 7,676 |
usterInfo determines whether or not to provide cluster
information, which could potentially contain very large CA data, to this
exec plugin as a part of the KUBERNETES_EXEC_INFO environment
variable. By default, it is set to false. Package k8s.io/client-go/tools/
auth/exec provides helper methods for reading this environment
variable.
interactiveMode
ExecInteractiveModeInteractiveMode determines this plugin's relationship with standard
input. Valid values are "Never" (this exec plugin never uses standard
input), "IfAvailable" (this exec plugin wants to use standard input if it is
available), or "Always" (this exec plugin requires standard input to
function). See ExecInteractiveMode values for more details.
If APIVersion is client.authentication.k8s.io/v1alpha1 or
client.authentication.k8s.io/v1beta1, then this field is optional and
defaults to "IfAvailable" when unset. Otherwise, this field is required. | 7,677 |
ExecEnvVar
Appears in:
ExecConfig
ExecEnvVar is used for setting environment variables when executing an exec-based credential
plugin.
Field Description
name [Required]
stringNo description provided.
value [Required]
stringNo description provided.
ExecInteractiveMode
(Alias of string )
Appears in:
ExecConfig
ExecInteractiveMode is a string that describes an exec plugin's relationship with standard input.
NamedAuthInfo
Appears in:
Config
NamedAuthInfo relates nicknames to auth information
Field Description
name [Required]
stringName is the nickname for this AuthInfo
user [Required]
AuthInfoAuthInfo holds the auth information
NamedCluster
Appears in:
Config
NamedCluster relates nicknames to cluster information•
•
•
• | 7,678 |
Field Description
name [Required]
stringName is the nickname for this Cluster
cluster [Required]
ClusterCluster holds the cluster information
NamedContext
Appears in:
Config
NamedContext relates nicknames to context information
Field Description
name [Required]
stringName is the nickname for this Context
context [Required]
ContextContext holds the context information
NamedExtension
Appears in:
Config
AuthInfo
Cluster
Context
Preferences
NamedExtension relates nicknames to extension information
Field Description
name [Required]
stringName is the nickname for this Extension
extension [Required]
k8s.io/apimachinery/pkg/runtime.RawExtensionExtension holds the extension information•
•
•
•
•
• | 7,679 |
Preferences
Appears in:
Config
Field Description
colors
boolNo description provided.
extensions
[]NamedExtensionExtensions holds additional information. This is useful for extenders so that
reads and writes don't clobber unknown fields
Kubelet Configuration (v1)
Resource Types
CredentialProviderConfig
CredentialProviderConfig
CredentialProviderConfig is the configuration containing information about each exec
credential provider. Kubelet reads this configuration from disk and enables each provider as
specified by the CredentialProvider type.
Field Description
apiVersion
stringkubelet.config.k8s.io/v1
kind
stringCredentialProviderConfig
providers
[Required]
[]CredentialProviderproviders is a list of credential provider plugins that will be enabled by
the kubelet. Multiple providers may match against a single image, in
which case credentials from all providers will be returned to the kubelet.
If multiple providers are called for a single image, the results are
combined. If providers re | 7,680 |
turn overlapping auth keys, the value from the
provider earlier in this list is used.
CredentialProvider
Appears in:
CredentialProviderConfig
CredentialProvider represents an exec plugin to be invoked by the kubelet. The plugin is only
invoked when an image being pulled matches the images handled by the plugin (see
matchImages).•
•
| 7,681 |
Field Description
name [Required]
stringname is the required name of the credential provider. It must match the
name of the provider executable as seen by the kubelet. The executable
must be in the kubelet's bin directory (set by the --image-credential-
provider-bin-dir flag).
matchImages
[Required]
[]stringmatchImages is a required list of strings used to match against images
in order to determine if this provider should be invoked. If one of the
strings matches the requested image from the kubelet, the plugin will
be invoked and given a chance to provide credentials. Images are
expected to contain the registry domain and URL 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 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 a single
| 7,682 |
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:
Both contain the same number of domain parts and each part
matches.
The URL path of an imageMatch must be a prefix of the target
image URL path.
If the imageMatch contains a port, then the port must match in
the image as well.
Example values of matchImages:
123456789.dkr.ecr.us-east-1.amazonaws.com
*.azurecr.io
gcr.io
..registry.io
registry.io:8080/path
defaultCacheDuration
[Required]
meta/v1.DurationdefaultCacheDuration is the default duration the plugin will cache
credentials in-memory if a cache duration is not provided in the plugin
response. This field is required.
apiVersion
[Required]
stringRequired input version of the exec CredentialProviderRequest. The
returned CredentialProviderResponse MUST use the same encoding
version as the input. Current supported values are:
credentialprovider.kubelet.k8s.io/v1
args
[]stringArguments to pass to the co | 7,683 |
mmand when executing it.•
•
•
•
•
•
•
•
| 7,684 |
Field Description
env
[]ExecEnvVarEnv defines additional environment variables to expose to the process.
These are unioned with the host's environment, as well as variables
client-go uses to pass argument to the plugin.
ExecEnvVar
Appears in:
CredentialProvider
ExecEnvVar is used for setting environment variables when executing an exec-based credential
plugin.
Field Description
name [Required]
stringNo description provided.
value [Required]
stringNo description provided.
Kubelet Configuration (v1alpha1)
Resource Types
CredentialProviderConfig
CredentialProviderConfig
CredentialProviderConfig is the configuration containing information about each exec
credential provider. Kubelet reads this configuration from disk and enables each provider as
specified by the CredentialProvider type.
Field Description
apiVersion
stringkubelet.config.k8s.io/v1alpha1
kind
stringCredentialProviderConfig
providers
[Required]
[]CredentialProviderproviders is a list of credential provider plugins that wil | 7,685 |
l be enabled by
the kubelet. Multiple providers may match against a single image, in
which case credentials from all providers will be returned to the kubelet.
If multiple providers are called for a single image, the results are
combined. If providers return overlapping auth keys, the value from the
provider earlier in this list is used.•
| 7,686 |
CredentialProvider
Appears in:
CredentialProviderConfig
CredentialProvider represents an exec plugin to be invoked by the kubelet. The plugin is only
invoked when an image being pulled matches the images handled by the plugin (see
matchImages).
Field Description
name [Required]
stringname is the required name of the credential provider. It must match the
name of the provider executable as seen by the kubelet. The executable
must be in the kubelet's bin directory (set by the --image-credential-
provider-bin-dir flag).
matchImages
[Required]
[]stringmatchImages is a required list of strings used to match against images
in order to determine if this provider should be invoked. If one of the
strings matches the requested image from the kubelet, the plugin will
be invoked and given a chance to provide credentials. Images are
expected to contain the registry domain and URL path.
Each entry in matchImages is a pattern which can optionally contain a
port and a path. Globs can be used in the | 7,687 |
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.*. 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 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.
The URL path of an imageMatch must be a prefix of the target
image URL path.
If the imageMatch contains a port, then the port must match in
the image as well.
Example values of matchImages:
123456789.dkr.ecr.us-east-1.amazonaws.com
*.azurecr.io
gcr.io
*.*.registry.io
registry.io:8080/path•
•
•
•
•
•
•
•
| 7,688 |
Field Description
defaultCacheDuration
[Required]
meta/v1.DurationdefaultCacheDuration is the default duration the plugin will cache
credentials in-memory if a cache duration is not provided in the plugin
response. This field is required.
apiVersion
[Required]
stringRequired input version of the exec CredentialProviderRequest. The
returned CredentialProviderResponse MUST use the same encoding
version as the input. Current supported values are:
credentialprovider.kubelet.k8s.io/v1alpha1
args
[]stringArguments to pass to the command when executing it.
env
[]ExecEnvVarEnv defines additional environment variables to expose to the process.
These are unioned with the host's environment, as well as variables
client-go uses to pass argument to the plugin.
ExecEnvVar
Appears in:
CredentialProvider
ExecEnvVar is used for setting environment variables when executing an exec-based credential
plugin.
Field Description
name [Required]
stringNo description provided.
value [Required]
stringNo de | 7,689 |
scription provided.
Kubelet Configuration (v1beta1)
Resource Types
CredentialProviderConfig
KubeletConfiguration
SerializedNodeConfigSource
FormatOptions
Appears in:
LoggingConfiguration•
•
•
•
•
| 7,690 |
FormatOptions contains options for the different logging formats.
Field Description
json
[Required]
JSONOptions[Alpha] JSON contains options for logging format "json". Only available when
the LoggingAlphaOptions feature gate is enabled.
JSONOptions
Appears in:
FormatOptions
JSONOptions contains options for logging format "json".
Field Description
splitStream [Required]
bool[Alpha] SplitStream redirects error messages to stderr while info
messages go to stdout, with buffering. The default is to write
both to stdout, without buffering. Only available when the
LoggingAlphaOptions feature gate is enabled.
infoBufferSize [Required]
k8s.io/apimachinery/pkg/api/
resource.QuantityValue[Alpha] InfoBufferSize sets the size of the info stream when
using split streams. The default is zero, which disables buffering.
Only available when the LoggingAlphaOptions feature gate is
enabled.
LogFormatFactory
LogFormatFactory provides support for a certain additional, non-default log format.
LoggingConfi | 7,691 |
guration
Appears in:
KubeletConfiguration
LoggingConfiguration contains logging options.
Field Description
format [Required]
stringFormat Flag specifies the structure of log messages. default value of
format is text
flushFrequency
[Required]
TimeOrMetaDurationMaximum time between log flushes. If a string, parsed as a duration
(i.e. "1s") If an int, the maximum number of nanoseconds (i.e. 1s =•
| 7,692 |
Field Description
1000000000). Ignored if the selected logging backend writes log
messages without buffering.
verbosity [Required]
VerbosityLevelVerbosity is the threshold that determines which log messages are
logged. Default is zero which logs only the most important messages.
Higher values enable additional messages. Error messages are always
logged.
vmodule [Required]
VModuleConfigurationVModule overrides the verbosity threshold for individual files. Only
supported for "text" log format.
options [Required]
FormatOptions[Alpha] Options holds additional parameters that are specific to the
different logging formats. Only the options for the selected format get
used, but all of them get validated. Only available when the
LoggingAlphaOptions feature gate is enabled.
LoggingOptions
LoggingOptions can be used with ValidateAndApplyWithOptions to override certain global
defaults.
Field Description
ErrorStream [Required]
io.WriterErrorStream can be used to override the os.Stderr default. | 7,693 |
InfoStream [Required]
io.WriterInfoStream can be used to override the os.Stdout default.
TimeOrMetaDuration
Appears in:
LoggingConfiguration
TimeOrMetaDuration is present only for backwards compatibility for the flushFrequency field,
and new fields should use metav1.Duration.
Field Description
Duration
[Required]
meta/v1.DurationDuration holds the duration
- [Required]
boolSerializeAsString controls whether the value is serialized as a string or an
integer | 7,694 |
TracingConfiguration
Appears in:
KubeletConfiguration
TracingConfiguration provides versioned configuration for OpenTelemetry tracing clients.
Field Description
endpoint
stringEndpoint of the collector this component will report traces to. The
connection is insecure, and does not currently support TLS.
Recommended is unset, and endpoint is the otlp grpc default,
localhost:4317.
samplingRatePerMillion
int32SamplingRatePerMillion is the number of samples to collect per
million spans. Recommended is unset. If unset, sampler respects its
parent span's sampling rate, but otherwise never samples.
VModuleConfiguration
(Alias of []k8s.io/component-base/logs/api/v1.VModuleItem )
Appears in:
LoggingConfiguration
VModuleConfiguration is a collection of individual file names or patterns and the
corresponding verbosity threshold.
VerbosityLevel
(Alias of uint32 )
Appears in:
LoggingConfiguration
VerbosityLevel represents a klog or logr verbosity threshold.
CredentialProviderConfig
CredentialProvide | 7,695 |
rConfig is the configuration containing information about each exec
credential provider. Kubelet reads this configuration from disk and enables each provider as
specified by the CredentialProvider type.
Field Description
apiVersion
stringkubelet.config.k8s.io/v1beta1•
•
| 7,696 |
Field Description
kind
stringCredentialProviderConfig
providers
[Required]
[]CredentialProviderproviders is a list of credential provider plugins that will be enabled by
the kubelet. Multiple providers may match against a single image, in
which case credentials from all providers will be returned to the kubelet.
If multiple providers are called for a single image, the results are
combined. If providers return overlapping auth keys, the value from the
provider earlier in this list is used.
KubeletConfiguration
KubeletConfiguration contains the configuration for the Kubelet
Field Description
apiVersion
stringkubelet.config.k8s.io/v1beta1
kind
stringKubeletConfiguration
enableServer [Required]
boolenableServer enables Kubelet's secured server.
Note: Kubelet's insecure port is controlled by the
readOnlyPort option. Default: true
staticPodPath
stringstaticPodPath is the path to the directory
containing local (static) pods to run, or the path to
a single static pod file. Default: ""
syncF | 7,697 |
requency
meta/v1.DurationsyncFrequency is the max period between
synchronizing running containers and config.
Default: "1m"
fileCheckFrequency
meta/v1.DurationfileCheckFrequency is the duration between
checking config files for new data. Default: "20s"
httpCheckFrequency
meta/v1.DurationhttpCheckFrequency is the duration between
checking http for new data. Default: "20s"
staticPodURL
stringstaticPodURL is the URL for accessing static pods
to run. Default: " | 7,698 |
Field Description
staticPodURLHeader
map[string][]stringstaticPodURLHeader is a map of slices with HTTP
headers to use when accessing the podURL.
Default: nil
address
stringaddress is the IP address for the Kubelet to serve
on (set to 0.0.0.0 for all interfaces). Default:
"0.0.0.0"
port
int32port is the port for the Kubelet to serve on. The
port number must be between 1 and 65535,
inclusive. Default: 10250
readOnlyPort
int32readOnlyPort is the read-only port for the Kubelet
to serve on with no authentication/authorization.
The port number must be between 1 and 65535,
inclusive. Setting this field to 0 disables the read-
only service. Default: 0 (disabled)
tlsCertFile
stringtlsCertFile is the file containing x509 Certificate for
HTTPS. (CA cert, if any, concatenated after server
cert). If tlsCertFile and tlsPrivateKeyFile are not
provided, a self-signed certificate and key are
generated for the public address and saved to the
directory passed to the Kubelet's --cert-dir flag.
Default: " | 7,699 |