IBM Support

How to access the ICO UI through a different host name

Question & Answer


Question

How do you access the IBM Cloud Orchestrator (ICO) User Interface (UI) through a different host name as opposed to the lengthy ones required by default?

Answer

Use a vanity URL by setting up a separate HTTP server and perform a redirect from the desired host name to the "real" one.

Follow the instructions below to configure a vanity URL.

Apache and SSL Install – Vanity URL Configuration


  1. Modify the /opt/app/apache/conf/httpd.conf configuration file
    1. Comment out:

      # Listen 192.168.1.1:8080

    2. Optionally uncomment if SSL will be used in the redirection URL:

      LoadModule ssl_module modules/mod_ssl.so

    3. Optionally uncomment so the command /opt/app/apache/bin/apachectl status does not return an error:

      LoadModule status_module modules/mod_status.so

    4. Comment out:

      # ServerName apache.companyc.com:8080

  2. Modify the /opt/app/apache/conf/local/vhosts.conf file, comment out the following line:

    #NameVirtualHost 192.168.1.1:8080

  3. Optionally, if using a "self-generated" SSL certificate locally, use the following to create a local SSL key and certificate that is valid for 10 years:
    1. cd /opt/app/apache/conf/local/vhosts
    2. openssl req -x509 -nodes -days 3650 -newkey rsa:2048 -keyout ico_2.4_ssl.key -out ico_2.4_ssl.crt

  4. Create an Apache config for each IP:Port combination, or each application, or a single configuration file depending on preference. In this case, a single file was created for each ICO component, for each virtual IP address being used:

    # ls -l
    total 40
    -rw-r--r-- 1 root apache  503 May 21 15:15 cs2_bpm.conf
    -rw-r--r-- 1 root apache  807 May 21 15:22 cs2_ui.conf
    -rw-r--r-- 1 root apache  421 May 21 15:26 cs2_websphere.conf
    -rw-r--r-- 1 root apache  609 May 22 08:42 saam.conf
    -rw-r--r-- 1 root apache  248 May 22 08:49 local_server_status.conf

    The contents of each file consists of a Listen directive to open a port on an IP address. Those contents are listed below.

    # more *.conf
    ::::::::::::::
    cs2_bpm.conf
    ::::::::::::::

    #
    # BPM Virtual Hosts consist of the same IP and port with two URIs
    #
    # /ProcessCenter and /ProcessAdmin should redirect to BPM
    #

    Listen 192.168.1.2:9443
    <VirtualHost 192.168.1.2:9443>

    #    SSLEngine on
    #    SSLCertificateFile conf/local/vhosts/ico_2.4_ssl.crt
    #    SSLCertificateKeyFile conf/local/vhosts/ico_2.4_ssl.key

       Redirect 301 /ProcessAdmin     https://cs2.companyc.com:9443/ProcessAdmin
       Redirect 301 /ProcessCenter     https://cs2.companyc.com:9443/ProcessCenter

    </VirtualHost>


    ::::::::::::::
    cs2_ui.conf
    ::::::::::::::

    #
    # ICO User Interface
    #
    # The ICO user interface is by default on port 8443, while the admin
    # interface is by default on port 443.  This configuration effectively
    # reverses those two so that the user URL looks "normal" and the admin
    # interface redirects to an unusual port
    #

    Listen 192.168.1.2:80
    <VirtualHost 192.168.1.2:80>

    #    SSLEngine on
    #    SSLCertificateFile conf/local/vhosts/ico_2.4_ssl.crt
    #    SSLCertificateKeyFile conf/local/vhosts/ico_2.4_ssl.key

       Redirect 301 /     https://cs2.companyc.com:8443/

    </VirtualHost>

    Listen 192.168.1.2:443
    <VirtualHost 192.168.1.2:443>

    #    SSLEngine on
    #    SSLCertificateFile conf/local/vhosts/ico_2.4_ssl.crt
    #    SSLCertificateKeyFile conf/local/vhosts/ico_2.4_ssl.key

       Redirect 301 /     https://cs2.companyc.com:443/

    </VirtualHost>


    ::::::::::::::
    cs2_websphere.conf
    ::::::::::::::

    #
    # BPM Virtual Hosts consist of the same IP and port with two URIs
    #
    # /ProcessCenter and /ProcessAdmin should redirect to BPM
    #

    Listen 192.168.1.2:9043
    <VirtualHost 192.168.1.2:9043>

    #    SSLEngine on
    #    SSLCertificateFile conf/local/vhosts/ico_2.4_ssl.crt
    #    SSLCertificateKeyFile conf/local/vhosts/ico_2.4_ssl.key

       Redirect 301 /ibm/console     https://cs2.companyc.com:9043/ibm/console

    </VirtualHost>


    ::::::::::::::
    saam.conf
    ::::::::::::::

    #
    # SAAM Application Interface
    #

    Listen 192.168.1.3:9043
    <VirtualHost 192.168.1.3:9043>

    #    SSLEngine on
    #    SSLCertificateFile conf/local/vhosts/ico_2.4_ssl.crt
    #    SSLCertificateKeyFile conf/local/vhosts/ico_2.4_ssl.key

       Redirect 301 /ibm/console     https://saam.companyc.com:9043/ibm/console

    </VirtualHost>

    Listen 192.168.1.3:80
    <VirtualHost 192.168.1.3:80>

    #    SSLEngine on
    #    SSLCertificateFile conf/local/vhosts/ico_2.4_ssl.crt
    #    SSLCertificateKeyFile conf/local/vhosts/ico_2.4_ssl.key

       Redirect 301 /ibm/console     https://saam.companyc.com:9043/ibm/console

    </VirtualHost>


    ::::::::::::::
    local_server_status.conf
    ::::::::::::::

    #
    # Listen on localhost so that "apachectl status" works
    #

    Listen 127.0.0.1:80
    <VirtualHost 127.0.0.1:80>

       <Location "/server-status">

           SetHandler server-status
    #        Require host localhost att.com

       </Location>

    </VirtualHost>
[{"Product":{"code":"SS4KMC","label":"IBM SmartCloud Orchestrator"},"Business Unit":{"code":"BU053","label":"Cloud & Data Platform"},"Component":"User Interface","Platform":[{"code":"PF016","label":"Linux"}],"Version":"2.4;2.4.0.1;2.4.0.2","Edition":"","Line of Business":{"code":"LOB45","label":"Automation"}}]

Document Information

More support for:
IBM SmartCloud Orchestrator

Software version:
2.4, 2.4.0.1, 2.4.0.2

Operating system(s):
Linux

Document number:
265729

Modified date:
17 June 2018

UID

swg21966447

Page Feedback