Skip to content

golangapiserver job from app-autoscaler/8.2.0

Github source: 8ef2566b or master branch

Properties

autoscaler

apiserver

broker
broker_credentials

The list of credentials to authenticate with service broker. This is useful when credential rotation is required example: - broker_username: user1 broker_password: password1 - broker_username: user2 broker_password: password2

Default
""
password

DEPRECATED - password to authenticate with service broker

plan_check

The plan check config which consists of plan_definitions: example_definition_name: planCheckEnabled: boolean (true|false) schedules_count: int (0..) scaling_rules_count: int (0..) plan_updateable: boolean (true|false)

Example below:

plan_definitions: Some-example-uuid-ONE: planCheckEnabled: true schedules_count: 2 scaling_rules_count: 4 Some-example-uuid-TWO: planCheckEnabled: true schedules_count: 10 scaling_rules_count: 10

Default
""
server
ca_cert

PEM-encoded CA certificate

catalog
dashboard_redirect_uri
port

Port where broker server will run

Default
6101
server_cert

PEM-encoded server certificate

server_key

PEM-encoded server key

username

DEPRECATED - username to authenticate with service broker

cred_helper
impl

Either default or stored_procedure which retrieves and manages credentials

Default
default
stored_procedure_config

Configuration to define the stored procedure config if stored_procedure is used as the implementation. NOTE: The procedure_name/function name is case sensitive. This is to secure the configuration quoting identifiers which makes them case sensitve stored_procedure_config: schema_name: string create_binding_credential_procedure_name: string drop_binding_credential_procedure_name: string drop_all_binding_credential_procedure_name: string validate_binding_credential_procedure_name: string

Example below:

stored_procedure_config: schema_name: SCHEMA create_binding_credential_procedure_name: CREATE drop_binding_credential_procedure_name: DROP drop_all_binding_credential_procedure_name: dropALL validate_binding_credential_procedure_name: VALIDATE

Default
{}
event_generator
ca_cert

PEM-encoded CA certificate

client_cert

PEM-encoded client certificate

client_key

PEM-encoded client key

host

Host where eventGenerator is running

Default
eventgenerator.service.cf.internal
port

Port where eventGenerator will listen

Default
6105
health
port
Default
1080
hooks
post_start

Script to run after apiserver has started

Default
""
post_stop

Script to run after apiserver has stopped

Default
""
pre_start

Script to run before starting apiserver

Default
""
Example
|+
  #!/bin/bash
  echo "Going to start apiserver"
  echo "apiserver data directory is ${DATA_DIR}"
  echo "apiserver port is ${PORT}"
  echo "apiserver directory is ${PACKAGE_DIR}"
pre_stop

Script to run before stopping apiserver

Default
""
info
build

Autoscaler application build number

Default
8.2.0
description

Autoscaler application short description

Default
  Automatically increase or decrease the number of application instances based on a
    policy you define.
name

Name of the autoscaler application to be shown in /info path

Default
Autoscaler
support_url

Autoscaler application support page URL

Default
https://github.com/cloudfoundry/app-autoscaler-release
logging
level

the level of logging

Default
info
metrics_collector
ca_cert

PEM-encoded CA certificate

client_cert

PEM-encoded client certificate

client_key

PEM-encoded client key

host

Host where metricsCollector is running

Default
metricscollector.service.cf.internal
port

Port where metricsCollector will listen

Default
6103
metrics_forwarder
host

Host where metricsforwarder is running

Default
autoscalermetrics.bosh-lite.com
mtls_host

Host where metricsforwarder mtls authentication route is available

Default
""
public_api
server
ca_cert

PEM-encoded CA certificate

port

Port where broker server will run

Default
6102
server_cert

PEM-encoded server certificate

server_key

PEM-encoded server key

rate_limit
max_amount

The number of requests accepted by rate limit

Default
10
valid_duration

The rate limit evaluation duration

Default
1s
scaling_engine
ca_cert

PEM-encoded CA certificate

client_cert

PEM-encoded client certificate

client_key

PEM-encoded client key

host

Host where scalingengine is running

Default
scalingengine.service.cf.internal
port

Port where scalingengine will listen

Default
6104
scaling_rules
cpu
lower_threshold

Allowable lower threshold of the cpu scaling range

Default
1
upper_threshold

Allowable upper threshold of the cpu scaling range

Default
100
scheduler
ca_cert

PEM-encoded CA certificate

client_cert

PEM-encoded client certificate

client_key

PEM-encoded client key

host

Host where scheduler is running

Default
autoscalerscheduler.service.cf.internal
port

Port where scheduler will listen

Default
6102
use_buildin_mode
Default
true

binding_db

address

IP address on which the bindingdb server will listen

Default
autoscalerpostgres.service.cf.internal
databases

The list of databases used in bindingdb database including name

db_scheme

Database scheme to be used to access bindingdb

Default
postgres
port

Port on which the bindingdb server will listen

roles

The list of database roles used in bindingdb database including name/password

sslmode

sslmode to connect to postgres server

Default
disable
tls
ca

PEM-encoded ca certificate for TLS database server

Default
""
crt

PEM-encoded certificate for TLS database client

Default
""
key

PEM-encoded key for TLS database client

Default
""

binding_db_connection_config

connection_max_lifetime
Default
60s
max_idle_connections
Default
10
max_open_connections
Default
20

cf

api

the Cloud Foundry API endpoint

client_id

the client id to log in cf

idle_connection_timeout_ms

The maximum amount of time an idle (keep-alive) connection will remain idle before closing itself. Zero means no limit.

Default
5000
max_idle_conns_per_host_ms

Controls the maximum idle (keep-alive) connections to keep pooled per-host. If zero, 2 is used.

Default
200
max_retries

The number of retries from the autoscaler to the cf api (cloud controller). 0 turns off the retries.

Default
3
max_retry_wait_ms

The maximum amount of time in milliseconds to wait between retries. 0 leaves it to the implementation to decide

Default
0
secret

the secret to log in cf

skip_ssl_validation

Flag to skip ssl validation to connect to CC and UAA

Default
false

changeloglock_timeout_seconds

Liquibase changelog lock timeout duration in seconds

Default
180

policy_db

address

IP address on which the policydb server will listen

Default
autoscalerpostgres.service.cf.internal
databases

The list of databases used in policydb database including name

db_scheme

Database scheme to be used to access policydb

Default
postgres
port

Port on which the policydb server will listen

roles

The list of database roles used in policydb database including name/password

sslmode

sslmode to connect to postgres server

Default
disable
tls
ca

PEM-encoded CA certificate for TLS database server

Default
""
crt

PEM-encoded certificate for TLS database client

Default
""
key

PEM-encoded key for TLS database client

Default
""

policy_db_connection_config

connection_max_lifetime
Default
60s
max_idle_connections
Default
10
max_open_connections
Default
20

storedprocedure_db

address

IP address on which the storedproceduredb server will listen

Default
""
databases

The list of databases used in storedproceduredb database including name

db_scheme

Database scheme to be used to access storedproceduredb

Default
postgres
port

Port on which the storedproceduredb server will listen

roles

The list of database roles used in storedproceduredb database including name/password

sslmode

sslmode to connect to postgres server

Default
disable
tls
ca

PEM-encoded ca certificate of tls database server

Default
""
crt

PEM-encoded certificate of tls database client

Default
""
key

PEM-encoded key of tls database client

Default
""

storedprocedure_db_connection_config

connection_max_lifetime
Default
60s
max_idle_connections
Default
10
max_open_connections
Default
20

Templates

Templates are rendered and placed onto corresponding instances during the deployment process. This job's templates will be placed into /var/vcap/jobs/golangapiserver/ directory (learn more).

  • bin/apiserver_ctl (from apiserver_ctl.erb)
  • bin/hooks/post-start.sh (from hooks/post-start.sh.erb)
  • bin/hooks/post-stop.sh (from hooks/post-stop.sh.erb)
  • bin/hooks/pre-start.sh (from hooks/pre-start.sh.erb)
  • bin/hooks/pre-stop.sh (from hooks/pre-stop.sh.erb)
  • bin/liquibase.properties (from liquibase.properties)
  • bin/pre-start (from pre-start.erb)
  • config/apiserver.yml (from apiserver.yml.erb)
  • config/catalog.json (from catalog.json.erb)
  • config/certs/apiserver/ca.crt (from apiserver_ca.crt.erb)
  • config/certs/apiserver/server.crt (from apiserver_server.crt.erb)
  • config/certs/apiserver/server.key (from apiserver_server.key.erb)
  • config/certs/binding_db/ca.crt (from binding_db_ca.crt.erb)
  • config/certs/binding_db/crt (from binding_db.crt.erb)
  • config/certs/binding_db/key (from binding_db.key.erb)
  • config/certs/brokerserver/ca.crt (from brokerserver_ca.crt.erb)
  • config/certs/brokerserver/server.crt (from brokerserver.crt.erb)
  • config/certs/brokerserver/server.key (from brokerserver.key.erb)
  • config/certs/eventgenerator/ca.crt (from eventgenerator_ca.crt.erb)
  • config/certs/eventgenerator/client.crt (from eventgenerator_client.crt.erb)
  • config/certs/eventgenerator/client.key (from eventgenerator_client.key.erb)
  • config/certs/metricscollector/ca.crt (from metricscollector_ca.crt.erb)
  • config/certs/metricscollector/client.crt (from metricscollector_client.crt.erb)
  • config/certs/metricscollector/client.key (from metricscollector_client.key.erb)
  • config/certs/policy_db/ca.crt (from policy_db_ca.crt.erb)
  • config/certs/policy_db/crt (from policy_db.crt.erb)
  • config/certs/policy_db/key (from policy_db.key.erb)
  • config/certs/scalingengine/ca.crt (from scalingengine_ca.crt.erb)
  • config/certs/scalingengine/client.crt (from scalingengine_client.crt.erb)
  • config/certs/scalingengine/client.key (from scalingengine_client.key.erb)
  • config/certs/scheduler/ca.crt (from scheduler_ca.crt.erb)
  • config/certs/scheduler/client.crt (from scheduler_client.crt.erb)
  • config/certs/scheduler/client.key (from scheduler_client.key.erb)
  • config/certs/storedprocedure_db/ca.crt (from storedprocedure_db_ca.crt.erb)
  • config/certs/storedprocedure_db/crt (from storedprocedure_db.crt.erb)
  • config/certs/storedprocedure_db/key (from storedprocedure_db.key.erb)
  • config/info.json (from info.json.erb)

Packages

Packages are compiled and placed onto corresponding instances during the deployment process. Packages will be placed into /var/vcap/packages/ directory.