Use an airy.yaml configuration file to customize your Airy Core instance
The configuration workflow is as simple as:
Your Airy Core instance will start and stop components according to your configuration. For example, if you do not wish to start Facebook components, it is enough not to provide any Facebook specific configuration.
If you installed Airy with Helm, then you need to setup your workspace directory, before you can use the CLI.
Now let's have a look at the different sections so you can make the changes you are looking for.
These settings are used to connect the Airy Components to your Kafka cluster:
brokerscomma separated list of the broker endpoints
zookeeperscomma separated list of the zookeeper endpoints
schemaRegistryUrlurl to the Schema Registry
commitIntervalthe Kafka Commit Interval if you are using the included Helm chart
authJaasthe JAAS configuration used to authenticate to remote Kafka clusters. Read more.
trueto enable HTTPS
loadbalancerAnnotationslist of annotations used to configure the LoadBalancer pointing to the ingress controller, in cloud environment (for AWS the following annotation is added by default:
letsencryptEmailthe e-mail address used for Let's Encrypt registration, when using HTTPS.
systemTokenset to a long secure secret to use for machine API authentication
allowedOriginsyour site's origin to prevent CORS-based attacks (default:
oidca map of values that when set enable and define OIDC authentication
jwtSecretused to create jwt http sessions derived from oidc authentication (default: randomized on installation)
appIdset this to your Facebook App ID
appSecretset this to your Facebook App Secret
webhookSecretset this to a webhook secret of your choice (optional)
saFilecopy here the content of your Google service account key file (one line json string)
partnerKeyset this to your Google partner key
authTokenset this to your Twilio authentication token
accountSidset this to your Twilio account SID
authTokenset this to your Viber authentication token
The Airy Controller only starts configured sources. To keep system load to a minimum, only add the sources you are using.
nameset this to the name of your webhook integration
s3Keyset this to your AWS S3 access key id
s3Secretset this to your AWS S3 secret access key (The bucket needs to have PublicRead privileges)
s3Bucketset this to your AWS S3 bucket
s3Regionset this to your AWS region
s3Pathset this to your AWS S3 path
hostset this to your Host
letsencryptset this to
trueif you are using LetsEncrypt in your ingress-controller
These settings are used to enable or disable some external tools used to monitor or debug the Airy Core.
akhqKafka GUI for Apache Kafka (For more information visit akhq.io)
enabledset to either
trueto start AKHQ or
false(default) to disable it
segmentTracking tool that tracks anonymous usage of the platform
falseif you want to disable tracking
For example, if you want to enable Facebook and Google sources, as well as the webhook integration, and the AKHQ tool, your
airy.yaml file should look like this: