Updating General Component Settings

On an existing CloudBlue Commerce installation, you can update the following general component settings specified in your config.yaml file:

components:
...
  a8n-config:
    env:
      TZ: TIMEZONE
      ENV_LOCALES: LOCALES
      ENV_SMTP_HOST: SMTP_SERVER_ADDRESS
      ENV_SMTP_PORT: SMTP_SERVER_PORT
      ENV_SMTP_LOGIN: SMTP_SERVER_USERNAME
      ENV_SMTP_PASSWORD: SMTP_SERVER_PASSWORD
      ENV_SMTP_AUTH: "yes"
...
  • components.a8n-config.env.TZ: The name of the time zone of your installation in the Area/Location format. For example: America/New_York

    Note: You can see more examples of time zone names here.

  • components.a8n-config.env.ENV_LOCALES: The default locales that will be enabled on your installation (en, es, de, fr, it, ja, nl, pt, and ru). When specifying several locales, use a comma as a separator. For example: en,es,de

  • components.a8n-config.env.ENV_SMTP_HOST: The hostname or IP address of the SMTP server that you prepared.

  • components.a8n-config.env.ENV_SMTP_PORT: The port of the SMTP server that you prepared.

  • components.a8n-config.env.ENV_SMTP_LOGIN: The user name of a user for SMTP authentication.

  • components.a8n-config.env.ENV_SMTP_PASSWORD: The password of a user for SMTP authentication.

  • components.a8n-config.env.ENV_HTTP_HEADER_MAX_SIZE (optional): The maximum size of one HTTP request header field, in bytes. If not specified, the default value is 8190.

  • components.a8n-config.env.ENV_HTTP_HEADER_MAX_COUNT (optional): The maximum number of header fields in one HTTP request. If not specified, the default value is 100.

  • components.a8n-config.env.ENV_HTTP_REQUEST_LINE_MAX_SIZE (optional): The maximum size of the HTTP request line, in bytes. If not specified, the default value is 8190.

  • The three settings above control the HTTP request limits of UI and Branding, BSS, and Identity Service together. Raise them if users who sign in through some single sign-on configurations arrive with large cookies and get errors or time-outs. For example:

    components:
      a8n-config:
        env:
          ENV_HTTP_HEADER_MAX_SIZE: "32768"
          ENV_HTTP_HEADER_MAX_COUNT: "100"
          ENV_HTTP_REQUEST_LINE_MAX_SIZE: "32768"

    Values are validated during deployment and when the containers start. Out-of-range values are rejected. Each of these components also has its own parameters for the same limits, but keep the limits aligned across the components for the platform to work in a stable manner.

    Note: Load balancers, ingress controllers, and other network layers in front of the platform have their own limits, which must be raised separately.

After you update the settings that you need in your config.yaml file, complete these steps:

  1. Create a deployment container and start its interactive shell. To learn how to do this, see Preparing a Deployment Container.

  2. In the interactive shell of the container, execute this command:

    setup-product.sh -n NAMESPACE -f /config/config.yaml -c a8n-config

    In this command, NAMESPACE is the namespace of your CloudBlue Commerce installation.

  3. Restart all components:

    1. Prepare a list of all Deployments and StatefulSets by executing these commands:

      kubectl -n NAMESPACE get deployments
      kubectl -n NAMESPACE get statefulsets
    2. Restart all Deployments and StatefulSets from the list that you prepared:

      kubectl -n NAMESPACE rollout restart deployment DEPLOYMENT
      kubectl -n NAMESPACE rollout restart sts STATEFULSET

    In these commands:

    • NAMESPACE is the namespace of your CloudBlue Commerce installation.

    • DEPLOYMENT is the name of a Deployment whose Pods you need to restart.

    • STATEFULSET is the name of a StatefulSet whose Pods you need to restart.

Note: The following components use the time zone specified in config.yaml for synchronization: Operations Support System (oss), Billing Support System (bss), UI and Branding (branding-ui-cluster), and Order Management (ordermanagement).