Skip to main content

Step 7: Install the Release with the Helm CLI

Next, install the same release using the Helm CLI. All releases that contain one or more Helm charts can be installed with the Helm CLI.

All Helm charts included in a release are automatically pushed to the Replicated registry when the release is promoted to a channel. Helm CLI installations require that the customer has a valid email address to authenticate with the Replicated registry.

To install the release with the Helm CLI:

  1. Create a new customer to test the Helm CLI installation:

    1. In the vendor portal, click Customers > Create customer.

      The Create a new customer page opens:

      Customer a new customer page in the vendor portal

      View a larger version of this image

    2. For Customer name, enter a name for the customer. For example, Helm Customer.

    3. For Channel, select Unstable. This allows the customer to install releases promoted to the Unstable channel.

    4. For Customer email, enter the email address for the customer. The customer email address is required to install the application with the Helm CLI. This email address is never used send emails to customers.

    5. For License type, select Trial.

    6. (Optional) For License options, disable the KOTS Install Enabled entitlement.

    7. Click Save Changes.

  2. On the Manage customer page for the new customer, click Helm install instructions.

    Helm install instrucitons button

    View a larger version of this image

    You will use the instructions provided in the Helm install instructions dialog to install the chart.

  3. Before you run the first command in the Helm install instructions dialog, create a gitea namespace for the installation:

    kubectl create namespace gitea

  4. Update the current kubectl context to target the new gitea namespace. This ensures that the chart is installed in the gitea namespace without requiring you to set the --namespace flag with the helm install command:

    kubectl config set-context --namespace=gitea --current

  5. Run the commands in the provided in the Helm install instructions dialog to log in to the registry and install the Helm chart.

    Helm install instructions dialog

    View a larger version of this image

    note

    You can ignore the No preflight checks found warning for the purpose of this tutorial. This warning appears because there are no specifications for preflight checks in the Helm chart archive.

  6. After the installation command completes, you can see that both the gitea Deployment and the Replicated SDK replicated Deployment were created:

    kubectl get deploy

    Example output:

    NAME         READY   UP-TO-DATE   AVAILABLE   AGE
    gitea        0/1     1            0           35s
    replicated   1/1     1            1           35s

  7. Watch the gitea LoadBalancer service until an external IP is available:

    kubectl get svc gitea --watch

  8. After an external IP address is available for the gitea LoadBalancer service, follow the instructions in the output of the installation command to get the Gitea URL and then confirm that you can open the application in a browser.

  9. In another browser window, open the vendor portal and go to Customers. Select the customer that you created for the Helm CLI installation.

    On the Reporting page for the customer, because the Replicated SDK was installed alongside the Gitea Helm chart, you can see details about the customer's license and installed instances:

    Customer reporting

    View a larger version of this image

  10. On the Reporting page, under Instances, click on the instance that you just installed to open the instance details page.

    On the instance details page, you can see additional insights such as the cluster where the application is installed, the version of the Replicated SDK running in the cluster, instance status and uptime, and more:

    Customer instance details

    View a larger version of this image

  11. Uninstall the Helm chart and the Replicated SDK:

    helm uninstall gitea

  12. Delete the gitea namespace:

    kubectl delete namespace gitea

Next Step​

Congratulations! As part of this tutorial, you created a release in the Replicated vendor platform and installed the release with both KOTS and the Helm CLI. To learn more about how to iterate on releases to add more functionality, such as defining preflight checks or custom license entitlements, see Replicated Quick Start.