OneClick WebApp (Beta)

22
casp1032
2
2
About OneClick WebApp
Leverage the new OneClick WebApp (Beta) with the latest CA Spectrum 10.3.1 release! OneClick WebApp ensures ease of use with browser access to the OneClick Console and comes without hassles of having to install and update Java with each launch.
Memory Requirements for OneClick WebApp web server:
For every new session that opens in the client, OneClick WebApp takes around 300 MB to 500 MB of server memory, as it creates a java process for each client.
CA Spectrum now ensures that the OC WebApp port is updated to 9443 if it is available, or to any other available port.
CA Spectrum 10.3.2 introduces the download and upload option as an improvement to the OneClick WebApp. These upload and download improvements are made where client files system is made available.
The service desk ticket launch now opens in a separate browser.
Configure OneClick WebApp in Docker
This section describes the procedure to configure the OneClick WebApp in Docker. You need the X Windows System virtual framebuffer X server package (
xorg-x11-server-Xvfb)
to start the webswing.
Follow these steps:
  1. While creating the container, create a port mapping like it is done for the OneClick port.
    For OneClick WebApp:
    docker run -e ROOT_PASSWORD=???.qaperf184 -e MAIN_LOCATION_SERVER=719de9a39c46 -e MAIN_LOCATION_SERVER_IP=172.17.0.2 -e TOMCAT_PORT=8080 -p 9090:8080 -p 9443:9443 -e MASTER_NODE=docker-rh74vm2 -it 1032ocimage
    Here 9443 is the port number that WebApp uses, once the OC container is created.
  2. Perform one of the following tasks to install the package.
    1. If the package is
      available
      , follow these steps:
      1. Copy the
        xorg-x11-server-Xvfb
        file to the
        <docker_host>/container
        directory using the ‘docker copy <filename> <containerName:/path>’ command.
      2. Install the package.
    2. If the package is
      not available
      , follow these steps:
      1. In the docker container, go to the
        /etc/yum.repo.d
        directory.
      2. Move all the repo file in this directory except the
        Vi test.repo
        file to a temporary location.
      3. Open the
        Vi test.repo
        file
      4. Insert the following code chunk:
        [test] name=test baseurl=http://vault.centos.org/6.2/os/x86_64 gpgcheck=0 enabled=1
      5. Save and close the file.
      6. Run the following command:
        yum clean all yum repolist
      7. Install the package using the yum install
        xorg-x11-server-Xvfb
        command.
  3. When package installation is completed, move the repo files that you put in a temporary location to the current directory.
Steps to Run OneClick WebApp on Windows
The OneClick WebApp application runs in a separate tomcat web server, also called as the OneClick WebApp web server. The OneClick WebApp web server runs on a service that is referred to as the SpectrumWebTomcat. By default, the SpectrumWebTomcat service is in stopped state.
Following these steps:
  1. Start the SpectrumWebTomcat service to launch the OneClick WebApp web server (as show in screenshot below). To start the SpectrumWebTomcat service, launch
    services.msc
    from your windows machine. Find and select the SpectrumWebTomcat service option (which as mentioned, is in stopped state) and start it. The OneClick WebApp web server takes a couple of minutes to start.
    The Webtomcat web server and the OneClick web server, run on separate ports. CA Spectrum 10.3.1 ensures the assigning of the next available port number (by reading the OneClick web server port number) to Webtomcat web server.
    image001 (5).png
  2. Launch the OneClick Admin page and select the OneClick WebApp (Beta) option (as shown here), to launch the OneClick WebApp application.
    Oneclick WebaPP beta.JPG
    The
    Spectrum OneClick WebApp Log in
    window opens. The WebApp URL is, as mentioned here:
    http://<server-name>:8081/spectrum/webapp
    To change the port number that has been assigned to the OneClick WebApp web server, navigate to the following location:
    %SPECROOT%Webtomcat>conf>server.xml
    file and look in the connector folder for the http protocol. For example:
    <Connector port="8081" protocol="HTTP/1.1" connectionTimeout="20000" redirectPort="8443" />
    In the example that is given above, the port number that is assigned to the OneClick WebApp web server is 8081.
  3. Log in using the username and password, for example, spectrum/spectrum, following which the OneClick WebApp launches the OneClick console in the browser.
  4. Should there be an issue starting the OneClick WebApp web server, analyze, and fetch the webtomcat logs for troubleshooting, from the following log locations:
    %SPECROOT%webtomcat/bin/webswing.log
    %SPECROOT%webtomcat/logs/stdout.><date-stamp>.log
Steps to run OneClick WebApp on Linux
Prerequisites
  1. Download and Extract the installation package (xorg-x11-server-Xvfb-1.10.4-6.el6.x86_64.rpm) to a temporary directory.
    wget http://vault.centos.org/6.2/os/x86_64/Packages/<package_name> tar <package_name>
  2. Install the package using one of the following methods.
    yum install <package_name> OR yum localinstall <package_name>
Following are the steps to run OneClick WebApp on Linux:
The OneClick WebApp application runs in a separate tomcat web server, also called as the OneClick WebApp web server. The OneClick WebApp web server runs on a service referred to as the SpectrumWebTomcat. By default, the SpectrumWebTomcat service is in stopped state.
  1. Navigate to the following location:
    $SPECROOT>webtomcat>bin
    directory and start the OneClick WebApp web server by executing the following command:
    ./startWebTomcat.sh
    The OneClick WebApp web server and the OneClick web server, run on separate ports. CA Spectrum 10.3.1 ensures the assigning of the next available port number (by reading the OneClick webserver port number) to OneClick WebApp web server.
  2. Launch the OneClick Admin page and select the OneClick WebApp (Beta) option (as shown here), to launch the OneClick WebApp application.
    Oneclick WebaPP beta.JPG
    The
    Spectrum OneClick WebApp Log in
    window opens. The WebApp URL is, as mentioned here:
    http://<server-name>:8081/spectrum/webapp
    To change the port number that has been assigned to the OneClick WebApp web server, navigate to the following location:
    $SPECROOT>webtomcat>conf>server.xml
    file and look in the connector folder for the http protocol. For example:
    <Connector port="8081" protocol="HTTP/1.1" connectionTimeout="20000" redirectPort="8443" />
    In the above example, the port number that is assigned to the OneClick WebApp web server is 8081.
  3. Log in using the username and password, for example, spectrum/spectrum, following which the OneClick WebApp launches the OneClick console in the browser.
  4. Should there be an issue starting the OneClick WebApp web server, analyze, and fetch the web tomcat logs for troubleshooting, from the following log locations:
    %SPECROOT%webtomcat>logs>Catalina.out
    %SPECROOT%webtomcat/bin/webswing.log
  5. To stop the OneClick WebApp application, run the following command:
    ./stopWebTomcat.sh
SSL Support for the OneClick WebApp
The SSL feature is enabled with OneClick and available with previous versions of Spectrum. Installation takes care of the client certificates and setting the SSL to true in the configuration. Selecting the Beta link the OneClick administration page loads the Spectrum console without errors. You can enable SSL support or change the OneClick WebApp URL.
If OneClick is SSL enabled before upgrading, the OneClick WebApp URL appears in
https
.
Follow these steps:
  1. Navigate to the
    tomcat >conf>server.xml
    file and copy the connector https ports-related information and paste it in the
    webtomcat>conf folder>server.xml file
    under the
    https connector
    section.
  2. Change the SSL connector port entry that you pasted in the
    webtomcat/conf/server.xml
    file, so that it does not conflict with the standard OneClick Tomcat SSL port. For example, change it from 8443 to 8450.
  3. Restart the web tomcat service.
Change the OneClick WebApp URL in the Admin Page
This section describes the steps to change the OneClick WebApp URL in the admin page if the port/protocol is changed.
Follow these steps:
  1. Navigate to the
    $pecroot/tomcat/webapps/spectrum/console/console-menubar.jsp
    and search for the following section:
    <% if ( request.isUserInRole("Administrator") == true || request.isUserInRole("Operator") == true ) { %> <th class="customFontSize"> <a href="http://<HOST>:<PORT>/spectrum/oneclickwebapp/" onMouseOver="window.parent.status='<apputil:message key='console-menubar.Lite-OC'/>';return true;" onMouseOut="window.parent.status='';return true;" target="_blank"><apputil:message key='console-menubar.Lite-OC'/></a> </th> <% } %>
  2. Customize the 'href' URL to match the OneClick hostname and the WebApp port that you set mentioned in Step 2.
    For Example: a href=https://OCServer:8450/spectrum/oneclickwebapp/
  3. Customize the 'href' URL mentioned above and save your changes.
  4. Refresh the admin page.
Post Upgrade Tasks
Follow these steps if you have enabled SSL in OneClick after upgrading to 10.3.x or if you have changed the OneClick ports after upgrading to 10.3.x:
  1. Log in to the OneClick WebApp administration page. The default URL is:
    https://<webapp-hostname>:<webapp-port>/spectrum
  2. Log in with the
    spectrum/spectrum
    username/password credentials and select
    Manage
    .
    PostUpgradeTaskWebApp Authentication
  3. Select
    Show Config
    , to view the configuration.
    PostUpgradeTaskWebApp Show Config
  4. Add the following for the JVM Arguments under the
    Application – Java
    section after the
    –Dsun.awt.noerasebackground=true
    entry:
    -Djavax.net.ssl.trustStore=${SPECROOT}/custom/keystore/cacerts-Djavax.net.ssl.trustStorePassword=changeit
    PostUpgradeTaskWebApp JVM Arguments
    Cross verify these values with the OneClick tomcat server.xml configuration (only if SSL is enabled).
    Do not set the ${SPECROOT} to an absolute path. However, change the path/filename of the keystore (the default is cacerts) and password (the default is changeit) if they are not the default entries.
  5. Navigate to the
    Launcher configuration>Main Arguments
    section and select the OneClick Hostname, OneClick port, and the SSL values, if SSL is enabled, change the –ssl to true.
    PostUpgradeTaskWebApp Main Arguments
    These values should be in sync with the OneClick details. The SSL port should be the same as your original Tomcat SSL port, that is 8443 (if SSL is enabled). If you changed the OneClick port, change it.
  6. After you have made the changes, select
    Apply
    on the top left corner and re-launch the OneClick WebApp from the administration page.
    PostUpgradeTaskWebApp Main Arguments
  7. Launch the OneClick Admin page and select the OneClick WebApp (Beta) option, to launch the OneClick WebApp application.
CAC Support for the OneClick Webapp
After configuring SSL, configure Common Access Cards (CAC) authentication on the OneClick WebApp.
Follow these steps
  1. Configure CAC for
    Spectrum
    OneClick, see How to Configure CA Spectrum for SSL and CAC Authentication.
  2. Log in to the OneClick WebApp administration page. The default URL is:
    https://<webapp-hostname>:<webapp-port>/spectrum
  3. Log in with the
    spectrum/spectrum
    username/password credentials and select
    Manage
    .
    PostUpgradeTaskWebApp Authentication
  4. Select
    Show Config
    , to view the configuration.
    PostUpgradeTaskWebApp Show Config
  5. Add the following for the JVM Arguments under the
    Application – Java
    section after the
    -Djavax.net.ssl.trustStorePassword=changeit
    entry:
    -Djavax.net.ssl.keyStore=${SPECROOT}/custom/keystore/cacerts -Djavax.net.ssl.keyStorePassword=changeit
    PostUpgradeTaskWebApp JVM Arguments
    Cross verify these values with the OneClick tomcat server.xml configuration (only if SSL is enabled).
  6. Verify that your JVM arguments are as follows:
    --Xmx1024m -Djavaws.cfg.jauthenticator=true -DbrowserIp=${clientIp} -Dsun.awt.noerasebackground=true -Duser.timezone=${clientTimeZone} -Djavax.net.ssl.trustStore=${SPECROOT}/custom/keystore/cacerts -Djavax.net.ssl.trustStorePassword=changeit -Djavax.net.ssl.keyStore=${SPECROOT}/custom/keystore/cacerts -Djavax.net.ssl.keyStorePassword=changeit
    Do not set the ${SPECROOT} to an absolute path. However, change the path/filename of the keystore (the default is cacerts) and password (the default is changeit) if they are not the default entries.
  7. Navigate to the
    Launcher configuration>Main Arguments
    section and add
    –cacEnabled true
    to the end of the entry.
    PostUpgradeTaskWebApp Main Arguments
  8. After you have made the changes, select
    Apply
    on the top left corner and re-launch the OneClick WebApp from the administration page.
    PostUpgradeTaskWebApp Main Arguments
  9. Launch the OneClick Admin page and select the OneClick WebApp (Beta) option, to launch the OneClick WebApp application.
Troubleshooting OneClick WebApp
This section describes the steps you can take to troubleshoot some common issues that you may face during WebApp configuration.
Troubleshooting Enabling the SSL support
This section discusses the procedure to troubleshoot any error while enabling the SSL Support.
Follow these steps:
  1. Log in to the OneClick WebApp administration page. Refer to the $SPECROOT/webtomcat/conf/server.xml file for webapp port details.
    Default URL
    : https://<webapp-hostname>:<webapp-port>/spectrum
  2. Log in with the spectrum/spectrum as a username/password.
  3. Select Manage.
  4. Check whether the OneClick WebApp is enabled or not. If it is not enabled you see the Enable button on the top right corner.
  5. Select
    Enable
    , if the option is in the disable state.
  6. Select Show Config, If it is already enabled. The JVM arguments contain the trustStore path and password under the application.
  7. Verify the data with OneClick Tomcat server.xml configuration.
  8. Navigate to the Launcher configuration, Main arguments.
  9. Verify that arguments point to the localhost, where the SSL port and the -ssl is be set to true.
Troubleshooting with launching/starting the Webtomcat:
Follow these steps:
  1. Check the
    tomcat/conf/server.xml
    and the
    webtomcat/conf/server.xml
    files for any port conflicts (often port conflicts will shutdown the port).
  2. For Linux, the webtomcat does not start if the XVFB is not installed. Refer to the section on Steps to run OneClick WebApp on Linux on this page.