— significa que el servicio no aplica ningún valor predeterminado. Una variable marcada Sensitive. lleva material de credenciales o de claves. Inyéctala desde tu gestor de secretos en tiempo de despliegue. Nunca hagas commit de un valor.
Cuando un valor del archivo de ejemplo publicado difiere del valor que aplica el código, esta página publica el valor del código.
Servicio y runtime
| Variable | Predeterminado / Obligatorio | Descripción |
|---|---|---|
APPLICATION_NAME | Nombre del servicio | Nombre de la aplicación del proceso que aparece en los logs y la telemetría. |
VERSION | 1.0.0 | Cadena de versión publicada del servicio. |
ENV_NAME | — | Etiqueta del entorno de despliegue, normalizada a minúsculas. El valor production activa todos los controles de producción de esta página. |
LOG_LEVEL | info | Nivel del logger estructurado: debug, info, warn o error. |
DEPLOYMENT_MODE | local | Postura operativa: local, byoc, saas u onprem. El valor saas exige TLS en cada dependencia. |
CCS_RUN_MODE | all | Selecciona los subsistemas que ejecuta este proceso: manager solo para la API HTTP, worker solo para los workers en segundo plano, o all para ambos. Un valor inválido detiene el arranque. |
SERVER_ADDRESS | — | Dirección de escucha HTTP principal. Un valor sin configurar hace que el servidor se enlace a un puerto que asigna el sistema operativo, por lo que los despliegues la configuran. |
SERVER_PORT | 4030 | Puerto que llama el binario de comprobación de salud dentro del contenedor. Mantenlo alineado con el puerto de SERVER_ADDRESS. |
GRPC_PORT | 7001 | Puerto de escucha gRPC. |
HTTP_BODY_LIMIT_BYTES | 104857600 | Tamaño máximo del cuerpo de una solicitud entrante, en bytes. |
SYSTEMPLANE_ENABLED | false | Monta la API de administración de configuración en tiempo de ejecución de Systemplane bajo /system. Desactivado de forma predeterminada, lo que mantiene al servicio en modo de solo variables de entorno. |
DEFAULT_TENANT_ID | — | Identificador de tenant de reserva para las rutas sin contexto de tenant por solicitud. |
MIGRATIONS_PATH | — | Ruta del sistema de archivos a los archivos de migración SQL. Los binarios de migración la leen directamente. El servicio nunca aplica las migraciones por sí mismo. |
INFRA_CONNECT_TIMEOUT_SEC | 30 | Presupuesto general de conexión a la infraestructura, en segundos. El servicio limita un valor de cero o menor a 30 segundos. |
Licencia
| Variable | Predeterminado / Obligatorio | Descripción |
|---|---|---|
LICENSE_KEY | Obligatorio en producción | Credencial de licencia emitida por Lerian. Sensitive. Déjala en blanco en desarrollo, lo que desactiva la aplicación. |
ORGANIZATION_IDS | Obligatorio en producción | Ámbito de organización que cubre la licencia. Lerian CCS ejecuta la librería de licencias en modo global, por lo que el valor es el literal global. |
LICENSE_SERVICE_ADDRESS | — | URL base opcional del gestor de licencias. En producción, el valor debe usar https y no debe apuntar a un host loopback, privado, link-local o de metadatos. |
CORS, TLS y proxies
| Variable | Predeterminado / Obligatorio | Descripción |
|---|---|---|
CORS_ALLOWED_ORIGINS | Obligatorio en producción | Lista separada por comas de los orígenes de navegador permitidos. Un arranque en producción rechaza una lista vacía y rechaza un comodín. |
CORS_ALLOWED_METHODS | — | Lista separada por comas de los métodos HTTP permitidos. |
CORS_ALLOWED_HEADERS | — | Lista separada por comas de los headers de solicitud permitidos. |
CORS_EXPOSE_HEADERS | — | Lista separada por comas de los headers de respuesta que el navegador puede leer. |
CORS_ALLOW_CREDENTIALS | false | Permite solicitudes cross-origin con credenciales. |
SERVER_TLS_CERT_FILE | — | Ruta al certificado TLS cuando el servicio termina el TLS por sí mismo. Configúrala junto con el archivo de la clave. |
SERVER_TLS_KEY_FILE | — | Ruta a la clave privada TLS. Configúrala junto con el archivo del certificado. |
TLS_TERMINATED_UPSTREAM | false | Marca la ruta de la solicitud como terminada en TLS por un proxy delante del servicio. |
TRUSTED_PROXIES | Obligatorio en producción | Rangos CIDR separados por comas de los proxies de capa 7 cuyo header X-Forwarded-For respeta el servicio. Un arranque en producción rechaza una lista vacía y rechaza un rango comodín. |
Multi-tenancy
| Variable | Predeterminado / Obligatorio | Descripción |
|---|---|---|
MULTI_TENANT_ENABLED | false | Activa el perfil multi-tenant y el cliente del gestor de tenants. |
MULTI_TENANT_URL | — | URL base HTTP del gestor de tenants. |
MULTI_TENANT_SERVICE_API_KEY | — | Clave de API estática para el cliente del gestor de tenants. Sensitive. |
MULTI_TENANT_REDIS_HOST | — | Host de la instancia de Redis que transporta el pub/sub de tenants. |
MULTI_TENANT_REDIS_PORT | 6379 | Puerto de la instancia de Redis del pub/sub de tenants. |
MULTI_TENANT_REDIS_PASSWORD | — | Contraseña de la instancia de Redis del pub/sub de tenants. Sensitive. |
MULTI_TENANT_REDIS_TLS | false — Obligatorio en producción cuando se configura un host de Redis de tenant | Activa TLS para el cliente Redis del pub/sub de tenants. |
MULTI_TENANT_REDIS_CA_CERT | — | Paquete de autoridad certificadora PEM codificado en base64 para el handshake de Redis de tenant. Configúralo solo cuando el clúster gestionado use una autoridad certificadora fuera del almacén de confianza del sistema. |
MULTI_TENANT_MAX_TENANT_POOLS | 0 | Limita el número de pools de conexión por tenant. Un valor de 0 significa ilimitado y desactiva el desalojo de pools. |
MULTI_TENANT_IDLE_TIMEOUT_SEC | 300 | Tiempo de espera de inactividad de la conexión por tenant, en segundos. |
MULTI_TENANT_TIMEOUT | 30 | Tiempo de espera del cliente del gestor de tenants, en segundos. |
MULTI_TENANT_CIRCUIT_BREAKER_THRESHOLD | 0 | Umbral de fallos consecutivos que activa el circuit breaker del gestor de tenants. Un valor de 0 desactiva el breaker. |
MULTI_TENANT_CIRCUIT_BREAKER_TIMEOUT_SEC | 30 | Tiempo de enfriamiento en estado abierto, en segundos, para el circuit breaker del gestor de tenants. |
MULTI_TENANT_CACHE_TTL_SEC | 120 | Vida útil de la caché por tenant, en segundos. |
MULTI_TENANT_CONNECTIONS_CHECK_INTERVAL_SEC | 30 | Intervalo en segundos entre barridos de conexiones inactivas de tenants. |
MULTI_TENANT_CONSUMER_PREFETCH_COUNT | 10 | Cantidad de mensajes de prefetch por canal de broker de cada tenant. |
PostgreSQL
| Variable | Predeterminado / Obligatorio | Descripción |
|---|---|---|
POSTGRES_HOST | — | Host de la base de datos primaria. La identidad de la conexión no lleva valores predeterminados, por lo que un bloque incompleto hace fallar la conexión en el arranque. |
POSTGRES_PORT | — | Puerto de la base de datos primaria. |
POSTGRES_USER | — | Usuario de la base de datos primaria. Un valor vacío hace que el driver recurra al usuario del sistema operativo del proceso. |
POSTGRES_PASSWORD | — | Contraseña de la base de datos primaria. Sensitive. |
POSTGRES_NAME | — | Nombre de la base de datos primaria. |
POSTGRES_SSLMODE | Obligatorio en producción | Modo TLS de la base de datos primaria. Un arranque en producción rechaza el valor disable. |
POSTGRES_REPLICA_HOST | — | Host de la réplica de lectura para escalar las consultas. |
POSTGRES_REPLICA_PORT | — | Puerto de la réplica de lectura. |
POSTGRES_REPLICA_USER | — | Usuario de la réplica de lectura. |
POSTGRES_REPLICA_PASSWORD | — | Contraseña de la réplica de lectura. Sensitive. |
POSTGRES_REPLICA_NAME | — | Nombre de la base de datos de la réplica de lectura. |
POSTGRES_REPLICA_SSLMODE | — | Modo TLS de la réplica de lectura. Un arranque en producción rechaza el valor disable. |
POSTGRES_MAX_OPEN_CONNS | 25 | Máximo de conexiones abiertas por pool. |
POSTGRES_MAX_IDLE_CONNS | — | Máximo de conexiones inactivas por pool. El valor efectivo difiere entre las rutas single-tenant y multi-tenant, por lo que el servicio no aplica ningún valor predeterminado aquí. |
POSTGRES_CONN_MAX_LIFETIME_MINS | 30 | Vida máxima de la conexión, en minutos. |
POSTGRES_CONN_MAX_IDLE_TIME_MINS | 5 | Tiempo máximo de inactividad de la conexión, en minutos. |
POSTGRES_CONNECT_TIMEOUT_SEC | — | Tiempo de espera de conexión, en segundos. Un valor sin configurar deja la conexión limitada solo por el tiempo de espera del sistema operativo. |
POSTGRES_POOL_FANOUT_ACK | — | Consentimiento del operador para superar el fan-out seguro de conexiones entre el pool del plano de control y los pools por tenant. Acepta true, 1, yes u on. Sin él, el arranque rechaza un fan-out excesivo. |
Redis
| Variable | Predeterminado / Obligatorio | Descripción |
|---|---|---|
REDIS_HOST | — | Dirección de Redis como host:port. Un valor no vacío también activa el control de la postura TLS en modo saas. |
REDIS_MASTER_NAME | — | Nombre del master de Sentinel cuando el despliegue usa Redis Sentinel. |
REDIS_PASSWORD | — | Contraseña de Redis. Sensitive. |
REDIS_DB | 0 | Número de base de datos lógica de Redis. |
REDIS_PROTOCOL | 3 | Versión del protocolo de red de Redis. |
REDIS_TLS | false — Obligatorio en producción cuando multi-tenancy está habilitado | Activa TLS para el cliente de Redis. |
REDIS_CA_CERT | — | Ruta a una autoridad certificadora adicional para el handshake de Redis. |
REDIS_POOL_SIZE | 10 | Tamaño máximo del pool de Redis. El cliente limita un valor superior a 1000. |
REDIS_MIN_IDLE_CONNS | — | Mínimo de conexiones inactivas de Redis mantenidas activas. El cliente no precalienta ninguna de forma predeterminada. |
REDIS_READ_TIMEOUT | 3 | Tiempo de espera de lectura de Redis, en segundos. |
REDIS_WRITE_TIMEOUT | 3 | Tiempo de espera de escritura de Redis, en segundos. |
REDIS_DIAL_TIMEOUT | 5 | Tiempo de espera de conexión de Redis, en segundos. |
REDIS_POOL_TIMEOUT | 2 | Tiempo de espera para obtener una conexión del pool de Redis, en segundos. |
REDIS_MAX_RETRIES | 3 | Presupuesto de reintentos de comandos de Redis. |
REDIS_MIN_RETRY_BACKOFF | 8 | Backoff mínimo de reintento de Redis, en milisegundos. |
REDIS_MAX_RETRY_BACKOFF | 1 | Backoff máximo de reintento de Redis, en segundos. |
Mensajería y circuit breaker
| Variable | Predeterminado / Obligatorio | Descripción |
|---|---|---|
CIRCUIT_BREAKER_ENABLED | false — Obligatorio como true | Conecta el gestor de circuit breaker. Tanto la integración con Reporter como los adaptadores de almacenamiento de objetos lo necesitan, por lo que el arranque rechaza un valor de false. |
RABBITMQ_ENABLED | false | Activa el cableado del message broker. |
RABBITMQ_URL | — | URL completa de conexión al broker. Sensitive. Configura esta variable o el host, porque el arranque rechaza que ambas estén vacías cuando el broker está activado. |
RABBITMQ_HOST | — | Host del broker. |
RABBITMQ_PORT_AMQP | — | Puerto de mensajes del broker. |
RABBITMQ_PORT_HOST | — | Puerto de administración del broker. |
RABBITMQ_DEFAULT_USER | — | Usuario del broker. |
RABBITMQ_DEFAULT_PASS | — | Contraseña del broker. Sensitive. |
RABBITMQ_VHOST | — | Host virtual del broker. |
RABBITMQ_QUEUE | — | Nombre de la cola predeterminada. |
RABBITMQ_EXCHANGE | — | Nombre del exchange predeterminado. Un valor vacío publica a través del exchange predeterminado del broker, que interpreta la routing key como un nombre de cola. |
RABBITMQ_HEALTH_CHECK_URL | — | Endpoint HTTP que llama el probe de readiness para comprobar el broker. |
RABBITMQ_HEALTH_CHECK_ALLOWED_HOSTS | — | Lista de permitidos, separada por comas, de los hosts que puede apuntar el probe de salud. |
RABBITMQ_REQUIRE_HEALTH_ALLOWED_HOSTS | false | Obliga a que la lista de permitidos del probe de salud no esté vacía. |
RABBITMQ_PUBLISHER_CONFIRM_TIMEOUT_MS | 5000 | Tiempo de espera de confirmación del publisher, en milisegundos. |
RABBITMQ_PUBLISHER_RECOVERY_INITIAL_MS | 1000 | Primer backoff de recuperación del publisher, en milisegundos. |
RABBITMQ_PUBLISHER_RECOVERY_MAX_MS | 30000 | Backoff máximo de recuperación del publisher, en milisegundos. |
RABBITMQ_PUBLISHER_MAX_RECOVERIES | 10 | Máximo de intentos de recuperación del publisher antes de que se rinda. |
CCS_CONSUMER_MAX_REDELIVERIES | 5 | Máximo de ciclos de reintento que puede tomar un mensaje con fallo transitorio antes de que el consumidor lo mueva a la dead-letter queue terminal. |
Outbox
Lerian CCS escribe cada mensaje saliente en un outbox transaccional, dentro de la misma transacción de base de datos que el cambio de estado. La familiaOUTBOX_ de abajo configura el dispatcher que ejecuta la librería de plataforma compartida.
| Variable | Predeterminado / Obligatorio | Descripción |
|---|---|---|
OUTBOX_ENABLED | false | Activa el worker del outbox. |
OUTBOX_TABLE_NAME | — | Nombre de la tabla del outbox. El arranque rechaza un valor vacío cuando el outbox está activado. |
OUTBOX_DISPATCH_INTERVAL_SEC | 2 | Intervalo en segundos entre ciclos de despacho. |
OUTBOX_BATCH_SIZE | 50 | Máximo de eventos drenados por ciclo de despacho. |
OUTBOX_PUBLISH_MAX_ATTEMPTS | 3 | Máximo de intentos de publicación por evento dentro de un ciclo. |
OUTBOX_PUBLISH_BACKOFF_MS | 200 | Backoff de reintento de publicación, en milisegundos. |
OUTBOX_RETRY_WINDOW_SEC | 300 | Ventana de reintento en segundos para un evento fallido. |
OUTBOX_MAX_DISPATCH_ATTEMPTS | 10 | Máximo de intentos de despacho por evento antes de que el dispatcher deje de reintentarlo. |
OUTBOX_PROCESSING_TIMEOUT_SEC | 600 | Tiempo de espera en segundos tras el cual el dispatcher recupera un evento atascado. |
OUTBOX_MAX_FAILED_PER_BATCH | 25 | Máximo de eventos fallidos en un lote antes de que el dispatcher detenga ese lote. |
OUTBOX_INCLUDE_TENANT_METRICS | false | Agrega etiquetas por tenant a las métricas del outbox. |
OUTBOX_PRIORITY_EVENT_TYPES | — | Tipos de evento separados por comas que el dispatcher envía primero. |
OUTBOX_ALLOW_EMPTY_TENANT | false | Acepta un evento que no lleva contexto de tenant. |
Anulaciones del outbox de CCS
| Variable | Predeterminado / Obligatorio | Descripción |
|---|---|---|
CCS_OUTBOX_OVERRIDES_ENABLED | false | Activa las cuatro anulaciones de abajo. Mientras es false, el servicio las carga y nunca las aplica. |
CCS_OUTBOX_DISPATCH_INTERVAL_MS | 1000 | Intervalo de despacho en milisegundos. Tiene precedencia sobre el intervalo basado en segundos, lo que preserva la precisión de menos de un segundo. |
CCS_OUTBOX_BATCH_SIZE | 50 | Máximo de eventos que procesan los handlers registrados por ciclo. |
CCS_OUTBOX_MAX_ATTEMPTS | 10 | Máximo de intentos de despacho antes de que el dispatcher marque un evento como no entregable de forma permanente. |
CCS_OUTBOX_DLQ_ROUTING_KEY | ccs.outbox.dlq | Routing key que el publisher de dead-letter estampa en un evento no entregable de forma permanente. |
Streaming
La librería de streaming de Lerian lee la familiaSTREAMING_, no la configuración del servicio. Lerian Streaming Hub entrega los eventos publicados.
| Variable | Predeterminado / Obligatorio | Descripción |
|---|---|---|
STREAMING_ENABLED | false | Interruptor maestro para la emisión de eventos de negocio. Mientras está desactivado, el servicio conecta un emisor sin operación y no publica nada. |
STREAMING_BROKERS | Obligatorio cuando el streaming está habilitado | Lista de arranque de brokers separada por comas. Una configuración habilitada con una lista vacía rechaza el arranque. |
STREAMING_CLOUDEVENTS_SOURCE | Fijo | Fuente de CloudEvents de este servicio. Define el espacio de nombres del topic y el prefijo del tipo de evento. Déjala sin configurar. Cualquier valor distinto de la fuente integrada rechaza el arranque, incluso cuando el streaming está desactivado. |
STREAMING_CLIENT_ID | Nombre de host | Identificador de cliente del broker usado para diagnósticos del lado del broker. |
STREAMING_CB_FAILURE_RATIO | 0.5 | Relación de fallos que abre el circuit breaker del productor. |
STREAMING_CB_MIN_REQUESTS | 10 | Mínimo de solicitudes antes de que el circuit breaker del productor evalúe la relación de fallos. |
STREAMING_CB_TIMEOUT_S | 30 | Tiempo de enfriamiento en estado abierto, en segundos, para el circuit breaker del productor. |
STREAMING_CLOSE_TIMEOUT_S | 30 | Ventana máxima de drenaje y vaciado, en segundos, cuando el productor se cierra. |
STREAMING_TLS_ENABLED | false — Obligatorio como true en saas | Activa TLS para la conexión al broker. La versión mínima es TLS 1.2. En modo saas, una conexión al broker en texto claro rechaza el arranque. |
STREAMING_TLS_CA_CERT | — | Autoridad certificadora PEM codificada en base64 para un broker privado o on-premises. Un valor vacío usa el almacén de confianza del host. Un valor malformado rechaza el arranque. |
STREAMING_SASL_MECHANISM | — | Mecanismo de autenticación del broker: PLAIN, SCRAM-SHA-256 o SCRAM-SHA-512. Un valor vacío desactiva la autenticación del broker. Un mecanismo sin sus credenciales rechaza el arranque. |
STREAMING_SASL_USERNAME | — | Usuario de autenticación del broker. |
STREAMING_SASL_PASSWORD | — | Contraseña de autenticación del broker. Sensitive. |
STREAMING_SASL_ALLOW_PLAINTEXT | false | Permite la autenticación del broker sobre una conexión en texto claro, lo que envía las credenciales sin cifrar. El servicio rechaza esa combinación a menos que configures este flag. |
Integración con STA
Lerian CCS envía cada archivo saliente a BACEN a través de Lerian STA y recibe de vuelta las respuestas.| Variable | Predeterminado / Obligatorio | Descripción |
|---|---|---|
STA_ENABLED | false | Conecta el cliente de STA, el handler de envío y el probe de readiness de STA. |
STA_BASE_URL | Obligatorio cuando STA está habilitado | URL base del servicio STA. Un valor vacío rechaza el arranque. |
STA_HTTP_TIMEOUT_SEC | 30 | Tiempo de espera por solicitud, en segundos, en el cliente de STA. El servicio recurre a 30 segundos para un valor de cero o menor. |
STA_SD_SERVICE_NAME | sta | Nombre en el catálogo de servicios que resuelve el cliente de descubrimiento para el upstream de STA. |
STA_FILE_HASH_VERIFY_ENABLED | false | Verifica el digest SHA-256 de un archivo entrante descargado contra el digest del evento del archivo. |
STA_EVENT_HMAC_VERIFY_ENABLED | false | Autentica los eventos de negocio entrantes de STA contra el esquema de firma compartido. Un arranque con la verificación activada y un catálogo de claves incompleto falla de forma explícita. |
STA_EVENT_HMAC_MASTER_KEYS | — | Catálogo de claves maestras version:hex compartidas con el servicio STA. Sensitive. |
STA_EVENT_HMAC_MASTER_KEY_VERSION | — | Versión del catálogo que el verificador trata como activa. |
STA_EVENT_HMAC_TOLERANCE_SECONDS | 300 | Ventana de vigencia en segundos para la marca de tiempo firmada. El servicio limita un valor de cero o menor a 300. |
Integración con Reporter
Lerian Reporter renderiza el archivo diario ACCS001, por lo que es un upstream obligatorio. El probe de readiness lo trata como una dependencia obligatoria. Inicia Lerian Reporter antes de esperar que Lerian CCS quede listo.| Variable | Predeterminado / Obligatorio | Descripción |
|---|---|---|
REPORTER_URL | Obligatorio | URL base del servicio Reporter. Un valor vacío rechaza el arranque. |
REPORTER_HTTP_TIMEOUT_SEC | 30 | Tiempo de espera por solicitud, en segundos, en el cliente de Reporter. El servicio recurre a 30 segundos para un valor de cero o menor. |
REPORTER_TEMPLATE_ID_ACCS001 | — | Identificador de la plantilla de Reporter a la que apunta el render de ACCS001. Reporter acuña este identificador por entorno cuando registras la plantilla. Un valor vacío rechaza la aprobación del lote con el error MYS-0008 y HTTP 503. |
REPORTER_TEMPLATE_NAME_ACCS001 | — | Descripción de la plantilla ACCS001 en Reporter. El servicio resuelve la plantilla por esta descripción cuando dejas el identificador sin configurar. |
REPORTER_SD_SERVICE_NAME | reporter | Nombre en el catálogo de servicios que resuelve el cliente de descubrimiento para el upstream de Reporter. |
DETAIL_RENDER_MODE | inline | Ruta de render para una respuesta de detalle. Solo inline inicia el servicio. Cualquier otro valor rechaza el arranque. |
CCS_REPORTER_POLL_INITIAL_DELAY_MS | 2000 | Primer retraso de backoff, en milisegundos, en el ciclo de sondeo del render. |
CCS_REPORTER_POLL_MAX_DELAY_MS | 30000 | Retraso máximo de backoff, en milisegundos, en el ciclo de sondeo del render. |
CCS_REPORTER_POLL_TOTAL_TIMEOUT_SEC | 1800 | Presupuesto total de sondeo, en segundos. Un render más antiguo que este presupuesto termina en tiempo de espera agotado. |
CCS_REPORTER_POLL_BACKOFF_MULTIPLIER | 2.0 | Multiplicador aplicado al retraso después de cada sondeo. El arranque rechaza un valor menor que 1.0. |
Descubrimiento de servicios
La librería de descubrimiento de servicios de Lerian lee la familiaSD_, no la configuración del servicio. Lerian CCS resuelve otros servicios y no se registra a sí mismo, por lo que no necesita una dirección anunciada.
| Variable | Predeterminado / Obligatorio | Descripción |
|---|---|---|
SD_ENABLED | false | Activa la resolución de upstreams a través del servidor de descubrimiento. Mientras está desactivado, el servicio usa las URLs de upstream estáticas. |
SD_ADDRESS | — | Dirección del servidor de descubrimiento como host:port. |
SD_TLS | false | Usa HTTPS para alcanzar el servidor de descubrimiento. |
SD_TLS_SKIP_VERIFY | false | Omite la verificación de certificado en la conexión al servidor de descubrimiento. |
SD_TOKEN | — | Token de control de acceso para el servidor de descubrimiento. Sensitive. |
SD_DIAL_TIMEOUT | 5s | Tiempo de espera de conexión del cliente de descubrimiento. |
SD_TLS_HANDSHAKE_TIMEOUT | 5s | Tiempo de espera del handshake TLS del cliente de descubrimiento. |
SD_RESPONSE_HEADER_TIMEOUT | 10s | Tiempo de espera del header de respuesta del cliente de descubrimiento. |
SD_SEED_TIMEOUT | 3s | Tiempo de espera para la primera lectura del catálogo al arrancar. |
SD_ALLOW_STALE | true | Permite lecturas obsoletas del catálogo, lo que mantiene la resolución disponible durante un cambio de líder. |
SD_EXTERNAL_ADDRESS | — | Dirección externa anunciada para el autorregistro. |
SD_EXTERNAL_PORT | 0 | Puerto externo anunciado para el autorregistro. |
SD_INTERNAL_ADDRESS | — | Dirección interna anunciada para el autorregistro. |
SD_INTERNAL_PORT | 0 | Puerto interno anunciado para el autorregistro. |
SD_INTERNAL_SCHEME | — | Esquema, http o https, para la vista interna de un registro. |
SD_PREFER_VIEW | external | Vista que prefiere el cliente cuando un servicio registra tanto una dirección externa como una interna. |
Autenticación
| Variable | Predeterminado / Obligatorio | Descripción |
|---|---|---|
PLUGIN_AUTH_ENABLED | false — Obligatorio como true en saas multi-tenant | Activa la autenticación por Bearer token en cada ruta /v1. También impulsa la acuñación de tokens salientes. |
PLUGIN_AUTH_HOST | Obligatorio cuando la autenticación está habilitada | URL base de Lerian Access Manager. |
Credenciales máquina a máquina
Lerian CCS acuña un token saliente por upstream a través de Lerian Access Manager. Cada upstream lleva su propio par de credenciales. Ningún upstream comparte una credencial, y el servicio no tiene reserva.| Variable | Predeterminado / Obligatorio | Descripción |
|---|---|---|
REPORTER_CLIENT_ID | Obligatorio cuando la autenticación está habilitada | Identificador de cliente para el upstream de Reporter. |
REPORTER_CLIENT_SECRET | Obligatorio cuando la autenticación está habilitada | Secreto de cliente para el upstream de Reporter. Sensitive. |
STA_CLIENT_ID | Obligatorio cuando la autenticación está habilitada | Identificador de cliente para el upstream de STA. |
STA_CLIENT_SECRET | Obligatorio cuando la autenticación está habilitada | Secreto de cliente para el upstream de STA. Sensitive. |
REPORTER_M2M_TARGET_SERVICE | — | Etiqueta de métricas para el upstream de Reporter. Un valor vacío recurre al nombre canónico del upstream. |
STA_M2M_TARGET_SERVICE | — | Etiqueta de métricas para el upstream de STA. Un valor vacío recurre al nombre canónico del upstream. |
M2M_CREDENTIAL_CACHE_TTL_SEC | 300 | Vida útil en segundos de una credencial saliente en caché. |
AWS_REGION | — | Región para el cliente de AWS Secrets Manager que resuelve las credenciales por tenant en modo saas. Un valor vacío deja la resolución de la región al SDK de la nube. |
Cifrado e idempotencia
| Variable | Predeterminado / Obligatorio | Descripción |
|---|---|---|
CCS_CRYPTO_MASTER_KEY | Obligatorio | Clave maestra AES-256 de 32 bytes codificada en hexadecimal que protege los datos personales en reposo. Sensitive. El arranque falla cuando el valor está ausente, es más corto o más largo que 64 caracteres hexadecimales, o no es hexadecimal. |
IDEMPOTENCY_KEY_PREFIX | idempotency: | Prefijo base de cada clave de caché de idempotencia. |
IDEMPOTENCY_KEY_TTL_HRS | 168 | Ventana de retención en horas para una respuesta en caché. |
IDEMPOTENCY_RETRY_WINDOW_SEC | — | Presupuesto de reintento heredado, en segundos, mantenido por compatibilidad. |
Documentación de la API
| Variable | Predeterminado / Obligatorio | Descripción |
|---|---|---|
SWAGGER_ENABLED | false | Monta la ruta interactiva de documentación de la API. |
SWAGGER_TITLE | Nombre del servicio | Título mostrado en la especificación de la API. |
SWAGGER_DESCRIPTION | — | Descripción mostrada en la especificación de la API. |
SWAGGER_VERSION | 1.0.0 | Etiqueta de versión de la API mostrada en la especificación. |
SWAGGER_HOST | — | Anulación de host para la especificación de la API. |
SWAGGER_SCHEMES | https | Esquemas de URL separados por comas que acepta la especificación. |
Telemetría y métricas
| Variable | Predeterminado / Obligatorio | Descripción |
|---|---|---|
ENABLE_TELEMETRY | false | Conecta el exportador de OpenTelemetry. Consulta Observabilidad para la vista de plataforma. |
OTEL_LIBRARY_NAME | — | Nombre de la librería de instrumentación. |
OTEL_RESOURCE_SERVICE_NAME | — | Atributo de recurso del nombre del servicio. |
OTEL_RESOURCE_SERVICE_VERSION | — | Atributo de recurso de la versión del servicio. También alimenta la cadena de versión de readiness. |
OTEL_RESOURCE_DEPLOYMENT_ENVIRONMENT | — | Atributo de recurso del entorno de despliegue. |
OTEL_EXPORTER_OTLP_ENDPOINT | — | Dirección del collector para el exportador de OpenTelemetry. |
Rate limits
Lerian CCS aplica cinco niveles de rate limit a las rutas/v1. El nivel export cubre lecturas pesadas como las consultas de auditoría y conciliación. El nivel dispatch cubre escrituras pesadas que llaman a un upstream.
| Variable | Predeterminado / Obligatorio | Descripción |
|---|---|---|
RATE_LIMIT_ENABLED | false — Obligatorio en producción como true | Activa el subsistema de rate limit. Un arranque en producción rechaza el valor false. |
RATE_LIMIT_MAX | 500 | Techo de solicitudes por ventana del nivel predeterminado. |
RATE_LIMIT_WINDOW_SEC | 60 | Ventana en segundos del nivel predeterminado. |
AGGRESSIVE_RATE_LIMIT_MAX | 100 | Techo de solicitudes por ventana del nivel aggressive. |
AGGRESSIVE_RATE_LIMIT_WINDOW_SEC | 60 | Ventana en segundos del nivel aggressive. |
RELAXED_RATE_LIMIT_MAX | 1000 | Techo de solicitudes por ventana del nivel relaxed. |
RELAXED_RATE_LIMIT_WINDOW_SEC | 60 | Ventana en segundos del nivel relaxed. |
EXPORT_RATE_LIMIT_MAX | 60 | Techo de solicitudes por ventana del nivel export. |
EXPORT_RATE_LIMIT_WINDOW_SEC | 60 | Ventana en segundos del nivel export. |
DISPATCH_RATE_LIMIT_MAX | 30 | Techo de solicitudes por ventana del nivel dispatch. |
DISPATCH_RATE_LIMIT_WINDOW_SEC | 60 | Ventana en segundos del nivel dispatch. |
Readiness y apagado
| Variable | Predeterminado / Obligatorio | Descripción |
|---|---|---|
READYZ_PROBE_TIMEOUT_SEC | 5 | Tiempo de espera en segundos para cada probe de dependencia. |
READYZ_DEP_SLOW_THRESHOLD_MS | 500 | Umbral en milisegundos por encima del cual un probe reporta una dependencia como lenta sin hacer fallar el readiness. |
STARTUP_SELF_PROBE_MAX_DURATION_SEC | 120 | Ventana máxima en segundos para el self-probe de arranque. |
STARTUP_SELF_PROBE_INITIAL_DELAY_MS | 1000 | Primer backoff del self-probe, en milisegundos. |
STARTUP_SELF_PROBE_MAX_DELAY_MS | 30000 | Backoff máximo del self-probe, en milisegundos. |
SHUTDOWN_DRAIN_GRACE_PERIOD_SEC | 15 | Ventana en segundos después de una señal de terminación durante la cual el servicio responde 503 antes de cerrar el listener. |
SHUTDOWN_TOTAL_TIMEOUT_SEC | 30 | Plazo total de apagado, en segundos. |
Lerian CCS expone
GET /health para liveness y GET /readyz para readiness en el puerto principal, además de GET /version y GET /metrics. Con multi-tenancy activado, también expone GET /readyz/tenant/{id}. Consulta Salud y readiness para el contrato del probe y Operar Lerian CCS para la lista de probes.Almacenamiento de objetos
Lerian CCS lee los archivos entrantes de un bucket y escribe los archivos salientes en otro. Ambos aceptan cualquier almacén compatible con S3. Un nombre de bucket vacío marca la comprobación de readiness correspondiente como omitida.| Variable | Predeterminado / Obligatorio | Descripción |
|---|---|---|
OBJECT_STORAGE_STA_ENDPOINT | — | Endpoint del bucket entrante. Un valor vacío selecciona el endpoint predeterminado de la nube. |
OBJECT_STORAGE_STA_REGION | us-east-1 | Región del bucket entrante. |
OBJECT_STORAGE_STA_BUCKET | — | Nombre del bucket entrante de solo lectura. |
OBJECT_STORAGE_STA_ACCESS_KEY | — | Clave de acceso para el bucket entrante. Sensitive. Déjala sin configurar cuando un rol de nube adjunto proporcione las credenciales. |
OBJECT_STORAGE_STA_SECRET_KEY | — | Clave secreta para el bucket entrante. Sensitive. |
OBJECT_STORAGE_STA_USE_PATH_STYLE | false | Usa direccionamiento de estilo de ruta en el bucket entrante. |
OBJECT_STORAGE_STA_DISABLE_SSL | false | Desactiva TLS en la conexión del bucket entrante. |
OBJECT_STORAGE_STA_MAX_OBJECT_BYTES | 536870912 | Tamaño máximo de un objeto entrante, en bytes. |
OBJECT_STORAGE_CCS_ENDPOINT | — | Endpoint del bucket saliente. Un valor vacío selecciona el endpoint predeterminado de la nube. |
OBJECT_STORAGE_CCS_REGION | us-east-1 | Región del bucket saliente. |
OBJECT_STORAGE_CCS_BUCKET | — | Nombre del bucket saliente que contiene los archivos regulatorios renderizados. |
OBJECT_STORAGE_CCS_ACCESS_KEY | — | Clave de acceso para el bucket saliente. Sensitive. Déjala sin configurar cuando un rol de nube adjunto proporcione las credenciales. |
OBJECT_STORAGE_CCS_SECRET_KEY | — | Clave secreta para el bucket saliente. Sensitive. |
OBJECT_STORAGE_CCS_USE_PATH_STYLE | false | Usa direccionamiento de estilo de ruta en el bucket saliente. |
OBJECT_STORAGE_CCS_DISABLE_SSL | false | Desactiva TLS en la conexión del bucket saliente. |
OBJECT_STORAGE_CCS_MAX_OBJECT_BYTES | 536870912 | Tamaño máximo de un objeto saliente, en bytes. |
Retención y ajustes regulatorios
| Variable | Predeterminado / Obligatorio | Descripción |
|---|---|---|
CCS_OUTBOUND_RETENTION_DAYS | 30 | Vida útil en días de un archivo saliente subido al bucket. El servicio aplica 30 días para un valor de cero o menor. |
CCS_ACCS009_RETENTION_DAYS | 30 | Vida útil en días de un informe de penalidad ACCS009 almacenado. |
CCS_NON_SUBMISSION_SCAN_INTERVAL_SEC | 3600 | Intervalo en segundos entre los escaneos de no envío. El arranque rechaza un valor de cero o menor y un valor superior a 86400. |
CCS_BACEN_DESTINATARIO_CNPJ_BASE | 00000000 | Destinatario BACEN de ocho dígitos estampado en el envelope del archivo. Configura el valor real antes de salir a producción. |
CCS_ACCS010_DTFIM_MODE | transfer_date | Regla que resuelve la fecha de fin obligatoria en una transferencia de relación. |

