capi_feature - aleixrm/one-apps GitHub Wiki

The appliance comes with a preinstalled Rancher instance, and includes the following features:

  • Rancher and the Turtles extension installed and integrated.
  • CAPONE configured as an infrastructure provider.
  • Adds RKE2 and Kubeadm CAPONE charts.

In this guide you'll learn how to use the contextualization attributes to automate the setup and configuration of your appliance.

Contextualization

The contextualization parameters (CONTEXT section) in the VM template controls the configuration of the service, see the table below:

Parameter Default Description
ONEAPP_CAPI_K3S_VERSION v1.31.7+k3s1 Kubernetes version for the K3s cluster where Rancher is deployed.
ONEAPP_CAPI_CERT_MANAGER_VERSION v1.17.2 Cert Manager Chart Version.
ONEAPP_CAPI_RANCHER_VERSION 2.11.1 Rancher Chart Version.
ONEAPP_CAPI_TURTLES_VERSION 0.19.0 Turtles Chart Version.
ONEAPP_CAPI_CAPONE_VERSION v0.1.5 Capone Version.
ONEAPP_CAPI_RANCHER_HOSTNAME Rancher Hostname.
ONEAPP_CAPI_RANCHER_PASSWORD capi1234 Rancher admin Password.

[!NOTE] The appliance has been tested with the specified combination of versions. While it is possible to modify these versions, their functionality has not been validated with different configurations.

Hostname Configuration

If ONEAPP_CAPI_RANCHER_HOSTNAME is not defined, the Rancher UI will be accessible via https://ETH0_IP.sslip.io, where ETH0_IP is the IP address of the machine’s eth0 interface. This configuration provides immediate access to the Rancher UI without requiring any additional DNS setup.

If a custom hostname is specified for ONEAPP_CAPI_RANCHER_HOSTNAME, the Rancher UI will be accessible at https://$ONEAPP_CAPI_RANCHER_HOSTNAME. In this case, it is crucial to ensure that the hostname is correctly configured and reachable. The specified hostname must be accessible not only from the local environment but also from all workload clusters deployed by the appliance.