Installing IBM Cloud Private Cloud Foundry with the Cloud Foundry deployment tool

Cloud Foundry deployment tool

The Cloud Foundry deployment tool is automatically installed on the inception container when you run the launch.sh script. You can use the Cloud Foundry deployment tool to manage extensions, upload your configurations, and start and monitor deployments.

By default, the Cloud Foundry deployment tool is accessible from all IP addresses and uses port 30100 to communicate. You can use the following parameters to restrict client access:

• Use the -ih parameter to configure wanted source IP addresses. The default, 0.0.0.0 is open for all sources.
• Use the -pui parameter to enable wanted ports for the Cloud Foundry deployment tool. The default is 30100.
• Use the -psslui parameter to enable the wanted port for HTTPS access to the Cloud Foundry deployment tool. The default is 30102.
• Use the -dc parameter to specify the path to your own domain certificate.
• Use the -dk parameter to specify the path to your own RSA key.
• Use the -hn parameter to specify the domain of the certificate. The default is localhost.

• Use the -rc parameter to renew the certificates or if you want to migrate from an auto-generated certificate to your own certificate.

  Note: if the -dc and -dk parameters are not provided, a valid self-signed certificate is created for the provided domain. See Providing certificates for IBM Cloud Private Cloud Foundry for more information.

For example:

./launch.sh -n IBMCloudPrivate -b ./BOM.yml -c /home/user/data -e LICENSE=accept -ih 10.10.1.2 -pui 9090

Configuring Cloud Foundry deployment tool settings

Complete the following steps to configure the Cloud Foundry deployment tool:

1. From the installation directory, run the following command:

    ./cm api
   

   Copy the Token. You need the token to set up the Cloud Foundry deployment tool.

2. From a web browser, browse to http[s]://<IP>:<Port> where IP is the IP address of the server that is running the inception container (usually the server from which you enter the launch.sh command). The default ports are 30100 (HTTP) and 30102 (HTTPS) or the ports you specified in the -pui and -psslui parameters of the launch.sh command.

   Note: If you use autogenerated or self-signed certificates, your browser must trust the Cloud Foundry deployment tool URL.

3. Click Settings and complete the following fields:

   • Configuration manager API endpoint http[s]://<IP>:<port> where IP is the IP address of the server that is running the inception container and the port is the default port 30101 (HTTP) and 30103 (HTTPS) or the port you specified in the -p and -pssl parameters of the launch.sh command.

     Note: If you use auto-generated or self-signed certificate, your browser must trust the Configuration manager API endpoint URL.

   • Token This is the token that you copied in step 1.

4. Click Submit.

Managing extensions

IBM provides extensions that are ready for you to use. You can also add your own custom extensions. For more information about using extensions, see Using extensions in IBM® Cloud Private Cloud Foundry.

You can view, register, and unregister extensions.

• To view all available extensions and to register or unregister custom extensions, select Register new extensions from the menu. From the same page, you can also add and remove an extension in the states file.
• To add or remove extensions from the deployment states file, select States from the menu.
• Monitor deployments and view deployment logs from the States table. To view logs for a specific deployment state, click the doc icon that is associated with the state you are interested in.

Configurations

You can upload, create, edit, or view and deploy your configurations.

• To upload new configurations for main deployments and extensions, select Upload configuration from the menu.
• To create a new configuration, select the configuration type and click the pencil. Now you can edit all parameters of the configuration. Next, click Save or Save and Exit to save the configuration.
• After the configuration is created or uploaded, the configuration settings are validated. If no errors are found, click Start deployment to deploy your configuration. The States window opens for you to view the deployment progress.

States

From the States page, you can follow up on the deployment.

• To view the logs of a state, click the document icon next to the state.
• To change the status of a state or multiple states, select the states for which you want to change the status. Click the pencil, then select the status that you want to set.
• To reset all states to READY, click the menu and select Reset statuses.
• To add an extension, click Add extension.
• The tick icon in the Next run column indicates the corresponding state that runs at the next deployment. For each change in the status of a state, this column updates based on the state dependencies. For example, if the Deploy Director is set to ready then a tick icon appears next to the Prepare Director to indicate that it runs at the next deployment.

Server logs

From the Server logs menu, you can see the logs of the Configuration manager.