Documentation
¶
Index ¶
- type Api
- type AppBitsPacker
- type AppEvents
- type AppEventsCleanup
- type AppUsageEvents
- type AppUsageEventsCleanup
- type AuditEvents
- type BlobstoreDelete
- type BlobstoreUpload
- type Buildpacks
- type BuildpacksCdn
- type BuildpacksWebdavConfig
- type Cc
- type CcServiceBrokerClient
- type CcServiceDashboards
- type Ccdb
- type Clients
- type CloudControllerClockJob
- type CompletedTasks
- type DeaNext
- type Diego
- type DropletDeletion
- type DropletUpload
- type Droplets
- type DropletsCdn
- type DropletsWebdavConfig
- type FailedJobs
- type Global
- type Hm9000
- type Jobs
- type Jwt
- type LoggerEndpoint
- type Login
- type MetronEndpoint
- type Nats
- type Newrelic
- type Packages
- type PackagesCdn
- type PackagesWebdavConfig
- type PendingPackages
- type Renderer
- type ResourcePool
- type ResourcePoolCdn
- type ResourcePoolWebdavConfig
- type ServiceUsageEvents
- type Ssl
- type Thresholds
- type TransactionTracer
- type Uaa
- type UaaCc
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Api ¶
type Api struct {
/*RestartIfAboveMb - Descr: The cc will restart if memory remains above this threshold for 3 monit cycles Default: 3750
*/
RestartIfAboveMb interface{} `yaml:"restart_if_above_mb,omitempty"`
/*RestartIfConsistentlyAboveMb - Descr: The cc will restart if memory remains above this threshold for 15 monit cycles Default: 3500
*/
RestartIfConsistentlyAboveMb interface{} `yaml:"restart_if_consistently_above_mb,omitempty"`
/*AlertIfAboveMb - Descr: The cc will alert if memory remains above this threshold for 3 monit cycles Default: 3500
*/
AlertIfAboveMb interface{} `yaml:"alert_if_above_mb,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
type AppBitsPacker ¶
type AppBitsPacker struct {
/*TimeoutInSeconds - Descr: The longest this job can take before it is cancelled Default: <nil>
*/
TimeoutInSeconds interface{} `yaml:"timeout_in_seconds,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
type AppEvents ¶
type AppEvents struct {
/*CutoffAgeInDays - Descr: How old an app event should stay in cloud controller database before being cleaned up Default: 31
*/
CutoffAgeInDays interface{} `yaml:"cutoff_age_in_days,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
type AppEventsCleanup ¶
type AppEventsCleanup struct {
/*TimeoutInSeconds - Descr: The longest this job can take before it is cancelled Default: <nil>
*/
TimeoutInSeconds interface{} `yaml:"timeout_in_seconds,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
type AppUsageEvents ¶
type AppUsageEvents struct {
/*CutoffAgeInDays - Descr: How old an app usage event should stay in cloud controller database before being cleaned up Default: 31
*/
CutoffAgeInDays interface{} `yaml:"cutoff_age_in_days,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
type AppUsageEventsCleanup ¶
type AppUsageEventsCleanup struct {
/*TimeoutInSeconds - Descr: The longest this job can take before it is cancelled Default: <nil>
*/
TimeoutInSeconds interface{} `yaml:"timeout_in_seconds,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
type AuditEvents ¶
type AuditEvents struct {
/*CutoffAgeInDays - Descr: How old an audit event should stay in cloud controller database before being cleaned up Default: 31
*/
CutoffAgeInDays interface{} `yaml:"cutoff_age_in_days,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
type BlobstoreDelete ¶
type BlobstoreDelete struct {
/*TimeoutInSeconds - Descr: The longest this job can take before it is cancelled Default: <nil>
*/
TimeoutInSeconds interface{} `yaml:"timeout_in_seconds,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
type BlobstoreUpload ¶
type BlobstoreUpload struct {
/*TimeoutInSeconds - Descr: The longest this job can take before it is cancelled Default: <nil>
*/
TimeoutInSeconds interface{} `yaml:"timeout_in_seconds,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
type Buildpacks ¶
type Buildpacks struct {
/*FogAwsStorageOptions - Descr: Storage options passed to fog for aws blobstores. Valid keys: ['encryption']. Default: <nil>
*/
FogAwsStorageOptions interface{} `yaml:"fog_aws_storage_options,omitempty"`
/*Cdn - Descr: URI for a CDN to used for buildpack downloads Default:
*/
Cdn *BuildpacksCdn `yaml:"cdn,omitempty"`
/*BlobstoreType - Descr: The type of blobstore backing to use. Valid values: ['fog', 'webdav'] Default: fog
*/
BlobstoreType interface{} `yaml:"blobstore_type,omitempty"`
/*BuildpackDirectoryKey - Descr: Directory (bucket) used store buildpacks. It does not have be pre-created. Default: cc-buildpacks
*/
BuildpackDirectoryKey interface{} `yaml:"buildpack_directory_key,omitempty"`
/*WebdavConfig - Descr: The basic auth password that CC uses to connect to the admin endpoint on webdav Default:
*/
WebdavConfig *BuildpacksWebdavConfig `yaml:"webdav_config,omitempty"`
/*FogConnection - Descr: Fog connection hash Default: <nil>
*/
FogConnection interface{} `yaml:"fog_connection,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
type BuildpacksCdn ¶
type BuildpacksCdn struct {
/*Uri - Descr: URI for a CDN to used for buildpack downloads Default:
*/
Uri interface{} `yaml:"uri,omitempty"`
/*KeyPairId - Descr: Key pair name for signed download URIs Default:
*/
KeyPairId interface{} `yaml:"key_pair_id,omitempty"`
/*PrivateKey - Descr: Private key for signing download URIs Default:
*/
PrivateKey interface{} `yaml:"private_key,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
type BuildpacksWebdavConfig ¶
type BuildpacksWebdavConfig struct {
/*BlobstoreTimeout - Descr: The timeout in seconds for requests to the blobstore Default: 5
*/
BlobstoreTimeout interface{} `yaml:"blobstore_timeout,omitempty"`
/*Username - Descr: The basic auth user that CC uses to connect to the admin endpoint on webdav Default:
*/
Username interface{} `yaml:"username,omitempty"`
/*Password - Descr: The basic auth password that CC uses to connect to the admin endpoint on webdav Default:
*/
Password interface{} `yaml:"password,omitempty"`
/*PrivateEndpoint - Descr: The location of the webdav server eg: https://blobstore.internal Default: https://blobstore.service.cf.internal:4443
*/
PrivateEndpoint interface{} `yaml:"private_endpoint,omitempty"`
/*PublicEndpoint - Descr: The location of the webdav server eg: https://blobstore.com Default:
*/
PublicEndpoint interface{} `yaml:"public_endpoint,omitempty"`
/*CaCert - Descr: The ca cert to use when communicating with webdav Default:
*/
CaCert interface{} `yaml:"ca_cert,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
type Cc ¶
type Cc struct {
/*Renderer - Descr: Default number of results returned per page if user does not specify Default: 50
*/
Renderer *Renderer `yaml:"renderer,omitempty"`
/*DefaultAppMemory - Descr: How much memory given to an app if not specified Default: 1024
*/
DefaultAppMemory interface{} `yaml:"default_app_memory,omitempty"`
/*CcPartition - Descr: Deprecated. Defines a 'partition' for the health_manager job Default: default
*/
CcPartition interface{} `yaml:"cc_partition,omitempty"`
/*ExternalPort - Descr: External Cloud Controller port Default: 9022
*/
ExternalPort interface{} `yaml:"external_port,omitempty"`
/*DefaultHealthCheckTimeout - Descr: Default health check timeout (in seconds) that can be set for the app Default: 60
*/
DefaultHealthCheckTimeout interface{} `yaml:"default_health_check_timeout,omitempty"`
/*Thresholds - Descr: The cc will alert if memory remains above this threshold for 3 monit cycles Default: 3500
*/
Thresholds *Thresholds `yaml:"thresholds,omitempty"`
/*StagingUploadPassword - Descr: User's password used to access internal endpoints of Cloud Controller to upload files when staging Default:
*/
StagingUploadPassword interface{} `yaml:"staging_upload_password,omitempty"`
/*Buildpacks - Descr: URI for a CDN to used for buildpack downloads Default:
*/
Buildpacks *Buildpacks `yaml:"buildpacks,omitempty"`
/*PendingPackages - Descr: How long packages can remain in pending state before being cleaned up Default: 1200
*/
PendingPackages *PendingPackages `yaml:"pending_packages,omitempty"`
/*ExternalHost - Descr: Host part of the cloud_controller api URI, will be joined with value of 'domain' Default: api
*/
ExternalHost interface{} `yaml:"external_host,omitempty"`
/*Newrelic - Descr: The api key for NewRelic Default: <nil>
*/
Newrelic *Newrelic `yaml:"newrelic,omitempty"`
/*BulkApiPassword - Descr: Password used to access the bulk_api, health_manager uses it to connect to the cc, announced over NATS Default: <nil>
*/
BulkApiPassword interface{} `yaml:"bulk_api_password,omitempty"`
/*ClientMaxBodySize - Descr: Maximum body size for nginx Default: 1536M
*/
ClientMaxBodySize interface{} `yaml:"client_max_body_size,omitempty"`
/*UaaResourceId - Descr: Name of service to register to UAA Default: cloud_controller,cloud_controller_service_permissions
*/
UaaResourceId interface{} `yaml:"uaa_resource_id,omitempty"`
/*AuditEvents - Descr: How old an audit event should stay in cloud controller database before being cleaned up Default: 31
*/
AuditEvents *AuditEvents `yaml:"audit_events,omitempty"`
/*UsersCanSelectBackend - Descr: Allow non-admin users to switch their apps between DEA and Diego backends Default: true
*/
UsersCanSelectBackend interface{} `yaml:"users_can_select_backend,omitempty"`
/*Jobs - Descr: The longest any job can take before it is cancelled unless overriden per job Default: 14400
*/
Jobs *Jobs `yaml:"jobs,omitempty"`
/*DefaultRunningSecurityGroups - Descr: The default running security groups that will be seeded in CloudController. Default: <nil>
*/
DefaultRunningSecurityGroups interface{} `yaml:"default_running_security_groups,omitempty"`
/*AppEvents - Descr: How old an app event should stay in cloud controller database before being cleaned up Default: 31
*/
AppEvents *AppEvents `yaml:"app_events,omitempty"`
/*MaximumAppDiskInMb - Descr: The maximum amount of disk a user can request Default: 2048
*/
MaximumAppDiskInMb interface{} `yaml:"maximum_app_disk_in_mb,omitempty"`
/*SecurityGroupDefinitions - Descr: Array of security groups that will be seeded into CloudController. Default: <nil>
*/
SecurityGroupDefinitions interface{} `yaml:"security_group_definitions,omitempty"`
/*FlappingCrashCountThreshold - Descr: The threshold of crashes after which the app is marked as flapping Default: 3
*/
FlappingCrashCountThreshold interface{} `yaml:"flapping_crash_count_threshold,omitempty"`
/*Droplets - Descr: The timeout in seconds for requests to the blobstore Default: 5
*/
Droplets *Droplets `yaml:"droplets,omitempty"`
/*ReservedPrivateDomains - Descr: File location of a list of reserved private domains (for file format, see https://publicsuffix.org/) Default: <nil>
*/
ReservedPrivateDomains interface{} `yaml:"reserved_private_domains,omitempty"`
/*StagingFileDescriptorLimit - Descr: File descriptor limit for staging tasks Default: 16384
*/
StagingFileDescriptorLimit interface{} `yaml:"staging_file_descriptor_limit,omitempty"`
/*InternalApiUser - Descr: User name used by Diego to access internal endpoints Default: internal_user
*/
InternalApiUser interface{} `yaml:"internal_api_user,omitempty"`
/*BrokerClientTimeoutSeconds - Descr: For requests to service brokers, this is the HTTP (open and read) timeout setting. Default: 60
*/
BrokerClientTimeoutSeconds interface{} `yaml:"broker_client_timeout_seconds,omitempty"`
/*DbLoggingLevel - Descr: Log level for cc database operations Default: debug2
*/
DbLoggingLevel interface{} `yaml:"db_logging_level,omitempty"`
/*InternalApiPassword - Descr: Password used by Diego to access internal endpoints Default: <nil>
*/
InternalApiPassword interface{} `yaml:"internal_api_password,omitempty"`
/*Stacks - Descr: Tag used by the DEA to describe capabilities (i.e. 'Windows7', 'python-linux'). DEA and CC must agree. Default: [map[name:cflinuxfs2 description:Cloud Foundry Linux-based filesystem]]
*/
Stacks interface{} `yaml:"stacks,omitempty"`
/*CompletedTasks - Descr: How long a completed task will stay in cloud controller database before being cleaned up based on last updated time with success or failure. Default: 31
*/
CompletedTasks *CompletedTasks `yaml:"completed_tasks,omitempty"`
/*InternalServiceHostname - Descr: Internal hostname used to resolve the address of the Cloud Controller Default: cloud-controller-ng.service.cf.internal
*/
InternalServiceHostname interface{} `yaml:"internal_service_hostname,omitempty"`
/*InstallBuildpacks - Descr: Set of buildpacks to install during deploy Default: <nil>
*/
InstallBuildpacks interface{} `yaml:"install_buildpacks,omitempty"`
/*LoggingMaxRetries - Descr: Passthru value for Steno logger Default: 1
*/
LoggingMaxRetries interface{} `yaml:"logging_max_retries,omitempty"`
/*DefaultStagingSecurityGroups - Descr: The default staging security groups that will be seeded in CloudController. Default: <nil>
*/
DefaultStagingSecurityGroups interface{} `yaml:"default_staging_security_groups,omitempty"`
/*DefaultAppDiskInMb - Descr: The default disk space an app gets Default: 1024
*/
DefaultAppDiskInMb interface{} `yaml:"default_app_disk_in_mb,omitempty"`
/*SystemHostnames - Descr: List of hostnames for which routes cannot be created on the system domain. Default: [api uaa login doppler loggregator hm9000]
*/
SystemHostnames interface{} `yaml:"system_hostnames,omitempty"`
/*Diego - Descr: URL of the Diego tps service Default: http://tps.service.cf.internal:1518
*/
Diego *Diego `yaml:"diego,omitempty"`
/*ServiceUsageEvents - Descr: How old a service usage event should stay in cloud controller database before being cleaned up Default: 31
*/
ServiceUsageEvents *ServiceUsageEvents `yaml:"service_usage_events,omitempty"`
/*DefaultToDiegoBackend - Descr: Use Diego backend by default for new apps Default: false
*/
DefaultToDiegoBackend interface{} `yaml:"default_to_diego_backend,omitempty"`
/*LoggingLevel - Descr: Log level for cc Default: info
*/
LoggingLevel interface{} `yaml:"logging_level,omitempty"`
/*QuotaDefinitions - Descr: Hash of default quota definitions. Overriden by custom quota definitions. Default: <nil>
*/
QuotaDefinitions interface{} `yaml:"quota_definitions,omitempty"`
/*ExternalProtocol - Descr: The protocol used to access the CC API from an external entity Default: https
*/
ExternalProtocol interface{} `yaml:"external_protocol,omitempty"`
/*StagingUploadUser - Descr: User name used to access internal endpoints of Cloud Controller to upload files when staging Default:
*/
StagingUploadUser interface{} `yaml:"staging_upload_user,omitempty"`
/*DefaultQuotaDefinition - Descr: Local to use a local (NFS) file system. AWS to use AWS. Default: default
*/
DefaultQuotaDefinition interface{} `yaml:"default_quota_definition,omitempty"`
/*InstanceFileDescriptorLimit - Descr: The file descriptors made available to each app instance Default: 16384
*/
InstanceFileDescriptorLimit interface{} `yaml:"instance_file_descriptor_limit,omitempty"`
/*FailedJobs - Descr: How old a failed job should stay in cloud controller database before being cleaned up Default: 31
*/
FailedJobs *FailedJobs `yaml:"failed_jobs,omitempty"`
/*StagingTimeoutInSeconds - Descr: Timeout for staging a droplet Default: 900
*/
StagingTimeoutInSeconds interface{} `yaml:"staging_timeout_in_seconds,omitempty"`
/*AppBitsUploadGracePeriodInSeconds - Descr: Extra token expiry time while uploading big apps. Default: 1200
*/
AppBitsUploadGracePeriodInSeconds interface{} `yaml:"app_bits_upload_grace_period_in_seconds,omitempty"`
/*AppUsageEvents - Descr: How old an app usage event should stay in cloud controller database before being cleaned up Default: 31
*/
AppUsageEvents *AppUsageEvents `yaml:"app_usage_events,omitempty"`
/*AllowAppSshAccess - Descr: Allow users to change the value of the app-level allow_ssh attribute Default: true
*/
AllowAppSshAccess interface{} `yaml:"allow_app_ssh_access,omitempty"`
/*ResourcePool - Descr: The timeout in seconds for requests to the blobstore Default: 5
*/
ResourcePool *ResourcePool `yaml:"resource_pool,omitempty"`
/*MaximumHealthCheckTimeout - Descr: Maximum health check timeout (in seconds) that can be set for the app Default: 180
*/
MaximumHealthCheckTimeout interface{} `yaml:"maximum_health_check_timeout,omitempty"`
/*DbEncryptionKey - Descr: key for encrypting sensitive values in the CC database Default:
*/
DbEncryptionKey interface{} `yaml:"db_encryption_key,omitempty"`
/*DefaultStack - Descr: The default stack to use if no custom stack is specified by an app. Default: cflinuxfs2
*/
DefaultStack interface{} `yaml:"default_stack,omitempty"`
/*BulkApiUser - Descr: User used to access the bulk_api, health_manager uses it to connect to the cc, announced over NATS Default: bulk_api
*/
BulkApiUser interface{} `yaml:"bulk_api_user,omitempty"`
/*Packages - Descr: Storage options passed to fog for aws blobstores. Valid keys: ['encryption']. Default: <nil>
*/
Packages *Packages `yaml:"packages,omitempty"`
/*DisableCustomBuildpacks - Descr: Disable external (i.e. git) buildpacks? (Admin buildpacks and system buildpacks only.) Default: false
*/
DisableCustomBuildpacks interface{} `yaml:"disable_custom_buildpacks,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
type CcServiceBrokerClient ¶
type CcServiceBrokerClient struct {
/*Scope - Descr: (DEPRECATED) - Used to grant scope for SSO clients for service brokers Default: openid,cloud_controller_service_permissions.read
*/
Scope interface{} `yaml:"scope,omitempty"`
/*Secret - Descr: (DEPRECATED) - Used for generating SSO clients for service brokers. Default: <nil>
*/
Secret interface{} `yaml:"secret,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
type CcServiceDashboards ¶
type CcServiceDashboards struct {
/*Secret - Descr: Used for generating SSO clients for service brokers. Default: <nil>
*/
Secret interface{} `yaml:"secret,omitempty"`
/*Scope - Descr: Used to grant scope for SSO clients for service brokers Default: openid,cloud_controller_service_permissions.read
*/
Scope interface{} `yaml:"scope,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
type Ccdb ¶
type Ccdb struct {
/*Port - Descr: The port of the database server Default: <nil>
*/
Port interface{} `yaml:"port,omitempty"`
/*Databases - Descr: Contains the name of the database on the database server Default: <nil>
*/
Databases interface{} `yaml:"databases,omitempty"`
/*PoolTimeout - Descr: The timeout for Sequel pooled connections Default: 10
*/
PoolTimeout interface{} `yaml:"pool_timeout,omitempty"`
/*DbScheme - Descr: The type of database being used. mysql or postgres Default: postgres
*/
DbScheme interface{} `yaml:"db_scheme,omitempty"`
/*Roles - Descr: Users to create on the database when seeding Default: <nil>
*/
Roles interface{} `yaml:"roles,omitempty"`
/*Address - Descr: The address of the database server Default: <nil>
*/
Address interface{} `yaml:"address,omitempty"`
/*MaxConnections - Descr: Maximum connections for Sequel Default: 25
*/
MaxConnections interface{} `yaml:"max_connections,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
type Clients ¶
type Clients struct {
/*CcServiceBrokerClient - Descr: (DEPRECATED) - Used for generating SSO clients for service brokers. Default: <nil>
*/
CcServiceBrokerClient *CcServiceBrokerClient `yaml:"cc_service_broker_client,omitempty"`
/*CcServiceDashboards - Descr: Used for generating SSO clients for service brokers. Default: <nil>
*/
CcServiceDashboards *CcServiceDashboards `yaml:"cc-service-dashboards,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
type CloudControllerClockJob ¶
type CloudControllerClockJob struct {
/*SystemDomainOrganization - Descr: The User Org that owns the system_domain, required if system_domain is defined Default:
*/
SystemDomainOrganization interface{} `yaml:"system_domain_organization,omitempty"`
/*Build - Descr: 'build' attribute in the /v2/info endpoint Default:
*/
Build interface{} `yaml:"build,omitempty"`
/*SupportAddress - Descr: 'support' attribute in the /v2/info endpoint Default:
*/
SupportAddress interface{} `yaml:"support_address,omitempty"`
/*Domain - Descr: Deprecated in favor of system_domain. Domain where cloud_controller will listen (api.domain) Default: <nil>
*/
Domain interface{} `yaml:"domain,omitempty"`
/*LoggerEndpoint - Descr: Port for logger endpoint listed at /v2/info Default: 443
*/
LoggerEndpoint *LoggerEndpoint `yaml:"logger_endpoint,omitempty"`
/*AppDomains - Descr: 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') Default: <nil>
*/
AppDomains interface{} `yaml:"app_domains,omitempty"`
/*Nats - Descr: Password for cc client to connect to NATS Default: <nil>
*/
Nats *Nats `yaml:"nats,omitempty"`
/*Login - Descr: URL of the login server Default: <nil>
*/
Login *Login `yaml:"login,omitempty"`
/*RequestTimeoutInSeconds - Descr: Timeout for requests in seconds. Default: 900
*/
RequestTimeoutInSeconds interface{} `yaml:"request_timeout_in_seconds,omitempty"`
/*Ccdb - Descr: The timeout for Sequel pooled connections Default: 10
*/
Ccdb *Ccdb `yaml:"ccdb,omitempty"`
/*Ssl - Descr: specifies that the job is allowed to skip ssl cert verification Default: false
*/
Ssl *Ssl `yaml:"ssl,omitempty"`
/*Uaa - Descr: Symmetric secret used to decode uaa tokens. Used for testing. Default: <nil>
*/
Uaa *Uaa `yaml:"uaa,omitempty"`
/*Hm9000 - Descr: URL of the hm9000 server Default: <nil>
*/
Hm9000 *Hm9000 `yaml:"hm9000,omitempty"`
/*Name - Descr: 'name' attribute in the /v2/info endpoint Default:
*/
Name interface{} `yaml:"name,omitempty"`
/*MetronEndpoint - Descr: The host used to emit messages to the Metron agent Default: 127.0.0.1
*/
MetronEndpoint *MetronEndpoint `yaml:"metron_endpoint,omitempty"`
/*DeaNext - Descr: Memory limit in mb for staging tasks Default: 1024
*/
DeaNext *DeaNext `yaml:"dea_next,omitempty"`
/*Cc - Descr: The api key for NewRelic Default: <nil>
*/
Cc *Cc `yaml:"cc,omitempty"`
/*Version - Descr: 'version' attribute in the /v2/info endpoint Default: 0
*/
Version interface{} `yaml:"version,omitempty"`
/*Description - Descr: 'description' attribute in the /v2/info endpoint Default:
*/
Description interface{} `yaml:"description,omitempty"`
/*SystemDomain - Descr: Domain reserved for CF operator, base URL where the login, uaa, and other non-user apps listen Default: <nil>
*/
SystemDomain interface{} `yaml:"system_domain,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
type CompletedTasks ¶
type CompletedTasks struct {
/*CutoffAgeInDays - Descr: How long a completed task will stay in cloud controller database before being cleaned up based on last updated time with success or failure. Default: 31
*/
CutoffAgeInDays interface{} `yaml:"cutoff_age_in_days,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
type DeaNext ¶
type DeaNext struct {
/*StagingDiskLimitMb - Descr: Disk limit in mb for staging tasks Default: 6144
*/
StagingDiskLimitMb interface{} `yaml:"staging_disk_limit_mb,omitempty"`
/*StagingMemoryLimitMb - Descr: Memory limit in mb for staging tasks Default: 1024
*/
StagingMemoryLimitMb interface{} `yaml:"staging_memory_limit_mb,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
type Diego ¶
type Diego struct {
/*StagerUrl - Descr: URL of the Diego stager service Default: http://stager.service.cf.internal:8888
*/
StagerUrl interface{} `yaml:"stager_url,omitempty"`
/*TpsUrl - Descr: URL of the Diego tps service Default: http://tps.service.cf.internal:1518
*/
TpsUrl interface{} `yaml:"tps_url,omitempty"`
/*NsyncUrl - Descr: URL of the Diego nsync service Default: http://nsync.service.cf.internal:8787
*/
NsyncUrl interface{} `yaml:"nsync_url,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
type DropletDeletion ¶
type DropletDeletion struct {
/*TimeoutInSeconds - Descr: The longest this job can take before it is cancelled Default: <nil>
*/
TimeoutInSeconds interface{} `yaml:"timeout_in_seconds,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
type DropletUpload ¶
type DropletUpload struct {
/*TimeoutInSeconds - Descr: The longest this job can take before it is cancelled Default: <nil>
*/
TimeoutInSeconds interface{} `yaml:"timeout_in_seconds,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
type Droplets ¶
type Droplets struct {
/*FogConnection - Descr: Fog connection hash Default: <nil>
*/
FogConnection interface{} `yaml:"fog_connection,omitempty"`
/*WebdavConfig - Descr: The timeout in seconds for requests to the blobstore Default: 5
*/
WebdavConfig *DropletsWebdavConfig `yaml:"webdav_config,omitempty"`
/*Cdn - Descr: Private key for signing download URIs Default:
*/
Cdn *DropletsCdn `yaml:"cdn,omitempty"`
/*DropletDirectoryKey - Descr: Directory (bucket) used store droplets. It does not have be pre-created. Default: cc-droplets
*/
DropletDirectoryKey interface{} `yaml:"droplet_directory_key,omitempty"`
/*BlobstoreType - Descr: The type of blobstore backing to use. Valid values: ['fog', 'webdav'] Default: fog
*/
BlobstoreType interface{} `yaml:"blobstore_type,omitempty"`
/*FogAwsStorageOptions - Descr: Storage options passed to fog for aws blobstores. Valid keys: ['encryption']. Default: <nil>
*/
FogAwsStorageOptions interface{} `yaml:"fog_aws_storage_options,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
type DropletsCdn ¶
type DropletsCdn struct {
/*Uri - Descr: URI for a CDN to used for droplet downloads Default:
*/
Uri interface{} `yaml:"uri,omitempty"`
/*KeyPairId - Descr: Key pair name for signed download URIs Default:
*/
KeyPairId interface{} `yaml:"key_pair_id,omitempty"`
/*PrivateKey - Descr: Private key for signing download URIs Default:
*/
PrivateKey interface{} `yaml:"private_key,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
type DropletsWebdavConfig ¶
type DropletsWebdavConfig struct {
/*PublicEndpoint - Descr: The location of the webdav server eg: https://blobstore.com Default:
*/
PublicEndpoint interface{} `yaml:"public_endpoint,omitempty"`
/*Password - Descr: The basic auth password that CC uses to connect to the admin endpoint on webdav Default:
*/
Password interface{} `yaml:"password,omitempty"`
/*Username - Descr: The basic auth user that CC uses to connect to the admin endpoint on webdav Default:
*/
Username interface{} `yaml:"username,omitempty"`
/*PrivateEndpoint - Descr: The location of the webdav server eg: https://blobstore.internal Default: https://blobstore.service.cf.internal:4443
*/
PrivateEndpoint interface{} `yaml:"private_endpoint,omitempty"`
/*CaCert - Descr: The ca cert to use when communicating with webdav Default:
*/
CaCert interface{} `yaml:"ca_cert,omitempty"`
/*BlobstoreTimeout - Descr: The timeout in seconds for requests to the blobstore Default: 5
*/
BlobstoreTimeout interface{} `yaml:"blobstore_timeout,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
type FailedJobs ¶
type FailedJobs struct {
/*CutoffAgeInDays - Descr: How old a failed job should stay in cloud controller database before being cleaned up Default: 31
*/
CutoffAgeInDays interface{} `yaml:"cutoff_age_in_days,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
type Global ¶
type Global struct {
/*TimeoutInSeconds - Descr: The longest any job can take before it is cancelled unless overriden per job Default: 14400
*/
TimeoutInSeconds interface{} `yaml:"timeout_in_seconds,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
type Hm9000 ¶
type Hm9000 struct {
/*Port - Descr: Port of the hm9000 Api Server Default: <nil>
*/
Port interface{} `yaml:"port,omitempty"`
/*Url - Descr: URL of the hm9000 server Default: <nil>
*/
Url interface{} `yaml:"url,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
type Jobs ¶
type Jobs struct {
/*AppUsageEventsCleanup - Descr: The longest this job can take before it is cancelled Default: <nil>
*/
AppUsageEventsCleanup *AppUsageEventsCleanup `yaml:"app_usage_events_cleanup,omitempty"`
/*BlobstoreUpload - Descr: The longest this job can take before it is cancelled Default: <nil>
*/
BlobstoreUpload *BlobstoreUpload `yaml:"blobstore_upload,omitempty"`
/*Global - Descr: The longest any job can take before it is cancelled unless overriden per job Default: 14400
*/
Global *Global `yaml:"global,omitempty"`
/*AppEventsCleanup - Descr: The longest this job can take before it is cancelled Default: <nil>
*/
AppEventsCleanup *AppEventsCleanup `yaml:"app_events_cleanup,omitempty"`
/*AppBitsPacker - Descr: The longest this job can take before it is cancelled Default: <nil>
*/
AppBitsPacker *AppBitsPacker `yaml:"app_bits_packer,omitempty"`
/*DropletUpload - Descr: The longest this job can take before it is cancelled Default: <nil>
*/
DropletUpload *DropletUpload `yaml:"droplet_upload,omitempty"`
/*BlobstoreDelete - Descr: The longest this job can take before it is cancelled Default: <nil>
*/
BlobstoreDelete *BlobstoreDelete `yaml:"blobstore_delete,omitempty"`
/*DropletDeletion - Descr: The longest this job can take before it is cancelled Default: <nil>
*/
DropletDeletion *DropletDeletion `yaml:"droplet_deletion,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
type Jwt ¶
type Jwt struct {
/*VerificationKey - Descr: ssl cert defined in the manifest by the UAA, required by the cc to communicate with UAA Default:
*/
VerificationKey interface{} `yaml:"verification_key,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
type LoggerEndpoint ¶
type LoggerEndpoint struct {
/*UseSsl - Descr: Whether to use ssl for logger endpoint listed at /v2/info Default: true
*/
UseSsl interface{} `yaml:"use_ssl,omitempty"`
/*Port - Descr: Port for logger endpoint listed at /v2/info Default: 443
*/
Port interface{} `yaml:"port,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
type Login ¶
type Login struct {
/*Protocol - Descr: http or https Default: https
*/
Protocol interface{} `yaml:"protocol,omitempty"`
/*Enabled - Descr: whether use login as the authorization endpoint or not Default: true
*/
Enabled interface{} `yaml:"enabled,omitempty"`
/*Url - Descr: URL of the login server Default: <nil>
*/
Url interface{} `yaml:"url,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
type MetronEndpoint ¶
type MetronEndpoint struct {
/*Host - Descr: The host used to emit messages to the Metron agent Default: 127.0.0.1
*/
Host interface{} `yaml:"host,omitempty"`
/*Port - Descr: The port used to emit messages to the Metron agent Default: 3457
*/
Port interface{} `yaml:"port,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
type Nats ¶
type Nats struct {
/*Machines - Descr: IP of each NATS cluster member. Default: <nil>
*/
Machines interface{} `yaml:"machines,omitempty"`
/*User - Descr: Username for cc client to connect to NATS Default: <nil>
*/
User interface{} `yaml:"user,omitempty"`
/*Port - Descr: IP port of Cloud Foundry NATS server Default: <nil>
*/
Port interface{} `yaml:"port,omitempty"`
/*Password - Descr: Password for cc client to connect to NATS Default: <nil>
*/
Password interface{} `yaml:"password,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
type Newrelic ¶
type Newrelic struct {
/*MonitorMode - Descr: Activate NewRelic monitor mode Default: false
*/
MonitorMode interface{} `yaml:"monitor_mode,omitempty"`
/*LogFilePath - Descr: The location for NewRelic to log to Default: /var/vcap/sys/log/cloud_controller_ng/newrelic
*/
LogFilePath interface{} `yaml:"log_file_path,omitempty"`
/*LicenseKey - Descr: The api key for NewRelic Default: <nil>
*/
LicenseKey interface{} `yaml:"license_key,omitempty"`
/*DeveloperMode - Descr: Activate NewRelic developer mode Default: false
*/
DeveloperMode interface{} `yaml:"developer_mode,omitempty"`
/*TransactionTracer - Descr: Enable transaction tracing in NewRelic Default: false
*/
TransactionTracer *TransactionTracer `yaml:"transaction_tracer,omitempty"`
/*CaptureParams - Descr: Capture and send query params to NewRelic Default: false
*/
CaptureParams interface{} `yaml:"capture_params,omitempty"`
/*EnvironmentName - Descr: The environment name used by NewRelic Default: development
*/
EnvironmentName interface{} `yaml:"environment_name,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
type Packages ¶
type Packages struct {
/*FogConnection - Descr: Fog connection hash Default: <nil>
*/
FogConnection interface{} `yaml:"fog_connection,omitempty"`
/*MaxPackageSize - Descr: Maximum size of application package Default: 1073741824
*/
MaxPackageSize interface{} `yaml:"max_package_size,omitempty"`
/*BlobstoreType - Descr: The type of blobstore backing to use. Valid values: ['fog', 'webdav'] Default: fog
*/
BlobstoreType interface{} `yaml:"blobstore_type,omitempty"`
/*FogAwsStorageOptions - Descr: Storage options passed to fog for aws blobstores. Valid keys: ['encryption']. Default: <nil>
*/
FogAwsStorageOptions interface{} `yaml:"fog_aws_storage_options,omitempty"`
/*WebdavConfig - Descr: The location of the webdav server eg: https://blobstore.com Default:
*/
WebdavConfig *PackagesWebdavConfig `yaml:"webdav_config,omitempty"`
/*Cdn - Descr: Private key for signing download URIs Default:
*/
Cdn *PackagesCdn `yaml:"cdn,omitempty"`
/*AppPackageDirectoryKey - Descr: Directory (bucket) used store app packages. It does not have be pre-created. Default: cc-packages
*/
AppPackageDirectoryKey interface{} `yaml:"app_package_directory_key,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
type PackagesCdn ¶
type PackagesCdn struct {
/*KeyPairId - Descr: Key pair name for signed download URIs Default:
*/
KeyPairId interface{} `yaml:"key_pair_id,omitempty"`
/*Uri - Descr: URI for a CDN to used for app package downloads Default:
*/
Uri interface{} `yaml:"uri,omitempty"`
/*PrivateKey - Descr: Private key for signing download URIs Default:
*/
PrivateKey interface{} `yaml:"private_key,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
type PackagesWebdavConfig ¶
type PackagesWebdavConfig struct {
/*Username - Descr: The basic auth user that CC uses to connect to the admin endpoint on webdav Default:
*/
Username interface{} `yaml:"username,omitempty"`
/*CaCert - Descr: The ca cert to use when communicating with webdav Default:
*/
CaCert interface{} `yaml:"ca_cert,omitempty"`
/*PrivateEndpoint - Descr: The location of the webdav server eg: https://blobstore.internal Default: https://blobstore.service.cf.internal:4443
*/
PrivateEndpoint interface{} `yaml:"private_endpoint,omitempty"`
/*BlobstoreTimeout - Descr: The timeout in seconds for requests to the blobstore Default: 5
*/
BlobstoreTimeout interface{} `yaml:"blobstore_timeout,omitempty"`
/*Password - Descr: The basic auth password that CC uses to connect to the admin endpoint on webdav Default:
*/
Password interface{} `yaml:"password,omitempty"`
/*PublicEndpoint - Descr: The location of the webdav server eg: https://blobstore.com Default:
*/
PublicEndpoint interface{} `yaml:"public_endpoint,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
type PendingPackages ¶
type PendingPackages struct {
/*FrequencyInSeconds - Descr: How often the package pending cleanup job runs Default: 300
*/
FrequencyInSeconds interface{} `yaml:"frequency_in_seconds,omitempty"`
/*ExpirationInSeconds - Descr: How long packages can remain in pending state before being cleaned up Default: 1200
*/
ExpirationInSeconds interface{} `yaml:"expiration_in_seconds,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
type Renderer ¶
type Renderer struct {
/*MaxInlineRelationsDepth - Descr: Maximum depth of inlined relationships in the result Default: 2
*/
MaxInlineRelationsDepth interface{} `yaml:"max_inline_relations_depth,omitempty"`
/*MaxResultsPerPage - Descr: Maximum number of results returned per page Default: 100
*/
MaxResultsPerPage interface{} `yaml:"max_results_per_page,omitempty"`
/*DefaultResultsPerPage - Descr: Default number of results returned per page if user does not specify Default: 50
*/
DefaultResultsPerPage interface{} `yaml:"default_results_per_page,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
type ResourcePool ¶
type ResourcePool struct {
/*MaximumSize - Descr: Maximum size of a resource to add to the pool Default: 536870912
*/
MaximumSize interface{} `yaml:"maximum_size,omitempty"`
/*MinimumSize - Descr: Minimum size of a resource to add to the pool Default: 65536
*/
MinimumSize interface{} `yaml:"minimum_size,omitempty"`
/*WebdavConfig - Descr: The timeout in seconds for requests to the blobstore Default: 5
*/
WebdavConfig *ResourcePoolWebdavConfig `yaml:"webdav_config,omitempty"`
/*FogConnection - Descr: Fog connection hash Default: <nil>
*/
FogConnection interface{} `yaml:"fog_connection,omitempty"`
/*Cdn - Descr: Private key for signing download URIs Default:
*/
Cdn *ResourcePoolCdn `yaml:"cdn,omitempty"`
/*BlobstoreType - Descr: The type of blobstore backing to use. Valid values: ['fog', 'webdav'] Default: fog
*/
BlobstoreType interface{} `yaml:"blobstore_type,omitempty"`
/*ResourceDirectoryKey - Descr: Directory (bucket) used store app resources. It does not have be pre-created. Default: cc-resources
*/
ResourceDirectoryKey interface{} `yaml:"resource_directory_key,omitempty"`
/*FogAwsStorageOptions - Descr: Storage options passed to fog for aws blobstores. Valid keys: ['encryption']. Default: <nil>
*/
FogAwsStorageOptions interface{} `yaml:"fog_aws_storage_options,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
type ResourcePoolCdn ¶
type ResourcePoolCdn struct {
/*Uri - Descr: URI for a CDN to used for resource pool downloads Default:
*/
Uri interface{} `yaml:"uri,omitempty"`
/*PrivateKey - Descr: Private key for signing download URIs Default:
*/
PrivateKey interface{} `yaml:"private_key,omitempty"`
/*KeyPairId - Descr: Key pair name for signed download URIs Default:
*/
KeyPairId interface{} `yaml:"key_pair_id,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
type ResourcePoolWebdavConfig ¶
type ResourcePoolWebdavConfig struct {
/*Username - Descr: The basic auth user that CC uses to connect to the admin endpoint on webdav Default:
*/
Username interface{} `yaml:"username,omitempty"`
/*PrivateEndpoint - Descr: The location of the webdav server eg: https://blobstore.internal Default: https://blobstore.service.cf.internal:4443
*/
PrivateEndpoint interface{} `yaml:"private_endpoint,omitempty"`
/*Password - Descr: The basic auth password that CC uses to connect to the admin endpoint on webdav Default:
*/
Password interface{} `yaml:"password,omitempty"`
/*PublicEndpoint - Descr: The location of the webdav server eg: https://blobstore.com Default:
*/
PublicEndpoint interface{} `yaml:"public_endpoint,omitempty"`
/*CaCert - Descr: The ca cert to use when communicating with webdav Default:
*/
CaCert interface{} `yaml:"ca_cert,omitempty"`
/*BlobstoreTimeout - Descr: The timeout in seconds for requests to the blobstore Default: 5
*/
BlobstoreTimeout interface{} `yaml:"blobstore_timeout,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
type ServiceUsageEvents ¶
type ServiceUsageEvents struct {
/*CutoffAgeInDays - Descr: How old a service usage event should stay in cloud controller database before being cleaned up Default: 31
*/
CutoffAgeInDays interface{} `yaml:"cutoff_age_in_days,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
type Ssl ¶
type Ssl struct {
/*SkipCertVerify - Descr: specifies that the job is allowed to skip ssl cert verification Default: false
*/
SkipCertVerify interface{} `yaml:"skip_cert_verify,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
type Thresholds ¶
type Thresholds struct {
/*Api - Descr: The cc will alert if memory remains above this threshold for 3 monit cycles Default: 3500
*/
Api *Api `yaml:"api,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
type TransactionTracer ¶
type TransactionTracer struct {
/*RecordSql - Descr: NewRelic's SQL statement recording mode: [off | obfuscated | raw] Default: off
*/
RecordSql interface{} `yaml:"record_sql,omitempty"`
/*Enabled - Descr: Enable transaction tracing in NewRelic Default: false
*/
Enabled interface{} `yaml:"enabled,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
type Uaa ¶
type Uaa struct {
/*Clients - Descr: Used for generating SSO clients for service brokers. Default: <nil>
*/
Clients *Clients `yaml:"clients,omitempty"`
/*Jwt - Descr: ssl cert defined in the manifest by the UAA, required by the cc to communicate with UAA Default:
*/
Jwt *Jwt `yaml:"jwt,omitempty"`
/*Url - Descr: URL of the UAA server Default: <nil>
*/
Url interface{} `yaml:"url,omitempty"`
/*Cc - Descr: Symmetric secret used to decode uaa tokens. Used for testing. Default: <nil>
*/
Cc *UaaCc `yaml:"cc,omitempty"`
}
* File Generated by enaml generator * !!! Please do not edit this file !!!
Source Files
¶
- api.go
- appbitspacker.go
- appevents.go
- appeventscleanup.go
- appusageevents.go
- appusageeventscleanup.go
- auditevents.go
- blobstoredelete.go
- blobstoreupload.go
- buildpacks.go
- buildpackscdn.go
- buildpackswebdavconfig.go
- cc.go
- ccdb.go
- ccservicebrokerclient.go
- ccservicedashboards.go
- clients.go
- cloudcontrollerclockjob.go
- completedtasks.go
- deanext.go
- diego.go
- dropletdeletion.go
- droplets.go
- dropletscdn.go
- dropletswebdavconfig.go
- dropletupload.go
- failedjobs.go
- global.go
- hm9000.go
- jobs.go
- jwt.go
- loggerendpoint.go
- login.go
- metronendpoint.go
- nats.go
- newrelic.go
- packages.go
- packagescdn.go
- packageswebdavconfig.go
- pendingpackages.go
- renderer.go
- resourcepool.go
- resourcepoolcdn.go
- resourcepoolwebdavconfig.go
- serviceusageevents.go
- ssl.go
- thresholds.go
- transactiontracer.go
- uaa.go
- uaacc.go