Proxy configuration for resource providers outside the internal network

If you are using a network proxy server to communicate with a resource provider outside of the internal network (the resource provider's service access point is located outside of the internal network), configure Codar and Operations Orchestration to use this proxy server.

If you are using a network proxy server to communicate with a resource provider outside of the internal network, proxy configuration is required in the following situations:

  • Codar - Validating the accessibility of a resource provider's URL. When a resource provider is created or modified, accessibility of the provider URL is validated with an HTTP or HTTPS GET call.
  • Operations Orchestration - Contacting a resource provider. When an Operations Orchestration workflow provisioning step is executed, Operations Orchestration attempts to contact the resource provider.

If you do not configure the proxy server, you may see a Provider Validation Failed message when creating or updating a resource provider whose service access point is located outside of the internal network. Or, provisioning of a design fails when Operations Orchestration is unable to communicate with a resource provider that is located outside of the internal network.

To configure the proxy server for Codar and Operations Orchestration, complete the following steps:

  1. On the system running Codar, in a text editor, open the CSA_HOME\jboss‑as\bin\standalone.conf.bat file on Windows or .CSA_HOME/jboss-as/bin/standalone.conf file on Linux.

  2. After the last uncommented line that sets the JAVA_OPTS property, add the following lines:

    On Windows:

    rem # HTTP Proxy Settings
    set "JAVA_OPTS=%JAVA_OPTS% -Dhttp.proxyHost=<proxy.company.com>
    -Dhttp.proxyPort=<proxy_port>"

    rem # HTTPS Proxy Settings
    set "JAVA_OPTS=%JAVA_OPTS% -Dhttps.proxyHost=<proxy.company.com>
    -Dhttps.proxyPort=<proxy_port>"

    rem # HTTP/HTTPS hosts not handled by the proxy
    set "JAVA_OPTS=%JAVA_OPTS% -Dhttp.nonProxyHosts=mycodarserver^^^|localhost^^^|127.*^^^|10.* "

    where <proxy.company.com> is the fully-qualified domain name of the proxy server,
    <proxy_port> is the port used to communicate with the proxy server, and ^^^| is the separator used when defining more than one non-proxy host.

    On Ubuntu Linux:

    # HTTP Proxy Settings
    JAVA_OPTS=$JAVA_OPTS -Dhttp.proxyHost=<proxy.company.com>
    -Dhttp.proxyPort=<proxy_port>"

    # HTTPS Proxy Settings
    JAVA_OPTS=$JAVA_OPTS -Dhttps.proxyHost=<proxy.company.com>
    -Dhttps.proxyPort=<proxy_port>"

    # HTTP/HTTPS hosts not handled by the proxy
    JAVA_OPTS=$JAVA_OPTS -Dhttp.nonProxyHosts=mycodarserver\|localhost\|127.*|10.*"

    <proxy.company.com> is the fully-qualified domain name of the proxy server,
    <proxy_port> is the port used to communicate with the proxy server, and ^^^| on Windows or \| on Linux is the separator used when defining more than one non-proxy host.

    Red Hat Enterprise Linux

    In the if-else block, add the following lines:

    # HTTP Proxy Settings
    JAVA_OPTS= "$JAVA_OPTS -Dhttp.proxyHost=<proxy.company.com>
    -Dhttp.proxyPort=<proxy_port>"

    # HTTPS Proxy Settings
    JAVA_OPTS= "$JAVA_OPTS -Dhttps.proxyHost=<proxy.company.com>
    -Dhttps.proxyPort=<proxy_port>"

    # HTTP/HTTPS hosts not handled by the proxy
    JAVA_OPTS= "$JAVA_OPTS -Dhttp.nonProxyHosts=localhost\|127.*\|10.* "

    <proxy.company.com> is the fully-qualified domain name of the proxy server,
    <proxy_port> is the port used to communicate with the proxy server, and \| is the separator used when defining more than one non-proxy host.

  3. Save and exit the file.
  4. Restart Codar service, see Restart Codar.

  5. If you have integrated with Operations Orchestration version 10.21, do the following:

    1. Log in to Operations Orchestration Central.
    2. Click the Content Management button.
    3. Select Configuration Items > System Properties.
    4. Click the Add icon.
    5. Enter the following information if it is not already configured:

      Field Description
      Name CODAR_Proxy_Host
      Override Value The fully-qualified domain name of the proxy server.
      Name CODAR_Proxy_Port
      Override Value The port used to communicate with the proxy server.
    6. Click Save.