Helm Options

Reference document for the options available in the HobbyFarm Helm chart.

This page contains a reference of the options available in the HobbyFarm Helm chart. Please visit the values.yaml file in the HobbyFarm repository for the most up-to-date list of options.

General

KeyDefaultPurpose
insecurefalseUse insecure protocols. Useful for local development.

Admin UI Options

KeyDefaultPurpose
admin.imagehobbyfarm/admin-ui:[version]Image used for admin-ui.
admin.configMapNameadmin-configConfigMap used to configure admin ui.
admin.config.titleHobbyFarm AdministrationTitle of admin ui as seen in browser.
admin.config.favicon/assets/default/favicon.pngPath to the favicon to use for admin ui.
admin.config.login.logo/assets/default/rancher-labs-stacked-color.svgPath to logo image as seen on admin ui login page.
admin.config.login.customlogoundefinedA Secret containing an SVG as a file.
admin.config.login.background/assets/default/vault.jpgPath to large background image as seen on admin ui login page.
admin.config.logo/assets/default/logo.svgPath to logo as seen in upper right corner of admin ui.

UI Options

KeyDefaultPurpose
ui.imagehobbyfarm/ui:[version]Image used for ui.
ui.configMapNameui-configConfigMap used to configure ui.
ui.config.titleHobbyFarm LearnTitle of ui as seen in browser.
ui.config.favicon/assets/default/favicon.pngPath to the favicon to use for ui.
ui.config.login.logo/assets/default/rancher-labs-stacked-color.svgPath to logo image as seen on ui login page.
ui.config.login.background/assets/default/login_container_farm.svgPath to large background image as seen on ui login page.
ui.config.logo/assets/default/logo.svgPath to logo as seen in upper right corner of ui.
ui.about.titleAbout HobbyFarmTitle of the about dropdown in ui.
ui.about.bodyHobbyFarm is a browser-based technology training tool developed at github.com/hobbyfarm
ui.config.about.buttonsundefinedSee the button section below for more information.
ui.config.customundefinedSee the custom section below for more information.

ui.config.about.buttons

This list allows for specification of custom buttons in the About modal of the HobbyFarm UI.

Example:

ui:
  config:
    about:
      buttons:
        - title: Example Title
          url: https://github.com/hobbyfarm
        - title: Example Title 2
          url: https://github.com/hobbyfarm/hobbyfarm

ui.config.custom

This heredoc allows for specification of custom CSS to be applied to the UI.

Example:

ui:
  config:
    custom: |
      .custom-css {
        background: none;
      }      

Gargantua

KeyDefaultPurpose
gargantua.imagehobbyfarm/gargantua:[version]Image used for the Gargantua backend.
gargantua.logLevel"0"Log level of Gargantua.
gargantua.dynamicBaseNamePrefix"dynamic"Name prefix for VMs provisioned using dynamic method.
gargantua.scheduledBaseNamePrefix"scheduled"Name prefix for VMs provisioned ahead of time (scheduled).
gargantua.apiPort80The port on which Gargantua’s API should be served.
gargantua.webhook.containerPort444Container port for CRD conversion webhook.
gargantua.webhook.servicePort443Service port for CRD conversion webhook. ⚠️

⚠️⚠️ The gargantua.webhook.servicePort port should remain 443. See this link for more information. ⚠️⚠️

Guacamole

KeyDefaultPurpose
guac.imageundefinedImage used when deploying Guacamole server for Windows RDP.

Shell

KeyDefaultPurpose
shell.replicas1Number of replicas of the shell service to run.

Ingress

KeyDefaultPurpose
ingress.enabledfalseEnable ingress.
ingress.annotations{}Additional annotations for ingress.
ingress.tls.enabledtrueEnable TLS on ingress.
ingress.tls.secrets.backendundefinedTLS secret for backend ingress.
ingress.tls.secrets.adminundefinedTLS secret for admin ui ingress.
ingress.tls.secrets.uiundefinedTLS secret for ui ingress.
ingress.tls.secrets.shellundefinedTLS secret for shell ingress.
ingress.hostnames.uiundefinedHostname for ui ingress.
ingress.hostnames.adminundefinedHostname for admin ui ingress.
ingress.hostnames.backendundefinedHostname for backend ingress.
ingress.hostnames.shellundefinedHostname for shell ingress.

Users

KeyDefaultPurpose
users.admin.enabledfalseCreates the user, admin.
users.admin.password$2a$10$9ToKMT37Z7K70xbCVnW9KOzEuPq0JyW/rA06gsukD4U9YfKFjMXTeBcrypt hashed password for the admin user. Default value is Sup3r@dmin.

Adding Users

Additional users can be added by adding a new entry to the users list. The following example shows how to add a user named user1 with the password password1.

users:
  admin:
    enabled: true
    password: $2a$10$9ToKMT37Z7K70xbCVnW9KOzEuPq0JyW/rA06gsukD4U9YfKFjMXTe
  user1:
    enabled: true
    password: $2a$12$DNBNq4TZarIdx.IaGjcdSOjKhubC0A4CpD5asd7dajgGJwjPROIlu

Terraform

⚠️⚠️⚠️ Terraform will be removed in a future version. It is NOT recommended to use Terraform as there are compatibility, instability and performance issues.

The options are not documented here as it is strongly inadvisable to use Terraform. Please instead use a provider-specific operator for VM provisioning.