cpi

Documentation

Index

• type Agent
• type AgentBlobstore
• type AgentNats
• type Azure
• type Blobstore
• type BlobstoreAgent
• type CpiJob
• type Env
• type Nats
• type Registry

Types

type Agent

type Agent struct {

	/*Nats - Descr: Address of the nats server Default: <nil>
	 */
	Nats *AgentNats `yaml:"nats,omitempty"`

	/*Mbus - Descr: Agent mbus Default: <nil>
	 */
	Mbus interface{} `yaml:"mbus,omitempty"`

	/*Blobstore - Descr: AWS access_key_id for agent used by s3 blobstore plugin Default: <nil>
	 */
	Blobstore *AgentBlobstore `yaml:"blobstore,omitempty"`
}

* File Generated by enaml generator * !!! Please do not edit this file !!!

type AgentBlobstore

type AgentBlobstore struct {

	/*SecretAccessKey - Descr: AWS secret_access_key for agent used by s3 blobstore plugin Default: <nil>
	 */
	SecretAccessKey interface{} `yaml:"secret_access_key,omitempty"`

	/*Address - Descr: Address for agent to connect to blobstore server used by simple blobstore plugin Default: <nil>
	 */
	Address interface{} `yaml:"address,omitempty"`

	/*AccessKeyId - Descr: AWS access_key_id for agent used by s3 blobstore plugin Default: <nil>
	 */
	AccessKeyId interface{} `yaml:"access_key_id,omitempty"`
}

* File Generated by enaml generator * !!! Please do not edit this file !!!

type AgentNats

type AgentNats struct {

	/*Address - Descr: Address of the nats server Default: <nil>
	 */
	Address interface{} `yaml:"address,omitempty"`
}

* File Generated by enaml generator * !!! Please do not edit this file !!!

type Azure

type Azure struct {

	/*SshUser - Descr: Default ssh user to use when spinning up new vms Default: vcap
	 */
	SshUser interface{} `yaml:"ssh_user,omitempty"`

	/*ResourceGroupName - Descr: Resource group name to use when spinning up new vms Default: <nil>
	 */
	ResourceGroupName interface{} `yaml:"resource_group_name,omitempty"`

	/*ClientSecret - Descr: The client secret for your service principal Default: <nil>
	 */
	ClientSecret interface{} `yaml:"client_secret,omitempty"`

	/*ParallelUploadThreadNum - Descr: The number of threads to upload stemcells in parallel Default: 16
	 */
	ParallelUploadThreadNum interface{} `yaml:"parallel_upload_thread_num,omitempty"`

	/*StorageAccountName - Descr: Azure storage account name Default: <nil>
	 */
	StorageAccountName interface{} `yaml:"storage_account_name,omitempty"`

	/*SshPublicKey - Descr: The content of the SSH public key to use when spinning up new vms Default: <nil>
	 */
	SshPublicKey interface{} `yaml:"ssh_public_key,omitempty"`

	/*Environment - Descr: The environment for Azure Management Service, AzureCloud, AzureChinaCloud or AzureStack Default: AzureCloud
	 */
	Environment interface{} `yaml:"environment,omitempty"`

	/*DebugMode - Descr: Enable debug mode to log all raw HTTP requests/responses Default: false
	 */
	DebugMode interface{} `yaml:"debug_mode,omitempty"`

	/*AzureStackDomain - Descr: The domain for your AzureStack deployment Default: <nil>
	 */
	AzureStackDomain interface{} `yaml:"azure_stack_domain,omitempty"`

	/*DefaultSecurityGroup - Descr: The name of the default security group that will be applied to all created VMs Default: <nil>
	 */
	DefaultSecurityGroup interface{} `yaml:"default_security_group,omitempty"`

	/*ClientId - Descr: The client id for your service principal Default: <nil>
	 */
	ClientId interface{} `yaml:"client_id,omitempty"`

	/*SubscriptionId - Descr: Azure Subscription Id Default: <nil>
	 */
	SubscriptionId interface{} `yaml:"subscription_id,omitempty"`

	/*AzureStackAuthentication - Descr: The authentication type for your AzureStack deployment. AzureAD, AzureStackAD or AzureStack Default: <nil>
	 */
	AzureStackAuthentication interface{} `yaml:"azure_stack_authentication,omitempty"`

	/*TenantId - Descr: The tenant id for your service principal Default: <nil>
	 */
	TenantId interface{} `yaml:"tenant_id,omitempty"`
}

* File Generated by enaml generator * !!! Please do not edit this file !!!

type Blobstore

type Blobstore struct {

	/*UseSsl - Descr: Whether the simple blobstore plugin should use SSL to connect to the blobstore server Default: true
	 */
	UseSsl interface{} `yaml:"use_ssl,omitempty"`

	/*Provider - Descr: Provider of the blobstore used by director and agent (dav|simple|s3) Default: dav
	 */
	Provider interface{} `yaml:"provider,omitempty"`

	/*AccessKeyId - Descr: AWS access_key_id used by s3 blobstore plugin Default: <nil>
	 */
	AccessKeyId interface{} `yaml:"access_key_id,omitempty"`

	/*Path - Descr: local blobstore path Default: <nil>
	 */
	Path interface{} `yaml:"path,omitempty"`

	/*BucketName - Descr: AWS S3 Bucket used by s3 blobstore plugin Default: <nil>
	 */
	BucketName interface{} `yaml:"bucket_name,omitempty"`

	/*S3ForcePathStyle - Descr: Whether s3 blobstore plugin will always use path style for bucket access Default: false
	 */
	S3ForcePathStyle interface{} `yaml:"s3_force_path_style,omitempty"`

	/*Host - Descr: Host of blobstore server used by simple blobstore plugin Default: <nil>
	 */
	Host interface{} `yaml:"host,omitempty"`

	/*Address - Descr: Address of blobstore server used by simple blobstore plugin Default: <nil>
	 */
	Address interface{} `yaml:"address,omitempty"`

	/*Port - Descr: Port of blobstore server used by simple blobstore plugin Default: 25250
	 */
	Port interface{} `yaml:"port,omitempty"`

	/*Agent - Descr: Password agent uses to connect to blobstore used by simple blobstore plugin Default: <nil>
	 */
	Agent *BlobstoreAgent `yaml:"agent,omitempty"`

	/*S3Port - Descr: Port of blobstore server used by s3 blobstore plugin Default: 443
	 */
	S3Port interface{} `yaml:"s3_port,omitempty"`

	/*SecretAccessKey - Descr: AWS secret_access_key used by s3 blobstore plugin Default: <nil>
	 */
	SecretAccessKey interface{} `yaml:"secret_access_key,omitempty"`
}

* File Generated by enaml generator * !!! Please do not edit this file !!!

type BlobstoreAgent

type BlobstoreAgent struct {

	/*Password - Descr: Password agent uses to connect to blobstore used by simple blobstore plugin Default: <nil>
	 */
	Password interface{} `yaml:"password,omitempty"`

	/*User - Descr: Username agent uses to connect to blobstore used by simple blobstore plugin Default: <nil>
	 */
	User interface{} `yaml:"user,omitempty"`
}

* File Generated by enaml generator * !!! Please do not edit this file !!!

type CpiJob

type CpiJob struct {

	/*Ntp - Descr: List of ntp server IPs. pool.ntp.org attempts to return IPs closest to your location, but you can still specify if needed. Default: [0.pool.ntp.org 1.pool.ntp.org]
	 */
	Ntp interface{} `yaml:"ntp,omitempty"`

	/*Nats - Descr: Address of the nats server Default: <nil>
	 */
	Nats *Nats `yaml:"nats,omitempty"`

	/*Registry - Descr: User to access the Registry Default: <nil>
	 */
	Registry *Registry `yaml:"registry,omitempty"`

	/*Blobstore - Descr: Port of blobstore server used by simple blobstore plugin Default: 25250
	 */
	Blobstore *Blobstore `yaml:"blobstore,omitempty"`

	/*Azure - Descr: The tenant id for your service principal Default: <nil>
	 */
	Azure *Azure `yaml:"azure,omitempty"`

	/*Agent - Descr: AWS access_key_id for agent used by s3 blobstore plugin Default: <nil>
	 */
	Agent *Agent `yaml:"agent,omitempty"`

	/*Env - Descr: Http proxy to connect to cloud API's Default: <nil>
	 */
	Env *Env `yaml:"env,omitempty"`
}

* File Generated by enaml generator * !!! Please do not edit this file !!!

type Env

type Env struct {

	/*HttpsProxy - Descr: Https proxy to connect to cloud API's Default: <nil>
	 */
	HttpsProxy interface{} `yaml:"https_proxy,omitempty"`

	/*NoProxy - Descr: No proxy environment variable Default: <nil>
	 */
	NoProxy interface{} `yaml:"no_proxy,omitempty"`

	/*HttpProxy - Descr: Http proxy to connect to cloud API's Default: <nil>
	 */
	HttpProxy interface{} `yaml:"http_proxy,omitempty"`
}

* File Generated by enaml generator * !!! Please do not edit this file !!!

type Nats

type Nats struct {

	/*User - Descr: Username to connect to nats with Default: nats
	 */
	User interface{} `yaml:"user,omitempty"`

	/*Address - Descr: Address of the nats server Default: <nil>
	 */
	Address interface{} `yaml:"address,omitempty"`

	/*Port - Descr: Port that the nats server listens on Default: 4222
	 */
	Port interface{} `yaml:"port,omitempty"`

	/*Password - Descr: Password to connect to nats with Default: <nil>
	 */
	Password interface{} `yaml:"password,omitempty"`
}

* File Generated by enaml generator * !!! Please do not edit this file !!!

type Registry

type Registry struct {

	/*Password - Descr: Password to access the Registry Default: <nil>
	 */
	Password interface{} `yaml:"password,omitempty"`

	/*Port - Descr: Port of the Registry to connect to Default: 25777
	 */
	Port interface{} `yaml:"port,omitempty"`

	/*Host - Descr: Address of the Registry to connect to Default: <nil>
	 */
	Host interface{} `yaml:"host,omitempty"`

	/*Endpoint - Descr: Full URL for the registry endpoint that may include basic auth credentials Default: <nil>
	 */
	Endpoint interface{} `yaml:"endpoint,omitempty"`

	/*Username - Descr: User to access the Registry Default: <nil>
	 */
	Username interface{} `yaml:"username,omitempty"`
}

* File Generated by enaml generator * !!! Please do not edit this file !!!