Fuzzball Documentation
Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Back to homepage

Environment Variables Used in Deployment

This guide is designed to be completed primarily through copy-and-paste instructions. But some values cannot be anticipated and are therefore included as environmental variables that you are expected to set. Some values are used in text files, and the cat command is used in the guide to automatically generate files with the correct variables.

Be aware as you complete the guide, that you will switch from one node to another at various points and variables will therefore need to be assigned values again in the new environment.

The following variables are determined by your specific network configuration.

  • IP1: This will be populated by the first IP address in your metallb pool (e.g. 10.0.0.99). See the appendix on installing a minimal K8s environment for more details.
  • NFS_SERVER_IP: This variable will contain the internal IP address of you NFS server (e.g. 10.0.0.3). If you choose to serve NFS from your Sever Node (where you will install Fuzzball Orchestrate), this will simply be the internal IP address of the Server Node. See the appendix on installing a minimal K8s for more details.
  • REALM_ID: Will be populated with a UUID in order to configure the Keycloak instance. This can be created using the uuidgen command.
  • PUBLIC_INTERFACE: The literal string name of the public interface. For instance, enp1s0.
  • INTERNAL_INTERFACE: The literal string name of the internal interface. For instance, enp8s0.

The remaining variables relate to accessing CIQ Depot and downloading artifacts from the container registry. Instructions for determining the values of these variables are included in the guide.

  • DEPOT_USER: A username to access CIQ Depot that is issued by your CIQ sales/support team once you subscribe to Fuzzball.
  • ACCESS_KEY: This is a token that you will receive from the CIQ sales/support team after subscribing to Fuzzball.
  • VERSION: Refers to the version of the Fuzzball Operator that you will be using for the Fuzzball Orchestrate deployment. If you want to use a value that differs from the value in the guides, you can find version information in Depot.
  • CHART: This is the URL of the Helm Chart that will be used to deploy the Fuzzball Operator.
  • IMAGE: Will be populated with the URL to find the image for the Fuzzball Operator.