Specifying common parameters
You can find a template file for your IaaS infrastructure type in the following location: /<installation_configuration_directory>/extensions/embedded/cfp-bosh-templates/uiconfig_<environment_type>_template.yml
. Copy this
file to your installation directory and modify it. Replace the default and sample values with the actual values for your vSphere, OpenStack, or AWS infrastructure.
These parameters are common to AWS, vSphere, and OpenStack. For example:
uiconfig:
#Infrastructure agnostic parameters.
developer_mode: "false"
main_user_name: "admin"
main_user_password: "mypassword"
diego_cell_instances: 1
bluemix_env_domain: "local.bluemix.net"
bluemix_env_domain_cert: |+
-----BEGIN CERTIFICATE-----
-----END CERTIFICATE-----
bluemix_env_domain_cert_ca: |+
-----BEGIN CERTIFICATE-----
-----END CERTIFICATE-----
bluemix_env_domain_cert_rsa_key: |+
-----BEGIN PRIVATE KEY-----
-----END PRIVATE KEY-----
bluemix_apps_domain: "local.mybluemix.net"
bluemix_apps_domain_cert: |+
-----BEGIN CERTIFICATE-----
-----END CERTIFICATE-----
bluemix_apps_domain_cert_rsa_key: |+
-----BEGIN PRIVATE KEY-----
-----END PRIVATE KEY-----
ntp_servers: "ntp1,myntp2.com"
subnet: "100.155.194.129/27"
address_range: "100.15.194.130-100.15.194.155"
external_dns: "100.12.13.14,100.12.13.15,100.12.13.16"
gateway: "100.15.194.1"
director_ip: "100.15.194.2"
console_ip: "100.15.194.5"
router_static_ips: "100.15.194.3, 100.15.194.4"
#cloud configuration customization.
#Uncomment the attribute 'cloud_config_custom' and add your customization in place of the example, if needed.
#cloud_config_custom: |
# ---
# my_custom_yaml: my_custom_yaml
#Cloud Foundry customization
#Uncomment the attribute `cf_custom` and add your customization in place of the example, if needed.
#cf_custom: |
# ---
# my_custom_yaml: my_custom_yaml
#Bosh director customization
#Uncomment the attribute `director_custom` and add your customization in place of the example, if needed.
#director_custom: |
# ---
# my_custom_yaml: my_custom_yaml
#Backups
#Note: Most of the parameters are optional.
bbr_backup:
#Set the `customer_nfs_host`, `customer_nfs_path` and `customer_short_name` if you want the director and
#deployment backups pushed to your own NFS server.
#The NFS mount is built as <customer_nfs_host>:/<customer_nfs_path>/<customer_short_name>
customer_nfs_host: "NFS IP or host name"
customer_nfs_path: "/bluemix_nfs"
customer_short_name: "bluemix1"
# director_backup: # Optional. Add this parameter if you want to change the default time for the director backup.
# The default value is 2 AM in the nfs_WAL_server time zone.
# scheduled: "* 2 * * *"
# enable: "false" # The default value is true, which means that backups are executed.
# nb_backups: "10" #Number of backup to keep on the nfs_WAL_server. The default value is 10.
# max_log_size: "1048576" #Maximum log size before it rolls over (in bytes). The default value is 1048576 (1 MB).
# nb_logs: "10" #Maximum number of logs to keep on the nfs_WAL_server. The default value is 10.
# deployments_backup:
# deployments: #Optional. Add this parameter if you want to change the default time for the Bluemix deployment backup.
# The default value is 2:30 AM in the nfs_WAL_server time zone.
# - name: Bluemix
# enabled: "false" # The default value is true, which means that the backup runs.
# nb_backups: "10" #Number of backups to keep on the nfs_WAL_server. The default value is 10.
# max_log_size: "1048576" #Maximum log size before it rolls over (in bytes). The default value is 1048576 (1 MB)
# nb_logs: "10" #Maximum number of logs to keep on the nfs_WAL_server. The default value is 10.
# schedule: "* 6 * * *"
db_nfs_copy:
#Set the customer_nfs_host, customer_nfs_path and customer_short_name if you want the UAADB and
#CCDB backups pushed to your own NFS server.
#The NFS mount is built as <customer_nfs_host>:/<customer_nfs_path>/<customer_short_name>
customer_nfs_host: "NFS server IP address or host name"
customer_nfs_path: "/bluemix_nfs"
customer_short_name: "bluemix1"
- developer_mode: Specifies whether you want to deploy single instance components or enterprise clustered components. Valid values are "true" or "false".
- main_user_name: The user name that is used to log in to the Cloud Foundry CLI and API. This user becomes the administrator.
- main_user_password: The password for the administrator user.
- diego_cell_instances: Specify the number of Diego cells to deploy. Each Diego cell uses 4 vCPUs, 32 GB of RAM, and 300 GB of disk space. For a high availability enterprise deployment, you must use two Diego cells.
- bluemix_apps_domain: The default shared domain to which applications are deployed. You must specify a different value than the bluemix_env_domain value.
- bluemix_apps_domain_cert: Optional. Wildcard application domain certificate (for example,
*.domain.com
). - bluemix_apps_domain_cert_ca: Optional. Wildcard application domain root certificate.
- bluemix_apps_domain_cert_rsa_key: Optional. Wildcard application domain key.
- bluemix_env_domain: The API and management domain that is used in Cloud Foundry deployments. You must specify a different value than the bluemix_apps_domain value.
- bluemix_env_domain_cert: Wildcard system domain certificate. You can provide this value or use automatically generated data. For more information, see Providing certificates for IBM® Cloud Private Cloud Foundry.
- bluemix_env_domain_cert_ca: Wildcard system domain root certificate. You can provide this value or use automatically generated data. For more information, see Providing certificates for IBM® Cloud Private Cloud Foundry.
- bluemix_env_domain_cert_rsa_key: Wildcard system domain key. You can provide this value or use automatically generated data. For more information, see Providing certificates for IBM® Cloud Private Cloud Foundry.
- ntp_servers: The NTP servers that are used to synchronize the virtual machine (VM) time during startup of the VMs. Provide the server names as a comma-separated list that doesn't contain spaces.
-
subnet: The subnet that hosts Cloud Foundry, such as
192.168.52.0/24
Note: A developer installation requires 25 IP addresses, and an enterprise installation requires at least 40 IP addresses.
- gateway: The IP address that Cloud Foundry uses to route the traffic from the subnet that you provide to other subnets or networks.
-
address_range: Optional. Specify the ranges of IP addresses that are available for use. The gateway is automatically considered unavailable. If you do not specify a value, the full subnet range is available.
For example, if the gateway is
192.168.52.1
and you want to use the .50 - .75 IP addresses to install a developer installation, specify192.168.52.50-192.168.52.75
. You can specify multiple ranges in the same subnet by separating each range with a comma, similar to the following example:192.168.52.50-192.168.52.65,192.168.52.70-192.168.52.80
. - external_dns: The DNS server list that resolves company, Internet, and Cloud Foundry wildcard URLs. Provide the server names as a comma-separated list that doesn't contain spaces.
- director_ip: The IP address in the available range to assign to the director.
- router_static_ips: The IP addresses in the available range to assign to the Go Routers. The number of static IPs in the list must match the number of Go routers configured. If
developer_mode=true
, only specify one IP. Ifdeveloper_mode=false
, specify two IPs. These IP addresses are the ingress point. - console_ip: The IP address in the available range to assign to the console user interface. This IP address is the ingress point that the wildcard domain points to.
- cloud_config_custom: YAML cloud configuration customization details.
- director_custom: YAML configurations that are applied to the BOSH director. This configuration information is spruce merged over the default configuration template. Create a YAML file with the custom configuration.
- cf_custom: YAML configurations that are applied to the Cloud Foundry deployment. This configuration information is spruce merged over the default configuration template. Create a YAML file with the custom configuration
(deprecated)
. - bbr_backup: Defines the properties (schedule, number of backups, external NFS server) for the director and deployment backups. See the
uiconfig-<vmware|openstack>-template.yml
file for more details. By default:- The director backup is taken every day at 2 AM, and 10 backups are kept on the
nfs_WAL_server
. - The Bluemix deployment backup (manifest only) is taken every day at 2:30 AM, and 10 backups are kept on the
nfs_WAL_server
. - No transfers are done to an external NFS server.
- The director backup is taken every day at 2 AM, and 10 backups are kept on the
- bbr_backup.customer_nfs_host: The IP address or host name of the external NFS server.
- bbr_backup.customer_nfs_path: The directory path for the NFS server.
- bbr_backup.customer_short_name: The environment
short_name
. Specify an arbitrary name to regroup all backups for an environment. - bbr_backup.director_backup.schedule: The schedule for the director backup in a crontab format. The default value is
2
(every day at 2:00 AM). - bbr_backup.director_backup.enabled: Enables the directory backup. The default value is true. You might want to disable this backup if the database is externalized and backed up separately.
- bbr_backup.director_backup.nb_backups: If no external NFS server is provided, this parameter specifies the number of backups to keep on the
nfs_WAL_server
. The default value is 10. - bbr_backup.director_backup.max_log_size: The maximum size of the log before it rolls over. The default value is 1 Mb.
- bbr_backup.director_backup.nb_logs: Number of logs to keep.
- bbr_backup.deployments_backup*.deployments: List of the deployments to back up. By default, only the Bluemix deployment is backed up by using the Cloud Foundry community script. By default, this backup is scheduled at 2:30 AM. Currently, only the manifest is backed up.
- bbr_backup.deployments_backup.deployments.name: The name of the deployment to back up.
- bbr_backup.deployments_backup.deployments.enabled: If set to true, this parameter enables the backup of the deployment. This parameter is useful if you want to disable the default backup (Bluemix).
- bbr_backup.deployments_backup.deployments.schedule: Uses crontab syntax
* * * * *
to specify when to move the backups to an external location. Crontab fields areMIN(0-59)
HOURS(0-23)
DAY(1-31)
MONTH(1-12)
WEEKDAY(0-6)
. - bbr_backup.deployments_backup.nb_backups: If no external NFS server is provided, this parameter specifies the number of backups to keep on the
nfs_WAL_server
. The default value is 10. - bbr_backup.deployments_backup.max_log_size: Specifies the maximum size of the log before it rolls over. The default value is 1 Mb.
- bbr_backup.deployments_backup.nb_logs: Specifies the number of logs to keep.
- db_nfs_copy: Defines the properties (schedule, number of backups, external NFS server) for the UAA and CC databases. By default, the backups are not transferred to an external NFS server.
- db_nfs_copy.customer_nfs_host: The IP address or host name of the external NFS server.
- db_nfs_copy.customer_nfs_path: The directory path for the NFS server.
- db_nfs_copy.customer_short_name: The environment
short_name
. Specify an arbitrary name to regroup all backups of an environment.