Skip to main content

Configuring AtScale with a Forward Proxy

You can optionally configure AtScale to use a forward proxy. This can be done before or after installing.

Prerequisites​

This procedure assumes you already have a proxy server set up.

Configure AtScale with a forward proxy​

To enable AtScale to use a forward proxy:

  1. On your Kubernetes cluster, set the following environment variables:

    • HTTP_PROXY: The proxy server to use for HTTP requests.
    • HTTPS_PROXY: The proxy server to use for HTTPS requests.
    • NO_PROXY: A comma-separated list of domains that should not be proxied. This ensures the proxy isn't used for communication between AtScale's internal services (Keycloak, the engine, entitlement, etc.).

  2. If you are configuring Keycloak to use the proxy, you must obtain its current environment variables from the values file. You will need to include these in the changes you make to the values override file in the next step; otherwise, they will be overridden.

    To obtain Keycloak's current environment variables:

    1. Run the following command:

      helm show values oci://docker.io/atscaleinc/atscale --version <version> > full_values.yaml

      Where <version> is the version of AtScale you're currently on,.

      This outputs the current contents of the values file to full_values.yaml.

    2. Open the file. In the keycloak section, locate the extraEnvVars property and copy all of its values.

  3. In your values override file, define the proxies to use for each of the AtScale services.

    atscale-api:
        extraEnvVars:
            - name: HTTP_PROXY
              value: http://proxy.example.com
    atscale-sml:
        extraEnvVars:
            - name: HTTP_PROXY
              value: http://proxy.example.com
    atscale-engine:
        extraEnvVars:
            - name: HTTP_PROXY
              value: http://proxy.example.com
    keycloak:
        extraEnvVars:
            - name: HTTP_PROXY
              value: http://proxy.example.com
    Important

    If you are configuring a proxy for the keycloak service, be sure to include the current environment variables you copied above.

  4. If you have not yet installed AtScale, continue on with the installation procedure.

    If you have already installed AtScale, apply the updated values file:

    helm upgrade atscale oci://docker.io/atscaleinc/atscale --version <version_number> -n <namespace> -f <values_file>

    Where <version_number> is the version of AtScale you're currently on, <namespace> is the namespace in which AtScale is installed, and <values_file> is your updated values file.