scyld-kube

NAME

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

USAGE

scyld-kube

[-h | --help] [--init] [--join] [--init-ha] [--join-ha] [--version VERSION] [--prep-lb OPTIONS] [--clear-lb] [--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 Scyld ClusterWare head node, a full-install ClusterWare compute node, or a separate non-ClusterWare server. This package contains the scyld-kube tool. See the Using Kubernetes appendix for detailed examples.

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 control plane node for High Availability (HA).

--version VERSION

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

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

MASTER_ID:MASTER_IP,BACKUP1_ID:BACKUP1_IP,...

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

APISERVER_VIP

The virtual IP address of the Application Programming interface (API) server within the network subnet.

APISERVER_PORT

An unused port (default 4200) for the API server.

ROUTER_ID:

Default 51.

AUTH_PASS:

Default 42

MASTER_ID:MASTER_IP,BACKUP1_ID:BACKUP1_IP,...

A comma- and a colon-separated list of master and backup hosts' unique ID and IP addresses.

--clear-lb

Clear High Availability (HA) load balancer config files (under /opt/scyld/clusterware-kubeadm).

--cluster [ IP | NODE ]

Optionally specify the cluster to join.

--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's IP or node name; use with --join or --join-ha.

--cahash CAHASH

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

--certificate-key KEY

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

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.