cpi

Documentation

Index

• type Actions
• type Agent
• type AgentBlobstore
• type AgentNats
• type Azure
• type Blobstore
• type BlobstoreAgent
• type Cpi
• type CpiAgent
• type CpiJob
• type Env
• type Nats
• type Photon
• type Registry

Types

type Actions

type Actions struct {

	/*GuestPersistentBindMountsDir - Descr: Directory with sub-directories at which persistent disks are mounted inside VMs Default: /photon-cpi-dev
	 */
	GuestPersistentBindMountsDir interface{} `yaml:"guest_persistent_bind_mounts_dir,omitempty"`

	/*HostEphemeralBindMountsDir - Descr: Directory with sub-directories at which ephemeral disks are mounted on the host Default: /var/vcap/store/cpi/ephemeral_bind_mounts_dir
	 */
	HostEphemeralBindMountsDir interface{} `yaml:"host_ephemeral_bind_mounts_dir,omitempty"`

	/*StemcellsDir - Descr: Directory where stemcells are stored Default: /var/vcap/store/cpi/stemcells
	 */
	StemcellsDir interface{} `yaml:"stemcells_dir,omitempty"`

	/*HostPersistentBindMountsDir - Descr: Directory with sub-directories at which persistent disks are mounted on the host Default: /var/vcap/store/cpi/persistent_bind_mounts_dir
	 */
	HostPersistentBindMountsDir interface{} `yaml:"host_persistent_bind_mounts_dir,omitempty"`

	/*AgentEnvService - Descr: Type of Agent Env Service to use, e.g. registry or file Default: file
	 */
	AgentEnvService interface{} `yaml:"agent_env_service,omitempty"`

	/*DisksDir - Descr: Directory where disks are stored Default: /var/vcap/store/cpi/disks
	 */
	DisksDir interface{} `yaml:"disks_dir,omitempty"`

	/*Registry - Descr: Port of registry Default: 6301
	 */
	Registry *Registry `yaml:"registry,omitempty"`

	/*GuestEphemeralBindMountPath - Descr: Path at which ephemeral disk is mounted inside VMs Default: /var/vcap/data
	 */
	GuestEphemeralBindMountPath interface{} `yaml:"guest_ephemeral_bind_mount_path,omitempty"`
}

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

type Agent

type Agent struct {

	/*Mbus - Descr: Mbus URL used by deployed BOSH agents Default:
	 */
	Mbus interface{} `yaml:"mbus,omitempty"`
}

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

type AgentBlobstore

type AgentBlobstore struct {

	/*Provider - Descr: Provider type for the blobstore used by deployed BOSH agents (e.g. dav, s3) Default: dav
	 */
	Provider interface{} `yaml:"provider,omitempty"`

	/*Options - Descr: Options for the blobstore used by deployed BOSH agents Default: map[]
	 */
	Options interface{} `yaml:"options,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 {

	/*Provider - Descr: Provider type for the blobstore used by deployed BOSH agents (e.g. dav, s3) Default:
	 */
	Provider interface{} `yaml:"provider,omitempty"`

	/*Options - Descr: Options for the blobstore used by deployed BOSH agents Default: map[]
	 */
	Options interface{} `yaml:"options,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 Cpi

type Cpi struct {

	/*Agent - Descr: Options for the blobstore used by deployed BOSH agents Default: map[]
	 */
	Agent *CpiAgent `yaml:"agent,omitempty"`

	/*Actions - Descr: Port of registry Default: 6301
	 */
	Actions *Actions `yaml:"actions,omitempty"`

	/*HostIp - Descr: IP address of the host that will be used by containers, must be the same as mbus IP Default: <nil>
	 */
	HostIp interface{} `yaml:"host_ip,omitempty"`
}

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

type CpiAgent

type CpiAgent struct {

	/*Blobstore - Descr: Options for the blobstore used by deployed BOSH agents Default: map[]
	 */
	Blobstore *AgentBlobstore `yaml:"blobstore,omitempty"`

	/*Ntp - Descr: NTP configuration used by deployed BOSH agents Default: []
	 */
	Ntp interface{} `yaml:"ntp,omitempty"`
}

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

type CpiJob

type CpiJob struct {

	/*Cpi - Descr: Options for the blobstore used by deployed BOSH agents Default: map[]
	 */
	Cpi *Cpi `yaml:"cpi,omitempty"`

	/*Photon - Descr: Photon user's password Default:
	 */
	Photon *Photon `yaml:"photon,omitempty"`

	/*Agent - Descr: Mbus URL used by deployed BOSH agents Default:
	 */
	Agent *Agent `yaml:"agent,omitempty"`

	/*Blobstore - Descr: Provider type for the blobstore used by deployed BOSH agents (e.g. dav, s3) Default:
	 */
	Blobstore *Blobstore `yaml:"blobstore,omitempty"`

	/*Ntp - Descr: ntp Default:
	 */
	Ntp interface{} `yaml:"ntp,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 Photon

type Photon struct {

	/*Project - Descr: Photon project Default:
	 */
	Project interface{} `yaml:"project,omitempty"`

	/*Password - Descr: Photon user's password Default:
	 */
	Password interface{} `yaml:"password,omitempty"`

	/*Target - Descr: Photon API-FE target Default:
	 */
	Target interface{} `yaml:"target,omitempty"`

	/*IgnoreCert - Descr: Whether to ignore certs check Default: true
	 */
	IgnoreCert interface{} `yaml:"ignore_cert,omitempty"`

	/*User - Descr: Photon user Default:
	 */
	User interface{} `yaml:"user,omitempty"`
}

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

type Registry

type Registry struct {

	/*Port - Descr: Port of registry Default: 6301
	 */
	Port interface{} `yaml:"port,omitempty"`

	/*Username - Descr: Username for registry Default:
	 */
	Username interface{} `yaml:"username,omitempty"`

	/*Password - Descr: Password for registry Default:
	 */
	Password interface{} `yaml:"password,omitempty"`

	/*Host - Descr: Hostname of registry Default:
	 */
	Host interface{} `yaml:"host,omitempty"`
}

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