Skip to main content
Version: 47.0.0

a9s CF Service Guard Properties

This section describes the supported properties of the a9s CF Service Guard component.

Cloud Foundry Configuration

PropertyDefault ValueDescription
cloud_foundry.api_endpointThe Cloud Foundry API endpoint in which the a9s CF Service Guard should manage the ASGs.
cloud_foundry.authentication.usernameThe Cloud Foundry username that should be used by the a9s CF Service Guard.
cloud_foundry.authentication.passwordThe Cloud Foundry password that should be used by the a9s CF Service Guard.
cloud_foundry.skip_ssl_validationfalseIndicates if the SSL validation for the Cloud Foundry connection can be skipped, e.g. when self-signed certificates are used.
cloud_foundry.asg_prefix"a9s-asg"The prefix for the Cloud Foundry ASGs created by the a9s CF Service Guard.
[cloud_foundry.asg_prefix]

When the property cloud_foundry.asg_prefix is set to another value in the a9s CF Service Guard, the change must also be reflected in the configuration of the smoke-test errand.

When the property cloud_foundry.asg_prefix is changed after the a9s CF Service Guard has already been deployed, only ASGs for newly created Service Instances will use this new prefix. The names of existing ASGs are not changed!

Service Brokers Configuration

PropertyDescription
service_brokersA list of a9s Service Brokers that should be asked for known service instances.

The a9s CF Service Guard can only create ASGs in Cloud Foundry for service instances that are known by one of the configured a9s Service Brokers.

To enable the support for the corresponding a9s Data Services the following Ops files MUST be applied to the a9s CF Service Guard deployment manifest:

  • a9s Elasticsearch: cf-service-guard/ops/add-elasticsearch.yml
  • a9s MariaDB: cf-service-guard/ops/add-mariadb.yml
  • a9s Messaging: cf-service-guard/ops/add-messaging.yml
  • a9s MongoDB: cf-service-guard/ops/add-mongodb.yml
  • a9s MySQL: cf-service-guard/ops/add-mysql.yml
  • a9s PostgreSQL: cf-service-guard/ops/add-postgresql.yml
  • a9s Redis: cf-service-guard/ops/add-redis.yml
  • a9s Search: cf-service-guard/ops/add-search.yml

Allowed Consul Nodes Configuration

PropertyDescription
allowed_consul_nodesAn array of Consul node names or regular expressions, for matching Consul node names, to be processed by the a9s CF Service Guard.

When using the a9s Data Service specific Ops files mentioned under Service Brokers Configuration, the corresponding regular expressions are also added to process the corresponding Consul nodes of the respective a9s Data Service.

Workers Configuration

PropertyDefault ValueDescription
workers.consul_nodes_processor.execute_interval15Number of seconds between each execution of the job.
workers.security_groups_synchronizer.execute_interval15Number of seconds between each execution of the job.
workers.security_groups_synchronizer.count3Number of security_groups_synchronizer worker processes.
workers.shared_spaces_updater.enabledfalsetrue to enable the shared_spaces_updater worker, false otherwise.
workers.shared_spaces_updater.execute_interval300Number of seconds between each execution of the job.

TLS Configuration

The a9s CF Service Guard comes with TLS (HTTPS) enabled for its API by default.

note

The a9s CF Service Guard is only configurable to listen to HTTPS and does not support HTTP anymore.

Protocols

For more details on this property, please refer to the a9s Framework TLS Configuration documentation.