IBM Cloud Automation Manager 2.1.0.3

Installation Getting Started Guide

Date: August 2nd, 2018

Overview 3 ..........................................................................................................................................................

Product overview 3 ............................................................................................................................................

Online vs Offline installation 4 ...........................................................................................................................

Topology Configuration 4 ...................................................................................................................................

Development Environment (Single VM) 4 .................................................................................................

IBM Cloud Private Installation 5 ........................................................................................................................

General Cloud Automation Manager Installation Steps 6 ................................................................................

Step 1: Understand the Cloud Automation Manager Installation Requirements 6 ....................................

Step 2: Setup Helm command line tools 7 ...................................................................................................

Step 3: Install IBM Cloud Automation Manager Community Edition 7 ........................................................

Step 4: Deploy the Content Runtime (optional) 8 ........................................................................................

Development Environment Installation 8 .........................................................................................................

Step 1: Create Docker Store Secret 8 ...........................................................................................................

Step 2: Generate a deployment ServiceID API Key 9 ...................................................................................

Step 3: Setup the NFS server 9 .....................................................................................................................

Step 4: Create the persistent volumes using the ICP user interface. 10 ....................................................

Step 5: Install CAM from the ICP user interface. 11 ....................................................................................

IBM Cloud Automation Manager Template Library 14 ......................................................................................

Content Runtime Installation 15 ......................................................................................................................

Step 1: Review the System Requirements 15 ..............................................................................................

Step 2: Gather Cloud specific information 15 ..............................................................................................

Step 3: Create Cloud Connections for the target cloud platforms 15 .........................................................

Step 4: Determine Cloud Provider and Runtime to create 15 .....................................................................

Step 5: Deploy the content runtime 16 ........................................................................................................

Step 6: Populate the software repository 17.................................................................................................

Page of 2 17

Overview

This guide gets you started installing IBM Cloud Automation Manager version 2.1.0.3 on IBM Cloud Private version 2.1.0.3. It is not a comprehensive step by step guide but a combination of pertinent information on making you successful installing IBM Cloud Automation Manager.

Product overview

IBM Cloud Automation Manager (CAM) on IBM Cloud Private (ICP) is a containerized cloud native application that is installed into an IBM Cloud Private worker node with a Helm Chart. IBM Cloud Automation Manager helps optimize developer’s need for speed with organization’s need for governance.

This is accomplished by:

1) Cloud Automation Manager Service Composer allows you to expose any cloud service in any cloud through the IBM Cloud Private catalog to accelerate developer velocity and improve governance.

2) Cloud Automation Manager brings a common approach to automate all workloads in all clouds to reduce configuration errors and improve operational efficiency. You can manage infrastructure as code using Hashicorp Terraform software. A Content library to get started fast which allows you to leverage IBM, community and home-grown assets as building blocks and modernize legacy applications and build new cloud native applications.

3) Cloud Automation Manager Template Designer that will accelerate development of reusable Terraform automation.

IBM Cloud Automation Manager product comes in two editions. The IBM Cloud Automation Manager Community Edition and IBM Cloud Automation Manager. Differences between the two editions:

Notes:

CAM Community Edition CAM

Production Usage No Yes

Online Install Yes Yes, see note 1

Offline Install No Yes

ICP Metering No Yes

Page of 3 17

1) Online install for IBM Cloud Automation Manager is achieved by downloading the product ID text file from IBM Passport Advantage and using the contents of the product ID text file as the Product Identifier during the install of the HELM chart.

Online vs Offline installation

IBM Cloud Automation Manager can be installed with and without access to the internet. The Knowledge Center refers to online installation as the environment you are installing CAM into has access to the internet so that the installation packages can be retrieved. Offline installation means that the environment you are installing CAM into does not have access to the internet. In this situation, you first must download all of the installation packages to your local environment.

The differences between the two installation methods are:

More information on offline can be found here: • Installing Cloud Automation Manager offline • Provisioning an offline Content Runtime

Topology Configuration

The development environment will be a single virtual machine that has ICP and CAM installed. This type of environment is good for understanding how CAM can be used within your organization without the need for multiple virtual machines.

Development Environment (Single VM)

In this environment, ICP and CAM are installed on a single virtual machine. The minimum requirements for this single virtual machine are:

- vCPU 4 or more.

Online Install Offline Install

CAM Community Edition Yes Not supported

CAM Edition Yes Supported

Starter pack templates loaded Yes No

Middleware templates loaded Yes No

Integration templates loaded Yes No

Content Runtime templates loaded

Yes No

Page of 4 17

- 16GB of RAM. - Disk Space greater than 200GB - NFS Server installed and configured for CAM persistent volumes.

IBM Cloud Private Installation

This guide assumes that IBM Cloud Private version 2.1.0.3 product has been correctly installed with the corresponding helm-api patch applied.

The Helm repository should be configured to the ibm-charts repository and local-charts repository. To verify, from the IBM Cloud Private UI, go to the navigation menu, click Manage > Helm Repositories and verify that you have the following repositories already configured. Note, you might see a different value for local-charts.

Page of 5 17

If you do not have these repositories configured, click on Add repository and enter in the Name and URL of the Helm repositories.

General Cloud Automation Manager Installation Steps

These are the general steps that should be followed when installing IBM Cloud Automation Manager on IBM Cloud Private.

Step 1: Understand the Cloud Automation Manager Installation Requirements

Before attempting to install Cloud Automation Manager, you will need to understand the installation requirements. The IBM Knowledge Center is the home of IBM product documentation and here you will find the IBM Cloud Automation Manager and IBM Cloud Private knowledge centers. These links serve as good reference material for additional questions and inquiries.

The CAM Installing section contain articles on system requirements, prerequisites, and how to install both IBM Cloud Automation Manager Community Edition and IBM Cloud Automation Manager edition.

Summary of items that you need to consider before you install CAM

1. Hardware requirements for single node and multi-node clusters. See ICP and CAM requirements.

2. Review the Prerequisites article. Make sure the following are complete: a. IBM Cloud Automation Manager helm api service ID token patch for IBM Cloud Private

version 2.1.0.3 has been applied. b. Helm CLI and kubectl CLI have been installed and configured.

Page of 6 17

c. Deployment ServiceID API key has been created and the API key that is returned is available.

3. Four persistent volumes in ICP environment must be created to store CAM database, logs files, Terraform and Template designer information.

4. Determine if storage volumes should be encrypted for security purposes. 5. Determine if the CAM bundled Mongo DB container will be used or an external MongoDB will be

used. It is recommended that you use an external MongoDB for production environments. 6. If you plan on using the CAM Template Designer, it is recommended to use an external database. 7. If performing online installs, you must create a Docker Store secret. See Creating Docker Store

secret article for more information. 8. If performing offline installs, you will need to download CAM from IBM Passport Advantage.

Review Installing Cloud Automation Manager offline and Downloading part numbers for Cloud Automation manager for more information.

Persistent Volume Requirements. a. CAM requires 4 persistent volumes. You can use NFS, GlusterFS or Kubernetes

hostPath. Please note that hostPath is only on supported single node cluster environments.

b. For NFS file systems, make sure that you have the appropriate NFS packages installed and properly exported the NFS file shares.

c. See Creating Cloud Automation Manager persistent volumes for additional details. When creating the persistent volumes, make sure that the implemented PV names and type match as specified in the knowledge center. Each file must have a correct path for export setup based on your chosen storage path.

Step 2: Setup Helm command line tools

Helm is a tool for managing Kubernetes charts and has a client (helm) and a server (tiller) component. Tiller runs inside the Kubernetes cluster, and manages releases of charts. Helm can run anywhere, but it is recommended to be installed on your client machine.

Install both the HELM and kubectl CLI in order to create the Docker secret for online installs. See Prerequisites for installing Cloud Automation Manager article, for additional information on installing Helm CLI, kubectl CLI and IBM Cloud Private CLI.

Step 3: Install IBM Cloud Automation Manager Community Edition

In this step, IBM Cloud Automation Manager will be installed. See Development Environment Installation section for details.

Page of 7 17

Step 4: Deploy the Content Runtime (optional)

The content runtime will need to be installed if deploying IBM Middleware products. See the Content Runtime Installation section for details.

Development Environment Installation

The IBM Cloud Automation Manager Community Edition will be used for the development environment and this section will provide details on the various steps. If installing IBM Cloud Automation Manager Edition, download the Product Identifier file from Passport Advantage and specify the contents of the file in the Global section of the helm chart. Replace IBMCloudAutomationManager_5737E67_2102_CE_000 with the appropriate text from the file downloaded.

See Installing Cloud Automation Manager Community Edition online or Installing Cloud Automation Manager online instructions for additional instructions on how to install Cloud Automation Manager using the online method.

The Installing IBM Cloud Automation Manager Community Edition video is a video installation of CAM. Please note that this video is based on IBM Cloud Automation Manager Community Edition 2.1.0.2, so versions, export paths, catalog entries, and other steps may vary. The video can be used for reference as progression through this guide is made. Do not skip steps or inputs.

Step 1: Create Docker Store Secret

The Docker Store secret needs to be created that will allow the Cloud Automation Manager docker images to be retrieved. Refer to the Creating Docker Store secret article for details on how to create your API key. Remember the secret name as it will be needed during the Cloud Automation Manager Community Edition install process. The Docker Store secret, Docker account API key, and Service ID API key in the next step are different values.

Page of 8 17

Step 2: Generate a deployment ServiceID API Key

From your terminal command line where you have the IBM Cloud Private CLI is installed: export serviceIDName='service-deploy' export serviceApiKeyName='service-deploy-api-key'

bx pr login -a https://localhost:8443 --skip-ssl-validation -u <admin_user> -p <admin_password> -c id-mycluster-account

bx pr target -n services bx pr iam service-id-create ${serviceIDName} -d 'Service ID for service-deploy' bx pr iam service-policy-create ${serviceIDName} -r Administrator,ClusterAdministrator --

service-name '' bx pr iam service-api-key-create ${serviceApiKeyName} ${serviceIDName} -d 'Api key for

service-deploy'

The output of this last command will display the API Key. This service API key is the API key that will be used during final configurations and installation of the helm chart.

Note: If you are running the bx command from a remote system, you can replace localhost with the IP address of the virtual machine used for configuration.

Step 3: Setup the NFS server In this installation of Cloud Automation Manager, we will use NFS backed persistent volumes. We will setup an NFS server on the development environment that will be used as the host.

Check with your I/T administrators for the proper NFS configuration for your company.

1. Install the NFS server and client packages for your Linux distribution • Ubuntu: nfs-kernel-server, rpcbind, nfs-common • Red Hat: nfs-utils, nfs-utils-lib

2. Create four directories that will be used to hold the persistent volumes mkdir -p /export/CAM_logs mkdir -p /export/CAM_db mkdir -p /export/CAM_terraform mkdir -p /export/CAM_BPD_appdata

3. Update /etc/exports and add these lines. /export *(rw,fsid=0,insecure,no_subtree_check,async) /export/CAM_logs *(rw,nohide,insecure,no_subtree_check,async,no_root_squash) /export/CAM_db *(rw,nohide,insecure,no_subtree_check,async,no_root_squash) /export/CAM_terraform *(rw,nohide,insecure,no_subtree_check,async,no_root_squash) /export/CAM_BPD_appdata *(rw,nohide,insecure,no_subtree_check,async,no_root_squash)

Page of 9 17

The path for both the exports and /etc/exports must be matching before installing the chart. Failure to do so results in pod errors when pulling images and cannot be edited while the chart is still deployed.

4. Restart the NFS server • service nfs-kernel-server restart

Step 4: Create the persistent volumes using the ICP user interface.

There are two ways of creating the persistent volumes within ICP. You can either use the ICP user interface or use the kubectl command line. See Creating Cloud Automation Manager persistent volumes article for both sets of instructions.

Use the IBM Cloud Private user interface to create the four persistent volumes.

1. Log in to IBM Cloud Private user interface. 2. From the navigation menu, select Platform > Storage > PersistentVolume and click Create

PersistentVolume. 3. This screen shot examples the cam-mongo-pv persistent volume.

On the General Tab:

Note:

1) The Name must match the value that is specified on the Helm Chart Configuration panel. 2) The storage class name field must be empty.

On the Labels Tab:

Page of 10 17

On the Parameters Tab:

Notes:

1) Your server IP will be different and make sure that the path value matches the name of the CAM_db NFS mount point.

2) The path value should match the exported NFS mount location you specified in /etc/exports.

4. Repeat the above steps for the cam-logs-pv, cam-terraform-pv and cam-bpd-appdata-pv.

Step 5: Install CAM from the ICP user interface.

From the IBM Cloud Private UI navigation menu, click Catalog and select ibm-cam-prod that is associated with the ibm-charts repository.

Page of 11 17

Double click ibm-cam Helm chart, the ibm-cam V1.3.0 Helm chart will be displayed.

IBM Cloud Private 2.1.0.3 release will have two IBM Cloud Automation Manager Helm charts. They are ibm-cam and ibm-cam-prod. You will want to always use ibm-cam as this will be the latest helm chart. The ibm-cam-prod will be depreciated in the future.

Click Configure.

In the Configuration section, enter the following values: • Release name – Enter the release name. The name can consist of only lowercase alphanumeric

characters or dash characters (-) and must start and end with an alphanumeric character. • Target namespace – Select services from the target namespace. • Select I have read and agreed to the license agreements.

In the Global section, enter the following value: • Image Pull Secret Name – Enter the Docker Store secret name that you generated in Step 1.

Page of 12 17

• Product Identifier –Use the default value. • Deploy API Key – Enter the create a deployment ServiceID API key you created in step 2.

Defaults for the rest of the Helm chart parameters.

Click Install

Step 6: Monitor the installation

1. From the IBM Cloud Private user interface 2. Navigate to Workloads > Helm Releases and click on the Release name specified in the

Configuration section of the CAM helm chart. 3. Scroll to the Deployment section and to see the list of all of the kubernete pods for CAM. You

will want to wait until all of the pods are available. This is denoted by a “1” in the available column.

It will take some time for Cloud Automation manager to initialize, please be patient.

You can also use kubectl to monitor the progress as well. Running kubectl get -n services pods will show you the status of the pods. When all pods are in “Running” status, this means that CAM is provisioned and ready for use.

Running kubectl describe pod <pod name> -n services shows more information on status. Use this as a way to start troubleshooting in the event of errors

The example below shows the pods in various states using the kubectl get -n services pods command.

Page of 13 17

Once all the pods are in running state, you can access the Cloud Automation Manager UI at https://<serivce_ip>:30000

IBM Cloud Automation Manager Template Library

IBM Cloud Automation manager supplies a variety of templates that allow deployment of software products to various Cloud platforms. When CAM is installed and has access to the internet, templates catalog will be populated.

You are can access the library by: 1. Log in to the IBM Cloud Automation user interface https://<service_ip>:30000/ 2. From the navigation menu Library > Templates

There are four basic template types

Template Type Purpose

My Templates Templates that you have created.

Middleware Chef based templates that deploy IBM middleware products or other vendor products. These templates require an Advanced Content Runtime to be deployed.

Integration Templates that illustrate how to integrate with other products.

Starterpacks Templates that allow you to stand up virtual machines with software products that are available from publicly available operations systems software repositories.

Page of 14 17

Note: The Middleware templates supports IBM Cloud, Amazon and VMWare vSphere Cloud platforms.

See Cloud Automation Content article for more information.

Content Runtime Installation

The Advanced Content Runtime is required by the CAM Middleware templates that are based on the IBM-CAMHub-Open GitHub repository. The middleware templates require a Chef based content runtime to be provisioned.

Steps to provision the Advanced Content Runtime.

Step 1: Review the System Requirements

See System requirements knowledge center article for hardware and supported operating systems.

If you will be performing an offline installation, please see Offline Content Runtime deployment for additional steps that need to be taken .

Step 2: Gather Cloud specific information

Before deploying any template or the content runtime, gather the necessary cloud specific information. Download the cam_parameters spreadsheet and fill the spreadsheet out based on the cloud platform you plan on deploying your templates to.

Step 3: Create Cloud Connections for the target cloud platforms

See Managed connections knowledge center article on how to create the cloud connection. Use the values you specified in the spreadsheet to help you fill in the appropriate values.

Step 4: Determine Cloud Provider and Runtime to create

There are four different types of Cloud Providers that can be created on the Create Content Runtime dialog box.

• Amazon EC2 • IBM • Other • VMWare vSphere

Page of 15 17

The Amazon EC2, IBM and VMWare vSphere cloud providers will provision a virtual machine to the appropriate select cloud. On the Create Content Runtime dialog box, you can select one of the following Runtime environments.

• CAM Content Runtime • CAM Content Runtime with existing Chef Server

If you want to supply your own Chef Server, you would select CAM Content Runtime with existing Chef Server. The CAM Content Runtime will install and configure Chef 12 server for you.

The Other Cloud Provider does not provision a virtual machine. You are required to provision a virtual machine first. This option allows you to customize the virtual machine to your company needs. There are three runtimes that can be selected for this Cloud Provider:

• CAM Content Runtime • CAM Content Runtime with existing Chef Server • CAM Content Runtime Offline Installation.

The CAM Content Runtime Offline Installation runtime is used when your virtual machine that is hosting the content runtime will not have access or limited access to the internet during provisioning.

See Provisioning and managing your content Runtime infrastructure article for more information.

Step 5: Deploy the content runtime

Refer to Provisioning and managing your Content Runtime infrastructure knowledge center article for deploying the content runtime.

1. Log in to the IBM Cloud Automation user interface https://service_ip:30000/ 2. From the navigation menu click on Manage > Content Runtimes 3. Click on Create Content Runtime

a. Name: Enter the runtime name. b. Cloud Provider: Select the appropriate cloud provider. c. Runtime: Select which type of runtime you want to have created. d. Click on Create.

4. On the Deploy Runtime panel, select the Cloud Connection that should be used and fill in the rest of the input parameters.

5. Click on Deploy and the provisioning of the Content Runtime will begin.

You can monitor the progress of the deployment from the Content Runtime Deployed Instances panel.

Page of 16 17

Step 6: Populate the software repository

The software repository contains product installation files that are using by the Chef based cookbooks to install the various software products. See the Managing a software repository article for additional details on how to populate this repository and verify that it is correctly setup.

The Chef based cookbooks will access the software repository using http or https protocols to retrieve the product binaries. The software repository uses NGIX webserver.

Page of 17 17