service_backup

Documentation

Index

• type Azure
• type Destination
• type S3
• type Scp
• type ServiceBackup
• type ServiceBackupJob

Types

type Azure

type Azure struct {

	/*StorageAccount - Descr: Azure account name to access the storage service Default: <nil>
	 */
	StorageAccount interface{} `yaml:"storage_account,omitempty"`

	/*Container - Descr: Container to which backups are uploaded Default: <nil>
	 */
	Container interface{} `yaml:"container,omitempty"`

	/*BlobStoreBaseUrl - Descr: Path in url to which backups are uploaded Default: core.windows.net
	 */
	BlobStoreBaseUrl interface{} `yaml:"blob_store_base_url,omitempty"`

	/*StorageAccessKey - Descr: Azure access key to access the storage service Default: <nil>
	 */
	StorageAccessKey interface{} `yaml:"storage_access_key,omitempty"`

	/*Path - Descr: Path in container to which backups are uploaded Default: <nil>
	 */
	Path interface{} `yaml:"path,omitempty"`
}

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

type Destination

type Destination struct {

	/*S3 - Descr: Bucket to which backups are uploaded Default: <nil>
	 */
	S3 *S3 `yaml:"s3,omitempty"`

	/*Scp - Descr: SSH port on remote server Default: 22
	 */
	Scp *Scp `yaml:"scp,omitempty"`

	/*Azure - Descr: Path in container to which backups are uploaded Default: <nil>
	 */
	Azure *Azure `yaml:"azure,omitempty"`
}

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

type S3

type S3 struct {

	/*BucketPath - Descr: Path in bucket to which backups are uploaded Default: <nil>
	 */
	BucketPath interface{} `yaml:"bucket_path,omitempty"`

	/*EndpointUrl - Descr: URL of the blobstore endpoint. Override this to use an S3-compatible blobstore like RiakS2. Default: https://s3.amazonaws.com
	 */
	EndpointUrl interface{} `yaml:"endpoint_url,omitempty"`

	/*AccessKeyId - Descr: AWS Access Key to access the blobstore Default: <nil>
	 */
	AccessKeyId interface{} `yaml:"access_key_id,omitempty"`

	/*SecretAccessKey - Descr: AWS Secret Access Key to access the blobstore Default: <nil>
	 */
	SecretAccessKey interface{} `yaml:"secret_access_key,omitempty"`

	/*BucketName - Descr: Bucket to which backups are uploaded Default: <nil>
	 */
	BucketName interface{} `yaml:"bucket_name,omitempty"`
}

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

type Scp

type Scp struct {

	/*Key - Descr: SSH key identity file for remote server Default: <nil>
	 */
	Key interface{} `yaml:"key,omitempty"`

	/*User - Descr: SCP user on remote server Default: <nil>
	 */
	User interface{} `yaml:"user,omitempty"`

	/*Server - Descr: SCP remote server host Default: <nil>
	 */
	Server interface{} `yaml:"server,omitempty"`

	/*Destination - Descr: Remote path on server for upload Default: <nil>
	 */
	Destination interface{} `yaml:"destination,omitempty"`

	/*Port - Descr: SSH port on remote server Default: 22
	 */
	Port interface{} `yaml:"port,omitempty"`
}

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

type ServiceBackup

type ServiceBackup struct {

	/*CleanupExecutable - Descr: Local executable to cleanup backups. Tokens are split on spaces; first is command to execute and remaining are passed as args to command. Default:
	 */
	CleanupExecutable interface{} `yaml:"cleanup_executable,omitempty"`

	/*ServiceIdentifierExecutable - Descr: Local executable to identify the service. If provided the identifier is included in log messages. Tokens are split on spaces; first is command to execute and remaining are passed as args to command. Default: <nil>
	 */
	ServiceIdentifierExecutable interface{} `yaml:"service_identifier_executable,omitempty"`

	/*Destination - Descr: Path in container to which backups are uploaded Default: <nil>
	 */
	Destination *Destination `yaml:"destination,omitempty"`

	/*ExitIfInProgress - Descr: Optional field to reject subsequent backup requests if a backup is already in progress. Defaults to false. Default: false
	 */
	ExitIfInProgress interface{} `yaml:"exit_if_in_progress,omitempty"`

	/*SourceFolder - Descr: Local path from which backups are uploaded. All files in here are uploaded. Default: <nil>
	 */
	SourceFolder interface{} `yaml:"source_folder,omitempty"`

	/*MissingPropertiesMessage - Descr: Custom message to show when required backup parameters are not present. Default: Provide these missing fields in your manifest.
	 */
	MissingPropertiesMessage interface{} `yaml:"missing_properties_message,omitempty"`

	/*SourceExecutable - Descr: Local executable to create backups. Tokens are split on spaces; first is command to execute and remaining are passed as args to command. Default: <nil>
	 */
	SourceExecutable interface{} `yaml:"source_executable,omitempty"`

	/*CronSchedule - Descr: Schedule on which to perform backups. Supports "* * * * *" syntax. Default: <nil>
	 */
	CronSchedule interface{} `yaml:"cron_schedule,omitempty"`
}

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

type ServiceBackupJob

type ServiceBackupJob struct {

	/*ServiceBackup - Descr: Schedule on which to perform backups. Supports "* * * * *" syntax. Default: <nil>
	 */
	ServiceBackup *ServiceBackup `yaml:"service-backup,omitempty"`
}

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