Quick start

It's easy to get started with Onepanel. First, install the CLI (opctl) and then using opctl, generate a params.yaml file and configure your deployment. Once complete, you can access your deployment from any browser, use your Kubernetes auth to login and finally run a workflow.

Step 0: Create a Kubernetes cluster

First, create a Kubernetes cluster in one of the following cloud providers:

We recommend launching a cluster with 2 Standard_D4s_v3 nodes to start, with autoscaling and network policy enabled. You can add additional CPU/GPU node pools as needed later.

Here is a sample az command to create a bare minimum cluster:

az aks create --resource-group <resource-group> --name <cluster-name> \
--node-count 2 \
--node-vm-size Standard_D4s_v3 \
--node-osdisk-size 100 \
--min-count 2 \
--max-count 2 \
--enable-cluster-autoscaler \
--network-plugin azure \
--network-policy azure \
--enable-addons monitoring \
--generate-ssh-keys
note

The --enable-addons monitoring flag in the command above enables Azure Monitor for log aggregation which can incur additional charges. You can optionally remove this flag and add --enable-efk-logging to opctl command below.

You can then get access credentials by running:

az aks get-credentials --resource-group <resource-group> --name <cluster-name> --admin

Step 1: Install Onepanel

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

  2. Run the following command to initialize a params.yaml template for your provider:

opctl init --provider aks \
--enable-https \
--enable-cert-manager \
--dns-provider <dns-provider>
note

If you have GPU nodes, you need to set the --gpu-device-plugins flag. Valid values are nvidia and amd or a comma separated combination of both nvidia,amd.

note

The --enable-https flag is optional and requires a TLS certificate, but it is highly recommended. You can optionally set the --enable-cert-manager and --dns-provider flags, so TLS certificates are automatically created and renewed via Let's Encrypt. If you do not set this flag and your DNS provider isn't one of the supported DNS providers, then you have to create a wildcard certificate and manually manage it.

  1. Populate params.yaml by following the instructions in the template, you can also refer to the configuration files section.

  2. Finally, run the following command to deploy to your cluster:

opctl apply
  1. Once the deployment completes, the CLI will display the IP and wildcard domain you need to use to setup your DNS. You can also get this information again by running:
opctl app ip
  1. Create an A record in your DNS provider based on the instructions above.

  2. Use the following command to get your auth token to log into Onepanel:

opctl auth token