Installing the blueprint design server in silent mode

In silent mode, you install the blueprint design server by specifying configuration information in command-line arguments. 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 commands ulimit -m and ulimit -v and ensure that they 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.
Read the license agreement. On Linux, it is in this folder: installation_directory/ibm-ucd-patterns-install/web-install/media/server/licenses/. On Windows, it is in this folder: installation_directory\media\server\licenses
From the command line, change the working directory. On Linux, change to the installation_directory/ibm-ucd-patterns-install/web-install/ folder, and on Windows, change to the installation_directory folder.

From the command line, run the installation command. This command must be on a single line.

On Linux, run the following command:
```
./install.sh -l options
```
On Windows, run the following command:
```
./install.bat -l options
```

Note: The -l option in this command indicates that you read and accepted the license agreement.

For options, include all the following arguments:

Argument	Default value	Required or optional	Description
`-f install_directory`	On Linux, /opt/ibm-ucd-patterns, and on Windows, C:\Program Files\ibm-ucd-patterns	Optional	Specify the directory to install the blueprint design server in.
`-i server_hostname`	The host name of the current system	Required	Specify the public IP address or host name that other systems, such as the IBM UrbanCode Deploy server, use to access this system.
`-o ucd_server`	`https://localhost:8443`	Optional for Linux, not applicable for Windows	Specify the full URL of the IBM UrbanCode Deploy server, including the port number. Note: Do not include a slash at the end of this URL.
`-t token`	None	Optional for Linux, not applicable for Windows	Specify the authorization token for the connection to IBM UrbanCode Deploy.
`-e cloud_discovery`	`http://localhost:7575`	Required	Specify the URI to the cloud discovery service, which is URL of the blueprint design server with the default port 7575, such as `http://blueprint_design_server.myserver.com:7575` .
`-d db_type`	`derby`	Required	Specify the type of database to use. For production systems, specify `mysql`, `mariadb`, `DB2`, `oracle`, or `sqlserver`. For evaluation systems, you can also specify `derby` to have the installer create a database for you.
`-a db_url`	`jdbc:mysql://localhost:3306/ibm_ucdp`	Required if you are not using a Derby database	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.
`-v db_user`	`ibm_ucdp`	Required if you are not using a Derby database	Specify the user name for the database.
`-q db_password`	`password`	Required if you are not using a Derby database	Specify the password for the database.
`-m database_driver`	`com.mysql.jdbc.Driver`	Required if you are not using a Derby database	If you are using a MySQL, MariaDB, DB2®, Oracle, or Microsoft SQL Server database, specify the class name of the JDBC driver. If you are using Derby, omit this argument.

For example, the following Linux command installs the blueprint design server, installs a Derby database for the blueprint design server to use, and connects to the server:

./install.sh -l 
-i designserver.example.com
-o https://deployserver.example.org:8443 
-t ABCDE12345 
-e http://engine.myserver.com:7575 
-d derby

The following Windows command installs the blueprint design server and installs a Derby database for the blueprint design server to use:

./install.bat -l 
-i designserver.example.com
-e http://engine.myserver.com:7575 
-d derby

These examples are split onto separate lines for clarity, but the command must be entered on a single line. To use another database, you must specify the information for the existing database. Be sure to place the JAR file for the database driver in the installation directory. The following example for Linux uses a MySQL database:

./install.sh -l 
-i designserver.example.com
-o https://deployserver.example.org:8443 
-t ABCDE12345 
-e http://engine.myserver.com:7575 
-d mysql 
-a jdbc:mysql://localhost:3306/ibm_ucdp
-v ibm_ucdp
-q password
-m com.mysql.jdbc.Driver

If you omit a required argument, the installation program prompts for the value, which means that the silent installation becomes interactive.

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"
```
Optional: On Windows, connect the blueprint design server to the server. See Connecting the blueprint design server to the 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