Install a single instance of Service Portal

Service Portal supports two installation modes: online installation and offline installation. That is, you can install it on a Red Hat Linux system with or without Internet access.

The difference between an online installation and an offline installation is that the former requires the downloading of certain dependency packages from the Red Hat Customer Portal during the installation, and the latter installs the dependency packages from a local yum repository that you need to create manually.

Tip To learn more about the installation process, see Understand the installation process.

Important During installation, be sure to extract all files in the installation archive (propel_complete_installer.zip) to the following folder: /opt/hp/propel_complete_installer.

Online installation

If your Red Hat Linux system has Internet access, perform the following tasks to install Service Portal.

Important For a distributed (clustered) deployment, perform the following steps on the load balancer node to install Service Portal on all nodes in the cluster. Be aware that you need to configure all cluster host names in the configure_extras.yml file of the load balancer node.

Task 1: Register your Red Hat Linux system

To register your Red Hat Linux system to the Red Hat Subscription service, follow these steps:

  1. Log in to the Red Hat system as the root user.
  2. Register your Red Hat Linux system to the Red Hat Subscription service.

    1. Set a proxy if necessary:

      # export http_proxy=http://<proxy_hostname>:<proxy_port>
      # export https_proxy=http://<proxy_hostname>:<proxy_port>
    1. Run the following command followed by the credentials used to log in to Red Hat Customer Portal:

      # subscription-manager register
    2. Run the following command:

      # subscription-manager attach --auto

    Tip You are strongly recommended to not enable keepcache in the /etc/yum.conf file.

Task 2: Download the installer archive

Download the installer archive (propel_complete_installer.zip) to the host.

Task 3: Perform installation configuration

  1. Prepare the folder structure:

    # mkdir /opt/hp
    # cd /opt/hp/
    
  2. Unpack the installer archive (propel_complete_installer.zip) to the current folder:

    # unzip propel_complete_installer.zip
  3. Configure Chat, Survey and LW-SSO in the configure_extras.yml file as follows.

    Run the following commands:

    # cd /opt/hp/propel_complete_installer/ansible_content
    # vi  configure_extras.yml

    Configure the following parameters in this file:

    chat_url: "https://chatserver.domain/chatui/#/"
    service_manager_url: "http://smhost.domain:13080"
    lwsso_init_string: "Init string must be replaced for producti0n"
    • The chat_url parameter must be set to https://<Apache server host>/chatui, where <Apache server host> is the FQDN of the Apache server that you installed when deploying Service Manager Collaboration. For example: https://training.sm-demo.com/chatui.
    • The "service_manager_url" parameter must be set to your Service Manager Server web service base URL: For example: https://mysmhost.mycompany.net:13443. For security reasons, https is strongly recommended.
    • Replace Init string must be replaced for producti0n with your own LW-SSO initString value, which must match the initString value in the lwssofmconfig.xml file located in the Service Manager Server's RUN directory. Additionally, the initString value must contain both numbers and letters and must be 32 characters in length.
  4. Change to the installation directory:

    # cd propel_complete_installer
  5. Set the host name of the server on which Service Portal is being installed:

    # vi propel_install.config

    Add the host name using the following format:

    hostname="<server FQDN>" password="<password of the server's root user>"

    For example:

    hostname="sgdlitvm1.mycompany.com" password="1Qaz2wsx"

    Note The password is optional. If you do not specify the password here, you will be prompted for the password later.

    Important For a distributed (clustered) deployment, you need to configure all of the host names of the cluster. The following is an example:

    hostname="<LB node host FQDN>" password="<password>"
    hostname="<application node 1 FQDN>" password="<password>"
    hostname="<application node 2 FQDN>" password="<password>"
    hostname="<master DB node FQDN>" password="<password>"
    hostname="<slave DB node FQDN>" password="<password>"

Task 4: Run the installation script

  1. Change to the installation directory:

    # cd propel_complete_installer
  2. Run the installation script:

    With proxy:

    # ./propel_install.sh --proxy http://<web proxy host FQDN>:<port>

    Without proxy:

    # ./propel_install.sh

    When prompted, enter the password of the root user.

    When the installation is successfully complete, the following messages are displayed:

    Propel installation completed!
    Done!

    Important If you missed the configure_extras.yml parameter configuration step before running the installation script or you configured incorrect parameter values in that file, you need to run the following commands after running the installation script:

    # cd /opt/hp/propel_complete_installer/ansible_content
    # ansible-playbook -i ansible_targets configure_extras.yml --tags "initLWSSO" --extra-vars '{"lwsso_init_string":"LWSSO_INIT_STRING"}'
    # ansible-playbook -i ansible_targets configure_extras.yml --tags "enableChat" --extra-vars '{"toggle_chat":"on","chat_url":"https://<Apache server host>/chatui"}'
    # ansible-playbook -i ansible_targets configure_extras.yml --tags "enableSurvey" --extra-vars '{"toggle_survey":"on","service_manager_url":"http://smhost.domain:13080"}'

Tip Next, you need to verify the installation. See Verify the installation.

Offline installation

If your Red Hat Linux system has no Internet access, perform the following tasks to install Service Portal.

Important Before you can install Service Portal on an RHEL system without Internet access, you need to download the Service Portal installation package first using a machine that has Internet access.

Note For a distributed (clustered) deployment, the following procedure also applies. However, be aware of the following:

  • The "offline host" refers to the load balancer node.
  • You need to configure all cluster host names in the configure_extras.yml file before running the installation script on the load balancer node.

Prerequisites

Prepare two Red Hat Linux systems: one has Internet access and will be used as a local repository server (referred to as "the online host"); the other has no Internet access and will be used to install Service Portal (referred to as "the offline host").

To avoid unexpected errors during installation, you are strongly recommended to do the following:

  • Make sure the offline host is a clean Red Had Linux system.
  • Make sure the offline host meets the minimum system requirements (see Meet the system requirements), and the online host has at least 4 GB of RAM and 4 GB of free space for the local cache.

The offline installation procedure consists of the following steps.

Task 1: Download Service Portal dependencies to the online host

  1. Log in as the root user to the Red Hat Linux machine that has Internet access ("online server").
  2. Register your Red Hat Linux system to the Red Hat Subscription service.

    1. Set a proxy if necessary:

      # export http_proxy=http://<proxy_hostname>:<proxy_port>
      # export https_proxy=http://<proxy_hostname>:<proxy_port>
    1. Run the following command followed by the credentials used to log in to Red Hat Customer Portal:

      # subscription-manager register
    2. Run the following command:

      # subscription-manager attach --auto
  3. Update the yum.conf file and clean up the yum cache:

    # vi /etc/yum.conf
    keepcache=1
    cachedir=<your_own_yum_cache_directory> 

    Note Changing from the default cache directory is optional. However, you must make sure your cache directory has at least 4GB of free space.

    # yum clean all  
  4. Prepare the folder structure:

    # mkdir /opt/hp
    # cd /opt/hp/
    
  5. Download the archive (propel_complete_installer.zip) containing the installers and Ansible playbooks to the machine.

  6. Unpack the archive:

    # unzip propel_complete_installer.zip
  7. Change to the installation directory:

    # cd propel_complete_installer
  8. Run the installation script:

    With proxy:

    # ./propel_install.sh --proxy http://<web proxy host>:<port> --no-install-propel

    Without proxy:

    # ./propel_install.sh --no-install-propel

    When prompted, enter the password of the root user.

  9. Copy the /usr/local/src/propel folder (keep the folder structure) and its content from the online server to the offline server.

Task 2: Create a local or LAN yum repository for the offline host

You need to create an offline repository for the offline server.

There are two ways to do this:

  • Run a machine as a LAN yum repository server and add this repository to the offline server (that is, the RHEL host without Internet access).

    The following are example steps to add and enable an LAN yum repository:

    # yum repolist all
    # yum-config-manager --add-repo http://<Repo_IP>/downloads/RHEL70/media.repo
    # yum repolist all
    repo id repo name status
    MediaRepo MediaRepo disabled
    # yum-config-manager --enable InstallMedia

    Note This step might not enable the repo, and thus the next step is to manually edit the repo file.

    # vi /etc/yum.repos.d/media.repo
    [InstallMedia]
    name=Red Hat Enterprise Linux 7.2
    mediaid=1424360759.989
    metadata_expire=-1
    baseurl=http://<Repo_IP>/downloads/RHEL70/
    enabled=1
    cost=500
    gpgcheck=0
    # yum repolist all
    repo id repo name status
    MediaRepo MediaRepo enabled
  • Copy the rpm packages to the offline server and create a local repository for the offline server.

    The following are example steps to add and enable a local yum repository:

    1. Create a directory:

      # mkdir -p /data/mirrors/RHEL/7/os/x86_64/RPMS
    2. Copy all of the rpm packages from the online host to this directory.

    3. Run the following commands:

      # createrepo /data/mirrors/RHEL/7/os/x86_64/
      # cd /etc/yum.repos.d/
      # vi mirrors.repo
      

      Add the following lines:

      [mirrors-base]
      name=RHEL-$releasever - LocalRepo
      baseurl=file:///data/mirrors/RHEL/7/os/x86_64/
      gpgcheck=0
      enable=1
      

      Disable other existing repositories by suffixing the repository names with .bak:

      # yum clean all
      # mv local.repo local.repo.bak
      # yum repolist

Task 3: Install Service Portal on the offline host

Perform the following steps on the host that has no Internet access.

Step 1: Copy the archive (propel_complete_installer.zip) containing the installers and Ansible playbooks to the machine.

Step 2: Perform installation configuration:

  1. Prepare the folder structure:

    # mkdir /opt/hp
    # cd /opt/hp/
    
  2. Unpack the installer archive (propel_complete_installer.zip) to the current folder:

    # unzip propel_complete_installer.zip
  3. Configure Chat, Survey and LW-SSO in the configure_extras.yml file as follows.

    Run the following commands:

    # cd /opt/hp/propel_complete_installer/ansible_content
    # vi  configure_extras.yml

    Configure the following parameters in this file:

    chat_url: "https://chatserver.domain/chatui/#/"
    service_manager_url: "http://smhost.domain:13080"
    lwsso_init_string: "Init string must be replaced for producti0n"
    • The chat_url parameter must be set to https://<Apache server host>/chatui, where <Apache server host> is the FQDN of the Apache server that you installed when deploying Service Manager Collaboration. For example: https://training.sm-demo.com/chatui.
    • The "service_manager_url" parameter must be set to your Service Manager Server web service base URL: For example: https://mysmhost.mycompany.net:13443. For security reasons, https is strongly recommended.
    • Replace Init string must be replaced for producti0n with your own LW-SSO initString value, which must match the initString value in the lwssofmconfig.xml file located in the Service Manager Server's RUN directory. Additionally, the initString value must contain both numbers and letters and must be 32 characters in length.
  4. Change to the installation directory:

    # cd propel_complete_installer
  5. Set the host name of the server on which Service Portal is being installed:

    # vi propel_install.config

    Add the host name using the following format:

    hostname="<server FQDN>" password="<password of the server's root user>"

    For example:

    hostname="sgdlitvm1.mycompany.com" password="1Qaz2wsx"

    Note The password is optional. If you do not specify the password here, you will be prompted for the password later.

    Important For a distributed (clustered) deployment, you need to configure all of the host names of the cluster. The following is an example:

    hostname="<LB node host FQDN>" password="<password>"
    hostname="<application node 1 FQDN>" password="<password>"
    hostname="<application node 2 FQDN>" password="<password>"
    hostname="<master DB node FQDN>" password="<password>"
    hostname="<slave DB node FQDN>" password="<password>"

Step 3: Run the installation script.

Change to the installation directory and then run the installation script:

# ./propel_install.sh --offline

When the installation is complete, the following message is displayed:

Propel installation completed!
Done!

Tip Next, you need to verify the installation.

Verify the installation

To verify the installation, log in to Service Portal by opening a browser window and entering any of the following URLs for the three Service Portal roles:

  • Service Portal Administrator: https://<Service Portal host FQDN>:9000/org/Provider (Use "admin" as the user and "propel" as the password.)
  • Organization Administrator: https://<Service Portal host FQDN>:9000/org/CONSUMER (Use "orgadmin" as the user and "propel" as the password.)

  • Consumer: https://<Service Portal host FQDN>:9000/org/CONSUMER (Use "consumer" as the user and "propel" as the password.)

Next, continue with the following tasks:

Tip If you need to uninstall Service Portal, see Uninstall Service Portal.