IBM Support

IBM Cloud Orchestrator Fix Pack 1 (2.5.0.1) for 2.5

Download


Abstract

IBM Cloud Orchestrator 2.5.0.1 has been made generally available and contains fixes to version 2.5.

Download Description

Table of Contents
Sections Description

The Change history section provides an overview on what is new in this release with a description of any new functions or enhancements when applicable.

The How critical is this fix section provides information related to the impact of this release to allow you to assess how your environment may be affected.

The Prerequisites section provides important information to review prior to the installation of this release.

The Download package section provides the direct link to obtain the download package for installation in your environment.

The Installation instructions section provides the installation instructions necessary to apply this release into your environment.

The Known side effects section contains a link to the known problems (open defects) identified at the time of this release.

Supporting Documentation
Document Description

Click to review the detailed system requirements information for a complete list of hardware requirements, supported operating systems, prerequisites and optional supported software, with component-level details and operating system restrictions.

IBM Knowledge Center provides an entry point to product documentation. You can view, browse, and search online information related to the product.

Click to review a complete list of the defects (APARs) resolved in this release including a list of resolved defects for the entire version family.

Prerequisites

Prerequisites include:

Review the Software prerequisites page in the IBM Knowledge Center to ensure your environment meets the minimum hypervisor and operating system requirements, especially if you are upgrading from a previous release of IBM Cloud Orchestrator.

Review the Prerequisites tab in the system requirements report for supported versions of Data Protection and Recovery, Databases and Process Management tools.

Installation Instructions

This fix pack can be installed as a fresh installation or as an upgrade of an existing installation. Follow the instructions in the tabs below.


Fresh installation of IBM Cloud Orchestrator


Step 1: Review the Installing topic in the IBM Knowledge Center.

IMPORTANT NOTE: For high-availability installations only: After you download the SA_MP_v4.1_Lnx.tar file, you must rename the file to SA_MP_4.1_Linux.tar or the installation procedure will fail.

Upgrade of IBM Cloud Orchestrator from version 2.5


The following upgrade scenarios are supported:

  • IBM Cloud Orchestrator V2.5 -> IBM Cloud Orchestrator V2.5 Fix Pack 1 (2.5.0.1)

Step 1: Review the Upgrading from IBM Cloud Orchestrator V2.5 topic in the IBM Knowledge Center.

Upgrade of IBM Cloud Orchestrator from version 2.4.0.2 or later


The following upgrade scenarios are supported:

  • IBM Cloud Orchestrator V2.4 Fix Pack 2 (2.4.0.2) -> IBM Cloud Orchestrator V2.5 Fix Pack 1 (2.5.0.1)
  • IBM Cloud Orchestrator V2.4 Fix Pack 3 or later (2.4.0.3) -> IBM Cloud Orchestrator V2.5 Fix Pack 1


Step 1: Review the Migrating from IBM Cloud Orchestrator V2.4.0.2 or later topic in the IBM Knowledge Center.


Step 2: If you are migrating from an IBM Cloud Orchestrator 2.4.0.2 (or later) environment, review the Before Migration, During Migration and After Migration sections and apply the steps appropriate for your setup.

Note: All references to version 2.4.0.2 also apply to version 2.4.0.3 or later.


Before migrations in preparation phase

Record allocated availability zones for domains and projects

On the IBM Cloud Orchestrator 2.4.0.2 system, take note of the availability zones that are added to each domain and project.


Record Domain Quotas

On the IBM Cloud Orchestrator 2.4.0.2 system, take note of the Domain quotas for the default domain.


KVM regions and non-default domains

When migrating a KVM region, some virtual machines in non-default domains may not shut down properly before being migrated.
As a result, they are in an 'active' state with their volumes still attached during the migration and there might be issues when restarting those instances after the migration.

Solution:
Before the migration, update the /opt/ico_install/{release_directory}/installer/stop_24_services.sh file on the IBM Cloud Orchestrator 2.5 server to add the --all-tenants flag after the nova and cinder list commands by running the following commands:

  • cd /opt/ico_install/{release directory}/installer
  • mv stop_24_services.sh stop_24_services.sh_old && sed "/shut down/,$ s%list%list --all-tenants%g" stop_24_services.sh_old > stop_24_services.sh && chmod +x stop_24_services.sh
After the migration, if you have issues with instances which fail to restart, you must manually stop and then start the instances again.


Before running the first region migration

After migrating a VMware region, you can not see or detach migrated volumes.

Solution:
Before running the first region migration, adjust the migration script by running the following commands:

cd /opt/ico_install/{release directory}/installer/upgrade
mv process_nova.py process_nova.py_old && head -n -14 process_nova.py_old > process_nova.py && chmod +x process_nova.py


Instruction changes in the Knowledge Center

When following the procedure described in the Preparing for the migration topic, you must complete step 9 before step 7.



During Migration

Additional steps to configure LDAP

If you are using LDAP user authentication, when migrating the first region, you must perform some additional steps to configure LDAP users in the IBM Cloud Orchestrator 2.5.0.1 environment.

Depending on the type of region that you are migrating, perform the following steps after step 3 of the procedure described in the Migrating a VMware region or Migrating a KVM region topic in the IBM Knowledge Center.

Solution:

  1. Copy the ldap_configure.sh script from the IBM Cloud Orchestrator 2.5.0.1 server to the destination node of the first region that you are migrating:

    scp /opt/ico_install/V2501/installer/ldap_configure.sh root@{destination_first_region}:/tmp


  2. Log in to the destination node as user root, go to the directory where you copied the script, and run the ldap_configure.sh script as follows:

    ./ldap_configure.sh


Additional Knowledge Center updates related to this issue:
  • Update to the Migrating a KVM region topic:



    The commands in step 1b must be replaced with the following:

    source ~/openrc
    glance image-list --all-tenants
    heat stack-list
    cinder list --all-tenants
    neutron net-list
    neutron subnet-list --all-tenants
    nova list --all-tenants
    nova image-list
    nova flavor-list

    The commands in step 4 must be replaced with the following:

    source ~/v3rc
    openstack endpoint list
    openstack user list
    openstack project list
    openstack domain list
    openstack image list
    heat stack-list
    cinder list --all-tenants
    openstack network list
    neutron subnet-list --all-tenants
    nova list --all-tenants
    openstack server list
    openstack flavor list

    The note in step 3.e of the procedure must be replaced with the following:

    "Note: If any of the compute nodes are not visible in the OpenStack Dashboard after restarting the services for the region, or if the instances do not start successfully, you must manually restart the openstack-nova-compute service by running the following command as user root on the relevant nodes: systemctl restart openstack-nova-compute"

    Step 6c must be replaced with the following:

    "Debug any errors that are displayed on the console output and check the upgrade, export and import logs in the /var/log/ico_install directory on the IBM Cloud Orchestrator V2.5.0.1 Server for any further issues which may have occurred during the data migration."

  • Update to the Migrating a VMware region topic:



    The commands in step 1b must be replaced with the following:

    source ~/openrc
    glance image-list --all-tenants
    heat stack-list
    cinder list --all-tenants
    neutron net-list
    neutron subnet-list --all-tenants
    nova list --all-tenants
    nova image-list
    nova flavor-list

    The commands in step 4 must be replaced with the following:

    source ~/v3rc
    openstack endpoint list
    openstack user list
    openstack project list
    openstack domain list
    openstack image list
    heat stack-list
    cinder list --all-tenants
    openstack network list
    neutron subnet-list --all-tenants
    nova list --all-tenants
    openstack server list
    openstack flavor list

    Step 6c must be replaced with the following:

    "Debug any errors that are displayed on the console output and check the upgrade, export and import logs in the /var/log/ico_install directory on the IBM Cloud Orchestrator V2.5.0.1 Server for any further issues which may have occurred during the data migration."


Running the upgrade-prereq-checker script on regions with nova networks

During the migration, if the upgrade-prereq-checker.sh script is run with the check-regions flag on a system which has a Nova network and no Neutron network is available, the script fails with a stack trace error message. The traceback error occurs after the "checking if the SOURCE_CENTRAL_DB_PASSWORD is correct" message, as per the following example.

Note: If this error occurs then it indicates that you cannot migrate that region because the migration of regions that use Nova networks is not supported.

Example command:



# ./upgrade-prereq-checker.py ico_upgrade.rsp --check-regions
INFO: Checking that prerequisite packages are installed on local machine
...
INFO:  - Checking that regions have not already been migrated
INFO:    - Status: Success
INFO:  - Checking that parameter SOURCE_CENTRAL_DB_PASSWORD is correct
INFO:    - Status: Success
Traceback (most recent call last):
  File "./upgrade-prereq-checker.py", line 93, in <module>
    if not migrate_validator.validate(install_packages, check_regions, param_dict, install_base=installdir):
  File "/opt/ico_install/V2501/ico-install/migrate_validator/__init__.py", line 165, in validate
    ks.make_service_call('neutron', '/v2.0/networks.json')
  File "/opt/ico_install/V2501/ico-install/migrate_validator/os_client.py", line 256, in make_service_call
    endpoint = self.get_service_endpoint(service_name, endpoint_type=endpoint_type)
  File "/opt/ico_install/V2501/ico-install/migrate_validator/os_client.py", line 183, in get_service_endpoint
    ep_stanza = filter_one(fn,manifest['endpoints'])
TypeError: 'NoneType' object has no attribute '__getitem__'
#



After Migration

Availability zones

When migrating from an IBM Cloud Orchestrator 2.4.0.2 environment, the allocated availability zones for the domains and projects are not migrated to the IBM Cloud Orchestrator 2.5.0.1 system.

Solution:

To address this issue, availability zones for the domains and projects should be allocated to match the availability zones that were recorded in the step above Record allocated availability zones for domains and projects.


Heat stack deployment

After migrating a region from an IBM Cloud Orchestrator 2.4.0.2 environment, Heat stack deployments might time out or fail.

Solution:

  1. Restart the Heat services by running the following commands on the IBM Cloud Manager controller:

    systemctl restart openstack-heat-engine
    systemctl restart openstack-heat-api


  2. Delete the failed deployment and deploy the Heat stack again.


KVM cinder volumes

After migrating from IBM Cloud Orchestrator 2.4.0.2, the following issues related to KVM cinder volumes might occur:

  • After the migration, KVM cinder volumes might not automatically be reattached on the IBM Cloud Orchestrator 2.5.0.1 region.
  • If you roll back the migration of a KVM region, KVM cinder volumes might not automatically be reattached on the IBM Cloud Orchestrator 2.4.0.2 region.

Solution:
To address this issue, after the migration or the rollback, you must manually reattach any volumes as required. The file /opt/ico_install/V2501/installer/cinder-attachments on the IBM Cloud Orchestrator 2.5.0.1 Server contains a list of the IBM Cloud Orchestrator 2.4.0.2 associations of cinder volume uuids to the corresponding instance uuids. You can use this file as a reference to manually re-attach any volumes as required.


Check logs

When following the procedure described in the Migrating IBM Cloud Orchestrator data topic, perform the following step after step 1:

Debug any errors that are displayed on the console output and check the upgrade, export, and import log files in the /var/log/ico_install directory on the IBM Cloud Orchestrator V2.5.0.1 Server for any further issues which may have occurred during the data migration.

Troubleshoot any issues which occurred during the IBM Cloud Orchestrator migration.

If you see any critical errors in the output during the migration which indicate that the migration was not successful, run the following steps:

  • To reduce system downtime during the debug process, you may roll the system back to use the IBM Cloud Orchestrator V2.4.0.2 environment by restarting the Public Cloud Gateway by running the following command on the IBM Cloud Orchestrator V2.4.0.2 Central Server 2:

    systemctl start pcg

    For more information about restarting IBM Cloud Orchestrator V2.4.0.2, review Managing the services topic.

    For more information about restarting IBM Cloud Orchestrator V2.4.0.3, review Managing the services topic.


Domain Quotas

When migrating from an IBM Cloud Orchestrator 2.4.0.2 environment, domain quotas for the default domain are not migrated to the IBM Cloud Orchestrator 2.5.0.1 system.

Solution:
To address this issue, domain quotas should be adjusted to match the ones that were recorded in the step above Record Domain Quotas.


Request history is not migrated automatically

Request history is not migrated automatically because of IBM Cloud Orchestrator 2.4.0.2 running in parallel with IBM Cloud Orchestrator 2.5.

The IBM Cloud Orchestrator 2.4.0.2 database can be used as an archive for the IBM Cloud Orchestrator 2.4.0.2 request history as it is still stored there. If you want to export the details of the request history to a file for purposes such as request auditing, run the following the procedure.

Note: This procedure generates the /home/db2inst1/request_history.csv file which can be opened in a spreadsheet application in comma separated fashion.

  1. Log in to the IBM Cloud Orchestrator 2.4 central database server (by default, Central Server 1).
  2. Run the following commands:
    • su - db2inst1
    • db2 connect to BPMDB
    • db2 "export to request_history.del of del select UUID, (date('1970-01-01')+(CREATED/86400000) days ) as CREATED, (date('1970-01-01')+(UPDATED/86400000) days ) as UPDATED, PROJECT, \"USER\", TRIM(CAST(REPLACE(SUBSTR(PARMSTRING, (LOCATE('extended_task_name',PARMSTRING)+21) ,(LOCATE('}',PARMSTRING))), '\"}', '')as varchar(2000)) ) as PROCESS, MESSAGEKEY, REMOTECORRELATIONKEY from ORCHESTRATOR.TASK, ORCHESTRATOR.TASKEXCEPTION where ISACTION=0 and REMOTECORRELATIONKEY>0 and DESCRIPTION_ID=ID and PARMSTRING LIKE '%extended_task_name%' UNION ALL select UUID, (date('1970-01-01')+(CREATED/86400000) days ) as CREATED, (date('1970-01-01')+(UPDATED/86400000) days ) as UPDATED, PROJECT, \"USER\", TRIM(CAST(REPLACE(SUBSTR(PARMSTRING, (LOCATE('process\":',PARMSTRING)+10) ,(LOCATE('\",\"',PARMSTRING)-10)), '\",\"', '')as varchar(2000)) ) as PROCESS, MESSAGEKEY, REMOTECORRELATIONKEY from ORCHESTRATOR.TASK, ORCHESTRATOR.TASKEXCEPTION where ISACTION=0 and REMOTECORRELATIONKEY>0 and DESCRIPTION_ID=ID and PARMSTRING NOT LIKE '%extended_task_name%'"
    • echo "REQUEST_ID, DATE_CREATED, DATE_UPDATED, PROJECT, USER, PROCESS, MESSAGE, REMOTE_PROCCESS_ID " > request_history.csv
    • cat request_history.del >> request_history.csv


Editing domains or projects

After migrating from an IBM Cloud Orchestrator 2.4.0.2 environment, when editing a domain or a project, the following error might be displayed in the OpenStack Dashboard:

Error: Unable to retrieve availability zone data.

In the httpd log file, the following error is displayed:

==> openstack-dashboard-error.log <== {Tue Dec 08 18:37:29.258353 2015} {:error} {pid 9343} Recoverable error: ('Connection aborted.', error(113, 'No route to host'))

Solution:
Restart the pcg and httpd services.

  • On the IBM Cloud Manager Controller: systemctl restart httpd
  • On the IBM Cloud Orchestrator server: systemctl restart pcg

Download Package

Download options
Access type Description

Passport Advantage and Passport Advantage Express clients are required to sign in to download the software package.

If you are entitled for IBM Cloud Orchestrator Enterprise Edition and need to download your software from Passport Advantage, perform the following steps:

  1. Logon to Passport Advantage.
  2. Select Software Downloads and Media Access.
  3. Select the Download Finder.
  4. Select Find by description or part number.
  5. Select the Product Description and All radio buttons and enter IBM Cloud Orchestrator Enterprise Edition in the description field.
  6. Select Continue.
  7. Expand the eAssemblies and you will see your entitled software.


Review eAssemblies Parts List document for a list of part numbers you can download for this product.

IBM Software Group OEM offerings are designed for partners who develop and sell business solutions with embedded or bundled IBM middleware software. Clients with Flexible Contract Type (FCT) license purchases and IBM Business Partners must sign in to download the software package.

Click the HTTP link below to obtain the release from Fix Central.

Image directory contents

  • 2.5.0-CSI-ICO-FP0001.tgz: IBM Cloud Orchestrator Version 2.5 Fix Pack 1 for Red Hat Enterprise Linux Multilingual

How critical is this fix?

Impact Assessment
Impact Description

Corrective

This is a maintenance release. It contains fixes for client-reported and internally found defects.

The following security vulnerabilities are also resolved in this fix pack:

  • CVE-2014-6221 - Random Data Generation using GSKit MSCAPI/MSCNG Interface Code does not generate cryptographically random data. An attacker could use this weakness to gain complete confidentially and/or integrity compromise.
  • CVE-2015-0138 - A vulnerability in various IBM SSL/TLS implementations could allow a remote attacker to downgrade the security of certain SSL/TLS connections. An IBM SSL/TLS client implementation could accept the use of an RSA temporary key in a non-export RSA key exchange ciphersuite. This could allow a remote attacker using man-in-the-middle techniques to facilitate brute-force decryption of TLS/SSL traffic between vulnerable clients and servers. This vulnerability is also known as the FREAK attack.
  • CVE-2015-0157 - IBM DB2 LUW contains a denial of service vulnerability. A remote, authenticated DB2 user could exploit this vulnerability by executing a specially-crafted SQL statement with the vulnerable scalar functions. This could result in a DB2 server crash; if so, the server would need to be restarted.
  • CVE-2015-0159 - An unspecified error in GSKit usage of OpenSSL crypto function related to the production of incorrect results on some platforms by Bignum squaring (BN_sqr) has an unknown attack vector and impact in some ECC operations.
  • CVE-2015-1885 - WebSphere Application Server Full Profile and Liberty Profile could allow a remote attacker to gain elevated privileges on the system caused when OAuth grant type of password is used.
  • CVE-2015-1932 - IBM WebSphere Application Server and IBM WebSphere Virtual Enterprise could allow a remote attacker to obtain information that identifies the proxy server software being used.
  • CVE-2015-2017 - IBM WebSphere Application Server is vulnerable to HTTP response splitting attacks. A remote attacker could exploit this vulnerability using specially-crafted URL to cause the server to return a split response, once the URL is clicked. This would allow the attacker to perform further attacks, such as Web cache poisoning, cross-site scripting, and possibly obtain sensitive information.
  • CVE-2015-3183 - Apache HTTP Server is vulnerable to HTTP request smuggling, caused by a chunk header parsing flaw in the apr_brigade_flatten() function. By sending a specially-crafted request in a malformed chunked header to the Apache HTTP server, an attacker could exploit this vulnerability to poison the web cache, bypass web application firewall protection, and conduct XSS attacks.
  • CVE-2015-4000 - The TLS protocol could allow a remote attacker to obtain sensitive information, caused by the failure to properly convey a DHE_EXPORT ciphersuite choice. An attacker could exploit this vulnerability using man-in-the-middle techniques to force a downgrade to 512-bit export-grade cipher. Successful exploitation could allow an attacker to recover the session key as well as modify the contents of the traffic.
  • CVE-2015-7450 - Apache Commons Collections could allow a remote attacker to execute arbitrary code on the system, caused by the deserialization of data with Java InvokerTransformer class. By sending specially crafted data, an attacker could exploit this vulnerability to execute arbitrary Java code on the system.

Test Results

Definitions

Regression: An error in the Maintenance Delivery Vehicle (MDV) that produces incorrect or unexpected behavior causing a supported feature to stop functioning as designed.
This includes:

  • Coding errors that cause a regression
  • Documentation or packaging problems that cause a regression
  • Errors reported in a new function delivered in a MDV that cause a regression

Incomplete: An error in the MDV has not regressed, but does not work as designed.
This includes:

  • Fixed APARs which did not solve the original problem but did not break anything new
  • APARs reporting documentation errors, such as readme errors, that cause problems applying an MDV but do not lead to a regression


Notes:
  • Regression and incomplete APARs are considered fix-in-error or MDV-in-error
  • Definitions above apply only to valid APARs that result in product fixes (APARs returned as working-as-designed are not assessed for being fix-in-error)
  • Issues in major releases due to new functionality do not apply in this definition

There are no known regressions to report.

Problems Solved

Defects resolved

Click the Fix List link in the table of contents above to review a list of the problems solved in this release.

Known Side Effects

Review the following list of known issues and open defects:

Review the Known errors and limitations section of the IBM Knowledge Center for issues related to this release.

The following items are not currently documented in the Knowledge Center:

In the Configuring the Public Cloud Gateway topic:

  • The correct default path of the Public Cloud Gateway configuration files is /opt/ibm/ico/pcg/etc

Open defects

Review the following list of open defects for IBM Cloud Orchestrator on the IBM Support Portal.

Change History

What's new

This fix pack includes the following enhancements:

  • Migration support from a non high-availability IBM Cloud Orchestrator environment with VMware or KVM regions which use Neutron networks from IBM Cloud Orchestrator V2.4 Fix Pack 2 or later fix pack to IBM Cloud Orchestrator V2.5.0.1 which uses IBM Cloud Manager with OpenStack as OpenStack distribution.
  • High availability of the IBM Cloud Orchestrator management stack.

For information about the new features and enhancements, review the What is new in this release topic in the IBM Knowledge Center.

Click the link in the Download Options column:

Off
[{"DNLabel":"ICO 2.5 fixes","DNDate":"18 Dec 2015","DNLang":"English","DNSize":"1","DNPlat":{"label":"Linux","code":"PF016"},"DNURL":"http://www.ibm.com/support/fixcentral/swg/quickorder?parent=ibm%7ETivoli&product=ibm/Tivoli/IBM+SmartCloud+Orchestrator&release=2.5.0&platform=All&function=all&source=fc","DNURL_FTP":" ","DDURL":null}]

Technical Support







Follow IBM Cloud Tech Support on Twitter

Review the IBM Cloud Support BLOG article Enhance your IBM Cloud Support Experience for a complete list of the different support offerings along with a brief description on the best way to use each resource to improve your experience using IBM Cloud products and services.


Forums | Communities | Documentation | Contacting Support | Helpful Hints


[{"Product":{"code":"SS4KMC","label":"IBM SmartCloud Orchestrator"},"Business Unit":{"code":"BU053","label":"Cloud & Data Platform"},"Component":"Installation","Platform":[{"code":"PF016","label":"Linux"}],"Version":"2.5.0.1","Edition":"","Line of Business":{"code":"LOB45","label":"Automation"}}]

Document Information

Modified date:
05 April 2019

UID

swg2C4000006