Choreo Connect Adaptor Configuration Catalog

This document describes all the configuration parameters that are used in WSO2 Choreo Connect Adaptor.

Instructions for use

Select the configuration sections, parameters, and values that are required for your use and add them to the config.toml file located in <CHOREO-CONNECT_HOME>/docker-compose/choreo-connect/conf/. See the example .toml file given below.

# This is an example .toml file.

[adapter.server]
  enabled = true
  host = "0.0.0.0"
  port = "9843"
  tokenTTL = "1h"
  tokenPrivateKeyPath = "/home/wso2/security/keystore/mg.key"
  [[adapter.server.users]]
    username = "admin"
    password = "$env{adapter_admin_pwd}"

# default vhosts mapping for standalone mode
[[adapter.vhostMapping]]
  environment = "Default"
  vhost = "localhost"

Server

[adapter.server]
  enabled = true
  host = "0.0.0.0"
  port = "9843"
  tokenTTL = "1h"
  tokenPrivateKeyPath = "/home/wso2/security/keystore/mg.key"
  [[adapter.server.users]]
    username = "admin"
    password = "$env{adapter_admin_pwd}"
[server] Required

This includes configurations required for configuring the deployment parameters that are used for identifying the Choreo Connect Adapter REST APIs.

enabled

boolean Required

Default: true
Possible Values: true, false

Enable/Disable Choreo Connect Adaptor REST API.

host

string Required

Default:

Hostname of the Choreo Connect Adaptor

port

string Required

Default: 9843

Port of the Choreo Connect Adaptor

tokenTTL

string

Default: 1h

Time to live for the Adaptor access token

tokenPrivateKeyPath

string

Default: /home/wso2/security/keystore/mg.key

Private key path to use for the token generation

Keystore

[adapter.keystore]
  certPath = "/home/wso2/security/keystore/mg.pem"
  keyPath = "/home/wso2/security/keystore/mg.key"
[keystore] Required

The configurations of key store used in Choreo Connect Adapter

certPath

string Required

Default: /home/wso2/security/keystore/mg.pem

Path of the certificate of the Adaptor

keyPath

string Required

Default: /home/wso2/security/keystore/mg.key

Path of the private key of the Adaptor

Truststore

[adapter.truststore]
  location = "/home/wso2/security/truststore"
[truststore] Required

The configurations of trust store used in in the Choreo Connect Adapter.

location

string Required

Default: /home/wso2/security/truststore

The directory path for the trusted certificates of the Choreo Connect Adaptor.

Virtual Host Mapping

[[adapter.vhostMapping]]
  environment = "Default"
  vhost = "localhost"
[vhostMapping]

Virtual host mappings.

environment

string Required

Default:

The Adapter environment

vhost

string Required

Default:

Virtual host to map to the environment

Consul

[adapter.consul]
  enable = false
  url = "https://169.254.1.1:8501" # scheme + host ip + port
  pollInterval = 5 # seconds
  aclToken = "d3a2a719-4221-8c65-5212-58d4727427ac"
  mgwServiceName = "wso2"
  serviceMeshEnabled = false
  # certs for tls
  caCertFile = "/home/wso2/security/truststore/consul/consul-agent-ca.pem"
  certFile = "/home/wso2/security/truststore/consul/local-dc-client-consul-0.pem"
  keyFile = "/home/wso2/security/truststore/consul/local-dc-client-consul-0-key.pem"
[consul]

Configurations related to Consul

enable

boolean Required

Default: false
Possible Values: true, false

Enable/Disable consul service.

url

string Required

Default:

connection url of the Consul HTTP API.

pollInterval

integer

Default: 5

The time interval (in seconds) in which the Choreo Connect should fetch updates from the Consul service catalog.

aclToken

string Required

Default:

Access Control Token generated using Consul. You should grant read access to services when creating the token

mgwServiceName

string Required

Default: wso2

Choreo Connect natively integrates with Consul service mesh. Therefore a service name is required to be defined inorder to grant access to other services in mesh. This only need to be defined if service mesh enabled in Consul.

serviceMeshEnabled

boolean

Default: false
Possible Values: true, false

Set this to true if service mesh is enabled in Consul

caCertFile

string

Default: /home/wso2/security/truststore/consul/consul-agent-ca.pem

This is the optional path to the CA certificate used for Consul communication, defaults to the system bundle if not specified.

certFile

string

Default: /home/wso2/security/truststore/consul/local-dc-client-consul-0.pem

This is the optional path to the certificate for Consul communication. If this is set, then you also need to set keyFile.

keyFile

string

Default: /home/wso2/security/truststore/consul/local-dc-client-consul-0-key.pem

This is the optional path to the private key for Consul communication. If this is set, then you need to also set certFile.

Top