Documentation ¶
Index ¶
- Constants
- Variables
- func EvacuateCgroup2() error
- func InitLogging() error
- func MustValidateGolang()
- func NewAgentCommand(action func(ctx *cli.Context) error) cli.Command
- func NewApp() *cli.App
- func NewCRICTL(action func(*cli.Context) error) cli.Command
- func NewCertCommands(rotate, rotateCA func(ctx *cli.Context) error) cli.Command
- func NewCheckConfigCommand(action func(*cli.Context) error) cli.Command
- func NewCompletionCommand(action func(*cli.Context) error) cli.Command
- func NewCtrCommand(action func(*cli.Context) error) cli.Command
- func NewEtcdSnapshotCommands(delete, list, prune, save func(ctx *cli.Context) error) cli.Command
- func NewKubectlCommand(action func(*cli.Context) error) cli.Command
- func NewSecretsEncryptCommands(...) cli.Command
- func NewServerCommand(action func(*cli.Context) error) cli.Command
- func NewTokenCommands(create, delete, generate, list, rotate func(ctx *cli.Context) error) cli.Command
- func ValidateGolang() error
- func WriteCoverage(ctx context.Context)
- type Agent
- type AgentShared
- type CertRotateCA
- type Log
- type Server
- type StartupHook
- type StartupHookArgs
- type Token
Constants ¶
View Source
const ( DefaultPauseImage = "rancher/mirrored-pause:3.6" DefaultSnapshotter = "overlayfs" )
View Source
const CertCommand = "certificate"
View Source
const ( // coredns and servicelb run controllers that are turned off when their manifests are disabled. // The k3s CloudController also has a bundled manifest and can be disabled via the // --disable-cloud-controller flag or --disable=ccm, but the latter method is not documented. DisableItems = "coredns, servicelb, traefik, local-storage, metrics-server, runtimes" )
View Source
const EtcdSnapshotCommand = "etcd-snapshot"
View Source
const SecretsEncryptCommand = "secrets-encrypt"
View Source
const TokenCommand = "token"
Variables ¶
View Source
var ( AgentConfig Agent AgentTokenFlag = &cli.StringFlag{ Name: "token,t", Usage: "(cluster) Token to use for authentication", EnvVar: version.ProgramUpper + "_TOKEN", Destination: &AgentConfig.Token, } NodeIPFlag = &cli.StringSliceFlag{ Name: "node-ip,i", Usage: "(agent/networking) IPv4/IPv6 addresses to advertise for node", Value: &AgentConfig.NodeIP, } NodeExternalIPFlag = &cli.StringSliceFlag{ Name: "node-external-ip", Usage: "(agent/networking) IPv4/IPv6 external IP addresses to advertise for node", Value: &AgentConfig.NodeExternalIP, } NodeNameFlag = &cli.StringFlag{ Name: "node-name", Usage: "(agent/node) Node name", EnvVar: version.ProgramUpper + "_NODE_NAME", Destination: &AgentConfig.NodeName, } WithNodeIDFlag = &cli.BoolFlag{ Name: "with-node-id", Usage: "(agent/node) Append id to node name", Destination: &AgentConfig.WithNodeID, } ProtectKernelDefaultsFlag = &cli.BoolFlag{ Name: "protect-kernel-defaults", Usage: "(agent/node) Kernel tuning behavior. If set, error if kernel tunables are different than kubelet defaults.", Destination: &AgentConfig.ProtectKernelDefaults, } SELinuxFlag = &cli.BoolFlag{ Name: "selinux", Usage: "(agent/node) Enable SELinux in containerd", Destination: &AgentConfig.EnableSELinux, EnvVar: version.ProgramUpper + "_SELINUX", } NoPivotRootFlag = &cli.BoolFlag{ Name: "no-pivot-root", Usage: "(agent/node) NoPivotRoot disables pivot root when creating a container", Destination: &AgentConfig.NoPivotRoot, EnvVar: version.ProgramUpper + "_NO_PIVOT_ROOT", } LBServerPortFlag = &cli.IntFlag{ Name: "lb-server-port", Usage: "(agent/node) Local port for supervisor client load-balancer. If the supervisor and apiserver are not colocated an additional port 1 less than this port will also be used for the apiserver client load-balancer.", Destination: &AgentConfig.LBServerPort, EnvVar: version.ProgramUpper + "_LB_SERVER_PORT", Value: 6444, } DockerFlag = &cli.BoolFlag{ Name: "docker", Usage: "(agent/runtime) (experimental) Use cri-dockerd instead of containerd", Destination: &AgentConfig.Docker, } CRIEndpointFlag = &cli.StringFlag{ Name: "container-runtime-endpoint", Usage: "(agent/runtime) Disable embedded containerd and use the CRI socket at the given path; when used with --docker this sets the docker socket path", Destination: &AgentConfig.ContainerRuntimeEndpoint, } DefaultRuntimeFlag = &cli.StringFlag{ Name: "default-runtime", Usage: "(agent/runtime) Set the default runtime in containerd", Destination: &AgentConfig.DefaultRuntime, } ImageServiceEndpointFlag = &cli.StringFlag{ Name: "image-service-endpoint", Usage: "(agent/runtime) Disable embedded containerd image service and use remote image service socket at the given path. If not specified, defaults to --container-runtime-endpoint.", Destination: &AgentConfig.ImageServiceEndpoint, } PrivateRegistryFlag = &cli.StringFlag{ Name: "private-registry", Usage: "(agent/runtime) Private registry configuration file", Destination: &AgentConfig.PrivateRegistry, Value: "/etc/rancher/" + version.Program + "/registries.yaml", } AirgapExtraRegistryFlag = &cli.StringSliceFlag{ Name: "airgap-extra-registry", Usage: "(agent/runtime) Additional registry to tag airgap images as being sourced from", Value: &AgentConfig.AirgapExtraRegistry, Hidden: true, } PauseImageFlag = &cli.StringFlag{ Name: "pause-image", Usage: "(agent/runtime) Customized pause image for containerd or docker sandbox", Destination: &AgentConfig.PauseImage, Value: DefaultPauseImage, } SnapshotterFlag = &cli.StringFlag{ Name: "snapshotter", Usage: "(agent/runtime) Override default containerd snapshotter", Destination: &AgentConfig.Snapshotter, Value: DefaultSnapshotter, } FlannelIfaceFlag = &cli.StringFlag{ Name: "flannel-iface", Usage: "(agent/networking) Override default flannel interface", Destination: &AgentConfig.FlannelIface, } FlannelConfFlag = &cli.StringFlag{ Name: "flannel-conf", Usage: "(agent/networking) Override default flannel config file", Destination: &AgentConfig.FlannelConf, } FlannelCniConfFileFlag = &cli.StringFlag{ Name: "flannel-cni-conf", Usage: "(agent/networking) Override default flannel cni config file", Destination: &AgentConfig.FlannelCniConfFile, } VPNAuth = &cli.StringFlag{ Name: "vpn-auth", Usage: "(agent/networking) (experimental) Credentials for the VPN provider. It must include the provider name and join key in the format name=<vpn-provider>,joinKey=<key>[,controlServerURL=<url>][,extraArgs=<args>]", EnvVar: version.ProgramUpper + "_VPN_AUTH", Destination: &AgentConfig.VPNAuth, } VPNAuthFile = &cli.StringFlag{ Name: "vpn-auth-file", Usage: "(agent/networking) (experimental) File containing credentials for the VPN provider. It must include the provider name and join key in the format name=<vpn-provider>,joinKey=<key>[,controlServerURL=<url>][,extraArgs=<args>]", EnvVar: version.ProgramUpper + "_VPN_AUTH_FILE", Destination: &AgentConfig.VPNAuthFile, } ResolvConfFlag = &cli.StringFlag{ Name: "resolv-conf", Usage: "(agent/networking) Kubelet resolv.conf file", EnvVar: version.ProgramUpper + "_RESOLV_CONF", Destination: &AgentConfig.ResolvConf, } ExtraKubeletArgs = &cli.StringSliceFlag{ Name: "kubelet-arg", Usage: "(agent/flags) Customized flag for kubelet process", Value: &AgentConfig.ExtraKubeletArgs, } ExtraKubeProxyArgs = &cli.StringSliceFlag{ Name: "kube-proxy-arg", Usage: "(agent/flags) Customized flag for kube-proxy process", Value: &AgentConfig.ExtraKubeProxyArgs, } NodeTaints = &cli.StringSliceFlag{ Name: "node-taint", Usage: "(agent/node) Registering kubelet with set of taints", Value: &AgentConfig.Taints, } NodeLabels = &cli.StringSliceFlag{ Name: "node-label", Usage: "(agent/node) Registering and starting kubelet with set of labels", Value: &AgentConfig.Labels, } ImageCredProvBinDirFlag = &cli.StringFlag{ Name: "image-credential-provider-bin-dir", Usage: "(agent/node) The path to the directory where credential provider plugin binaries are located", Destination: &AgentConfig.ImageCredProvBinDir, Value: "/var/lib/rancher/credentialprovider/bin", } ImageCredProvConfigFlag = &cli.StringFlag{ Name: "image-credential-provider-config", Usage: "(agent/node) The path to the credential provider plugin config file", Destination: &AgentConfig.ImageCredProvConfig, Value: "/var/lib/rancher/credentialprovider/config.yaml", } DisableAgentLBFlag = &cli.BoolFlag{ Name: "disable-apiserver-lb", Usage: "(agent/networking) (experimental) Disable the agent's client-side load-balancer and connect directly to the configured server address", Destination: &AgentConfig.DisableLoadBalancer, } DisableDefaultRegistryEndpointFlag = &cli.BoolFlag{ Name: "disable-default-registry-endpoint", Usage: "(agent/containerd) Disables containerd's fallback default registry endpoint when a mirror is configured for that registry", Destination: &AgentConfig.ContainerdNoDefault, } )
View Source
var ( ServicesList cli.StringSlice CertRotateCAConfig CertRotateCA CertRotateCommandFlags = []cli.Flag{ DebugFlag, ConfigFlag, LogFile, AlsoLogToStderr, DataDirFlag, &cli.StringSliceFlag{ Name: "service,s", Usage: "List of services to rotate certificates for. Options include (admin, api-server, controller-manager, scheduler, " + version.Program + "-controller, " + version.Program + "-server, cloud-controller, etcd, auth-proxy, kubelet, kube-proxy)", Value: &ServicesList, }, } CertRotateCACommandFlags = []cli.Flag{ cli.StringFlag{ Name: "server,s", Usage: "(cluster) Server to connect to", EnvVar: version.ProgramUpper + "_URL", Value: "https://127.0.0.1:6443", Destination: &ServerConfig.ServerURL, }, cli.StringFlag{ Name: "data-dir,d", Usage: "(data) Folder to hold state default /var/lib/rancher/" + version.Program + " or ${HOME}/.rancher/" + version.Program + " if not root", Destination: &ServerConfig.DataDir, }, cli.StringFlag{ Name: "path", Usage: "Path to directory containing new CA certificates", Destination: &CertRotateCAConfig.CACertPath, Required: true, }, cli.BoolFlag{ Name: "force", Usage: "Force certificate replacement, even if consistency checks fail", Destination: &CertRotateCAConfig.Force, }, } )
View Source
var ( LogConfig Log VLevel = &cli.IntFlag{ Name: "v", Usage: "(logging) Number for the log level verbosity", Destination: &LogConfig.VLevel, } VModule = &cli.StringFlag{ Name: "vmodule", Usage: "(logging) Comma-separated list of FILE_PATTERN=LOG_LEVEL settings for file-filtered logging", Destination: &LogConfig.VModule, } LogFile = &cli.StringFlag{ Name: "log,l", Usage: "(logging) Log to file", Destination: &LogConfig.LogFile, } AlsoLogToStderr = &cli.BoolFlag{ Name: "alsologtostderr", Usage: "(logging) Log to standard error as well as file (if set)", Destination: &LogConfig.AlsoLogToStderr, } )
View Source
var ( Debug bool DebugFlag = &cli.BoolFlag{ Name: "debug", Usage: "(logging) Turn on debug logs", Destination: &Debug, EnvVar: version.ProgramUpper + "_DEBUG", } PreferBundledBin = &cli.BoolFlag{ Name: "prefer-bundled-bin", Usage: "(experimental) Prefer bundled userspace binaries over host binaries", } )
View Source
var ( ServerConfig Server DataDirFlag = &cli.StringFlag{ Name: "data-dir,d", Usage: "(data) Folder to hold state default /var/lib/rancher/" + version.Program + " or ${HOME}/.rancher/" + version.Program + " if not root", Destination: &ServerConfig.DataDir, } ServerToken = &cli.StringFlag{ Name: "token,t", Usage: "(cluster) Shared secret used to join a server or agent to a cluster", Destination: &ServerConfig.Token, EnvVar: version.ProgramUpper + "_TOKEN", } ClusterCIDR = &cli.StringSliceFlag{ Name: "cluster-cidr", Usage: "(networking) IPv4/IPv6 network CIDRs to use for pod IPs (default: 10.42.0.0/16)", Value: &ServerConfig.ClusterCIDR, } ServiceCIDR = &cli.StringSliceFlag{ Name: "service-cidr", Usage: "(networking) IPv4/IPv6 network CIDRs to use for service IPs (default: 10.43.0.0/16)", Value: &ServerConfig.ServiceCIDR, } ServiceNodePortRange = &cli.StringFlag{ Name: "service-node-port-range", Usage: "(networking) Port range to reserve for services with NodePort visibility", Destination: &ServerConfig.ServiceNodePortRange, Value: "30000-32767", } ClusterDNS = &cli.StringSliceFlag{ Name: "cluster-dns", Usage: "(networking) IPv4 Cluster IP for coredns service. Should be in your service-cidr range (default: 10.43.0.10)", Value: &ServerConfig.ClusterDNS, } ClusterDomain = &cli.StringFlag{ Name: "cluster-domain", Usage: "(networking) Cluster Domain", Destination: &ServerConfig.ClusterDomain, Value: "cluster.local", } ExtraAPIArgs = &cli.StringSliceFlag{ Name: "kube-apiserver-arg", Usage: "(flags) Customized flag for kube-apiserver process", Value: &ServerConfig.ExtraAPIArgs, } ExtraEtcdArgs = &cli.StringSliceFlag{ Name: "etcd-arg", Usage: "(flags) Customized flag for etcd process", Value: &ServerConfig.ExtraEtcdArgs, } ExtraSchedulerArgs = &cli.StringSliceFlag{ Name: "kube-scheduler-arg", Usage: "(flags) Customized flag for kube-scheduler process", Value: &ServerConfig.ExtraSchedulerArgs, } ExtraControllerArgs = &cli.StringSliceFlag{ Name: "kube-controller-manager-arg", Usage: "(flags) Customized flag for kube-controller-manager process", Value: &ServerConfig.ExtraControllerArgs, } )
View Source
var ( TokenConfig = Token{} TokenFlags = []cli.Flag{ DataDirFlag, cli.StringFlag{ Name: "kubeconfig", Usage: "(cluster) Server to connect to", EnvVar: "KUBECONFIG", Destination: &TokenConfig.Kubeconfig, }, } )
View Source
var ( // ConfigFlag is here to show to the user, but the actually processing is done by configfileargs before // call urfave ConfigFlag = &cli.StringFlag{ Name: "config,c", Usage: "(config) Load configuration from `FILE`", EnvVar: version.ProgramUpper + "_CONFIG_FILE", Value: "/etc/rancher/" + version.Program + "/config.yaml", } )
View Source
var ( EncryptFlags = []cli.Flag{ DataDirFlag, ServerToken, &cli.StringFlag{ Name: "server, s", Usage: "(cluster) Server to connect to", EnvVar: version.ProgramUpper + "_URL", Value: "https://127.0.0.1:6443", Destination: &ServerConfig.ServerURL, }, } )
View Source
var EtcdSnapshotFlags = []cli.Flag{ DebugFlag, ConfigFlag, LogFile, AlsoLogToStderr, &cli.StringFlag{ Name: "node-name", Usage: "(agent/node) Node name", EnvVar: version.ProgramUpper + "_NODE_NAME", Destination: &AgentConfig.NodeName, }, DataDirFlag, &cli.StringFlag{ Name: "dir,etcd-snapshot-dir", Usage: "(db) Directory to save etcd on-demand snapshot. (default: ${data-dir}/db/snapshots)", Destination: &ServerConfig.EtcdSnapshotDir, }, &cli.StringFlag{ Name: "name", Usage: "(db) Set the base name of the etcd on-demand snapshot (appended with UNIX timestamp).", Destination: &ServerConfig.EtcdSnapshotName, Value: "on-demand", }, &cli.BoolFlag{ Name: "snapshot-compress,etcd-snapshot-compress", Usage: "(db) Compress etcd snapshot", Destination: &ServerConfig.EtcdSnapshotCompress, }, &cli.BoolFlag{ Name: "s3,etcd-s3", Usage: "(db) Enable backup to S3", Destination: &ServerConfig.EtcdS3, }, &cli.StringFlag{ Name: "s3-endpoint,etcd-s3-endpoint", Usage: "(db) S3 endpoint url", Destination: &ServerConfig.EtcdS3Endpoint, Value: "s3.amazonaws.com", }, &cli.StringFlag{ Name: "s3-endpoint-ca,etcd-s3-endpoint-ca", Usage: "(db) S3 custom CA cert to connect to S3 endpoint", Destination: &ServerConfig.EtcdS3EndpointCA, }, &cli.BoolFlag{ Name: "s3-skip-ssl-verify,etcd-s3-skip-ssl-verify", Usage: "(db) Disables S3 SSL certificate validation", Destination: &ServerConfig.EtcdS3SkipSSLVerify, }, &cli.StringFlag{ Name: "s3-access-key,etcd-s3-access-key", Usage: "(db) S3 access key", EnvVar: "AWS_ACCESS_KEY_ID", Destination: &ServerConfig.EtcdS3AccessKey, }, &cli.StringFlag{ Name: "s3-secret-key,etcd-s3-secret-key", Usage: "(db) S3 secret key", EnvVar: "AWS_SECRET_ACCESS_KEY", Destination: &ServerConfig.EtcdS3SecretKey, }, &cli.StringFlag{ Name: "s3-bucket,etcd-s3-bucket", Usage: "(db) S3 bucket name", Destination: &ServerConfig.EtcdS3BucketName, }, &cli.StringFlag{ Name: "s3-region,etcd-s3-region", Usage: "(db) S3 region / bucket location (optional)", Destination: &ServerConfig.EtcdS3Region, Value: "us-east-1", }, &cli.StringFlag{ Name: "s3-folder,etcd-s3-folder", Usage: "(db) S3 folder", Destination: &ServerConfig.EtcdS3Folder, }, &cli.BoolFlag{ Name: "s3-insecure,etcd-s3-insecure", Usage: "(db) Disables S3 over HTTPS", Destination: &ServerConfig.EtcdS3Insecure, }, &cli.DurationFlag{ Name: "s3-timeout,etcd-s3-timeout", Usage: "(db) S3 timeout", Destination: &ServerConfig.EtcdS3Timeout, Value: 5 * time.Minute, }, }
View Source
var ServerFlags = []cli.Flag{}/* 109 elements not displayed */
Functions ¶
func EvacuateCgroup2 ¶
func EvacuateCgroup2() error
EvacuateCgroup2 will handle evacuating the root cgroup in order to enable subtree_control, if running as pid 1 without rootless support.
func InitLogging ¶
func InitLogging() error
func MustValidateGolang ¶
func MustValidateGolang()
func NewCertCommands ¶
func NewCheckConfigCommand ¶
func NewEtcdSnapshotCommands ¶
func NewTokenCommands ¶
func ValidateGolang ¶
func ValidateGolang() error
func WriteCoverage ¶
Types ¶
type Agent ¶
type Agent struct { Token string TokenFile string ClusterSecret string ServerURL string APIAddressCh chan []string DisableLoadBalancer bool DisableServiceLB bool ETCDAgent bool LBServerPort int ResolvConf string DataDir string NodeIP cli.StringSlice NodeExternalIP cli.StringSlice NodeName string PauseImage string Snapshotter string Docker bool ContainerdNoDefault bool ContainerRuntimeEndpoint string DefaultRuntime string ImageServiceEndpoint string FlannelIface string FlannelConf string FlannelCniConfFile string VPNAuth string VPNAuthFile string Debug bool Rootless bool WithNodeID bool EnableSELinux bool NoPivotRoot bool ProtectKernelDefaults bool ClusterReset bool PrivateRegistry string SystemDefaultRegistry string AirgapExtraRegistry cli.StringSlice ExtraKubeletArgs cli.StringSlice ExtraKubeProxyArgs cli.StringSlice Labels cli.StringSlice Taints cli.StringSlice ImageCredProvBinDir string ImageCredProvConfig string AgentReady chan<- struct{} }
type AgentShared ¶
type AgentShared struct {
}type CertRotateCA ¶
type Server ¶
type Server struct { ClusterCIDR cli.StringSlice AgentToken string AgentTokenFile string Token string TokenFile string ClusterSecret string ServiceCIDR cli.StringSlice ServiceNodePortRange string ClusterDNS cli.StringSlice ClusterDomain string // The port which kubectl clients can access k8s HTTPSPort int // The port which custom k3s API runs on SupervisorPort int // The port which kube-apiserver runs on APIServerPort int APIServerBindAddress string DataDir string DisableAgent bool KubeConfigOutput string KubeConfigMode string HelmJobImage string TLSSan cli.StringSlice TLSSanSecurity bool BindAddress string EnablePProf bool ExtraAPIArgs cli.StringSlice ExtraEtcdArgs cli.StringSlice ExtraSchedulerArgs cli.StringSlice ExtraControllerArgs cli.StringSlice ExtraCloudControllerArgs cli.StringSlice Rootless bool DatastoreEndpoint string DatastoreCAFile string DatastoreCertFile string DatastoreKeyFile string AdvertiseIP string AdvertisePort int DisableScheduler bool ServerURL string FlannelBackend string FlannelIPv6Masq bool FlannelExternalIP bool EgressSelectorMode string DefaultLocalStoragePath string DisableCCM bool DisableNPC bool DisableHelmController bool DisableKubeProxy bool DisableAPIServer bool DisableControllerManager bool DisableETCD bool EmbeddedRegistry bool ClusterInit bool ClusterReset bool ClusterResetRestorePath string EncryptSecrets bool EncryptForce bool EncryptOutput string EncryptSkip bool SystemDefaultRegistry string StartupHooks []StartupHook EtcdSnapshotName string EtcdDisableSnapshots bool EtcdExposeMetrics bool EtcdSnapshotDir string EtcdSnapshotCron string EtcdSnapshotRetention int EtcdSnapshotCompress bool EtcdListFormat string EtcdS3 bool EtcdS3Endpoint string EtcdS3EndpointCA string EtcdS3SkipSSLVerify bool EtcdS3AccessKey string EtcdS3SecretKey string EtcdS3BucketName string EtcdS3Region string EtcdS3Folder string EtcdS3Timeout time.Duration EtcdS3Insecure bool ServiceLBNamespace string }
type StartupHook ¶
type StartupHookArgs ¶
Click to show internal directories.
Click to hide internal directories.