Skip to main content

☸️ Start with Helm Chart

πŸš€ Getting Started with Helm Chart​

πŸ”‘ Credentials

There are no default credentials. Configure a random JWT signing key and explicit local credentials before starting. See Security configuration.

For SSO-only deployments, explicitly set BASIC_AUTH_ENABLED=false and configure RBAC policies.

πŸ“¦ Installing from Registry​

  1. Add OTWLD repository

    helm repo add otwld https://helm.otwld.com/
  2. Update repository

    helm repo update
  3. Create a values-local.yaml file following Security configuration. A signing secret and authentication settings are required.

    Environment Variables

    You can add environment variables in the values.yaml

    env: []
    envFrom: []
  4. Create a namespace

    kubectl create namespace velero-ui
  5. Install the chart

    helm install velero-ui otwld/velero-ui --namespace velero-ui --values values-local.yaml

πŸ–₯️ Installing from Source​

  1. Clone the repository
  • Using SSH
    git clone git@github.com:otwld/velero-ui.git
  • Using HTTPS
    git clone https://github.com/otwld/velero-ui.git
  1. Go to the chart directory

    cd velero-ui/kubernetes/chart
  2. Create a values-local.yaml file following Security configuration. A signing secret and authentication settings are required.

    Environment Variables

    You can add environment variables in the values.yaml

    env: []
    envFrom: []
  3. Create a namespace

    kubectl create namespace velero-ui
  4. Install the chart

    helm install velero-ui . --namespace velero-ui --values values-local.yaml

πŸ”„ Upgrading​

Make adjustments to your values as needed, then run helm upgrade:

  1. Update repository

    helm repo update
  2. Upgrade

    helm upgrade velero-ui olwld/velero-ui --namespace velero-ui --values values.yaml

πŸ—‘ Uninstalling​

To uninstall/delete the velero-ui deployment in the velero-ui namespace:

helm delete velero-ui --namespace velero-ui

See `helm delete --help for a full reference on delete parameters and flags.