Skip to main content

Step 5: Install the Release on a VM

Next, get the customer-specific Embedded Cluster installation commands and then install the release on a Linux VM.

To install the release with Embedded Cluster:

  1. In the Vendor Portal, go to Customers. Click on the name of the customer you created.

  2. Click Install instructions > Embedded cluster.

    Customer install instructions dropdown

    View a larger version of this image

    The Embedded cluster install instructions dialog opens.

    Embedded Cluster install instructions dialog

    View a larger version of this image

  3. On the command line, SSH onto your Linux VM.

  4. Run the first command in the Embedded cluster install instructions dialog to download the latest release.

  5. Run the second command to extract the release.

  6. Run the third command to install the release.

  7. When prompted, enter a password for accessing the KOTS Admin Console.

    The installation command takes a few minutes to complete.

  8. When the installation command completes, go to the URL provided in the output to log in to the Admin Console.

    Example output:

    ✔  Host files materialized
    ? Enter an Admin Console password: ********
    ? Confirm password: ********
    ✔  Node installation finished
    ✔  Storage is ready!
    ✔  Embedded Cluster Operator is ready!
    ✔  Admin Console is ready!
    ✔  Finished!
    Visit the admin console to configure and install gitea-kite: http://104.155.145.60:30000

    At this point, the cluster is provisioned and the KOTS Admin Console is deployed, but the application is not yet installed.

  9. Bypass the browser TLS warning by clicking Continue to Setup.

  10. Click Advanced > Proceed.

  11. On the HTTPS for the Gitea Admin Console page, select Self-signed and click Continue.

  12. On the login page, enter the Admin Console password that you created during installation and click Log in.

  13. On the Nodes page, you can view details about the VM where you installed, including its node role, status, CPU, and memory. Users can also optionally add additional nodes on this page before deploying the application. Click Continue.

    The Admin Console dashboard opens.

  14. In the Version section, for version 0.1.0, click Deploy then Yes, Deploy.

    The application status changes from Missing to Unavailable while the gitea Deployment is being created.

  15. After a few minutes when the application status is Ready, click Open App to view the Gitea application in a browser:

    Admin console dashboard showing ready status

    View a larger version of this image

    Gitea app landing page

    View a larger version of this image

  16. In another browser window, open the Vendor Portal and go to Customers. Select the customer that you created.

    On the Reporting page for the customer, you can see details about the customer's license and installed instances:

    Customer reporting page

    View a larger version of this image

  17. 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 version of Embedded Cluster that is running, instance status and uptime, and more:

    Customer instance details page

    View a larger version of this image

  18. (Optional) Reset the node to remove the cluster and the application from the node. This is useful for iteration and development so that you can reset a machine and reuse it instead of having to procure another machine.

    sudo ./APP_SLUG reset --reboot

    Where APP_SLUG is the unique slug for the application that you created. You can find the appication slug by running replicated app ls on the command line on your local machine.

Next Step​

Congratulations! As part of this tutorial, you created a release in the Replicated Vendor Portal and installed the release with Replicated Embedded Cluster in a VM. To learn more about Embedded Cluster, see Using Embedded Cluster. 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.