EditAttachPrintable
Revision 4 - 2017-11-29 - 21:21:04 - Main.ccarty

Example of end to end deployment using Quick Deployertodo.png

Authors: ClareCarty
Build basis: CE/CLM 6.0.4+.

This article describes the end to end process for using IBM Quick Deployer 2.0 to install and deploy an example IBM Continuous Engineering 6.0.4 topology on Websphere Application Server with a DB2 backend on Windows 2012 servers.

There are three main steps to this process: -

  • Prepare: Decide what you are going to deploy and plan and assemble your bits and accounts.
  • Setup: Setup your systems including installing Quick Deployer into UrbanCode Deploy, set up your media server (if used) with all the install bits, and set up your target VMs.
  • Run: Run install Applications on Quick Deployer to install CE/CLM onto your target VMs.

Prepare

I’ve picked a small topology from the Recommended ALM topologies - this one: (ALM-D1) Departmental - Single application server / Windows / DB2: alm_d1.png

This is a Windows topology with a DB2 database. I’m going to modify it a bit and remove the DOORS/DWA piece since Quick Deployer doesn’t install those and I don’t need it anyway. I’m also going to use a Tivoli LDAP server since that’s what we’ve used to test Quick Deployer and I’m going to put DCC on the same server as the JTS. Note that this image is a bit out of date and VVC is no longer a separate app.

Netting this out, this gives us four server VMs: One IBM HTTPS reverse proxy server, one DB2 server, one WAS application server with LQE and one with all the other CE apps including JTS, CCM, QM, RM, RS, DCC, GC, LDX, RELM and DM. I’m going to allocate 4 Windows 2012 VMs for these servers, each with 4 CPUs, at least 8G of RAM and minimum 100G hard drives. These will be my target VMs.

There are three other pieces I need to think about to prepare for my deployment: -

  • Where the media – the zips and bits I’m going to install - are going to be.
  • What LDAP server and accounts I’m going to use.
  • What UrbanCode Deploy server I’m going to install Quick Deployer on.

Media Server

For media, I will need the bits for Websphere application server, DB2 install, IBM Installation Manager, IHS (IBM HTTP Server) and the install bits for CE/CLM. I’ve got a couple of options here. I could choose to download the media locally – that means downloading all the middleware and CE install zips on to each target VM. Or I could use an FTP media server that con-tains all the installers. [Note that mapped network drives aren’t supported for Quick Deployer on Win-dows]. For further details on the media server requirements you can check the Quick Deployer wiki. For simplicity, I’m going to use an existing ftp server that my team has set up with all the install bits. For the purposes of this article, I’m going to call it ftp://tompw7-qd-ftp01.ibm.com:2121/604/

LDAP Server

Here I’m going to reuse the Tivoli Directory Server LDAP that we use in our Continuous Delivery pipeline. I would expect in any client environment that you would already have your own LDAP server setup to use with CE/CLM. I’m going to call this server https://clmpipeline.ibm.com for this article..

Urban Code Deploy Server

I’m going to use a new UCD server (https://ucd-15.ibm.com:8443/) and install Quick Deployer into it. The steps to install UCD are out of scope for this article but you can consult the UCD documentation for help. Quick Deployer is pushed into UCD using an installer script but there are some properties files that need to be edited before the installer is run and we’ll go through those in the Setup section. And that’s it, those are the main items I need to think about during the planning and preparation stage. Let’s move on to Setup now and start assembling our bits.

Setup

First, I’ll prep my UCD Server for installing Quick Deployer.

Urban Code Deploy Server Setup

The UCD Server should have a recent version installed. For this demo I’m using 6.2.1.1.x. I’m just using the default admin account on UCD here for this article. I create an administration token using the admin account from UCD’s Settings tab. Quick Deployer’s installer uses this in qd.properties as the authentication token to install QD into UCD.

ucd_create_token.png

I give the token an expiration date and select the other defaults.

new_auth_token.png

Let's take stock and see what we've assembled so far:-

Get the Quick Deployer package and configure the properties files

I download the QD 2.0 package from the wiki and unzip it into a folder on my laptop. I already have java 7.1 installed on my laptop and available on my system path so I can run the installer when I’ve finished editing the properties files. Here’s what the contents of the Quick Deployer package look like:-

qd_package.png

Before I can run the QD installer, I must edit the properties files.

There are four properties files here I’m going to edit before I run the install.jar.

  • qd.properties
  • usercreds.properties
  • ldap.properties
  • db2Parameter_windows.properties

If I were using an Oracle database, I’d have to use oracleParameter_windows.properties and if I were on linux I’d choose the appropriate linux properties files. The downloaded package contains sample properties files and I could actually just run the install.jar with mostly default properties - though I must first edit qd.properties because that’s where I must set my UCD server information, media option, db vendor and other credentials. If I did install Quick Deployer with sample ldap, database and userCreds properties, I would have to then run the set default ldap, database and userCred properties processes in Quick Deployer via UCD. I prefer to set the ldap, database and userCreds properties files so I can install Quick Deployer in one step and avoid having to tweak process properties afterwards. Let’s have a look at each of these properties files in turn.

qd.properties

This is the main properties file used by the QD installer. This is one I absolutely must edit before running the Quick Deployer installer.

some of the fields to be changed in qd.properties include:-

  • #URL to the IBM Urban Code Deploy server to which Quick Deployer will be installed.
  • ucdUrl=https://ucd-15.ibm.com:8443

  • #An authentication token that can be used to authenticate to the IBM UrbanCode Deployer server specified by the ucdUrl property.
  • ucdToken= 6be42c13-32e9-4091-9946-3753e6f7394f

  • #The URL of the media server that contains the product artifacts. This should not be set if localPath is being used.
  • mediaUrl=ftp://tompw7-qd-ftp01.ibm.com:2121/604/

  • #Administrator user name as defined on the LDAP server.
  • wasUserName=clmadmin

  • #Administrator password as defined on the LDAP server.
  • wasPassword=MyUserPassword

  • Remove comment marker on next line to specify full or relative path to LDAP proper-ties.
  • ldapProperties=./ldap.properties

  • Remove comment marker on next line to specify full or relative path to user creden-tials properties.
  • #userCredsPropertiesLinux=./userCreds.properties
  • userCredsPropertiesWindows=./userCreds.properties

  • Remove comment marker on next line to specify full or relative path to database prop-erties.
  • databaseProperties=./db2Parameter_windows.properties

A short word on accounts and URLS

The server URLs used here are not real and the accounts and passwords are also fictional but they are representative of real accounts and are used to give realistic examples.

userCreds.properties

This is where I set up my credentials for QD to use, with passwords in Base64 format. You can encode your passwords into Base64 using an online tool or you can skip this step and run the Change user proper-ties process (which will do the encoding for you) once Quick Deployer is installed. I prefer to set it all up now so I’m using the Base64 encoded values.

Some of the fields to be changed include:-

ldap.properties

You may need to consult with your local LDAP expert for the correct settings for your LDAP server.

Some of the fields to be changed include:-

  • # LDAP fully qualified hostname
  • jazz_ldap_host="clmpipeline.ibm.com"

db2_Parameter.properties

Finally, my db2 properties, specific to windows.

Make sure for windows that each DB being created (where application is 'xx') has an entry that looks like this:-

  • createdxxDBOption="ON 'C:\IBMQD\db2fs' DBPATH ON 'C:' USING CODESET UTF-8 TERRITORY EN PAGESIZE 16384"
xxDBName=xxDB

Install Quick Deployer on the Urban Code Deploy Server

So now I’ve got my properties files all set up and UCD prepped, I’m ready to install Quick Deployer into UCD.

Since I have java already in my environment I can open a cmd window, change directory to the folder where I placed the install.jar and run the install jar with qd.properties

java -jar install.jar qd.properties

If we go take a look in UCD now, we see the application has been created: -

qd_app_created.png

If I click on the Components tab I can also see my components: -

qd_components.png

QD Post-install tasks

I could do a bunch of configuration tasks now including

  • Updating the permissions granted to the Team Member role.
  • Setting fixed component versions on application processes - Set fixed component versions.
  • Enabling installation of iFix releases.
  • Securing the administrator and user passwords. Securing user passwords.
Right now, I’m just going to set fixed component versions on the Install Application process.

Set fixed component versions on the Install application process

I navigate to the Applications page and select the Rational_QD_604 application, switch to the Processes tab and select the Install Applications process.

app_processes.png

On the process Configuration tab, I select Basic Settings and set all 5 components to a specific version. Typically, you would select the latest version of each component from the version drop-down list.

install_app_process.png

Once all versions are set, I select save.

inst_app_process_settings.png

Target VM Setup

I’ve got Quick Deployer installed and ready. Now I need to prepare my target VMs. I’ve got 4 Windows VMs I need to set up with some pre-requisites. These are listed in the System Re-quirements. I log into each of the VMs as The Administrator and do the following:

  • Check that the operating system is Windows Server 2012 R2 Standard (64-bit) – that’s the latest supported Windows operating system for CE/CLM 6.0.4
  • Check the Windows Management Instrumentation Service is running (I use services.msc and check the service is running)
  • Check that my VMs are all in the same domain and that the fully qualified domain name of each VM contains only lower case characters.
  • Check that all VMs are set to the same time zone.
  • Download and install python (I’m using python 2.7.9)and add python.exe to the system path
  • Download and install java 1.7 and add java to the system path
  • Create a user account called clmadmin with password MyUserPassword
  • Give the clmadmin account remote desktop access and ensure the local security policy is amend-ed so that ‘log on as a service’ is enabled for the clmadmin account. Login to each VM using re-mote desktop with the clmadmin account to verify everything is setup correctly.
  • As a final step, using a web browser, I access the UCD server from each VM and download the UCD agent.
  • I get the UCD agent from the UCD server’s tools menu. I download the zip and extract it.

ucd_tools_menu.png

ucd_agent_menu.png

  • I double click on the install agent batch file to install it with these settings.
  • Use the default install directory,
  • default agent home directory,
  • I don’t use an agent relay,
  • I enter ucd-15.ibm.com as the hostname of the server,
  • I use the default port,
  • I don’t use a failover port,
  • I use the defaults for two-way authentication and end-to-end encryption
  • I don’t enable the agent to verify the https certificate,
  • I skip entering the full url of the ucd server,
  • I use the default agent name,
  • I enter Rational QD CLM as the team,
  • I say yes to installing the agent as a windows service,
  • I leave the unique service name for the agent at the default,
  • I enter the user account name as .\Administrator and
  • I enter the password,
  • and finally, I opt to start the agent service automatically.

I verify the ucd agent is started by going into services and verifying the agent service is running:

ucd_agent_service.png

Now I go into UCD (Resources>Agents) and verify the agent is online.

ucd_agent_online.png

Once I’ve completed these preparation steps for all my target VMs, all four of my agents should be online.

ucd_all_agents_online.png

I take a snapshot of all my VMs in case anything goes wrong and now I’m ready to create my Quick De-ployer Application environment.

Create the Application Environment

The application environment in UCD is how we tell the Quick Deployer application where to install the CE/CLM apps on our VMs. Detailed instructions on how to do this are on the Quick Deployer wiki.

Create top-level resource group

The first thing I do is create a top-level resource group in UCD.

top-level-resource.png

I create one called w16-qd

w16_rg.png

Create Environment

Then I open the Rational_QD_604 application and select Create Environment, naming it w16-qd and press Save.

app_env.png

Add the top-level resource to the environment

I open the environment and add the top-level resource I just created.

add_res_to_env.png

Add the agents to the base resource in the environment

Now, I add the 4 UCD agents that were installed on the target VMs to the base resource in my new envi-ronment.

add_agent_to_resource.png

Which gives me:

all_agents_in_env.png

Map the components to the agents

Now I map components to my agents as follows: Select a resource, then click Actions > Add Component. This is the list of components I need to map:

  • Rational_QD_Application_604
  • Rational_QD_ApplicationServer_604
  • Rational_QD_Database_604
  • Rational_QD_InstallationManager_604
  • Rational_QD_SystemPre-Requisite_604

These can be found in the Components tab in UCD. If you remember, my topology maps as follows: -

  • DB2 server
  • IHS Server
  • Node 1 – WAS application server with JTS, CCM, QM, RM, RS, DCC, GC, LDX, RELM and DM.
  • Node 2 – WAS application server with LQE

For this, I will need the following component mappings:

  • DB2 Server :

Miscellaneous

Related topics: Deployment web home, Deployment web home

External links:

Additional contributors: TWikiUser, TWikiUser

  • all_agents_in_env.png:
    all_agents_in_env.png
Edit | Attach | Printable | Raw View | Backlinks: Web, All Webs | History: r13 | r6 < r5 < r4 < r3 | More topic actions...
This site is powered by the TWiki collaboration platformCopyright © by IBM and non-IBM contributing authors. All material on this collaboration platform is the property of the contributing authors.
Contributions are governed by our Terms of Use. Please read the following disclaimer.
Dashboards and work items are no longer publicly available, so some links may be invalid. We now provide similar information through other means. Learn more here.