a9s Public API Properties
This section describes the supported properties of the a9s Public API component.
Authentication Provider Configuration
| Property | Default Value | Description |
|---|---|---|
auth_provider.name | cloud_foundry | SSO auth provider strategy. cloud_foundry is the only supported option. |
auth_provider.options.api_host | The api address for Cloud Foundry. | |
auth_provider.options.oauth_host | The address to the OAuth server (UAA). | |
auth_provider.options.token_host | The address to the token server (UAA). | |
auth_provider.options.ca | The CA certificate to communicate with the CloudFoundry APIs. | |
auth_provider.options.dashboard_client_id | The unique identifier for the OAuth client that will be created for your service dashboard on the token server (UAA). | |
auth_provider.options.dashboard_client_secret | The shared secret your dashboard will use to authenticate with the token server (UAA). | |
auth_provider.options.dashboard_client_scope | The scope your dashboard requires. | |
auth_provider.options.uaa_checkup_interval | Cooldown period between each request, during which UAA will not be polled. |
a9s Backup Manager Configuration
| Property | Description |
|---|---|
backup_manager.api_endpoint Fully qualified name to reach a9s Backup Manager. | |
backup_manager.authentication.username Username to be used for basic auth to a9s Backup Manager. | |
backup_manager.authentication.password Password to be used for basic auth to a9s Backup Manager. | |
backup_manager.ca The content of the CA in PEM format and is used to validate the HTTPS requests to the a9s Backup Manager API Server. |
a9s Service Broker Configuration
| Property | Description |
|---|---|
service_broker.api_endpoint Fully qualified name to reach a9s Service Broker. | |
service_broker.authentication.username Username to be used for basic auth to a9s Service Broker. | |
service_broker.authentication.password Password to be used for basic auth to a9s Service Broker. | |
service_broker.ca The content of the CA in PEM format and is used to validate the HTTPS requests to the a9s Service Broker API Server. |
a9s Bee Configuration
| Property | Default Value | Description |
|---|---|---|
beehive.bee.timeout | 10s | The general timeout for all beehive to bee requests. |
beehive.bee.port | 7600 | The port used by the a9s Bees. |
beehive.bee.authentication.username | The username used by the a9s Bees. | |
beehive.bee.authentication.password | The password used by the a9s Bees. | |
beehive.bee.ca | The content of the CA in PEM format and is used to validate the HTTPS requests to the a9s Bee API Server. |
a9s Platform Configuration
| Property | Default Value | Description |
|---|---|---|
platform.backup_download_allowed | true | Defines if backups can be downloaded. |
platform.recreate_allowed | true | Defines if the instances can be recreated. |
platform.restart_allowed | true | Defines if the instances can be restarted. |
platform.update_service_instance_settings_allowed | false | Allow service instance settings to be updated by the user. |
platform.support_email | dssupport@anynines.com | The email address displayed to users when an error page ('4xx' or '5xx') appears. |
platform.static_urls | [] | Accept a list of object that will be used as static links in the navigation bar. |
Miscellaneous Configuration
| Property | Default Value | Description |
|---|---|---|
timeout | 30s | The default timeout for all backends, except backup download. |
consul.service_name | public-api | Part of the host name used for the Consul (DNS) registration |
endpoint.port | public-api | Port used to serve a9s Public API on public interface. |