The CMS service is a microservice designed for managing taxonomies and content inside an application. Delivered as a Docker image, it simplifies content editing and analysis. This guide provides step-by-step instructions for setting up the service and configuring it to suit your needs.
flowx
.Environment variable | Description |
---|---|
SECURITY_OAUTH2_BASESERVERURL | Base URL for the OAuth 2.0 Authorization Server |
SECURITY_OAUTH2_CLIENT_CLIENTID | Unique identifier for the client application |
SECURITY_OAUTH2_CLIENT_CLIENTSECRET | Secret key to authenticate client requests |
SECURITY_OAUTH2_REALM | Realm name for OAuth 2.0 provider authentication |
Environment variable | Description | Default value |
---|---|---|
APPLICATION_FLOWXRUNTIMESANAME | Name of the Runtime Manager service account in Keycloak | flowx-runtime-manager-sa |
Environment variable | Description | Default value |
---|---|---|
SPRING_DATA_MONGODB_URI | URI for connecting to the CMS MongoDB instance | Format: mongodb://${DB_USERNAME}:${DB_PASSWORD}@<host1>,<host2>,<arbiter-host>:<port>/${DB_NAME}?retryWrites=false |
DB_USERNAME | MongoDB username | cms-core |
DB_NAME | MongoDB database name | cms-core |
DB_PASSWORD | MongoDB password | |
MONGOCK_TRANSACTIONENABLED | Enables transactions in MongoDB for Mongock library | false (Set to false to support successful migrations) |
MONGOCK_TRANSACTIONENABLED
to false
due to known issues with transactions in MongoDB version 5.Environment variable | Description | Default value |
---|---|---|
SPRING_DATA_MONGODB_RUNTIME_URI | URI for connecting to Runtime MongoDB | Format: mongodb://${RUNTIME_DB_USERNAME}:${RUNTIME_DB_PASSWORD}@<host1>,<host2>,<arbiter-host>:<port>/${RUNTIME_DB_NAME}?retryWrites=false |
RUNTIME_DB_USERNAME | Runtime MongoDB username | app-runtime |
RUNTIME_DB_NAME | Runtime MongoDB database name | app-runtime |
RUNTIME_DB_PASSWORD | Runtime MongoDB password | |
SPRING_DATA_MONGODB_STORAGE | Storage type for Runtime MongoDB (Azure environments only) | mongodb (Options: mongodb , cosmosdb ) |
Environment variable | Description |
---|---|
SPRING_DATA_REDIS_HOST | Hostname or IP of the Redis server |
SPRING_DATA_REDIS_PASSWORD | Authentication password for Redis |
SPRING_REDIS_TTL | Maximum time-to-live for Redis cache keys (in seconds) |
Environment variable | Description | Default value |
---|---|---|
SPRING_KAFKA_BOOTSTRAPSERVERS | Address of the Kafka server | localhost:9092 |
SPRING_KAFKA_SECURITY_PROTOCOL | Security protocol for Kafka | "PLAINTEXT" |
Environment variable | Description | Default value |
---|---|---|
KAFKA_AUTHEXCEPTIONRETRYINTERVAL | Retry interval after an authorization exception | 10 |
KAFKA_MESSAGE_MAX_BYTES | Maximum message size in bytes | 52428800 (50MB) |
Environment variable | Description | Default value |
---|---|---|
KAFKA_CONSUMER_GROUPID_CONTENTTRANSLATE | Group ID for content translation | cms-consumer-preview |
KAFKA_CONSUMER_GROUPID_RESUSAGEVALIDATION | Group ID for resource usage validation | cms-res-usage-validation-group |
Environment variable | Description | Default value |
---|---|---|
KAFKA_CONSUMER_THREADS_CONTENTTRANSLATE | Threads for content translation | 1 |
KAFKA_CONSUMER_THREADS_RESUSAGEVALIDATION | Threads for resource usage validation | 2 |
Environment variable | Description | Default value |
---|---|---|
KAFKA_TOPIC_REQUEST_CONTENT_IN | Topic for incoming content retrieval requests | ai.flowx.dev.plugin.cms.trigger.retrieve.content.v1 |
KAFKA_TOPIC_REQUEST_CONTENT_OUT | Topic for content retrieval results | ai.flowx.dev.engine.receive.plugin.cms.retrieve.content.results.v1 |
Environment variable | Description | Default value |
---|---|---|
KAFKA_TOPIC_AUDIT_OUT | Topic for sending audit logs | ai.flowx.dev.core.trigger.save.audit.v1 |
Environment variable | Description | Default value |
---|---|---|
KAFKA_TOPIC_APPLICATION_IN_RESUSAGEVALIDATION | Topic for resource usage validation | ai.flowx.dev.application-version.resources-usages.sub-res-validation.cms.v1 |
KAFKA_TOPIC_APPLICATION_RESOURCE_RESELEMUSAGEVALIDATION_OUT_CMS
on Application Manager must match KAFKA_TOPIC_APPLICATION_IN_RESUSAGEVALIDATION
on CMSai.flowx.dev.engine.receive.*
ai.flowx.dev.integration.receive.*
Environment variable | Description |
---|---|
LOGGING_LEVEL_ROOT | Log level for root service logs |
LOGGING_LEVEL_APP | Log level for application-specific logs |
Environment variable | Description |
---|---|
APPLICATION_FILESTORAGE_S3_SERVERURL | URL of S3 server for file storage |
APPLICATION_FILESTORAGE_S3_BUCKETNAME | S3 bucket name |
APPLICATION_FILESTORAGE_S3_ROOTDIRECTORY | Root directory in S3 bucket |
APPLICATION_FILESTORAGE_S3_CREATEBUCKET | Auto-create bucket if it doesnβt exist (true /false ) |
APPLICATION_FILESTORAGE_S3_PUBLICURL | Public URL for accessing files |
Environment variable | Description |
---|---|
APPLICATION_FILESTORAGE_S3_PRIVATESERVERURL | URL of S3 server for private storage |
APPLICATION_FILESTORAGE_S3_PRIVATEBUCKETNAME | S3 bucket name for private storage |
APPLICATION_FILESTORAGE_S3_PRIVATECREATEBUCKET | Auto-create private bucket (true /false ) |
APPLICATION_FILESTORAGE_S3_PRIVATEACCESSKEY | Access key for private S3 server |
APPLICATION_FILESTORAGE_S3_PRIVATESECRETKEY | Secret key for private S3 server |
Environment variable | Description | Default value |
---|---|---|
SPRING_SERVLET_MULTIPART_MAXFILESIZE | Maximum file size for uploads | 50MB |
SPRING_SERVLET_MULTIPART_MAXREQUESTSIZE | Maximum request size for uploads | 50MB |
MANAGEMENT_METRICS_EXPORT_PROMETHEUS_ENABLED
: Enables or disables Prometheus metrics export.Environment variable | Description | Default value |
---|---|---|
MANAGEMENT_PROMETHEUS_METRICS_EXPORT_ENABLED | Enables Prometheus metrics export | false |