Preparing config.yaml

Prepare a configuration file that contains a list of components to be installed and their settings:

On your computer, by using the template below, create a file named config.yaml.

components:
  a8n-db:
    admin_password: POSTGRESQL_SERVER_ADMIN_USER_PASSWORD
    admin_user: POSTGRESQL_SERVER_ADMIN_USER_NAME
    host: POSTGRESQL_SERVER_DOMAIN_NAME
  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"
cluster_domain: CLUSTER_DOMAIN
# cluster_domain_override: CLUSTER_DOMAIN_OVERRIDE
default_repo: 21-public

In your config.yaml, specify the following settings:
- PostgreSQL server settings
  - components.a8n-db.admin_password: The admin password of the PostgreSQL server that you prepared.
  - components.a8n-db.admin_user: The admin user name of the PostgreSQL server that you prepared.
  - components.a8n-db.host: The domain name of the PostgreSQL server that you prepared.
- General component settings
  - 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.
Define the format for hostnames of automatically created ingress rules. You can use one of these formats:
- PREFIX.NAMESPACE_OF_YOUR_CBC_INSTALLATION.CLUSTER_DOMAIN
- PREFIX.CLUSTER_DOMAIN_OVERRIDE
where:
- PREFIX is a service-specific auto-generated prefix.
- NAMESPACE_OF_YOUR_CBC_INSTALLATION is the namespace of your CloudBlue Commerce 21.0 installation.
- CLUSTER_DOMAIN is a domain specified in the cluster_domain setting.
- CLUSTER_DOMAIN_OVERRIDE is a domain specified in the cluster_domain_override setting.
If you specify a domain in the cluster_domain setting only, the first format will be used. If you specify a domain in the cluster_domain_override setting, the second format will be used regardless of whether the cluster_domain setting is specified or not.

Examples of hostnames of automatically created ingress rules:
- aps.cbc.example.com
- aps.example.com
Notes:
1. During the deployment, an ingress rule for the incoming APS proxy will be automatically created in your cluster.
2. To learn more about the incoming APS proxy, please refer to the APS SDK documentation.
Depending on which components you need to deploy, add these components to the file. For example:
```
components:
...
  oss: {}
  bss: {}
  branding-ui-cluster: {}
...
```
To obtain a list of CloudBlue Commerce components, their names, and links to their guides, see System Components and Their Business Purposes.
For the components that you specified in the file, learn which settings these components have. To do this, please refer to the guides of these components. If a setting of a component does not have a default value or its default value is not suitable, specify this setting and its value in the file.
(Azure-specific) Specify which kinds of load balancers will be used for the branded UI (TCP port 443) and the admin UI (TCP port 8080). You have the following options:
- (Default) Use public load balancers for the branded UI and the admin UI. As a result, both UIs will be exposed by using public IP addresses configured on these load balancers.
  
  Important: You must configure a firewall to make the admin UI accessible from your company's network only.
  
  To obtain this configuration, either omit the use_internal_loadbalancers and use_branding_ui_local_external_load_balancer settings or adjust your config.yaml file as shown below:
```
components:
...
use_internal_loadbalancers: true
use_branding_ui_local_external_load_balancer: true
```
- (Recommended) Use a public load balancer for the branded UI and an internal load balancer for the admin UI. As a result, the branded UI will be exposed by using a public IP address configured on a public load balancer, and the admin UI will be exposed by using an internal IP address configured on an internal load balancer.
  
  Note: You will need to configure a VPN connection between your company's network and your installation's network to have access to the admin UI.
  
  To obtain this configuration, adjust your config.yaml file as shown below:
```
components:
...
use_internal_loadbalancers: true
use_branding_ui_local_external_load_balancer: false
```
- Use internal load balancers for the branded UI and the admin UI. As a result, both UIs will be exposed by using internal IP addresses configured on these load balancers.
  
  Notes:
  1. You will need to configure NAT to allow access to the branded UI from the Internet.
  2. You will need to configure a VPN connection between your company's network and your installation's network to have access to the admin UI.
  
  To obtain this configuration, adjust your config.yaml file as shown below:
```
components:
...
use_internal_loadbalancers: false
use_branding_ui_local_external_load_balancer: false
```
Note: To learn more about public and internal load balancers in Azure, please refer to the Azure documentation.

Important: You must keep your config.yaml after the initial deployment as you will need this file to install new components, upgrade existing components, and change component settings on your CloudBlue Commerce installation. We recommend that you keep this file in a version control system, such as Git, and commit changes as it updates.