Flexiant Cloud Orchestrator Documentation v5.0.15
Page tree
Skip to end of metadata
Go to start of metadata

Changes to configuration files can affect your entire platform. For this reason, we recommend that configuration files are only modified by users with an appropriate level of knowledge and that comprehensive backups are in place.

Do not use " characters when setting values in a configuration file, for example when setting a password, company, or brand, as this prevents the build-config command from running.

Default values are set for variables in Flexiant Cloud Orchestrator using configuration files. These files are used to generate the vars files that are interpreted by Flexiant Cloud Orchestrator. The configuration files are arranged hierarchically such that, when the build-config command is run, information in a higher level file is used to generate the variables in the vars file unless it is overridden by information in a lower level file. The file hierarchy is as follows:



This means that values specified in build-config.cfg are used in the vars files when the build-config command is run, unless they are overridden by values in local.cfg or cluster.cfg. 

To edit the configuration of your platform:

  1. Log in to the console of your platform.

  2. Using the editor of your choice, edit the required configuration file.

    build-config.cfg should not be modified, as it contains the master configuration options. If you want to change a value in this file, override it by specifying a value in local.cfg or cluster.cfg.

    The locations of the files are as follows:

    • /etc/extility/templates/build-config.cfg.

    • /etc/extility/local.cfg
    • /etc/extility/cluster.cfg
       

    1. Search for the appropriate value and modify it as required. If the value is not present in the required configuration file, it can be added. The following is a list of selected values that can be specified in the configuration files:

      The value _SEED is used to generate all passwords that are not specifically overridden in local.cfg. This is set to a random value on installation and should be kept secure.

      ValueDescription
      JADE_FIRST_SUBNET_IS_FREE

      When this value is set to 1, the first subnet allocated to a customer is not billed.

      When this value is set to 1, the following applies:

      • If the first network purchased by a customer is a PVIP network, this means the first PVIP subnet is free. 

      • If the first network purchased by a customer is a VLAN network, this means the first VLAN subnet is free.

      If this value is set to 1, this does not mean that both the first PVIP subnet and the first VLAN subnet are free.

      HYPERV_DISK_IO_BILLINGWhen this value is set to 1, it becomes possible to bill for disk I/O in Hyper-V clusters. The default value for this field is 0.

      JOB_BILLING_EPSILON_NF

      		This field is used to specify the minimum unit usage which qualifies as a unit transaction. If an operation does not generate more than the number of units set by this value, no unit transaction is recorded for it.
      CLUSTER_EXT_HOSTThis field should be used to specify an IP or FQDN for a cluster control server. It is used in cluster.cfg for a Virtuozzo (formerly PCS) cluster being used as a secondary cluster.
      PVIP_ON_HYPERVWhen this value is set to 1, it is possible to use PVIP networking in Hyper-V clusters. Note that additional configuration is required during installation for PVIP networking to work; see Hyper-V cluster configuration for more details.
      VMWARE_MATCH_DATASTOREWhen this value is set to 1, Flexiant Cloud Orchestrator performs a check when a virtual machine is started. This check establishes if the virtual machine's disk is held in any datastore connected to the node the virtual machine is to start on. If the virtual disk is present in a datastore attached to the node, the disk is left where it is. If the disk is not present in any datastore attached to the node, the disk is copied to datastore[0], i.e. the first datastore attached to the node. When this value is set to 0, a virtual machine's disk will always be held in datastore[0]. The default value for this field is 0.
      VNODE_MANAGEMENT_SWITCHThis field should be used to specify which switch the vNode uses to communicate with the cluster control server. The default value is vSwitch0.
      VNODE_EXTERNAL_SWITCHThis field should be used to specify which switch the vNode uses to communicate with the storage network and VLANs. The default value for this field is vSwitch1.
      VNODE_HOST_SWITCHThis field should be used to specify which switch the vNode uses to handle PVIP routing. The default value for this field is vSwitch2.

      XVP_DISABLE_KILL_ON_FAILED_MIGRATE

      This setting is only available in Xen clusters.

      When this value is set to 1, a virtual machine that fails to migrate from one node to another will not be removed from both nodes and will remain on the original node. When this value is set to 0, a virtual machine that fails to migrate to another node will be removed from both nodes.

      The default setting for this value is 0. This is because a virtual machine that fails to migrate may duplicate a virtual disk on two separate nodes; should this occur, this is a serious problem that can cause loss or corruption of data stored on either virtual disk.

      DISABLE_EMULATED_DEVICES

      		When this value is set to false, emulated devices for KVM and Xen hypervisors are enabled by default. When this value is set to true, emulated devices for KVM and Xen hypervisors are enabled by default. For more information about emulated devices, see Hypervisor specific settings.
      VMWARE_DV_SWITCH_ENABLEDWhen this value is set to 0, the VMWARE_HOST_SWITCH is used. When this value is set to 1, the VMWARE_DISTRIBUTED_SWITCH is used.
      VMWARE_DISTRIBUTED_SWITCHThe name of the distributed switch used by the ESXi hosts on VMware platforms. This switch is only used when VMWARE_DV_SWITCH_ENABLED is set to 1.
      VMWARE_HOST_SWITCHThe name of the default switch used by the ESXi hosts on VMware platforms. This switch is not used when VMWARE_DV_SWITCH_ENABLED is set to 1.
      JOB_BILLING_TIMEThe time interval in seconds between each run of the billing engine. Setting this value to a lower number does not mean that customers are billed more frequently, just that the billing engine checks more frequently to see if activity that should be billed for has taken place.
      JADE_MEASUREMENT_INTERVALThe time interval in seconds between the recording of measurement statistics in the Jade database. For the most accurate billing, this should be set to a lower value than JOB_BILLING_TIME.
      JADE_DELETE_MEASUREMENT_INTERVALThe interval in seconds for which measurement statistics are retained in the Jade database before they are deleted. By default, this is set to 172800 (2 days). If you increase this value, this will lead to a corresponding increase in the size of your Jade database unless you also increase the JADE_MEASUREMENT_INTERVAL value.
      VNC_FORCE_HANDLERThis value forces the use of one remote desktop handler over another. This can be set to either NOVNC or GUACAMOLE, both of which are supplied with Flexiant Cloud Orchestrator. As noVNC uses fewer resources and has been more thoroughly tested, we recommend that it is used in preference to Guacamole unless your platform uses Hyper-V as the hypervisor.
      _SEEDThis value is used to generate all passwords that are not specifically overridden. It is set to a random value on installation and should be kept secure.
      SINGLEIP

      When this variable is set to 1, public IPs are behind a single IP address.

      SKIP_HOST_CHECKWhen this variable is set to 1, the check to ensure the platform is running on the correct host is skipped. This is useful for debugging.
      JADE_DB_HOSTThe name of the machine running the Opal MySQL database. This is resolved to an internal IP address by internal DNS. By default, the IP address of the management server is used.
      API_HOSTThe name of the machine running the API. This is resolved to an internal IP address by internal DNS. By default, the IP address of the management server is used.
      API_ENDPOINT_HOSTThe external IP address of the machine running the user API.
      API_ADMIN_ENDPOINT_HOSTThe external IP address of the machine running the admin API.
      API_MANAGEMENT_ENDPOINT_HOSTThe external IP address of the machine running the system API.
      JADE_API_HTTPS_PORTThe HTTPS port used to communicate with the user API.
      JADE_ADMINAPI_HTTPS_PORTThe HTTPS port used to communicate with the admin API.
      JADE_MANAGEMENTAPI_HTTPS_PORTThe HTTPS port used to communicate with the system API.
      JOB_ERROR_NOTIFY_EMAILThe email address to which email notifications of job failures are sent.
      TL_HOSTThe name of the machine running Tigerlily. This is resolved to an internal IP address by internal DNS. By default, the IP address of the management server is used.
      XVPSVC_HOSTThe name of the machine running XVPManager. This is resolved to an internal IP address by internal DNS. By default, the IP address of the management server is used.
      TL_DB_HOSTThe name of the machine running the Tigerlily Postgres database. This is resolved to an internal IP address by internal DNS. By default, the IP address of the management server is used.
      METADATA_HOSTThe name of the machine running the metadata service on the MGMT network. This is resolved to an internal IP address by internal DNS. By default, the IP address of the management server is used.
      METADATA_NODE_HOSTThe name of the machine running the metadata service on the MGMT network. This is resolved to an internal IP address by internal DNS.
      METADATA_DOMAIN_NAMEThe domain name used to construct hostnames for EC2 metadata compatibility.
      APACHE_SERVER_ADMINThe email address of the administrator, displayed on HTTP 404 error pages when a page cannot be found.
      LOG_HOSTThe name of the machine on the MGMT network to which the nodes output their syslog files. This is resolved to an internal IP address by internal DNS. By default, the IP address of the management server is used.
      NODE_LOG_HOSTThe name of the machine on the NODE network to which the nodes output their syslog files. This is resolved to an internal IP address by internal DNS.
      CP_HOSTThe name of the machine running the control panel.
      CP_FQDN_HOSTThe IP address of the machine running the control panel.
      ADMINCP_FQDN_HOSTThe IP address of the machine running the admin control panel.

      ADMINCP_HTTP_PORT

      		The HTTP port used for communication with the admin control panel.
      ADMINCP_HTTPS_PORTThe HTTPS port used for communication with the admin control panel.

      CP_VALIDATION_EMAIL

      		The email address that validation emails appear to come from.

      CP_NO_REPLY_EMAIL

      		The reply-to email address on validation emails, for example noreply@example.com.

      CP_SUPPORT_TEL

      		The telephone number used for customer support.

      CP_GOOGLE_ANALYTICS_UA

      		The Google Analytics User Agent for the control panel.

      CP_BRAND

      		The brand.

      API_CUSTOMER_MAXSUBNET

      		The maximum total number of subnets that can be created by the default customer. When this value is -1, an unlimited number of subnets can be created.

      API_CUSTOMER_MAXRAM

      		The maximum total amount of RAM that can be used by the default customer. When this value is -1, an unlimited amount of RAM can be used.

      API_CUSTOMER_MAXCPU

      		The maximum total amount of CPU cores that can be used by the default customer. When this value is -1, an unlimited amount of CPU cores can be used.

      API_CUSTOMER_MAXSERVERS

      		The maximum total number of servers that can be created by the default customer. When this value is -1, an unlimited number of servers can be created.

      API_CUSTOMER_MAXDISKS

      		The maximum total number of disks that can be created by the default customer. When this value is -1, an unlimited number of disks can be created.

      API_CUSTOMER_MAXSTORAGEGB

      		The maximum total amount of disk storage that can be used by the default customer. When this value is -1, an unlimited amount of disk storage can be used.

      API_CUSTOMER_MAXSNAPSHOTS

      		The maximum total number of snapshots that can be created by the default customer. When this value is -1, an unlimited number of snapshots can be created.

      API_CUSTOMER_MAXIMAGES

      		The maximum total number of images that can be created by the default customer. When this value is -1, an unlimited number of images can be created.

      API_CUSTOMER_MAXCONTACTS

      		The maximum total number of users that can be created by the default customer. When this value is -1, an unlimited number of users can be created.

      API_CUSTOMER_MAXVDC

      		The maximum total number of VDCs that can be created by the default customer. When this value is -1, an unlimited number of VDCs can be created.

      API_CUSTOMER_MAXVLANS

      		The maximum total number of VLANs that can be created by the default customer. When this value is -1, an unlimited number of VLANs can be created.

      CP_COMPANY

      		The default company.

      CP_SIGNUP_ENABLE_CARD_CHECK

      		If this value is set to true, signing up for an account on the platform requires a credit card.

      CP_SIGNUP_RECAPTCHA_PUBLIC_KEY

      		This value contains the public recaptcha key for customer verification during the sign up process.

      CP_SIGNUP_RECAPTCHA_PRIVATE_KEY

      		This value contains the private recaptcha key for customer verification during the sign up process.

      SSLCERT_GEN

      		If this value is set to 1, self-signed SSL certificates are generated for the entire platform when the build-config command is run.

      SSLCERT_GEN_CP

      		If this value is set to 1, self-signed SSL certificates are generated for the control panel when the build-config command is run.

      SSLCERT_GEN_ADMINCP

      		If this value is set to 1, self-signed SSL certificates are generated for the admin control panel when the build-config command is run.

      SSLCERT_GEN_API

      		If this value is set to 1, self-signed SSL certificates are generated for the API when the build-config command is run.

      NETSVC_DNS_SERVERS

      		This value specifies the external DNS servers used by customers. Multiple DNS servers can be entered as long as they are separated by a comma and space, for example 8.8.8.8, 8.8.4.4.

      IPTABLES_ENABLE

      		If this value is non-zero, firewalling is enabled.

      JOB_ERROR_NOREPLY_EMAIL

      		The email address that failed job notifications are sent to.

      NETWORK_MANAGEMENT_RANGE

      		The IP range for the MGMT network.

      NETWORK_NODE_RANGE

      		The IP range for the NODE network.

      NETWORK_STORAGE1_RANGE

      		The IP range for the STORAGE1 network.

      NETWORK_STORAGE2_RANGE

      		The IP range for the STORAGE2 network.

      NODE_ROUTINGPROTOCOL

      		The routing protocol to the used for the NODE network.

      INITIAL_ADMIN_USER

      		The initial admin user's username.

      INITIAL_ADMIN_PASSWORD

      		The initial admin user's password.

      HYPERVISOR

      		The hypervisor used on the platform.

      LICENCE_USER

      		The type of license.

      LICENCE_PASSWORD

      		The password for the license.

      SSH_PUBLIC_KEY

      		The public SSH key for the platform.

       

  3. Update the vars file with the new value definitions by running the build-config command. As this command only restarts the services that have been updated, it may be necessary to run the build-config -a command; this will however cause disruption to any customers that are running virtual machines on your platform. As such it is recommended to run the build-config -a command only when the platform is not in use.

  • No labels