Skip to main content

Install APL with Helm

Install client binaries​

When installing APL using the Helm chart, make sure the following client binaries exist:

  • Kubectl to access the cluster
  • Helm for Helm chart installation of APL

Add the APL repository​

helm repo add apl https://linode.github.io/apl-core
helm repo update

See helm repo for command documentation.

Minimal values​

info

The APL Builds and Projects features and using Harbor for private registries is NOT supported when APL is installed with minimal configuration. Install APL with DNS to use all APL features.

cluster:
  name: # the name of your cluster
  provider: # choose between aws, azure, google, digitalocean, ovh, vultr, scaleway or custom

When the chart is installed, follow the post installation steps.

Custom values​

To view the required values.yaml file with detailed comments, view and download the chart's latest values.yaml. Run the following command to view all the values (which might be overwhelming):

helm show values apl/apl

To test wether the input values are correct run the following command:

helm template -f values.yaml apl/apl

Install the Helm chart​

Install the Helm chart:

helm install -f values.yaml apl apl/apl

Monitoring the installation​

The chart deploys a Job (-apl) in the default namespace. Monitor the chart install using kubectl:

# get the status of the job
kubectl get job apl -w
# watch the helm chart install status:
watch helm list -Aa

Or view detailed info about Kubernetes resources with k9s

When the chart is installed, follow the post installation steps.

Installing from source​

As an alternative, you can also clone the apl-core source code from the Github and install APL using the chart source code.

Download source​

git clone https://github.com/linode/apl-core.git
cd apl-core

Install​

Now customize the values.yaml file. Make sure to set the version to the branch you like to use:

otomi:
  version: main

Use the following command to install the chart with the name my-apl-release (a custom name that you choose).

helm install -f values.yaml my-apl-release chart/apl