Specifying OpenStack parameters

During installation, after launch.sh has run and prior to running launch_deployment.sh, locate the template file for OpenStack: /<installation_configuration_directory>/extensions/embedded/cfp-bosh-templates/uiconfig_openstack_template.yml. Copy this file to your installation directory and modify it. Replace the default and sample values with the actual values for your particular environment.

The following example parameters apply only to OpenStack. You can also use common parameters. For more information, see Specifying common parameters.

Use the OpenStack user interface to download parameter descriptions. For older OpenStack versions, such as Liberty or Mitaka, select Project > Compute > Access & Security > API Access > Download OpenStack RC File v3. For newer OpenStack versions, such as Pike, select Project > API Access > Download OpenStack RC File > Identity API v3 or Project > API Access > Download OpenStack RC File > Clouds.yaml File. This downloads descriptions for parameters that are shown in the following example:

uiconfig:
  openstack_key_pair_name:  "my_icp_cf_key_name"
  openstack_key_pair_private: |+
      -----BEGIN RSA PRIVATE KEY-----
      -----END RSA PRIVATE KEY-----
  openstack_availability_zone: "nova"
  openstack_security_groups:  "CF-Sec1,CF-Sec2"
  openstack_cacert: |+
      -----BEGIN CERTIFICATE-----
      -----END CERTIFICATE-----

  openstack:
    auth:
      auth_url: "https://hostname:5000/v3"
      project_name: "myopenstack_project_name"
      project_id: "e16asdfasdf7ab80ac9b4234a74d"
      user_domain_name: "myopenstack_domain_name"
      username: "myopenstack_user"
      password: "myopenstack_password"
  identity_api_version: 3
  interface: "public"
  region_name: "RegionOne"

  #Uncomment this section and overwrite with your flavor if needed.
  #  flavors:
  #    icpcf_cfp_ui: <your_flavor>
  #    icpcf_compilation: <your_flavor>
  #    icpcf_director: <your_flavor>
  #    icpcf_minimal: <your_flavor>
  #    icpcf_small: <your_flavor>
  #    icpcf_small-highmem: <your_flavor>

• openstack_key_pair_name: The key pair name that is used to access OpenStack virtual machines. This is the name of the key pair you imported into OpenStack. From the OpenStack user interface, select Project > Compute > Access & Security > Key Pairs to see the available key pair names.

• openstack_key_pair_private: The key pair private key that is used to access OpenStack virtual machines. WARNING: If you are using an older OpenStack version, such as Liberty or Mitaka, do not create the key pair with the OpenStack Horizon dashboard. Instead make sure that you generate the SSH key pair manually. For example, use the ssh-keygen command:

  ssh-keygen -t rsa -b 4096 -C "bosh" -f bosh.key
  

  Then import that key pair into OpenStack using the OpenStack user interface, select Project > Compute > Access & Security > Key Pairs > Import Key Pair. This is due to an OpenStack bug.

• openstack_availability_zone: The availability zone.
• openstack_security_groups: The OpenStack security groups that are attached to virtual machines. Provide the security group names as a comma-separated list that does not contain spaces. For example, default,bosh.

• openstack_cacert: The certificates to use to connect to OpenStack. The certificate is stored in /data/openstack-cacert.pem. To acquire the certificate from the OpenStack API, perform the following:

  openssl s_client -connect <OpenStack IP>:443 -showcerts |  sed -ne '/-BEGIN CERTIFICATE-/,/-END CERTIFICATE-/p'
  

  If multiple certificate sections are returned, only use the last certificate.

• openstack: The content of this attribute is stored in /data/home/.config/openstack/clouds.yaml, which allows openstack --os-cloud cf <sub-command> to run from the inception container.
• openstack.auth.auth_url: The OpenStack authentication URL. For example, https://<hostname>:5000/v3. Retrieve this value from OpenStack RC environment variable, OS_AUTH_URL.
• openstack.auth.project_name: The project name to use for IBM® Cloud Private Cloud Foundry installation. Retrieve this value from OpenStack RC environment variable, OS_PROJECT_NAME.
• openstack.auth.project_id: The project ID to use for IBM® Cloud Private Cloud Foundry installation. Retrieve this value from OpenStack RC environment variable, OS_PROJECT_ID.
• openstack.auth.user_domain_name: The domain name to use for IBM® Cloud Private Cloud Foundry installation. Retrieve this value from OpenStack RC environment variable, OS_USER_DOMAIN_NAME.
• openstack.auth.username: The OpenStack user to use for IBM® Cloud Private Cloud Foundry deployments. Retrieve this value from OpenStack RC environment variable, OS_USERNAME.
• openstack.auth.password: The OpenStack password to use for IBM® Cloud Private Cloud Foundry deployments. Retrieve this value from OpenStack RC environment variable, OS_PASSWORD.
• openstack.identity_api_version: Must be set to 3. Retrieve this value from OpenStack RC environment variable, OS_IDENTITY_API_VERSION.
• openstack.interface: Valid values are public or private. Retrieve this value from OpenStack RC environment variable, OS_INTERFACE.
• openstack.region_name: The region to use for IBM® Cloud Private Cloud Foundry deployments. Retrieve this value from OpenStack RC environment variable, OS_REGION_NAME.
• flavors: The flavor to use for each IBM® Cloud Private Cloud Foundry job. If the provided user has the authority to create flavors, they are automatically created. If not, then you can set your own flavors for each job by using this parameter. For more information, see OpenStack size requirements for IBM® Cloud Private Cloud Foundry developer installation.