scyld-kube

NAME

scyld-kube -- Tool for installing Kubernetes control plane and worker nodes.

USAGE

scyld-kube

[-h | --help] [--init] [--join] [--init-ha] [--join-ha] [--version VERSION] [--prepare-lb OPTIONS] [--cluster [IP | NODE]] [--image IMAGE] [--token TOKEN] [--cahash CAHASH] [--certificate-key KEY] [[-i | --ids] NODES] [--all] [--up] [--core-inst]

DESCRIPTION

To administer Kubernetes in a cluster, install the clusterware-kubeadm package on either a ClusterWare admin node, a full-install ClusterWare compute node, or a separate non-ClusterWare server. This package contains the scyld-kube tool.

STANDARD OPTIONS

-h, --help

Print usage message and exit. Ignore trailing args, parse and ignore preceding args.

--init

Initialize the only control plane node.

--join

Add worker node.

--init-ha

Initialize the first control plane node for High Availability (HA).

--join-ha

Add additional control plane node(s) for High Availability (HA).

--version VERSION

Optionally specify a major.minor.patch version for an --init, --init-ha, --join, or --join-ha.

--prepare-lb APISERVER_VIP[:APISERVER_PORT:ROUTER_ID:AUTH_PASS]

FIRST_CONTROL_PLANE_NODE_ID:FIRST_CONTROL_PLANE_NODE_IP, ADDITIONAL_CONTROL_PLANE_NODE_ID1:ADDITIONAL_CONTROL_PLANE_NODE_IP1,...

Re-generate High Availability (HA) load balancer config files from local template.

APISERVER_VIP

Required. The virtual IP address of the Kubernetes API server within the network subnet.

APISERVER_PORT

Optional. An unused port for the API server, default 4200.

Note: All three optional values must be specified if non-Default values are to be used.

ROUTER_ID:

Optional. Default 51.

Note: All three optional values must be specified if non-Default values are to be used.

AUTH_PASS:

Optional. Default 42

Note: All three optional values must be specified if non-Default values are to be used.

FIRST_CONTROL_PLANE_NODE_ID:FIRST_CONTROL_PLANE_NODE_IP, ADDITIONAL_CONTROL_PLANE_NODE_ID1:ADDITIONAL_CONTROL_PLANE_NODE_IP1,...

A comma- and a colon-separated list of first and additional hosts' unique ID (can be hostnames) and IP addresses.

--cluster [ IP | NODE ]

Specify the cluster (first control plane node); use with --join or --join-ha.

--image IMAGE

Optionally modify the specified image for persistence across compute node reboots, so that nodes with this IMAGE auto-join when booted.

--token TOKEN

Optionally specify first control plane node's token; use with --join or --join-ha.

--cahash CAHASH

Optionally specify first control plane node's discover-token-ca-cert-hash; use with --join or --join-ha.

--certificate-key KEY

Optionally specify first control plane node's certificate-key; use with --join-ha.

CLUSTERWARE NODE SELECTION OPTIONS

-i, --ids NODES

A comma-separated list of nodes or an admin-defined group of nodes to act upon.

--all

Configure all nodes (rare).

--up

Configure all up nodes (rare).

ADVANCED OPTIONS

--core-inst

Only install core packages.

EXAMPLES

RETURN VALUES

Upon successful completion, scyld-kube returns 0. On failure, an error message is printed to stderr and scyld-kube returns 1.