cloud_controller_clock job from cf/227
The Cloud Controller clock periodically schedules Cloud Controller clean up tasks for app usage events, audit events, failed jobs, and more. Only single instance of this job is necessary.
Github source:
07527d79 or
master branch
Properties¶
app_domains¶
Array of domains for user apps (example: ‘user.app.space.foo’, a user app called ‘neat’ will listen at ‘http://neat.user.app.space.foo')
build¶
- Default
"2222"
cc¶
allow_app_ssh_access¶Allow users to change the value of the app-level allow_ssh attribute
- Default
app_bits_upload_grace_period_in_seconds¶Extra token expiry time while uploading big apps.
- Default
app_events¶
cutoff_age_in_days¶How old an app event should stay in cloud controller database before being cleaned up
- Default
app_usage_events¶
cutoff_age_in_days¶How old an app usage event should stay in cloud controller database before being cleaned up
- Default
audit_events¶
cutoff_age_in_days¶How old an audit event should stay in cloud controller database before being cleaned up
- Default
broker_client_timeout_seconds¶For requests to service brokers, this is the HTTP (open and read) timeout setting.
- Default
buildpacks¶
buildpack_directory_key¶Directory (bucket) used store buildpacks. It does not have be pre-created.
- Default
cdn¶
key_pair_id¶Key pair name for signed download URIs
- Default
private_key¶Private key for signing download URIs
- Default
uri¶URI for a CDN to used for buildpack downloads
- Default
fog_connection¶Fog connection hash
bulk_api_password¶Password used to access the bulk_api, health_manager uses it to connect to the cc, announced over NATS
bulk_api_user¶User used to access the bulk_api, health_manager uses it to connect to the cc, announced over NATS
- Default
cc_partition¶Deprecated. Defines a ‘partition’ for the health_manager job
- Default
client_max_body_size¶Maximum body size for nginx
- Default
db_encryption_key¶key for encrypting sensitive values in the CC database
- Default
db_logging_level¶Log level for cc database operations
- Default
default_app_disk_in_mb¶The default disk space an app gets
- Default
default_app_memory¶How much memory given to an app if not specified
- Default
default_fog_connection¶
local_root¶Local root when fog provider is not overridden (should be an NFS mount if using more than one cloud controller)
- Default
provider¶Local fog provider (should always be ‘Local’), used if fog_connection hash is not provided in the manifest
- Default
default_health_check_timeout¶Default health check timeout (in seconds) that can be set for the app
- Default
default_quota_definition¶Local to use a local (NFS) file system. AWS to use AWS.
- Default
default_running_security_groups¶The default running security groups that will be seeded in CloudController.
default_stack¶The default stack to use if no custom stack is specified by an app.
- Default
default_staging_security_groups¶The default staging security groups that will be seeded in CloudController.
default_to_diego_backend¶Use Diego backend by default for new apps
- Default
development_mode¶Enable development features for monitoring and insight
- Default
diego¶
nsync_url¶URL of the Diego nsync service
- Default
stager_url¶URL of the Diego stager service
- Default
tps_url¶URL of the Diego tps service
- Default
disable_custom_buildpacks¶Disable external (i.e. git) buildpacks? (Admin buildpacks and system buildpacks only.)
- Default
droplets¶
cdn¶
key_pair_id¶Key pair name for signed download URIs
- Default
private_key¶Private key for signing download URIs
- Default
uri¶URI for a CDN to used for droplet downloads
- Default
droplet_directory_key¶Directory (bucket) used store droplets. It does not have be pre-created.
- Default
fog_connection¶Fog connection hash
external_host¶Host part of the cloud_controller api URI, will be joined with value of ‘domain’
- Default
external_port¶External Cloud Controller port
- Default
external_protocol¶The protocol used to access the CC API from an external entity
- Default
failed_jobs¶
cutoff_age_in_days¶How old a failed job should stay in cloud controller database before being cleaned up
- Default
flapping_crash_count_threshold¶The threshold of crashes after which the app is marked as flapping
- Default
info¶
build¶build attribute in the /info endpoint
custom¶Custom values for /v2/info endpoint
description¶free form description for attribute in the /info endpoint
name¶name attribute in the /info endpoint
version¶version attribute in the /info endpoint
install_buildpacks¶Set of buildpacks to install during deploy
instance_file_descriptor_limit¶The file descriptors made available to each app instance
- Default
internal_api_password¶Password used by Diego to access internal endpoints
internal_api_user¶User name used by Diego to access internal endpoints
- Default
jobs¶
app_bits_packer¶
timeout_in_seconds¶The longest this job can take before it is cancelled
app_events_cleanup¶
timeout_in_seconds¶The longest this job can take before it is cancelled
app_usage_events_cleanup¶
timeout_in_seconds¶The longest this job can take before it is cancelled
blobstore_delete¶
timeout_in_seconds¶The longest this job can take before it is cancelled
blobstore_upload¶
timeout_in_seconds¶The longest this job can take before it is cancelled
droplet_deletion¶
timeout_in_seconds¶The longest this job can take before it is cancelled
droplet_upload¶
timeout_in_seconds¶The longest this job can take before it is cancelled
global¶
timeout_in_seconds¶The longest any job can take before it is cancelled unless overriden per job
- Default
logging_level¶Log level for cc
- Default
logging_max_retries¶Passthru value for Steno logger
- Default
maximum_app_disk_in_mb¶The maximum amount of disk a user can request
- Default
maximum_health_check_timeout¶Maximum health check timeout (in seconds) that can be set for the app
- Default
newrelic¶
capture_params¶Capture and send query params to NewRelic
- Default
developer_mode¶Activate NewRelic developer mode
- Default
environment_name¶The environment name used by NewRelic
- Default
license_key¶The api key for NewRelic
log_file_path¶The location for NewRelic to log to
- Default
monitor_mode¶Activate NewRelic monitor mode
- Default
transaction_tracer¶
enabled¶Enable transaction tracing in NewRelic
- Default
record_sql¶NewRelic’s SQL statement recording mode: [off | obfuscated | raw]
- Default
packages¶
app_package_directory_key¶Directory (bucket) used store app packages. It does not have be pre-created.
- Default
cdn¶
key_pair_id¶Key pair name for signed download URIs
- Default
private_key¶Private key for signing download URIs
- Default
uri¶URI for a CDN to used for app package downloads
- Default
fog_connection¶Fog connection hash
max_package_size¶Maximum size of application package
- Default
pending_packages¶
expiration_in_seconds¶How long packages can remain in pending state before being cleaned up
- Default
frequency_in_seconds¶How often the package pending cleanup job runs
- Default
quota_definitions¶Hash of default quota definitions. Overriden by custom quota definitions.
renderer¶
default_results_per_page¶Default number of results returned per page if user does not specify
- Default
max_inline_relations_depth¶Maximum depth of inlined relationships in the result
- Default
max_results_per_page¶Maximum number of results returned per page
- Default
resource_pool¶
cdn¶
key_pair_id¶Key pair name for signed download URIs
- Default
private_key¶Private key for signing download URIs
- Default
uri¶URI for a CDN to used for resource pool downloads
- Default
fog_connection¶Fog connection hash
maximum_size¶Maximum size of a resource to add to the pool
- Default
minimum_size¶Minimum size of a resource to add to the pool
- Default
resource_directory_key¶Directory (bucket) used store app resources. It does not have be pre-created.
- Default
security_group_definitions¶Array of security groups that will be seeded into CloudController.
service_usage_events¶
cutoff_age_in_days¶How old a service usage event should stay in cloud controller database before being cleaned up
- Default
stacks¶Tag used by the DEA to describe capabilities (i.e. ‘Windows7’, ‘python-linux’). DEA and CC must agree.
- Default
- description: Cloud Foundry Linux-based filesystem name: cflinuxfs2
staging_file_descriptor_limit¶File descriptor limit for staging tasks
- Default
staging_timeout_in_seconds¶Timeout for staging a droplet
- Default
staging_upload_password¶User’s password used to access internal endpoints of Cloud Controller to upload files when staging
- Default
staging_upload_user¶User name used to access internal endpoints of Cloud Controller to upload files when staging
- Default
thresholds¶
api¶
alert_if_above_mb¶The cc will alert if memory remains above this threshold for 3 monit cycles
- Default
restart_if_above_mb¶The cc will restart if memory remains above this threshold for 3 monit cycles
- Default
restart_if_consistently_above_mb¶The cc will restart if memory remains above this threshold for 15 monit cycles
- Default
uaa_resource_id¶Name of service to register to UAA
- Default
users_can_select_backend¶Allow non-admin users to switch their apps between DEA and Diego backends
- Default
ccdb¶
address¶
databases¶
db_scheme¶
- Default
max_connections¶Maximum connections for Sequel
- Default
pool_timeout¶
- Default
port¶
roles¶
dea_next¶
staging_disk_limit_mb¶Disk limit in mb for staging tasks
- Default
staging_memory_limit_mb¶Memory limit in mb for staging tasks
- Default
description¶
- Default
Cloud Foundry sponsored by Pivotal
domain¶
domain where cloud_controller will listen (api.domain) often the same as the system domain
hm9000¶
url¶
logger_endpoint¶
port¶Port for logger endpoint listed at /v2/info
- Default
use_ssl¶Whether to use ssl for logger endpoint listed at /v2/info
- Default
login¶
enabled¶whether use login as the authorization endpoint or not
- Default
protocol¶http or https
- Default
url¶
metron_endpoint¶
host¶The host used to emit messages to the Metron agent
- Default
port¶The port used to emit messages to the Metron agent
- Default
name¶
- Default
vcap
nats¶
machines¶IP of each NATS cluster member.
password¶Password for cc client to connect to NATS
port¶IP port of Cloud Foundry NATS server
user¶Username for cc client to connect to NATS
request_timeout_in_seconds¶
Timeout for requests in seconds.
- Default
900
ssl¶
skip_cert_verify¶specifies that the job is allowed to skip ssl cert verification
- Default
support_address¶
- Default
http://support.cloudfoundry.com
system_domain¶
Domain reserved for CF operator, base URL where the login, uaa, and other non-user apps listen
system_domain_organization¶
The User Org that owns the system_domain, required if system_domain is defined
- Default
""
uaa¶
cc¶
token_secret¶
clients¶
cc-service-dashboards¶
scope¶Used to grant scope for SSO clients for service brokers
- Default
secret¶Used for generating SSO clients for service brokers.
cc_service_broker_client¶
scope¶(DEPRECATED) - Used to grant scope for SSO clients for service brokers
- Default
secret¶(DEPRECATED) - Used for generating SSO clients for service brokers.
jwt¶
verification_key¶ssl cert defined in the manifest by the UAA, required by the cc to communicate with UAA
- Default
url¶
version¶
- Default
"2"
Templates¶
Templates are rendered and placed onto corresponding
instances during the deployment process. This job's templates
will be placed into /var/vcap/jobs/cloud_controller_clock/ directory
(learn more).
bin/cloud_controller_clock_ctl(fromcloud_controller_clock_ctl.erb)bin/console(fromconsole.erb)bin/ruby_version.sh(fromruby_version.sh.erb)config/cloud_controller_ng.yml(fromcloud_controller_clock.yml.erb)config/newrelic.yml(fromnewrelic.yml.erb)config/stacks.yml(fromstacks.yml.erb)
Packages¶
Packages are compiled and placed onto corresponding
instances during the deployment process. Packages will be
placed into /var/vcap/packages/ directory.