Adding or upgrading components

Before adding features or upgrading your cluster, we highly recommend you back up your params.yaml file.

tip

It is highly recommended that you commit params.yaml file into a private repository and encrypt it with BlackBox or use a secret management service like Azure Key Vault, AWS Secret Manager, GCP Secret Manager or HashiCorp Vault.

important

Try these steps on a copy of the production cluster first.

Adding components

To add additional features to Onepanel:

  1. Run opctl init with additional flags. For example if you initially ran:
opctl init --provider gke

You can enable https and cert-manager by running:

opctl init --provider gke --enable-https --enabl-cert-manager --dns-provider clouddns
  1. Review your params.yaml file and complete the new fields accordingly.
tip

See configuration files for additional information.

  1. Apply your changes:
opctl apply
note

If the application is not loading after these updates, visit our Troubleshooting page for some steps that can help resolve most issues. If you are still having issues, join our Slack community or open an issue in GitHub.

Upgrading components

When upgrading Onepanel, it is best to upgrade one minor version at a time (e.g. 0.9.0 => 0.10.0).

To upgrade Onepanel:

  1. Check the current version of opctl:
opctl version
CLI version: 0.10.0
Manifest version: v0.10.0
API version: v0.10.0
Web UI version: v0.10.0
  1. Download the next version up of opctl for your operating system from our release page.

  2. Run opctl init with the initial flags you used, for example:

opctl init --provider gke
important

Run opctl init only with the initial flags, you can add additional flags after the upgrade completes.

  1. Apply your changes:
opctl apply
note

If the application is not loading after these updates, visit our Troubleshooting page for some steps that can help resolve most issues. If you are still having issues, join our Slack community or open an issue in GitHub.