Supplemental Helm instructions

App Platform uses a Helm chart as the basis for its installation. The following instructions can be used to tweak the Helm installation method outlined in both the manual and custom installation methods.

Install client binaries

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

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

Add the repository

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

See helm repo for command documentation.

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 whether the input values are correct run the following command:

helm template -f values.yaml apl/apl

Customize the values

Adjust the values.yaml by changing the provider and adding dns configuration.

Install the Helm chart

Install the Helm chart:

helm install -f values.yaml apl apl/apl

Monitoring the installation

The apl Helm chart deploys the operator to the apl-operator namespace. The installation is completed once the App Platform URL is reachable. The URL is stored in the welcome config map.

kubectl get configmap welcome -n apl-operator -oyaml

You can follow the operator logs by executing the below command:

kubectl logs -n apl-operator -l app.kubernetes.io/name=apl-operator -f

For the detailed information about Kubernetes resources it is recommended to use 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 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