Performing the upgrade

This topic provides instructions on upgrading BMC Release Process Management (BRPM) and BMC Release Lifecycle Management (RLM) Requester UI to 5.0.x. In addition, it provides instructions on applying a hotfix.

If you are using both BRPM and 

Some content is unavailable due to permissions.

, you can upgrade these components in any sequence.

Where you are in the Upgrade process

Step

Task

1

2

Performing the upgrade (You are here)

3

Before you begin

Before you begin the upgrade process, perform the following tasks:

  • Extract the downloaded BRPM ZIP files in a temporary directory.
  • BMC recommends that you stop the BRPM service before you upgrade the product database to the new version.

During the upgrade, ensure that you meet the following requirements:

  • For HTTP/HTTPS and messaging system ports, use different port numbers for 5.0.x and your current product version.
  • All passwords must be at least six characters long and contain at least one letter, one number, and one non-alphanumeric symbol.

Upgrading BMC Release Process Management

You can upgrade from an earlier version of the product to the new BRPM version in one of the following ways:

  • By migrating the database from the earlier to new version.
  • By using a fresh database for the latest version.

In addition, the upgrade can be performed either to a new installation folder or to the same one as your current version.

Important

The database.yml file contains the following sections:

  • Development
  • Test
  • Production

Before upgrading, you must make sure that the configurations in each of these sections match with each other. You must also make sure that these configurations match with the parameters in the BRPMInstalledConfiguration.xml file present in the location /opt/bmc/RLMhome/.

Upgrading to version 5.0.03.004 or later

To upgrade to version 5.0.03.004 or later in a new installation folder

Do the following:

  1. Start the installation program. 
    Windows:

    • To install the product with the administrator privileges, go to RLMinstallationDirectory\RLM\Disk1 and run the setup.cmd command.
    • To install the product as a normal user, double-click setup.cmd.

    Linux:

    1. Log in as a root user.
    2. Navigate to RLMinstallation Directory/RLM/Disk1.
    3. To make the installation file executable, run the chmod -R +x . command.
    4. To start the installation program, run the ./setup.sh  command.
  2. On the welcome page of the BMC Release Lifecycle Management 5.0.x Installer wizard, click Next.
  3. On the license agreement page, select I agree to the terms of the license agreement, and then click Next.
  4. On the Directory Selection page, specify a new installation directory for BRPM 5.0.x, and then click Next.
  5. On the Installation Type page, do one of the following, and then click Next.
    • If you started the installation program with Administrator or root privileges, select Installer is started with root privileges so perform full installation.
    • If you started the installation program without Administrator or root privileges, select Install solution files and configurations. Do not perform tasks that require special rights.
  6. On the Select features page, select the products and components that you want to upgrade, and then click Next.
  7. On the BRPM data migration page, in the Copy data from list, do one of the following:
    • To skip the database migration, ensure that No migration required is selected, and then click Next.
    • To migrate the data from your previous product version, select your current BRPM version, and then specify the following details for migrating your database:

      1. In Existing installation location, specify the directory path to your current product version from which you want to migrate the data.

        Tip

        The default directory path to your current product version is the following:

        • Windows: C:\Program Files\BMC Software\RLM\releases\releaseVersion\RPM
        • Linux/Solaris: /opt/bmc/RLM/releases/releaseVersion/RPM
      2. In Database migration:
        • To save your data from the existing database and update the database to the 5.0.x version, select Update database.
        • To delete your data from the existing database and update the database to the 5.0.x version, select Clean database (Reset data contents).
      3. (Optional) Select Copy SMTP configuration settings.
      4. (Optional) Select Copy automation results.

      5. (Optional) In the Cluster installation section, ensure that the Skip database modification (remote database only) check box is selected if you are installing the product application files and are not making changes to the database.

        Note

        You can use the Skip database modification option if you install the BRPM product to a node in a cluster and you already have installed the same version of the application and database on another node of the same cluster. For more information, see High-availability-deployment. 

      6. Click Next.
  8. On the BMC RPM Server Instance type page, select the deployment mode for BRPM, enter the details and click Next:
    • To run BRPM as a single instance, select Standalone, and do the following:
      1. In the Node name box, enter the name of the standalone node.
      2. In the Node IP box, enter the IP address of the standalone node.
    • To run BRPM as a node in the cluster, select Cluster, and do the following:
      1. In the Node name box, enter the name of the cluster node.
      2. In the Node IP box, enter the IP address of the cluster node.
  2. On the JRE Information page:
    • To Use the bundled JRE (version <version>), click Next. 
    • To use any other JRE, clear the Use the bundled JRE (version <version>) check box, click Browse, set the path to the JRE on your computer, and then click Next.
  3. (This page appears only when you are using http protocol in your existing installation)  On the Server HTTPS Port Information page, do one of the following, and click Next:
    • Select the Generate Self-Signed Certificate option, and enter the following information if you want to use the self-signed certificate generated by the installer:
      1. In the HTTPS Port box, enter the HTTPS port number. Default is 8443.
      2. In the Passphrase box, create a passphrase for your certificate. 
      3. In the Common Name (CN) box, specify the name that represents the server protected by the certificate. For example, SAT.co.in.
      4. In the Organization Unit (OU) box, specify the name of the name of your organization unit. For example, Accounting. 
      5. In the Organization Name (O) box, specify the name of your organization. For example, SAT Pvt. Ltd.
      6. In the Locality Name (L) box, specify your city or other locality. For example, Brooklyn.
      7. In the State Name (S) box, specify the name of your state, province, or other political subdivision. For example, New York.
      8. In the Country Code (C) box, specify the name of your country. For example, US. You can enter only upto 2 characters.
    • Enter the following information if you want to use a third-party SSL certificate:
      1. In the HTTPS Port box, enter the port number for the SSL connection.
      2. In the Private Key box, specify the directory path to the private key for SSL encryption.
      3. In the Certificate File box, specify the directory path to the certificate for SSL connection.
      4. In the Passphrase box, enter the passphrase for your certificate.
        For more information about how to obtain SSL private key, certificate file, and passphrase, see Obtaining-test-SSL-certificates.

  4. On the Super User Details page, provide the superuser credentials, and then click Next.

    Notes

    • The Super User Details page is not available if you selected to update your database on the BRPM data migration page.
    • The superuser is the first user who has administrator access permissions to use BRPM.
  5. On the JBoss Super User Details page, enter the following details, and then click Next:
    • Login: Username for the superuser required to log on to the JBoss server.
    • Password: Password for the JBoss superuser
  6. On the Messaging System Details page, specify the following details to connect to the messaging system server of BRPM, and then click Next.
    • Port: Port for the messaging system server that is different from the one used for the previous version.
    • User: User name for the messaging system server.
    • Password: Password of the messaging system server.
  7. On the Database details page, specify the relevant details for the database, and then click Next.

  8. On the Email Notification details page, do one of the following, and then click Next.

    Note

    The Email Notification details page is not available if you selected to copy your SMTP settings from the previous BMC Release Process Management on the BRPM data migration page.

    • Not to configure email notifications, click Next.

      Note

      You can configure email notifications later. For more information, see Changing-the-email-notification-configuration-manually.

    • To configure email notification settings, select Use SMTP, and then specify the following SMTP server details:

      1. SMTP Server: The fully qualified name of the SMTP server used for sending emails.
      2. SMTP Port: (Default 25) The SMTP server port.
      3. SMTP Domain: The part of the user name after "xyz@" in your email address. For example, if your user name is redmine@example.net, then your domain name is example.net.
      4. SMTP Authentication: The authentication mechanism used for your SMTP service. You can select from one of the options in the list displayed.
      5. SMTP User: The user name used to connect to the SMTP server. For example, redmine@example.net.
      6. SMTP Password: The password used to connect to the SMTP server.
      7. TLS: Select this check box if your SMTP server requires a secure connection and is using TLS.

      To learn more about email notifications and how to change notification configurations manually, see Changing email notification configuration manually.

    Click Next.

  9. On the Installation Preview page, view the installation details, and then click Install.
To upgrade version 5.0.03.004 or later in the same installation folder as your current version

Do the following:

  1. Start the installation program: 
    Windows : 

    • To install the product with the administrator privileges, go to  RLMInstallationDirectory\RLM\Disk1 and run the setup.cmd command.
    • To install the product as a normal user, double-click setup.cmd.

    Linux:

    1. Log in as a root user.
    2. In terminal, go to RLMInstallationDirectory/RLM/Disk1.
    3. Enter the chmod -R +x . command.
    4. Enter the ./setup.sh command.
  2. On the welcome page of the BMC Release Lifecycle Management 5.0.x Installer wizard, click Next.
  3. On the license agreement page, select I agree to the terms of the license agreement, and then click Next.

  4. On the Directory Selection page, specify your current installation directory for BRPM, and then click Next.

    Example

    If you installed the previous version of BRPM to /opt/bmc/RLM, then the same path must be specified on the Directory Selection page when upgrading.

  5. On the Destination Warning page, click Next.
  6. On the Installation Type page, do one of the following, and then click Next.
    • If you started the installation program with administrator or root privileges, select Installer is started with root privileges so perform full installation.
    • If you started the installation program without administrator or root privileges, select Install solution files and configurations. Do not perform tasks that require special rights.
  7. On the feature selection page, view the products and components that will be upgraded, and then click Next.
  8. On the BRPM data migration page, in the Copy data from list, do one of the following:
    • To skip the database migration, ensure that No migration required is selected, and then click Next.
    • To migrate the data from your previous product version, select your current BRPM version, and then specify the following details for migrating your database:

      1. In Existing installation location, specify the directory path to your current product version from which you want to migrate the data.

        Tip

        The default directory path to your current product version is the following:

        • Windows: C:\Program Files\BMC Software\RLM\releases\releaseVersion\RPM
        • Linux/Solaris: /opt/bmc/RLM/releases/releaseVersion/RPM
      2. In Database migration:
        • To save your data from the existing database and update the database to the 5.0.x version, select Update database.
        • To delete your data from the existing database and update the database to the 5.0.x version, select Clean database (Reset data contents).
      3. (Optional) Select Copy SMTP configuration settings.

      4. (Optional) In the Cluster installation section, ensure that the Skip database modification (remote database only) check box is selected if you are installing the product application files and are not making changes to the database.

        Note

        You can use the Skip database modification option if you install the BRPM product to a node in a cluster and you already have installed the same version of the application and database on another node of the same cluster. For more information, see High-availability-deployment. 

      5. Click Next.
  9. On the JRE information page: 
    • To Use the bundled JRE (version <version>), click Next. 
    • To use any other JRE, clear the Use the bundled JRE (version <version>) check box, click Browse, set the path to the JRE on your computer, and then click Next. 
  10. (This page appears only when you are using http protocol in your existing installation) On the Server HTTPS Port Information page, do one of the following, and click Next:
    • Select the Generate Self-Signed Certificate option, and enter the following information if you want to use the self-signed certificate generated by the installer:
      1. In the HTTPS Port box, enter the HTTPS port number. Default is 8443.
      2. In the Passphrase box, create a passphrase for your certificate. 
      3. In the Common Name (CN) box, specify the name that represents the server protected by the certificate. For example, SAT.co.in.
      4. In the Organization Unit (OU) box, specify the name of the name of your organization unit. For example, Accounting. 
      5. In the Organization Name (O) box, specify the name of your organization. For example, SAT Pvt. Ltd.
      6. In the Locality Name (L) box, specify your city or other locality. For example, Brooklyn.
      7. In the State Name (S) box, specify the name of your state, province, or other political subdivision. For example, New York.
      8. In the Country Code (C) box, specify the name of your country. For example, US. You can enter only upto 2 characters.
    • Enter the following information if you want to use a third-party SSL certificate:
      1. In the HTTPS Port box, enter the port number for the SSL connection.
      2. In the Private Key box, specify the directory path to the private key for SSL encryption.
      3. In the Certificate File box, specify the directory path to the certificate for SSL connection.
      4. In the Passphrase box, enter the passphrase for your certificate.
        For more information about how to obtain SSL private key, certificate file, and passphrase, see Obtaining-test-SSL-certificates.
  11. On the JBoss Super User Details page, enter the following details, and then click Next:
    • Login: Username for the superuser required to log on to the JBoss server.
    • Password: Password for the JBoss superuser.

  12. On the Messaging system details page, specify the following details to connect to the messaging system server, and then click Next.

    Note

    The Messaging system details page displays only if your current messaging system password does not match the following pattern:

    • At least one letter
    • At least one number
    • At least one non-alphanumeric symbol
    • The Port and Host boxes are dimmed since they use information from your previous installed versions.
    • User: User name for the messaging system server.
    • Password: Password of the messaging system server.
  13. On the Database details page, specify the following details to connect to the database server, and then click Next.
    • Database: Select your database type, either POSTGRESQL, ORACLE, or SQL_SERVER.
    • Host: Host address for the database system server. The Host field is disabled. By default, the installation program detects the IP address of the host computer on which you are installing this product.
    • Port: Port for the database system server. The default port value is 5432 (PostgreSql), 1521 (Oracle), and 1433 (SQL_Server).
    • RPM Database/SID Name: Specify a database name or identifier (for example, bmc_rpm_db).
    • RPM Database User:User name for the database system server.
    • RPM Database Password: Password of the database system server.
  14. On the Installation Preview page, view the installation details, and then click Next.

Upgrading 

Some content is unavailable due to permissions.

You can upgrade your current version of 

Some content is unavailable due to permissions.

to the same installation folder as your current version.

Note

During the upgrade, the Apache server is not upgraded.

To upgrade 

Some content is unavailable due to permissions.

:

  1. Start the installation program: 
    Windows : 

    • To install the product with the administrator privileges, go to RLMinstallationDirectory\RLMUI\Disk1 and run the setup.cmd command.
    • To install the product as a normal user, double-click setup.cmd.

    Linux: 

    1. Log in as a root user.
    2. In terminal, go to  RLMinstallationDirectory/RLMUI/Disk1.
    3. Enter the chmod -R +x . command.
    4. Enter the ./setup.bin command.
  2. On the welcome page of the 

    Some content is unavailable due to permissions.

    5.0.x Installer wizard, click Next.
  3. On the license agreement page, select I agree to the terms of the license agreement, and then click Next.

  4. On the Directory Selection page, specify your current installation directory for the 

    Some content is unavailable due to permissions.

    , and then click  Next.

    Example

    If you installed the previous version of the

    Some content is unavailable due to permissions.

    to /opt/bmc/RLMUI, then the same path must be specified on the Directory Selection page when upgrading.

  5. On the Destination Problem page, click Next.
  6. On the Installation Type page, do one of the following, and then click Next.
    • If you started the installation program with administrator or root privileges, select Installer is started with root privileges so perform full installation.
    • If you started the installation program without administrator or root privileges, select Install solution files and configurations. Do not perform tasks that require special rights
  7. (This page appears only when you are using http protocol in your existing installation)  On the Server HTTPS Port Information page, do one of the following, and click Next:
    • Select the Generate Self-Signed Certificate option, and enter the following information if you want to use the self-signed certificate generated by the installer:
      1. In the HTTPS Port box, enter the HTTPS port number. Default is 8443.
      2. In the Passphrase box, create a passphrase for your certificate. 
      3. In the Common Name (CN) box, specify the name that represents the server protected by the certificate. For example, SAT.co.in.
      4. In the Organization Unit (OU) box, specify the name of the name of your organization unit. For example, Accounting. 
      5. In the Organization Name (O) box, specify the name of your organization. For example, SAT Pvt. Ltd.
      6. In the Locality Name (L) box, specify your city or other locality. For example, Brooklyn.
      7. In the State Name (S) box, specify the name of your state, province, or other political subdivision. For example, New York.
      8. In the Country Code (C) box, specify the name of your country. For example, US. You can enter only upto 2 characters.
    • Enter the following information if you want to use a third-party SSL certificate:
      1. In the HTTPS Port box, enter the port number for the SSL connection.
      2. In the Private Key box, specify the directory path to the private key for SSL encryption.
      3. In the Certificate File box, specify the directory path to the certificate for SSL connection.
      4. In the Passphrase box, enter the passphrase for your certificate.
        For more information about how to obtain SSL private key, certificate file, and passphrase, see Obtaining-test-SSL-certificates.
  8. On the BMC Release Process Management Server URL page, enter the URL for the BMC RPM server that you have upgraded and click Next.
  9. On the Installation Preview page, view the upgrade details, and then click Install.
    You can click the link at the bottom to check the connection to the BRPM 5.0.x server.

  10. On the Installation Summary page, click Done.
    You can click the 

    Some content is unavailable due to permissions.

     5.0.x link to check the connection.

Note

After you upgraded the

Some content is unavailable due to permissions.

, you must perform manual fixes to avoid clickjacking attacks and a leak of directory listings and web server methods.

Post-upgrade tasks

After you complete the upgrade, you might need to perform the following tasks:

  • To verify that the upgrade was completed successfully, access the product interface. For more information, see Accessing-the-interface.
  • If you cannot access 

    Some content is unavailable due to permissions.

    from Google Chrome or Mozilla Firefox, clear the browser cache, cookies, and temporary files.
  • To fix the SSH and NSH automation scripts after an upgrade to BRPM 5.0.01.00 (for the details, see DRZXB-16048), do the following:
    1. Go to RLMhome/releases/5.0.01.00/RPM/lib/script_support and open the dispatch_script_header.rb file in a text editor.
    2. In line 468, value_str = "#{value}".gsub!('"', '\"'), delete ! after the gsub method. 
       Result: value_str = "#{value}".gsub('"', '\"').
    3. Save the file, and then restart the services.
  • To remove groups and teams automatically created during database migration, see Using a rake task to remove groups and teams.
  • To remove manual group assignments for LDAP users, see Using a rake task to remove manual group assignments for LDAP users.
  • During upgrade to 5.0.03, 5.0.03.001, 5.0.03.002, or 5.0.03.003, the torquebox.yml file (located at RLMhome\releases\productVersion\RPM\config) is retained from the previous version and it does not get refreshed with the latest version. As a result, live updates fail for requests and the Requester UI does not get refreshed automatically. To fix the issue, do the following:
    1. Stop the BRPM service.
    2. Navigate to the RLMhome\releases\productVersion\RPM\config directory for the version to which you have upgraded.
    3. Copy the attached torquebox.yml file in the config directory.
    4. Search for the stomp section and update the value of the host parameter.
    5. Search for the messaging section and update the value of the concurrency parameter.
    6. Save and close the file.
    7. Start the BRPM service.

For more information, see Additional-actions-after-the-upgrade.

Post-upgrade tasks to access the Requester UI

This section describes the tasks you need to perform depending on the version to which you are upgrading.

After you upgrade

During upgrade, the production.rb file gets replaced by a new instance of the file. If you have made changes to the production.rb file before upgrade, ensure that you update the file again after upgrade. This file is located at RLMhome\releases\newProductVersion\RPM\portal.war\WEB-INF\config\environments.

After you upgrade to 5.0.00.01 or 5.0.01.00

After you upgrade 

Some content is unavailable due to permissions.

to 5.0.00.01 or 5.0.01.00 or install 5.0.00.00 or 5.0.00.01, you must perform the following actions to avoid the security issues.

Note

Fixes for these security issues are provided with the installer if you perform a fresh installation of the

Some content is unavailable due to permissions.

5.0.01.00.

  1. Stop the 

    Some content is unavailable due to permissions.

    service.
  2. Go to RLMUIhome/apache/conf, and then open the httpd.conf file in a text editor.
  3. To restrict the directory listings from the web server, replace Options Indexes FollowSymLinks with Options FollowSymLinkstwice.

  4. To disable the OPTIONS method that provides a list of the web server methods and to include the X-Frame-Options header to avoid clickjacking attacks, do the following:

    1. Ensure that the LoadModule allowmethods_module modules/mod_allowmethods.so line is uncommented.
    2. Ensure that the LoadModule headers_module modules/mod_headers.so line is uncommented.

    3. If the file does not contain the <Location "/"> block, then add the following lines after the </Directory> tag:

      <Location "/">
          AllowMethods GET HEAD POST
          Header always append X-Frame-Options DENY
      </Location>

    4. If the file already contains the <Location "/"> block, then add only these lines to it:

      AllowMethods GET HEAD POST
      Header always append X-Frame-Options DENY
    Example

    httpd_conf_example.png

  5. Save the file.
  6. Start the 

    Some content is unavailable due to permissions.

    service.

After you upgrade to 5.0.03

After upgrading the Requester UI to 5.0.03, every time the UI is refreshed, the following error message is displayed:

Not found. The requested URL rlmui/releases/ was not found on this server.

This issue only occurs when using secure protocol HTTPS for the Requester UI.

Workaround:

  1. Stop the 

    Some content is unavailable due to permissions.

    service.
  2. Go to RLMUIhome/apache/conf, and then open the httpd.conf file in a text editor.

  3. Remove the following settings from the configuration file.

     # Serve gzip compressed CSS files if they exist
     # and the client accepts gzip.
    RewriteCond "%{HTTP:Accept-encoding}" "gzip"
    RewriteCond "%{REQUEST_FILENAME}\.gz" -s
    RewriteRule "^(.*)\.css" "$1\.css\.gz" [QSA]

     # Serve gzip compressed JS files if they exist
     # and the client accepts gzip.
    RewriteCond "%{HTTP:Accept-encoding}" "gzip"
    RewriteCond "%{REQUEST_FILENAME}\.gz" -s
    RewriteRule "^(.*)\.js" "$1\.js\.gz" [QSA]

     # Serve correct content types, and prevent mod_deflate double gzip.
    RewriteRule "\.css\.gz$" "-" [T=text/css,E=no-gzip:1]
    RewriteRule "\.js\.gz$" "-" [T=text/javascript,E=no-gzip:1]
  4. Save changes and restart the 

    Some content is unavailable due to permissions.

    service.

Configuring JVM heap size settings after you upgrade to 5.0.03.001 or later

When you upgrade to BMC Release Process Management 5.0.03.001 and later, the JVM memory is set to 8 GB, by default. Even if the memory settings in your environment are different, after the upgrade the JVM memory size is set to 8. Ensure that you adjust the memory settings that match your environment.

To adjust the Java heap size memory, perform the following steps: 

  1. Stop the BMC Release Process Management service.
  2. From the command prompt, go to /opt/bmc/RLM/bin location and open the Start.sh file. 

  3. For the export JAVA_OPTS parameter, change the values that match your requirements. 
    By default, the -Xms and the -Xmx value is 8192m. 

    Important

    BMC recommends that you specify minimum 8GB JVM heap size for an efficient performance of the BRPM application.

  4. From the command prompt, go to the /opt/bmc/RLM5.0.03/RPM/config/ location and open the automation_settings.rb file.

  5. For the AUTOMATION_JAVA_OPTS parameter, update the values with the memory settings that match your requirements. 
    By default, the values for the parameter are: -Xmx128m -Xms32m -Xss2048k.

    Important

    BMC recommends that you specify the value for -Xmx as 256m for an efficient performance of the BRPM application.

  6. Restart the BMC Release Process Management service.

Restarting the 

Some content is unavailable due to permissions.

service after you upgrade to 5.0.03.002 or later

If you have not restarted the BRPM Requester UI service while performing any of the tasks mentioned in the previous sections, stop and then start the service.

Where to go from here

Additional-actions-after-the-upgrade

Related topics

Disabling-IPv6

Rolling-back-after-the-failed-installation-or-upgrade

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*