Installing the blueprint design server in interactive mode

In interactive mode, you install the blueprint design server by typing configuration information in a command-line program. This installation includes the cloud discovery service.

Before you begin

Ensure that your account has the required permissions:
- If you install the blueprint design server on a Linux operating system, root access is required. The operating system must have the most recent package updates. For more information, see Installing and Managing Software in the Red Hat Enterprise Linux customer portal.
- If you install the blueprint design server on a Windows operating system, your account must be a member of the Administrators group.
Make sure that your system meets the system requirements. See System requirements and performance considerations.
Make sure that your networks and firewalls allow communication on the required ports. See Firewall and communication configuration.
Make sure that you have a license server with available IBM UrbanCode Deploy licenses.
Install an engine. You can install the blueprint design server and engine on the same computer or on different computers. See Installing engines. If you install the engine and blueprint design server on the same computer, you must install the same version of each program.
Install or upgrade the IBM UrbanCode Deploy server.
Create an authorization token on the IBM UrbanCode Deploy server. You must have this token to retrieve information about components from the server.
Configure a database for the blueprint design server. See Blueprint design server database configuration.
If you are using a database other than Apache Derby or PostgreSQL, either note the location of the JDBC JAR file for the database or place the file in the installation_directory/ibm-ucd-patterns-install/web-install/media/server/opt/tomcat/lib folder.
If you install the blueprint designer on a Linux operating system, install the following prerequisite packages:
- gcc
- python-devel
On a Red Hat Enterprise Linux system, the command to install these packages might resemble the following code:
```
yum install -y gcc python-devel
```
If you install the blueprint designer on a Windows system, install Python 2.7.9 or a higher 2.x version. Version 3 and later are not supported. You can install Python yourself, or the installation program will install a compatible version.
Ensure that there is no limit on the maximum memory size and virtual memory size. For example, on most Linux systems, you can run the ulimit -m and ulimit -v commands and ensure that both return the value unlimited. To find out how to remove the limit on the maximum memory size and virtual memory size, see the documentation for the operating system.

Procedure

Download and extract the installation files for the blueprint design server. These files are available for download from the IBM Passport Advantage® website. See the IBM UrbanCode Deploy download document.
From the command line, run the installation program. On Windows, you must use the command line instead of the WindowsPowerShell.
- On Linux, change to the installation_directory/ibm-ucd-patterns-install/web-install/ folder, and run the install.sh file.
- On Windows, change to the installation_directory folder, and run the install.bat file.
At the prompt If you do not have Python 2 installed, press 'y' and Python 2.7.9 will be installed on this machine, press y if Python is installed or if you want to install Python automatically. Press n to close the installer and install Python on your own.
Read the license agreements for the software package. Press the Space bar to show one page at a time, or press F to show the entire license text.
If you agree to the terms of all of the license agreements, press Y, and then press Enter.
Specify the following information as the installation program prompts you. You can accept the default values (displayed within brackets) by pressing Enter. If two options are given, such as [Y/n], the uppercase option is the default value.
Specify the directory where the blueprint design server for UrbanCode Deploy should be installed.

Specify the directory to install the blueprint design server in. The default installation directory is /opt/ibm-ucd-patterns on Linux and C:\Program Files\ibm-ucd-patterns on Windows.

The specified directory does not exist. Do you want to create it?

Press Y to create the installation directory.

Enter the public IP address or host name of this system.

Specify the public IP address or host name that other systems, such as the IBM UrbanCode Deploy server, use to access this system. In most cases, specify the host name of the computer that hosts the server, such as designserver.example.com.

Do you want the blueprint design server to always use secure connections using SSL?

Press Y to use secure connections to the blueprint design server. If you select this option, you must configure a certificate for the blueprint design server; see Configuring SSL security on Apache Tomcat for the blueprint design server.

Enter the port on which the blueprint design server should listen for secure HTTPS requests.

Specify the HTTPS port for the blueprint design server. The default value is 8443. If you are installing the IBM UrbanCode Deploy server and the blueprint design server on the same computer, be sure to use a different port for each server.

Enter the port to which the blueprint design server should redirect unsecured HTTP requests.

Specify the HTTP port for the blueprint design server. The default value is 8080. If you are installing the IBM UrbanCode Deploy server and the blueprint design server on the same computer, be sure to use a different port for each server.

Create database schema?

In most cases, press Y to create new schema definitions in the database. However, if you have a pre-populated database, press N.

Enter the database type to use.

Specify the type of database to use. For production systems, specify mysql, mariadb, db2, oracle, sqlserver, or postgres. For evaluation systems, you can use one of these databases, or you can specify derby to have the installer create a database for you.
Note: Derby is not appropriate for production blueprint design servers.
Specify the following information for the database connection:
Enter the database driver.

Specify the class name of the driver, such as com.mysql.jdbc.Driver. This field is required only if you are not using a Derby database.

Enter the database connection string.

Specify the complete connection string for the database. For example, if you use a MySQL database, the connection string resembles the following code: jdbc:mysql://hostname:3306/ibm_ucdp , where hostname is the host name or IP address of the database server.

If you are using the MySQL database on an engine, specify jdbc:mysql://engine.example.org:3306/ibm_ucdp , where engine.example.org is the host name or IP address of the engine.

Enter the database username.

Specify the user name for the database. The default user name is ibm_ucdp. If you are connecting to a production database, specify the user name for an existing account on the database. If you are creating a Derby database, specify a new user name for the database.

Enter the database password.

Specify the password for the database. The default password is password. If you are connecting to a production database, specify the password for the database account. If you are creating a Derby database, specify a new password for the database account.

Enter the path to the database library jar file to copy into your installation.

If you are using a production database, specify the location and file name of the database JDBC JAR file. For example, on Linux the path and file name might look like this string: /root/mysql-connector-java-5.1.27-bin.jar. On Windows, the path and file might look like this string: C:\tmp\mysql-connector-java-5.1.27-bin.jar

Enter the URI for the IBM UrbanCode Deploy server.

Specify the URL for the server, including the port. The default port is 8443, for example: https://deployserver.example.org:8443.
Note: Do not include a slash at the end of this URL.
If you do not want to connect, leave this field blank.

Enter the authentication token to access the UrbanCode Deploy server.

Specify the authentication token from the IBM UrbanCode Deploy server. If you are not connecting, leave this field blank.
Configure the cloud discovery service. See Setting up images, regions, and flavors for the cloud discovery service and engine.
Start the cloud discovery service:
- On Linux systems that manage services with the systemd system manager, use the systemctl command:
```
systemctl start ibm-cloud-discovery.service
```
- On Linux systems that do not manage services with the systemd system, run the following command:
```
cloud-discovery-service &
```
- On Windows, run the following command:
```
C:\python_installation_directory\Scripts\cloud-discovery-service.exe
```
  Use the location where Python is installed for python_installation_directory. The default installation directory is C:\Python27. By default, the command looks like this code:
```
C:\Python27\Scripts\cloud-discovery-service.exe
```
If you installed the blueprint design server on the same computer that you installed the engine, restart the Heat services and Keystone, if applicable. See Starting the blueprint designer, cloud discovery service, and engine.
Start the blueprint design server:
- On Linux, run the following command:
```
server_installation_directory/bin/server start
```
  Use the location of the blueprint design server installation for server_installation_directory. The default installation directory is /opt/ibm-ucd-patterns. By default, the command looks like the following code:
```
/opt/ibm-ucd-patterns/bin/server start
```
- On Windows, run the following command:
```
C:\server_installation_directory\bin\start_server
```
  Use the location of the blueprint design server installation for server_installation_directory. The default installation directory is C:\Program Files\ibm-ucd-patterns. By default, the command looks like the following code:
```
"C:\Program Files\ibm-ucd-patterns\bin\start_server"
```
Change the local Git server password. See Changing the local Git server password.
Provide the IBM UrbanCode Deploy server with files that install an agent on the cloud instances that you provision. Follow these steps on a Linux computer to install the agent components on the server. These components are included automatically in deployments that require agents.
1. Extract the installation files for the blueprint design server and the agent components.
2. Set the system JRE to the JRE that is provided in the blueprint design server installation files. For example, to temporarily set the JRE on a Linux computer, use the following command:
```
export JAVA_HOME=installation_directory/ibm-ucd-patterns-install/web-install/media/server/java/jre
```
  For installation_directory, use the location of the blueprint design server installation files.
3. From the command line, change to the installation_directory/ibm-ucd-patterns-install/agent-package-install/ folder, and run the installation program:
  - On a Linux computer, change to the directory where you extracted the agent components and run the following command:
```
./install-agent-packages.sh -s ucd_url -a token
```
    - ucd_url is the full URL of the IBM UrbanCode Deploy server, such as https://deployserver.example.org:8443
    - token is a token from the server
  - On a Windows computer, change to the directory where you extracted the agent components and run the following command:
```
.\install-agent-packages.ps1 -s ucd_url -a token
```
    - ucd_url is the full URL of the IBM UrbanCode Deploy server, such as https://deployserver.example.org:8443
    - token is a token from the server
  Note: If you are using Windows server, you must run the command from PowerShell.
4. On the IBM UrbanCode Deploy server, verify that the agent components were created. The names of the components are ucd-agent-linux-ppc64, ucd-agent-linux-x86_64, ucd-agent-win-x86_64, and ucd-agent-linux-s390x.
5. On the IBM UrbanCode Deploy server, add these components to any teams that provision environments from the blueprint designer. Users must have access to these components to provision environments from the blueprint designer.
Connect the server to the blueprint design server:
1. On the server, click Settings > Blueprint Designer Integrations.
2. Click New Blueprint Designer Integration.
3. Specify a name for the connection to the blueprint design server.
4. In the URL field, specify the complete URL to the blueprint design server, such as http://blueprint_design_server.example.com:8080/landscaper.
5. Select the Authentication Method.
  - To require each user to authenticate to the blueprint design server, select Automatically authenticate for each UrbanCode Deploy user. On the blueprint designer, you must create an authentication realm for this UrbanCode Deploy server. See Importing user accounts from IBM UrbanCode Deploy to the blueprint design server.
  - To use only one set of blueprint designer credentials, select Always authenticate with one blueprint designer username. Ensure that blueprint designer user name that you enter has permissions to access the cloud platforms where you provision cloud environments. Specify the blueprint design server user name and password to use to connect. The server has access to only the blueprints that this user name has access to.
6. Click Save.
Optional: To test the connection between the server and the blueprint design server, install the sample application and ensure that you can access it from the blueprint designer:
1. Set the system JRE to the JRE that is provided in the blueprint design server installation files. For example, to temporarily set the JRE on a Linux computer, use the following command:
```
export JAVA_HOME=installation_directory/ibm-ucd-patterns-install/web-install/media/server/java/jre
```
  For installation_directory, use the location of the blueprint design server installation files.
2. From the command line, change to the installation_directory/ibm-ucd-patterns-install/agent-package-install/ folder, and run the installation program:
  - On a Linux computer, change to the directory where you extracted the agent components and run the following command:
```
./install-ucd-blueprint-designer-test-app.sh -s ucd_url -a token
```
    - ucd_url is the full URL of the IBM UrbanCode Deploy server, such as https://deployserver.example.org:8443
    - token is a token from the server
  - On a Windows computer, change to the directory where you extracted the agent components and run the following command:
```
.\install-ucd-blueprint-designer-test-app.ps1 -s ucd_url -a token
```
    - ucd_url is the full URL of the IBM UrbanCode Deploy server, such as https://deployserver.example.org:8443
    - token is a token from the server
  Note: If you are using Windows server, you must run the command from PowerShell.
3. On the IBM UrbanCode Deploy server, verify that the sample component and application were created. The component is named ucd_blueprint_designer_test and the application is named ucd_blueprint_designer_test_app.
4. Log in to the blueprint designer.
5. Create a blueprint.
6. From the Images drawer of the palette, add a Referenced Image resource to the blueprint.
7. From the Components drawer, drag the ucd_blueprint_designer_test component to the Referenced Image resource.
8. From the Choose UCD Application window, select the check box next to the ucd_blueprint_designer_test_app application, click OK, and click OK again.
The component shows a warning that says MISSING because it has no versions. Other than that warning, if you can add the component in this way, the blueprint designer is connected to the IBM UrbanCode Deploy server.

Results

You can access the blueprint design server by opening the following URL in a web browser: https://hostname:port/landscaper , where hostname is the host name of the blueprint design server and port is the HTTP port that you specified when you installed the blueprint design server. The default administrator user name is ucdpadmin, and the default password is ucdpadmin .

What to do next

If you did not connect the blueprint design server to the IBM UrbanCode Deploy server during the installation, connect it now. See Connecting the blueprint design server to the server.
Connect to a cloud. See Overview of integrations.

Feedback