ocne cluster start

Deploys a Kubernetes cluster using default or customized configuration.

Four primary types of deployments are available:

  • Local virtualization

  • Preprovisioned compute resources

  • Self provisioned compute resources

  • Cloud provider or other infrastructure automation

ocne cluster start 
[{-u|--auto-start-ui} {true|false}]
[{-o|--boot-volume-container-image} URI]
[{-C|--cluster-name} name]
[{-c|--config} path] 
[{-n|--control-plane-nodes} integer] 
[{-i|--key} path]
[--load-balancer address]
[{-P|--provider} provider]
[{-s|--session} URI]
[{-v|--version} version]
[--virtual-ip IP]
[{-w|--worker-nodes} integer]

Where:

{-u|--auto-start-ui} {true|false}

Sets whether the UI is automatically loaded in a browser window after the cluster has started. The default is true.

{-o|--boot-volume-container-image} URI

The URI of a container image that contains the OS boot volume.

{-C|--cluster-name} name

The name of the cluster to start. The default is ocne.

{-c|--config} path

The path to a configuration file that contains the definition of the cluster. If this value isn't provided, a small (ephemeral) cluster might be created, using the default hypervisor, for the system where the command is run.

{-n|--control-plane-nodes} integer

The number of control plane nodes to provision for clusters deployed using local virtualization.

{-i|--key} path

The path to the SSH public key for the remote system. The default is $HOME/.ssh/id_rsa.pub.

--load-balancer address

The hostname or IP address of an external load balancer for the Kubernetes API Server.

{-P|--provider} provider

The provider to use when interacting with the cluster. Options are:

  • libvirt (the default)

  • oci

  • byo

  • none

{-s|--session} URI

The session URI for the libvirt provider.

For local sessions, use qemu:///system.

For remote sessions, use the format qemu+ssh://host/system where host is the name or IP address of the remote system.

{-v|--version} version

The Kubernetes version number to use.

--virtual-ip IP

The virtual IP address to use for the Kubernetes API Server when using the internal load balancer. If you don't set an IP address, one is set automatically using the subnet of the control plane nodes.

{-w|--worker-nodes} integer

The number of worker nodes to provision for clusters deployed using local virtualization.

Example 4-60 Create a default cluster using the libvirt provider

To create a libvirt cluster, using all default settings:

ocne cluster start

Example 4-61 Create a default cluster using the oci provider

To create a cluster on OCI, using the default settings and default configuration files on the system:

ocne cluster start --provider oci

Example 4-62 Create a libvirt cluster using a configuration file

To create a libvirt cluster using a configuration file:

ocne cluster start --config myconfig.yaml

Example 4-63 Create a cluster using the byo provider

To create a cluster using the byo provider:

ocne cluster start --provider byo

Example 4-64 Create a libvirt cluster with specified nodes and virtual IP

To create a cluster with a specified number of worker and control plane nodes, and a virtual IP address:

ocne cluster start --control-plane-nodes 3 --worker-nodes 5 --virtual-ip 192.168.0.100

Example 4-65 Create a remote libvirt cluster using a configuration file

To create a cluster on a remote host using a configuration file:

ocne cluster start --session qemu+ssh://myuser@myhost.example.com/system --config myconfig.yaml

Example 4-66 Install the UI and application catalog into an existing cluster

To install the UI and application catalog into an existing Oracle CNE Release 1.x Kubernetes cluster:

ocne cluster start --provider none --kubeconfig $HOME/.kube/kubeconfig.ocne19