CLI Tools

Octelium comes with 3 CLI tools: octelium, octeliumctl and octops. Let's quickly see what these CLI tools are for.

note

You can read in detail on how to install and upgrade Octelium CLIs here.

octelium

octelium is the CLI that can be used by any User mainly to connect to the Cluster and access its Services. You can read more about connecting to the Cluster here. Some examples:

export OCTELIUM_DOMAIN=example.com

# List available Services
octelium get service
# Connect to the Cluster via the detached mode
octelium connect -d
# Disconnect from the Cluster
octelium disconnect

octeliumctl is used by the Cluster's administrators to control the Cluster's resources (e.g. Services, Namespaces, Users, Sessions, etc...). You can read more about the Cluster management here. Here are some examples:

export OCTELIUM_DOMAIN=example.com
# Apply declaratively all your Cluster resources
octeliumctl apply /path/to/directory
# List Services
octeliumctl get service
# List Users
octeliumctl get user

octops

octops is a tool that helps you to install, upgrade and uninstall Octelium Clusters. You can read more about installing production Clusters here. Here is an example:

octops init octelium.example.com --bootstrap /path/to/bootstrap_file.yaml