CLI overview

Install opctl

Download the latest opctl for your operating system from our release page

Initializing configuration file

You can initialize configuration files by running the following command. See configuration files section for more information.

opctl init --provider <provider-name>

Available provider options are: aks, eks and gke for public cloud installations and minikube, microk8s for local installations.

To use an artifact repository other than s3 use the --artifact-repository-provider flag:

opctl init --provider <provider-name> \

--artifact-repository-provider <object-storage-provider>

Available options for --artifact-repository-provider are s3 and gcs.

HTTPS is not enabled by default, to enable HTTPS but manage the TLS certificate yourself:

opctl init --provider <provider-name> --enable-https

To enable HTTPS and enable automatic TLS management:

opctl init --provider <provider-name> \

--enable-https \

--enable-cert-manager \

--dns-provider <dns-provider-name>

tip

Refer to TLS certificates section for more information and a list of supported DNS providers.

To add ElasticSearch, Fluentd, and Kibana (EFK) logging, add the --enable-logging flag.

note

Onepanel's admin CLI serves as a thin abstraction layer on top of kubectl and kustomize, therefore the CLI can easily be extended to manage additional Kubernetes modules.