Skip to content

Latest commit

 

History

History

caf-audit-service-container

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 

Audit Web Service Container

This is a docker container for the CAF Audit Web Service. It consists of a web server that connects to Elasticsearch. It uses the Oracle Linux JRE21 base image. Audit Service Deploy can be used to deploy this container on Docker.

Configuration

Environment Variables

CAF_ELASTIC_PROTOCOL

The protocol used to connect to the Elasticsearch server. e.g. http or https. Default value is http.

CAF_ELASTIC_HOST_AND_PORT_VALUES

Comma separated list of Elasticsearch HOST:PORT value pairs. e.g. 192.168.56.10:9200,192.168.56.20:9200. Default value is elastic search host value constructed from alternate configurations CAF_ELASTIC_HOST_VALUES and CAF_ELASTIC_PORT_VALUE.

CAF_ELASTIC_HOST_VALUES

This is the alternative configuration with comma separated list of Elasticsearch host names. eg. localhost

CAF_ELASTIC_PORT_VALUE

This is the alternative configuration for REST port of the Elasticsearch server listens on. e.g 9200.

Note: CAF_ELASTIC_HOST_AND_PORT_VALUES will take precedence over CAF_ELASTIC_HOST_VALUES and CAF_ELASTIC_PORT_VALUE if all three environment variables have values.

CAF_ELASTIC_USERNAME

Elasticsearch username. Defaults to null (anonymous access).

CAF_ELASTIC_PASSWORD

Elasticsearch password. Defaults to null (anonymous access).

CAF_ELASTIC_NUMBER_OF_SHARDS

The number of primary shards that an Elasticsearch index should have. e.g. 5. Default value: 5.

CAF_ELASTIC_NUMBER_OF_REPLICAS

The number of replica shards (copies) that each primary shard should have. e.g. 1. Default value: 1.

CAF_AUDIT_FORCE_INDEX_TEMPLATE_UPDATE

Should the index template be updated by force even if it already exists. eg. true. Default value: false.

CAF_AUDIT_SERVICE_API_CONFIG_PATH

The path to the directory containing the config.properties which can be used as an alternative means of specifying the environment variables. e.g. .\config-props

CAF_LOG_LEVEL

The logging level for the CAF Audit Web Service. e.g. DEBUG

The Logging levels supported are:

  • WARN
  • ERROR
  • INFO
  • TRACE
  • DEBUG
  • ALL

A default logging level of INFO is applied if this environment variable is not configured.

CAF_AUDIT_SERVICE_LIVENESS_INITIAL_DELAY_DURATION

The initial delay to use when first scheduling the liveness check. Default value: 15s

CAF_AUDIT_SERVICE_LIVENESS_CHECK_INTERVAL_DURATION

The interval on which to perform a liveness check for while in a healthy state. Default value: 60s

CAF_AUDIT_SERVICE_LIVENESS_DOWNTIME_INTERVAL_DURATION

The interval on which to perform a liveness check for while in an unhealthy state. Default value: 60s

CAF_AUDIT_SERVICE_LIVENESS_FAILURE_ATTEMPTS

The threshold of consecutive failed attempts needed to mark the liveness check as unhealthy (from a healthy state). Default value: 3

CAF_AUDIT_SERVICE_LIVENESS_SUCCESS_ATTEMPTS

The threshold of consecutive successful attempts needed to mark the liveness check as healthy (from an unhealthy state). Default value: 1

CAF_AUDIT_SERVICE_READINESS_INITIAL_DELAY_DURATION

The initial delay to use when first scheduling the readiness check. Default value: 15s

CAF_AUDIT_SERVICE_READINESS_CHECK_INTERVAL_DURATION

The interval on which to perform a readiness check for while in a healthy state. Default value: 60s

CAF_AUDIT_SERVICE_READINESS_DOWNTIME_INTERVAL_DURATION

The interval on which to perform a readiness check for while in an unhealthy state. Default value: 60s

CAF_AUDIT_SERVICE_READINESS_FAILURE_ATTEMPTS

The threshold of consecutive failed attempts needed to mark the readiness check as unhealthy (from a healthy state). Default value: 3

CAF_AUDIT_SERVICE_READINESS_SUCCESS_ATTEMPTS

The threshold of consecutive successful attempts needed to mark the readiness check as healthy (from an unhealthy state). Default value: 1



Audit Service Links

Overview

Features

Getting Started

Web Service

Architecture

API