External Dependencies

Using external services for Comet application dependencies¶

Comet supports integration with externally managed and hosted SaaS offerings for its application dependencies on all installation types. Relational database services such as Aurora and Cloud SQL should use the MySQL 5.7 (or nearest compatible) database engine. Caching services such as ElastiCache and MemoryStore should use a Redis or nearest compatible engine.

Note

If you're setting up an external MySQL instance, it's essential to adhere to the requirements outlined in this document

AWS¶

GCP¶

MySQL¶

To configure an externally hosted relational database in place of the on-premises MySQL installation add the following variables by running cometctl aio update-config:

mysql_host: <host>
mysql_user: <username>
mysql_password: <password>

You can optionally specify the database name to be used:

mysql_db: <db_name>

If you do not explicitly specify a name, logger will be used as the application database name.

In case you’re authenticating to RDS using IAM Roles

You’ll need to enable SSL and set some other configuration settings as follows:

mysql_iam_enabled: true
mysql_use_ssl: true
mysql_aws_region_name: us-east-1

Once you've finished configuring, run cometctl aio update-config. If you have configured prior to installation, you may now continue where you left off.

Redis:¶

To configure an externally hosted caching layer in place of the on-premises Redis installation, invoke cometctl aio update-config and add the following variables:

redis_host: <host>

You can optionally specify an auth token, as well as a non-standard redis ports:

redis_auth_token: <auth token>
redis_port: <redis_port>

In case you do not specify a Redis port, the default of 6379 will be used.

Once you've finished configuring, save your file. If you have configured prior to installation, you may now continue where you left off.

S3:¶

To configure an externally hosted datastore in place of the on-premises MinIO installation, invoke cometctl aio update-config and add the following variables:

When using GCP, set the s3_url variable to storage.googleapis.com instead of s3.amazonaws.com

s3_url: s3.amazonaws.com
s3_bucket: <s3 bucket name>
s3_access_key: <s3 access key>
s3_secret_key: <s3 secret key>
s3_https_enabled: true

You can optionally specify the region your bucket is located in:

s3_region: <s3 region>

In case you do not specify a region, us-east-1 will be used.

If you are authenticating using S3 roles rather than Access keys, set both the S3 key variables to the following string value:

s3_access_key: “IAM-ROLE”
s3_secret_key: “IAM-ROLE”

If your deployment is using Kubernetes, set the values to the following instead:

s3_access_key: “IAM-ROLE-SERVICE-ACCOUNT”
s3_secret_key: “IAM-ROLE-SERVICE-ACCOUNT”

Once you've finished configuring, run cometctl aio update-config. If you have configured prior to installation, you may now continue where you left off.

Jul. 9, 2024