Documentation ¶
Index ¶
- Constants
- Variables
- func NewEnvFactory(deps BasicDeps, manifestPath string, manifestVars boshtpl.Variables, ...) *envFactory
- func NewValueStringPercent(str string) boshtbl.Value
- type AddBlobArgs
- type AddBlobCmd
- type AddBlobOpts
- type AliasEnvArgs
- type AliasEnvCmd
- type AliasEnvOpts
- type AllOrInstanceGroupOrInstanceSlugArgs
- type BackUpArgs
- type BackUpOpts
- type BasicDeps
- type BasicLoginStrategy
- type BlobsCmd
- type BlobsOpts
- type BoolArg
- type BoshOpts
- type BuildManifestArgs
- type BuildManifestCmd
- type BuildManifestOpts
- type CancelTaskCmd
- type CancelTaskOpts
- type CleanUpCmd
- type CleanUpOpts
- type CloudCheckCmd
- type CloudCheckOpts
- type CloudConfigCmd
- type CloudConfigOpts
- type Cmd
- type CreateEnvArgs
- type CreateEnvCmd
- type CreateEnvOpts
- type CreateReleaseArgs
- type CreateReleaseCmd
- type CreateReleaseOpts
- type DeleteCmd
- type DeleteDeploymentCmd
- type DeleteDeploymentOpts
- type DeleteDiskArgs
- type DeleteDiskCmd
- type DeleteDiskOpts
- type DeleteEnvArgs
- type DeleteEnvOpts
- type DeleteReleaseArgs
- type DeleteReleaseCmd
- type DeleteReleaseOpts
- type DeleteSnapshotArgs
- type DeleteSnapshotCmd
- type DeleteSnapshotOpts
- type DeleteSnapshotsCmd
- type DeleteSnapshotsOpts
- type DeleteStemcellArgs
- type DeleteStemcellCmd
- type DeleteStemcellOpts
- type DeleteVMArgs
- type DeleteVMCmd
- type DeleteVMOpts
- type DeployArgs
- type DeployCmd
- type DeployOpts
- type DeploymentCmd
- type DeploymentDeleter
- type DeploymentManifestParser
- type DeploymentOpts
- type DeploymentPreparer
- type DeploymentsCmd
- type DeploymentsOpts
- type DeploymentsTable
- type DirOrCWDArg
- type DisksCmd
- type DisksOpts
- type Downloader
- type EnvironmentCmd
- type EnvironmentOpts
- type EnvironmentsCmd
- type EnvironmentsOpts
- type ErrandsCmd
- type ErrandsOpts
- type EventsCmd
- type EventsOpts
- type ExportReleaseArgs
- type ExportReleaseCmd
- type ExportReleaseOpts
- type Factory
- type FileBytesArg
- type FileBytesWithPathArg
- type FinalizeReleaseArgs
- type FinalizeReleaseCmd
- type FinalizeReleaseOpts
- type GatewayFlags
- type GenerateJobArgs
- type GenerateJobCmd
- type GenerateJobOpts
- type GeneratePackageArgs
- type GeneratePackageCmd
- type GeneratePackageOpts
- type HelpOpts
- type IgnoreCmd
- type IgnoreOpts
- type InfoFeatureSorting
- type InfoTable
- type InitReleaseCmd
- type InitReleaseOpts
- type InspectReleaseArgs
- type InspectReleaseCmd
- type InspectReleaseOpts
- type InstanceSlugArgs
- type InstanceTable
- type InstanceTableValues
- type InstancesCmd
- type InstancesOpts
- type LocksCmd
- type LocksOpts
- type LogInCmd
- type LogInOpts
- type LogOutCmd
- type LogOutOpts
- type LoginStrategy
- type LogsCmd
- type LogsOpts
- type ManifestCmd
- type ManifestOpts
- type MessageOpts
- type OpsFileArg
- type OpsFlags
- type RecreateCmd
- type RecreateOpts
- type ReleaseCreatingCmd
- type ReleaseManager
- type ReleaseSetAndInstallationManifestParser
- type ReleaseTables
- type ReleaseUploader
- type ReleaseUploadingCmd
- type ReleasesCmd
- type ReleasesOpts
- type RemoveBlobArgs
- type RemoveBlobCmd
- type RemoveBlobOpts
- type ResetReleaseCmd
- type ResetReleaseOpts
- type RestartCmd
- type RestartOpts
- type RunErrandArgs
- type RunErrandCmd
- type RunErrandOpts
- type RuntimeConfigCmd
- type RuntimeConfigOpts
- type SCPArgs
- type SCPCmd
- type SCPOpts
- type SSHCmd
- type SSHOpts
- type Session
- type SessionContext
- type SessionContextImpl
- type SessionImpl
- func (c SessionImpl) AnonymousDirector() (boshdir.Director, error)
- func (c SessionImpl) Credentials() cmdconf.Creds
- func (c *SessionImpl) Deployment() (boshdir.Deployment, error)
- func (c *SessionImpl) Director() (boshdir.Director, error)
- func (c SessionImpl) Environment() string
- func (c SessionImpl) UAA() (boshuaa.UAA, error)
- type SnapshotsCmd
- type SnapshotsOpts
- type StartCmd
- type StartOpts
- type StemcellsCmd
- type StemcellsOpts
- type StopCmd
- type StopOpts
- type SyncBlobsCmd
- type SyncBlobsOpts
- type TakeSnapshotCmd
- type TakeSnapshotOpts
- type TaskArgs
- type TaskCmd
- type TaskOpts
- type TasksCmd
- type TasksOpts
- type TempRootConfigurator
- type TrimmedSpaceArgs
- type UAALoginStrategy
- type UIDownloader
- type URLArg
- type UnignoreCmd
- type UnignoreOpts
- type UpdateCloudConfigArgs
- type UpdateCloudConfigCmd
- type UpdateCloudConfigOpts
- type UpdateResurrectionArgs
- type UpdateResurrectionCmd
- type UpdateResurrectionOpts
- type UpdateRuntimeConfigArgs
- type UpdateRuntimeConfigCmd
- type UpdateRuntimeConfigOpts
- type UploadBlobsCmd
- type UploadBlobsOpts
- type UploadReleaseArgs
- type UploadReleaseCmd
- type UploadReleaseOpts
- type UploadStemcellArgs
- type UploadStemcellCmd
- type UploadStemcellOpts
- type VMsCmd
- type VMsOpts
- type ValueCPUTotal
- type ValueDiskSize
- type ValueMemIntSize
- type ValueMemSize
- type ValueUptime
- type VarFlags
- type VersionArg
Constants ¶
View Source
const VersionLabel = "[DEV BUILD]"
Variables ¶
View Source
var InstanceTableHeader = InstanceTableValues{ Name: boshtbl.NewValueString("Instance"), Process: boshtbl.NewValueString("Process"), ProcessState: boshtbl.NewValueString("Process State"), AZ: boshtbl.NewValueString("AZ"), VMType: boshtbl.NewValueString("VM Type"), IPs: boshtbl.NewValueString("IPs"), State: boshtbl.NewValueString("State"), VMCID: boshtbl.NewValueString("VM CID"), DiskCIDs: boshtbl.NewValueString("Disk CIDs"), AgentID: boshtbl.NewValueString("Agent ID"), Resurrection: boshtbl.NewValueString("Resurrection\nPaused"), Ignore: boshtbl.NewValueString("Ignore"), DNS: boshtbl.NewValueString("DNS A Records"), Uptime: boshtbl.NewValueString("Uptime"), Load: boshtbl.NewValueString("Load\n(1m, 5m, 15m)"), CPUTotal: boshtbl.NewValueString("CPU\nTotal"), CPUUser: boshtbl.NewValueString("CPU\nUser"), CPUSys: boshtbl.NewValueString("CPU\nSys"), CPUWait: boshtbl.NewValueString("CPU\nWait"), Memory: boshtbl.NewValueString("Memory\nUsage"), Swap: boshtbl.NewValueString("Swap\nUsage"), SystemDisk: boshtbl.NewValueString("System\nDisk Usage"), EphemeralDisk: boshtbl.NewValueString("Ephemeral\nDisk Usage"), PersistentDisk: boshtbl.NewValueString("Persistent\nDisk Usage"), }
Functions ¶
func NewEnvFactory ¶
func NewValueStringPercent ¶
Types ¶
type AddBlobArgs ¶
type AddBlobCmd ¶
type AddBlobCmd struct {
// contains filtered or unexported fields
}
func NewAddBlobCmd ¶
func NewAddBlobCmd(blobsDir boshreldir.BlobsDir, fs boshsys.FileSystem, ui boshui.UI) AddBlobCmd
func (AddBlobCmd) Run ¶
func (c AddBlobCmd) Run(opts AddBlobOpts) error
type AddBlobOpts ¶
type AddBlobOpts struct { Args AddBlobArgs `positional-args:"true" required:"true"` Directory DirOrCWDArg `long:"dir" description:"Release directory path if not current working directory" default:"."` // contains filtered or unexported fields }
type AliasEnvArgs ¶ added in v0.0.96
type AliasEnvArgs struct {
Alias string `positional-arg-name:"ALIAS" description:"Environment alias"`
}
type AliasEnvCmd ¶ added in v0.0.96
type AliasEnvCmd struct {
// contains filtered or unexported fields
}
func NewAliasEnvCmd ¶ added in v0.0.96
func (AliasEnvCmd) Run ¶ added in v0.0.96
func (c AliasEnvCmd) Run(opts AliasEnvOpts) error
type AliasEnvOpts ¶ added in v0.0.96
type AliasEnvOpts struct { Args AliasEnvArgs `positional-args:"true" required:"true"` URL string CACert string // contains filtered or unexported fields }
type AllOrInstanceGroupOrInstanceSlugArgs ¶ added in v0.0.102
type AllOrInstanceGroupOrInstanceSlugArgs struct {
Slug boshdir.AllOrInstanceGroupOrInstanceSlug `positional-arg-name:"[POOL[/ID]]"`
}
type BackUpArgs ¶
type BackUpArgs struct {
Path string `positional-arg-name:"PATH"`
}
type BackUpOpts ¶
type BackUpOpts struct { Args BackUpArgs `positional-args:"true" required:"true"` Force bool `long:"force" description:"Overwrite if the backup file already exists"` // contains filtered or unexported fields }
type BasicDeps ¶
type BasicLoginStrategy ¶
type BasicLoginStrategy struct {
// contains filtered or unexported fields
}
func NewBasicLoginStrategy ¶
func (BasicLoginStrategy) Try ¶
func (s BasicLoginStrategy) Try() error
type BlobsCmd ¶
type BlobsCmd struct {
// contains filtered or unexported fields
}
func NewBlobsCmd ¶
func NewBlobsCmd(blobsDir boshreldir.BlobsDir, ui boshui.UI) BlobsCmd
type BlobsOpts ¶
type BlobsOpts struct { Directory DirOrCWDArg `long:"dir" description:"Release directory path if not current working directory" default:"."` // contains filtered or unexported fields }
Blobs
type BoshOpts ¶
type BoshOpts struct { VersionOpt func() error `long:"version" short:"v" description:"Show CLI version"` ConfigPathOpt string `long:"config" description:"Config file path" env:"BOSH_CONFIG" default:"~/.bosh/config"` EnvironmentOpt string `long:"environment" short:"e" description:"Director environment name or URL" env:"BOSH_ENVIRONMENT"` CACertOpt string `long:"ca-cert" description:"Director CA certificate path or value" env:"BOSH_CA_CERT"` // Specify basic credentaials UsernameOpt string `long:"user" description:"Override username" env:"BOSH_USER"` PasswordOpt string `long:"password" description:"Override password" env:"BOSH_PASSWORD"` // Specify UAA client credentaials UAAClientOpt string `long:"uaa-client" description:"Override UAA client" env:"BOSH_CLIENT"` UAAClientSecretOpt string `long:"uaa-client-secret" description:"Override UAA client secret" env:"BOSH_CLIENT_SECRET"` DeploymentOpt string `long:"deployment" short:"d" description:"Deployment name" env:"BOSH_DEPLOYMENT"` // Output formatting JSONOpt bool `long:"json" description:"Output as JSON"` TTYOpt bool `long:"tty" description:"Force TTY-like output"` NoColorOpt bool `long:"no-color" description:"Toggle colorized output"` NonInteractiveOpt bool `long:"non-interactive" short:"n" description:"Don't ask for user input"` Help HelpOpts `command:"help" description:"Show this help message"` // Environments Environment EnvironmentOpts `command:"environment" alias:"env" description:"Show environment"` Environments EnvironmentsOpts `command:"environments" alias:"envs" description:"List environments"` CreateEnv CreateEnvOpts `command:"create-env" description:"Create or update BOSH environment"` DeleteEnv DeleteEnvOpts `command:"delete-env" description:"Delete BOSH environment"` AliasEnv AliasEnvOpts `command:"alias-env" description:"Alias environment to save URL and CA certificate"` // Authentication LogIn LogInOpts `command:"log-in" alias:"l" alias:"login" description:"Log in"` LogOut LogOutOpts `command:"log-out" alias:"logout" description:"Log out"` // Tasks Task TaskOpts `command:"task" alias:"t" description:"Show task status and start tracking its output"` Tasks TasksOpts `command:"tasks" alias:"ts" description:"List running or recent tasks"` CancelTask CancelTaskOpts `command:"cancel-task" alias:"ct" description:"Cancel task at its next checkpoint"` // Misc Locks LocksOpts `command:"locks" description:"List current locks"` CleanUp CleanUpOpts `command:"clean-up" description:"Clean up releases, stemcells, disks, etc."` BackUp BackUpOpts `command:"back-up" description:"Back up the Director database to a tarball"` // Cloud config CloudConfig CloudConfigOpts `command:"cloud-config" alias:"cc" description:"Show current cloud config"` UpdateCloudConfig UpdateCloudConfigOpts `command:"update-cloud-config" alias:"ucc" description:"Update current cloud config"` // Runtime config RuntimeConfig RuntimeConfigOpts `command:"runtime-config" alias:"rc" description:"Show current runtime config"` UpdateRuntimeConfig UpdateRuntimeConfigOpts `command:"update-runtime-config" alias:"urc" description:"Update current runtime config"` // Deployments Deployment DeploymentOpts `command:"deployment" alias:"dep" description:"Show deployment"` Deployments DeploymentsOpts `command:"deployments" alias:"ds" alias:"deps" description:"List deployments"` DeleteDeployment DeleteDeploymentOpts `command:"delete-deployment" alias:"deld" description:"Delete deployment"` Deploy DeployOpts `` /* 143-byte string literal not displayed */ Manifest ManifestOpts `command:"manifest" alias:"m" alias:"man" alias:"download-manifest" description:"Download deployment manifest locally"` BuildManifest BuildManifestOpts `command:"build-manifest" alias:"bm" description:"Interpolates variables into a manifest"` // Events Events EventsOpts `command:"events" description:"List events"` // Stemcells Stemcells StemcellsOpts `command:"stemcells" alias:"ss" alias:"stems" description:"List stemcells"` UploadStemcell UploadStemcellOpts `command:"upload-stemcell" alias:"us" description:"Upload stemcell"` DeleteStemcell DeleteStemcellOpts `command:"delete-stemcell" alias:"dels" description:"Delete stemcell"` // Releases Releases ReleasesOpts `command:"releases" alias:"rs" alias:"rels" description:"List releases"` UploadRelease UploadReleaseOpts `command:"upload-release" alias:"ur" description:"Upload release"` ExportRelease ExportReleaseOpts `command:"export-release" alias:"expr" description:"Export the compiled release to a tarball"` InspectRelease InspectReleaseOpts `` /* 136-byte string literal not displayed */ DeleteRelease DeleteReleaseOpts `command:"delete-release" alias:"delr" description:"Delete release"` // Errands Errands ErrandsOpts `command:"errands" alias:"es" alias:"errs" description:"List errands"` RunErrand RunErrandOpts `command:"run-errand" alias:"re" description:"Run errand"` // Disks Disks DisksOpts `command:"disks" description:"List disks"` DeleteDisk DeleteDiskOpts `command:"delete-disk" description:"Delete disk"` // Snapshots Snapshots SnapshotsOpts `command:"snapshots" alias:"snaps" description:"List snapshots"` TakeSnapshot TakeSnapshotOpts `command:"take-snapshot" alias:"tsnap" description:"Take snapshot"` DeleteSnapshot DeleteSnapshotOpts `command:"delete-snapshot" alias:"delsnap" description:"Delete snapshot"` DeleteSnapshots DeleteSnapshotsOpts `command:"delete-snapshots" alias:"delsnaps" description:"Delete all snapshots in a deployment"` // Instances Instances InstancesOpts `command:"instances" alias:"is" alias:"ins" description:"List all instances in a deployment"` VMs VMsOpts `command:"vms" description:"List all VMs in all deployments"` UpdateResurrection UpdateResurrectionOpts `command:"update-resurrection" description:"Enable/disable resurrection"` Ignore IgnoreOpts `command:"ignore" description:"Ignore an instance"` Unignore UnignoreOpts `command:"unignore" description:"Unignore an instance"` CloudCheck CloudCheckOpts `command:"cloud-check" alias:"cck" alias:"cloudcheck" description:"Cloud consistency check and interactive repair"` // Instance management Logs LogsOpts `command:"logs" description:"Fetch logs from instance(s)"` Start StartOpts `command:"start" description:"Start instance(s)"` Stop StopOpts `command:"stop" description:"Stop instance(s)"` Restart RestartOpts `command:"restart" description:"Restart instance(s)"` Recreate RecreateOpts `command:"recreate" description:"Recreate instance(s)"` DeleteVM DeleteVMOpts `command:"delete-vm" description:"Delete VM"` // SSH instance SSH SSHOpts `command:"ssh" description:"SSH into instance(s)"` SCP SCPOpts `command:"scp" description:"SCP to/from instance(s)"` // Release creation InitRelease InitReleaseOpts `command:"init-release" description:"Initialize release"` ResetRelease ResetReleaseOpts `command:"reset-release" description:"Reset release"` GenerateJob GenerateJobOpts `command:"generate-job" description:"Generate job"` GeneratePackage GeneratePackageOpts `command:"generate-package" description:"Generate package"` CreateRelease CreateReleaseOpts `command:"create-release" alias:"cr" description:"Create release"` FinalizeRelease FinalizeReleaseOpts `command:"finalize-release" alias:"finr" description:"Create final release from dev release tarball"` // Blob management Blobs BlobsOpts `command:"blobs" description:"List blobs"` AddBlob AddBlobOpts `command:"add-blob" description:"Add blob"` RemoveBlob RemoveBlobOpts `command:"remove-blob" description:"Remove blob"` SyncBlobs SyncBlobsOpts `command:"sync-blobs" description:"Sync blobs"` UploadBlobs UploadBlobsOpts `command:"upload-blobs" description:"Upload blobs"` }
type BuildManifestArgs ¶
type BuildManifestArgs struct {
Manifest FileBytesArg `positional-arg-name:"PATH" description:"Path to a template that will be interpolated"`
}
type BuildManifestCmd ¶
type BuildManifestCmd struct {
// contains filtered or unexported fields
}
func NewBuildManifestCmd ¶
func NewBuildManifestCmd(ui boshui.UI) BuildManifestCmd
func (BuildManifestCmd) Run ¶
func (c BuildManifestCmd) Run(opts BuildManifestOpts) error
type BuildManifestOpts ¶
type BuildManifestOpts struct { Args BuildManifestArgs `positional-args:"true" required:"true"` VarFlags OpsFlags VarErrors bool `long:"var-errs" description:"Expect all variables to be found, otherwise error"` // contains filtered or unexported fields }
type CancelTaskCmd ¶
type CancelTaskCmd struct {
// contains filtered or unexported fields
}
func NewCancelTaskCmd ¶
func NewCancelTaskCmd(director boshdir.Director) CancelTaskCmd
func (CancelTaskCmd) Run ¶
func (c CancelTaskCmd) Run(opts CancelTaskOpts) error
type CancelTaskOpts ¶
type CancelTaskOpts struct { Args TaskArgs `positional-args:"true" required:"true"` // contains filtered or unexported fields }
type CleanUpCmd ¶
type CleanUpCmd struct {
// contains filtered or unexported fields
}
func NewCleanUpCmd ¶
func NewCleanUpCmd(ui boshui.UI, director boshdir.Director) CleanUpCmd
func (CleanUpCmd) Run ¶
func (c CleanUpCmd) Run(opts CleanUpOpts) error
type CleanUpOpts ¶
type CleanUpOpts struct { All bool `long:"all" description:"Remove all unused releases, stemcells, etc.; otherwise most recent resources will be kept"` // contains filtered or unexported fields }
type CloudCheckCmd ¶
type CloudCheckCmd struct {
// contains filtered or unexported fields
}
func NewCloudCheckCmd ¶
func NewCloudCheckCmd(deployment boshdir.Deployment, ui boshui.UI) CloudCheckCmd
func (CloudCheckCmd) Run ¶
func (c CloudCheckCmd) Run(opts CloudCheckOpts) error
type CloudCheckOpts ¶
type CloudConfigCmd ¶
type CloudConfigCmd struct {
// contains filtered or unexported fields
}
func NewCloudConfigCmd ¶
func NewCloudConfigCmd(ui boshui.UI, director boshdir.Director) CloudConfigCmd
func (CloudConfigCmd) Run ¶
func (c CloudConfigCmd) Run() error
type CloudConfigOpts ¶
type CloudConfigOpts struct {
// contains filtered or unexported fields
}
Cloud config
type Cmd ¶
type Cmd struct { BoshOpts BoshOpts Opts interface{} // contains filtered or unexported fields }
type CreateEnvArgs ¶
type CreateEnvArgs struct {
Manifest FileBytesWithPathArg `positional-arg-name:"PATH" description:"Path to a manifest file"`
}
type CreateEnvCmd ¶
type CreateEnvCmd struct {
// contains filtered or unexported fields
}
func NewCreateEnvCmd ¶
func NewCreateEnvCmd(ui boshui.UI, envProvider func(string, boshtpl.Variables, patch.Ops) DeploymentPreparer) *CreateEnvCmd
func (*CreateEnvCmd) Run ¶
func (c *CreateEnvCmd) Run(stage boshui.Stage, opts CreateEnvOpts) error
type CreateEnvOpts ¶
type CreateEnvOpts struct { Args CreateEnvArgs `positional-args:"true" required:"true"` VarFlags OpsFlags // contains filtered or unexported fields }
Original bosh-init
type CreateReleaseArgs ¶
type CreateReleaseArgs struct {
Manifest FileBytesWithPathArg `positional-arg-name:"PATH"`
}
type CreateReleaseCmd ¶
type CreateReleaseCmd struct {
// contains filtered or unexported fields
}
func NewCreateReleaseCmd ¶
func NewCreateReleaseCmd( releaseDirFactory func(DirOrCWDArg) (boshrel.Reader, boshreldir.ReleaseDir), ui boshui.UI, ) CreateReleaseCmd
func (CreateReleaseCmd) Run ¶
func (c CreateReleaseCmd) Run(opts CreateReleaseOpts) (boshrel.Release, error)
type CreateReleaseOpts ¶
type CreateReleaseOpts struct { Args CreateReleaseArgs `positional-args:"true"` Directory DirOrCWDArg `long:"dir" description:"Release directory path if not current working directory" default:"."` Name string `long:"name" description:"Custom release name"` Version VersionArg `long:"version" description:"Custom release version (e.g.: 1.0.0, 1.0-beta.2+dev.10)"` TimestampVersion bool `long:"timestamp-version" description:"Create release with the timestamp as the dev version (e.g.: 1+dev.TIMESTAMP)"` Final bool `long:"final" description:"Make it a final release"` Tarball bool `long:"tarball" description:"Create release tarball"` Force bool `long:"force" description:"Ignore Git dirty state check"` // contains filtered or unexported fields }
type DeleteCmd ¶
type DeleteCmd struct {
// contains filtered or unexported fields
}
func NewDeleteCmd ¶
type DeleteDeploymentCmd ¶
type DeleteDeploymentCmd struct {
// contains filtered or unexported fields
}
func NewDeleteDeploymentCmd ¶
func NewDeleteDeploymentCmd(ui boshui.UI, deployment boshdir.Deployment) DeleteDeploymentCmd
func (DeleteDeploymentCmd) Run ¶
func (c DeleteDeploymentCmd) Run(opts DeleteDeploymentOpts) error
type DeleteDeploymentOpts ¶
type DeleteDeploymentOpts struct { Force bool `long:"force" description:"Ignore errors"` // contains filtered or unexported fields }
type DeleteDiskArgs ¶
type DeleteDiskArgs struct {
CID string `positional-arg-name:"CID"`
}
type DeleteDiskCmd ¶
type DeleteDiskCmd struct {
// contains filtered or unexported fields
}
func NewDeleteDiskCmd ¶
func NewDeleteDiskCmd(ui boshui.UI, director boshdir.Director) DeleteDiskCmd
func (DeleteDiskCmd) Run ¶
func (c DeleteDiskCmd) Run(opts DeleteDiskOpts) error
type DeleteDiskOpts ¶
type DeleteDiskOpts struct { Args DeleteDiskArgs `positional-args:"true" required:"true"` // contains filtered or unexported fields }
type DeleteEnvArgs ¶
type DeleteEnvArgs struct {
Manifest FileBytesWithPathArg `positional-arg-name:"PATH" description:"Path to a manifest file"`
}
type DeleteEnvOpts ¶
type DeleteEnvOpts struct { Args DeleteEnvArgs `positional-args:"true" required:"true"` VarFlags OpsFlags // contains filtered or unexported fields }
type DeleteReleaseArgs ¶
type DeleteReleaseArgs struct {
Slug boshdir.ReleaseOrSeriesSlug `positional-arg-name:"NAME[/VERSION]"`
}
type DeleteReleaseCmd ¶
type DeleteReleaseCmd struct {
// contains filtered or unexported fields
}
func NewDeleteReleaseCmd ¶
func NewDeleteReleaseCmd(ui boshui.UI, director boshdir.Director) DeleteReleaseCmd
func (DeleteReleaseCmd) Run ¶
func (c DeleteReleaseCmd) Run(opts DeleteReleaseOpts) error
type DeleteReleaseOpts ¶
type DeleteReleaseOpts struct { Args DeleteReleaseArgs `positional-args:"true" required:"true"` Force bool `long:"force" description:"Ignore errors"` // contains filtered or unexported fields }
type DeleteSnapshotArgs ¶
type DeleteSnapshotArgs struct {
CID string `positional-arg-name:"CID"`
}
type DeleteSnapshotCmd ¶
type DeleteSnapshotCmd struct {
// contains filtered or unexported fields
}
func NewDeleteSnapshotCmd ¶
func NewDeleteSnapshotCmd(ui boshui.UI, deployment boshdir.Deployment) DeleteSnapshotCmd
func (DeleteSnapshotCmd) Run ¶
func (c DeleteSnapshotCmd) Run(opts DeleteSnapshotOpts) error
type DeleteSnapshotOpts ¶
type DeleteSnapshotOpts struct { Args DeleteSnapshotArgs `positional-args:"true" required:"true"` // contains filtered or unexported fields }
type DeleteSnapshotsCmd ¶
type DeleteSnapshotsCmd struct {
// contains filtered or unexported fields
}
func NewDeleteSnapshotsCmd ¶
func NewDeleteSnapshotsCmd(ui boshui.UI, deployment boshdir.Deployment) DeleteSnapshotsCmd
func (DeleteSnapshotsCmd) Run ¶
func (c DeleteSnapshotsCmd) Run() error
type DeleteSnapshotsOpts ¶
type DeleteSnapshotsOpts struct {
// contains filtered or unexported fields
}
type DeleteStemcellArgs ¶
type DeleteStemcellArgs struct {
Slug boshdir.StemcellSlug `positional-arg-name:"NAME/VERSION"`
}
type DeleteStemcellCmd ¶
type DeleteStemcellCmd struct {
// contains filtered or unexported fields
}
func NewDeleteStemcellCmd ¶
func NewDeleteStemcellCmd(ui boshui.UI, director boshdir.Director) DeleteStemcellCmd
func (DeleteStemcellCmd) Run ¶
func (c DeleteStemcellCmd) Run(opts DeleteStemcellOpts) error
type DeleteStemcellOpts ¶
type DeleteStemcellOpts struct { Args DeleteStemcellArgs `positional-args:"true" required:"true"` Force bool `long:"force" description:"Ignore errors"` // contains filtered or unexported fields }
type DeleteVMArgs ¶ added in v0.0.95
type DeleteVMArgs struct {
CID string `positional-arg-name:"CID"`
}
type DeleteVMCmd ¶ added in v0.0.95
type DeleteVMCmd struct {
// contains filtered or unexported fields
}
func NewDeleteVMCmd ¶ added in v0.0.95
func NewDeleteVMCmd(ui boshui.UI, deployment boshdir.Deployment) DeleteVMCmd
func (DeleteVMCmd) Run ¶ added in v0.0.95
func (c DeleteVMCmd) Run(opts DeleteVMOpts) error
type DeleteVMOpts ¶ added in v0.0.95
type DeleteVMOpts struct { Args DeleteVMArgs `positional-args:"true" required:"true"` // contains filtered or unexported fields }
type DeployArgs ¶
type DeployArgs struct {
Manifest FileBytesArg `positional-arg-name:"PATH" description:"Path to a manifest file"`
}
type DeployCmd ¶
type DeployCmd struct {
// contains filtered or unexported fields
}
func NewDeployCmd ¶
func NewDeployCmd( ui boshui.UI, deployment boshdir.Deployment, releaseUploader ReleaseUploader, ) DeployCmd
func (DeployCmd) Run ¶
func (c DeployCmd) Run(opts DeployOpts) error
type DeployOpts ¶
type DeployOpts struct { Args DeployArgs `positional-args:"true" required:"true"` VarFlags OpsFlags NoRedact bool `long:"no-redact" description:"Show non-redacted manifest diff"` Recreate bool `long:"recreate" description:"Recreate all VMs in deployment"` Fix bool `long:"fix" description:"Recreate unresponsive instances"` SkipDrain boshdir.SkipDrain `long:"skip-drain" description:"Skip running drain scripts"` Canaries string `long:"canaries" description:"Override manifest values for canaries"` MaxInFlight string `long:"max-in-flight" description:"Override manifest values for max_in_flight"` DryRun bool `long:"dry-run" description:"Renders job templates without altering deployment"` // contains filtered or unexported fields }
type DeploymentCmd ¶
type DeploymentCmd struct {
// contains filtered or unexported fields
}
func NewDeploymentCmd ¶
func (DeploymentCmd) Run ¶
func (c DeploymentCmd) Run() error
type DeploymentDeleter ¶
func NewDeploymentDeleter ¶
func NewDeploymentDeleter( ui biui.UI, logTag string, logger boshlog.Logger, deploymentStateService biconfig.DeploymentStateService, releaseManager boshinst.ReleaseManager, cloudFactory bicloud.Factory, agentClientFactory bihttpagent.AgentClientFactory, blobstoreFactory biblobstore.Factory, deploymentManagerFactory bidepl.ManagerFactory, deploymentManifestPath string, deploymentVars boshtpl.Variables, deploymentOps patch.Ops, cpiInstaller bicpirel.CpiInstaller, cpiUninstaller biinstall.Uninstaller, releaseFetcher boshinst.ReleaseFetcher, releaseSetAndInstallationManifestParser ReleaseSetAndInstallationManifestParser, tempRootConfigurator TempRootConfigurator, targetProvider biinstall.TargetProvider, ) DeploymentDeleter
type DeploymentManifestParser ¶
type DeploymentManifestParser interface {
GetDeploymentManifest(path string, vars boshtpl.Variables, ops patch.Ops, releaseSetManifest birelsetmanifest.Manifest, stage biui.Stage) (bideplmanifest.Manifest, string, error)
}
func NewDeploymentManifestParser ¶
func NewDeploymentManifestParser( deploymentParser bideplmanifest.Parser, deploymentValidator bideplmanifest.Validator, releaseManager birel.Manager, templateFactory bidepltpl.DeploymentTemplateFactory) DeploymentManifestParser
type DeploymentOpts ¶
type DeploymentOpts struct {
// contains filtered or unexported fields
}
Deployments
type DeploymentPreparer ¶
type DeploymentPreparer struct {
// contains filtered or unexported fields
}
func NewDeploymentPreparer ¶
func NewDeploymentPreparer( ui biui.UI, logger boshlog.Logger, logTag string, deploymentStateService biconfig.DeploymentStateService, legacyDeploymentStateMigrator biconfig.LegacyDeploymentStateMigrator, releaseManager boshinst.ReleaseManager, deploymentRecord bidepl.Record, cloudFactory bicloud.Factory, stemcellManagerFactory bistemcell.ManagerFactory, agentClientFactory bihttpagent.AgentClientFactory, vmManagerFactory bivm.ManagerFactory, blobstoreFactory biblobstore.Factory, deployer bidepl.Deployer, deploymentManifestPath string, deploymentVars boshtpl.Variables, deploymentOps patch.Ops, cpiInstaller bicpirel.CpiInstaller, releaseFetcher boshinst.ReleaseFetcher, stemcellFetcher bistemcell.Fetcher, releaseSetAndInstallationManifestParser ReleaseSetAndInstallationManifestParser, deploymentManifestParser DeploymentManifestParser, tempRootConfigurator TempRootConfigurator, targetProvider biinstall.TargetProvider, ) DeploymentPreparer
func (*DeploymentPreparer) PrepareDeployment ¶
func (c *DeploymentPreparer) PrepareDeployment(stage biui.Stage) (err error)
type DeploymentsCmd ¶
type DeploymentsCmd struct {
// contains filtered or unexported fields
}
func NewDeploymentsCmd ¶
func NewDeploymentsCmd(ui biui.UI, director boshdir.Director) DeploymentsCmd
func (DeploymentsCmd) Run ¶
func (c DeploymentsCmd) Run() error
type DeploymentsOpts ¶
type DeploymentsOpts struct {
// contains filtered or unexported fields
}
type DeploymentsTable ¶
type DeploymentsTable struct { Deployments []boshdir.Deployment UI boshui.UI }
func (DeploymentsTable) Print ¶
func (t DeploymentsTable) Print() error
type DirOrCWDArg ¶
type DirOrCWDArg struct {
Path string
}
func (*DirOrCWDArg) UnmarshalFlag ¶
func (a *DirOrCWDArg) UnmarshalFlag(data string) error
type DisksOpts ¶
type DisksOpts struct { Orphaned bool `long:"orphaned" short:"o" description:"List orphaned disks"` // contains filtered or unexported fields }
Disks
type Downloader ¶
type EnvironmentCmd ¶
type EnvironmentCmd struct {
// contains filtered or unexported fields
}
func NewEnvironmentCmd ¶
func NewEnvironmentCmd(ui boshui.UI, director boshdir.Director) EnvironmentCmd
func (EnvironmentCmd) Run ¶
func (c EnvironmentCmd) Run() error
type EnvironmentOpts ¶
type EnvironmentOpts struct {
// contains filtered or unexported fields
}
Environment
type EnvironmentsCmd ¶
type EnvironmentsCmd struct {
// contains filtered or unexported fields
}
func NewEnvironmentsCmd ¶
func NewEnvironmentsCmd(config cmdconf.Config, ui boshui.UI) EnvironmentsCmd
func (EnvironmentsCmd) Run ¶
func (c EnvironmentsCmd) Run() error
type EnvironmentsOpts ¶
type EnvironmentsOpts struct {
// contains filtered or unexported fields
}
type ErrandsCmd ¶
type ErrandsCmd struct {
// contains filtered or unexported fields
}
func NewErrandsCmd ¶
func NewErrandsCmd(ui boshui.UI, deployment boshdir.Deployment) ErrandsCmd
func (ErrandsCmd) Run ¶
func (c ErrandsCmd) Run() error
type EventsCmd ¶
type EventsCmd struct {
// contains filtered or unexported fields
}
func (EventsCmd) Run ¶
func (c EventsCmd) Run(opts EventsOpts) error
type EventsOpts ¶
type EventsOpts struct { BeforeID string `long:"before-id" description:"Show events with ID less than the given ID"` Before string `long:"before" description:"Show events before the given timestamp (ex: 2016-05-08 17:26:32)"` After string `long:"after" description:"Show events after the given timestamp (ex: 2016-05-08 17:26:32)"` Deployment string Task string `long:"task" description:"Show events with the given task ID"` Instance string `long:"instance" description:"Show events with given instance"` // contains filtered or unexported fields }
Events
type ExportReleaseArgs ¶
type ExportReleaseArgs struct { ReleaseSlug boshdir.ReleaseSlug `positional-arg-name:"NAME/VERSION"` OSVersionSlug boshdir.OSVersionSlug `positional-arg-name:"OS/VERSION"` }
type ExportReleaseCmd ¶
type ExportReleaseCmd struct {
// contains filtered or unexported fields
}
func NewExportReleaseCmd ¶
func NewExportReleaseCmd(deployment boshdir.Deployment, downloader Downloader) ExportReleaseCmd
func (ExportReleaseCmd) Run ¶
func (c ExportReleaseCmd) Run(opts ExportReleaseOpts) error
type ExportReleaseOpts ¶
type ExportReleaseOpts struct { Args ExportReleaseArgs `positional-args:"true" required:"true"` Directory DirOrCWDArg `long:"dir" description:"Destination directory" default:"."` // contains filtered or unexported fields }
type FileBytesArg ¶
type FileBytesArg struct { FS boshsys.FileSystem Bytes []byte }
func (*FileBytesArg) UnmarshalFlag ¶
func (a *FileBytesArg) UnmarshalFlag(data string) error
type FileBytesWithPathArg ¶ added in v0.0.94
type FileBytesWithPathArg struct { FS boshsys.FileSystem Bytes []byte Path string }
func (*FileBytesWithPathArg) UnmarshalFlag ¶ added in v0.0.94
func (a *FileBytesWithPathArg) UnmarshalFlag(data string) error
type FinalizeReleaseArgs ¶
type FinalizeReleaseArgs struct {
Path string `positional-arg-name:"PATH"`
}
type FinalizeReleaseCmd ¶
type FinalizeReleaseCmd struct {
// contains filtered or unexported fields
}
func NewFinalizeReleaseCmd ¶
func NewFinalizeReleaseCmd( releaseReader boshrel.Reader, releaseDir boshreldir.ReleaseDir, ui boshui.UI, ) FinalizeReleaseCmd
func (FinalizeReleaseCmd) Run ¶
func (c FinalizeReleaseCmd) Run(opts FinalizeReleaseOpts) error
type FinalizeReleaseOpts ¶
type FinalizeReleaseOpts struct { Args FinalizeReleaseArgs `positional-args:"true" required:"true"` Directory DirOrCWDArg `long:"dir" description:"Release directory path if not current working directory" default:"."` Name string `long:"name" description:"Custom release name"` Version VersionArg `long:"version" description:"Custom release version (e.g.: 1.0.0, 1.0-beta.2+dev.10)"` Force bool `long:"force" description:"Ignore Git dirty state check"` // contains filtered or unexported fields }
type GatewayFlags ¶
type GatewayFlags struct { Disable bool `long:"gw-disable" description:"Disable usage of gateway connection" env:"BOSH_GW_DISABLE"` Username string `long:"gw-user" description:"Username for gateway connection" env:"BOSH_GW_USER"` Host string `long:"gw-host" description:"Host for gateway connection" env:"BOSH_GW_HOST"` PrivateKeyPath string `long:"gw-private-key" description:"Private key path for gateway connection" env:"BOSH_GW_PRIVATE_KEY"` // todo private file? }
type GenerateJobArgs ¶
type GenerateJobArgs struct {
Name string `positional-arg-name:"NAME"`
}
type GenerateJobCmd ¶
type GenerateJobCmd struct {
// contains filtered or unexported fields
}
func NewGenerateJobCmd ¶
func NewGenerateJobCmd(releaseDir boshreldir.ReleaseDir) GenerateJobCmd
func (GenerateJobCmd) Run ¶
func (c GenerateJobCmd) Run(opts GenerateJobOpts) error
type GenerateJobOpts ¶
type GenerateJobOpts struct { Args GenerateJobArgs `positional-args:"true" required:"true"` Directory DirOrCWDArg `long:"dir" description:"Release directory path if not current working directory" default:"."` // contains filtered or unexported fields }
type GeneratePackageArgs ¶
type GeneratePackageArgs struct {
Name string `positional-arg-name:"NAME"`
}
type GeneratePackageCmd ¶
type GeneratePackageCmd struct {
// contains filtered or unexported fields
}
func NewGeneratePackageCmd ¶
func NewGeneratePackageCmd(releaseDir boshreldir.ReleaseDir) GeneratePackageCmd
func (GeneratePackageCmd) Run ¶
func (c GeneratePackageCmd) Run(opts GeneratePackageOpts) error
type GeneratePackageOpts ¶
type GeneratePackageOpts struct { Args GeneratePackageArgs `positional-args:"true" required:"true"` Directory DirOrCWDArg `long:"dir" description:"Release directory path if not current working directory" default:"."` // contains filtered or unexported fields }
type IgnoreCmd ¶ added in v0.0.101
type IgnoreCmd struct {
// contains filtered or unexported fields
}
func NewIgnoreCmd ¶ added in v0.0.101
func NewIgnoreCmd(deployment boshdir.Deployment) IgnoreCmd
func (IgnoreCmd) Run ¶ added in v0.0.101
func (cmd IgnoreCmd) Run(opts IgnoreOpts) error
type IgnoreOpts ¶ added in v0.0.101
type IgnoreOpts struct { Args InstanceSlugArgs `positional-args:"true" required:"true"` // contains filtered or unexported fields }
type InfoFeatureSorting ¶
type InfoFeatureSorting []string
func (InfoFeatureSorting) Len ¶
func (s InfoFeatureSorting) Len() int
func (InfoFeatureSorting) Less ¶
func (s InfoFeatureSorting) Less(i, j int) bool
func (InfoFeatureSorting) Swap ¶
func (s InfoFeatureSorting) Swap(i, j int)
type InitReleaseCmd ¶
type InitReleaseCmd struct {
// contains filtered or unexported fields
}
func NewInitReleaseCmd ¶
func NewInitReleaseCmd(releaseDir boshreldir.ReleaseDir) InitReleaseCmd
func (InitReleaseCmd) Run ¶
func (c InitReleaseCmd) Run(opts InitReleaseOpts) error
type InitReleaseOpts ¶
type InitReleaseOpts struct { Directory DirOrCWDArg `long:"dir" description:"Release directory path if not current working directory" default:"."` Git bool `long:"git" description:"Initialize git repository"` // contains filtered or unexported fields }
Release creation
type InspectReleaseArgs ¶
type InspectReleaseArgs struct {
Slug boshdir.ReleaseSlug `positional-arg-name:"NAME/VERSION"`
}
type InspectReleaseCmd ¶
type InspectReleaseCmd struct {
// contains filtered or unexported fields
}
func NewInspectReleaseCmd ¶
func NewInspectReleaseCmd(ui boshui.UI, director boshdir.Director) InspectReleaseCmd
func (InspectReleaseCmd) Run ¶
func (c InspectReleaseCmd) Run(opts InspectReleaseOpts) error
type InspectReleaseOpts ¶
type InspectReleaseOpts struct { Args InspectReleaseArgs `positional-args:"true" required:"true"` // contains filtered or unexported fields }
type InstanceSlugArgs ¶
type InstanceSlugArgs struct {
Slug boshdir.InstanceSlug `positional-arg-name:"INSTANCE-GROUP/INSTANCE-ID"`
}
type InstanceTable ¶
type InstanceTable struct {
Processes, VMDetails, Details, DNS, Vitals bool
}
func (InstanceTable) AsValues ¶
func (t InstanceTable) AsValues(v InstanceTableValues) []boshtbl.Value
AsValues is public instead of being private to aid ease of accessing vals in tests
func (InstanceTable) ForProcess ¶
func (t InstanceTable) ForProcess(p boshdir.VMInfoProcess) InstanceTableValues
func (InstanceTable) ForVMInfo ¶
func (t InstanceTable) ForVMInfo(i boshdir.VMInfo) InstanceTableValues
func (InstanceTable) Header ¶
func (t InstanceTable) Header() InstanceTableValues
type InstanceTableValues ¶
type InstanceTableValues struct { Name boshtbl.Value Process boshtbl.Value ProcessState boshtbl.Value State boshtbl.Value AZ boshtbl.Value VMType boshtbl.Value IPs boshtbl.Value // Details VMCID boshtbl.Value DiskCIDs boshtbl.Value AgentID boshtbl.Value Resurrection boshtbl.Value Ignore boshtbl.Value // DNS DNS boshtbl.Value // Vitals Uptime boshtbl.Value // only for Process Load boshtbl.Value CPUTotal boshtbl.Value // only for Process CPUUser boshtbl.Value CPUSys boshtbl.Value CPUWait boshtbl.Value Memory boshtbl.Value Swap boshtbl.Value SystemDisk boshtbl.Value EphemeralDisk boshtbl.Value PersistentDisk boshtbl.Value }
type InstancesCmd ¶
type InstancesCmd struct {
// contains filtered or unexported fields
}
func NewInstancesCmd ¶
func NewInstancesCmd(ui boshui.UI, deployment boshdir.Deployment) InstancesCmd
func (InstancesCmd) Run ¶
func (c InstancesCmd) Run(opts InstancesOpts) error
type InstancesOpts ¶
type InstancesOpts struct { Details bool `long:"details" short:"i" description:"Show details including VM CID, persistent disk CID, etc."` DNS bool `long:"dns" description:"Show DNS A records"` Vitals bool `long:"vitals" description:"Show vitals"` Processes bool `long:"ps" short:"p" description:"Show processes"` Failing bool `long:"failing" short:"f" description:"Only show failing instances"` // contains filtered or unexported fields }
Instances
type LogInCmd ¶
type LogInCmd struct {
// contains filtered or unexported fields
}
func NewLogInCmd ¶
func NewLogInCmd( basicStrategy LoginStrategy, uaaStrategy LoginStrategy, director boshdir.Director, ) LogInCmd
type LogOutCmd ¶
type LogOutCmd struct {
// contains filtered or unexported fields
}
func NewLogOutCmd ¶
type LogOutOpts ¶
type LogOutOpts struct {
// contains filtered or unexported fields
}
type LoginStrategy ¶
type LoginStrategy interface {
Try() error
}
type LogsCmd ¶
type LogsCmd struct {
// contains filtered or unexported fields
}
func NewLogsCmd ¶
func NewLogsCmd( deployment boshdir.Deployment, downloader Downloader, uuidGen boshuuid.Generator, nonIntSSHRunner boshssh.Runner, ) LogsCmd
type LogsOpts ¶
type LogsOpts struct { Args AllOrInstanceGroupOrInstanceSlugArgs `positional-args:"true"` Directory DirOrCWDArg `long:"dir" description:"Destination directory" default:"."` Follow bool `long:"follow" short:"f" description:"Follow logs via SSH"` Num int `long:"num" description:"Last number of lines"` Quiet bool `long:"quiet" short:"q" description:"Suppresses printing of headers when multiple files are being examined"` Jobs []string `long:"job" description:"Limit to only specific jobs"` Filters []string `long:"only" description:"Filter logs (comma-separated)"` Agent bool `long:"agent" description:"Include only agent logs"` GatewayFlags // contains filtered or unexported fields }
type ManifestCmd ¶
type ManifestCmd struct {
// contains filtered or unexported fields
}
func NewManifestCmd ¶
func NewManifestCmd(ui boshui.UI, deployment boshdir.Deployment) ManifestCmd
func (ManifestCmd) Run ¶
func (c ManifestCmd) Run() error
type ManifestOpts ¶
type ManifestOpts struct {
// contains filtered or unexported fields
}
type MessageOpts ¶ added in v0.0.57
type MessageOpts struct {
Message string
}
MessageOpts is used for version and help flags
type OpsFileArg ¶ added in v0.0.62
type OpsFileArg struct { FS boshsys.FileSystem Ops patch.Ops }
func (*OpsFileArg) UnmarshalFlag ¶ added in v0.0.62
func (a *OpsFileArg) UnmarshalFlag(filePath string) error
type OpsFlags ¶ added in v0.0.62
type OpsFlags struct {
OpsFiles []OpsFileArg `long:"ops-file" short:"o" value-name:"PATH" description:"Load manifest operations from a YAML file"`
}
Shared
type RecreateCmd ¶
type RecreateCmd struct {
// contains filtered or unexported fields
}
func NewRecreateCmd ¶
func NewRecreateCmd(ui boshui.UI, deployment boshdir.Deployment) RecreateCmd
func (RecreateCmd) Run ¶
func (c RecreateCmd) Run(opts RecreateOpts) error
type RecreateOpts ¶
type RecreateOpts struct { Args AllOrInstanceGroupOrInstanceSlugArgs `positional-args:"true"` SkipDrain boshdir.SkipDrain `long:"skip-drain" description:"Skip running drain scripts"` Force bool `long:"force" description:"No-op for backwards compatibility"` Canaries string `long:"canaries" description:"Override manifest values for canaries"` MaxInFlight string `long:"max-in-flight" description:"Override manifest values for max_in_flight"` DryRun bool `long:"dry-run" description:"Renders job templates without altering deployment"` // contains filtered or unexported fields }
type ReleaseCreatingCmd ¶ added in v0.0.63
type ReleaseCreatingCmd interface {
Run(CreateReleaseOpts) (boshrel.Release, error)
}
type ReleaseManager ¶ added in v0.0.63
type ReleaseManager struct {
// contains filtered or unexported fields
}
func NewReleaseManager ¶ added in v0.0.63
func NewReleaseManager( createReleaseCmd ReleaseCreatingCmd, uploadReleaseCmd ReleaseUploadingCmd, ) ReleaseManager
func (ReleaseManager) UploadReleases ¶ added in v0.0.63
func (m ReleaseManager) UploadReleases(bytes []byte) ([]byte, error)
type ReleaseSetAndInstallationManifestParser ¶
type ReleaseSetAndInstallationManifestParser struct { ReleaseSetParser birelsetmanifest.Parser InstallationParser biinstallmanifest.Parser }
func (ReleaseSetAndInstallationManifestParser) ReleaseSetAndInstallationManifest ¶
func (y ReleaseSetAndInstallationManifestParser) ReleaseSetAndInstallationManifest(deploymentManifestPath string, vars boshtpl.Variables, ops patch.Ops) (birelsetmanifest.Manifest, biinstallmanifest.Manifest, error)
type ReleaseTables ¶
func (ReleaseTables) Print ¶
func (t ReleaseTables) Print(ui boshui.UI)
type ReleaseUploader ¶ added in v0.0.63
type ReleaseUploadingCmd ¶
type ReleaseUploadingCmd interface {
Run(UploadReleaseOpts) error
}
type ReleasesCmd ¶
type ReleasesCmd struct {
// contains filtered or unexported fields
}
func NewReleasesCmd ¶
func NewReleasesCmd(ui boshui.UI, director boshdir.Director) ReleasesCmd
func (ReleasesCmd) Run ¶
func (c ReleasesCmd) Run() error
type RemoveBlobArgs ¶
type RemoveBlobArgs struct {
BlobsPath string `positional-arg-name:"BLOBS-PATH"`
}
type RemoveBlobCmd ¶
type RemoveBlobCmd struct {
// contains filtered or unexported fields
}
func NewRemoveBlobCmd ¶
func NewRemoveBlobCmd(blobsDir boshreldir.BlobsDir, ui biui.UI) RemoveBlobCmd
func (RemoveBlobCmd) Run ¶
func (c RemoveBlobCmd) Run(opts RemoveBlobOpts) error
type RemoveBlobOpts ¶
type RemoveBlobOpts struct { Args RemoveBlobArgs `positional-args:"true" required:"true"` Directory DirOrCWDArg `long:"dir" description:"Release directory path if not current working directory" default:"."` // contains filtered or unexported fields }
type ResetReleaseCmd ¶
type ResetReleaseCmd struct {
// contains filtered or unexported fields
}
func NewResetReleaseCmd ¶
func NewResetReleaseCmd(releaseDir boshreldir.ReleaseDir) ResetReleaseCmd
func (ResetReleaseCmd) Run ¶
func (c ResetReleaseCmd) Run(opts ResetReleaseOpts) error
type ResetReleaseOpts ¶
type ResetReleaseOpts struct { Directory DirOrCWDArg `long:"dir" description:"Release directory path if not current working directory" default:"."` // contains filtered or unexported fields }
type RestartCmd ¶
type RestartCmd struct {
// contains filtered or unexported fields
}
func NewRestartCmd ¶
func NewRestartCmd(ui boshui.UI, deployment boshdir.Deployment) RestartCmd
func (RestartCmd) Run ¶
func (c RestartCmd) Run(opts RestartOpts) error
type RestartOpts ¶
type RestartOpts struct { Args AllOrInstanceGroupOrInstanceSlugArgs `positional-args:"true"` SkipDrain boshdir.SkipDrain `long:"skip-drain" description:"Skip running drain scripts"` Force bool `long:"force" description:"No-op for backwards compatibility"` Canaries string `long:"canaries" description:"Override manifest values for canaries"` MaxInFlight string `long:"max-in-flight" description:"Override manifest values for max_in_flight"` // contains filtered or unexported fields }
type RunErrandArgs ¶
type RunErrandArgs struct {
Name string `positional-arg-name:"NAME"`
}
type RunErrandCmd ¶
type RunErrandCmd struct {
// contains filtered or unexported fields
}
func NewRunErrandCmd ¶
func NewRunErrandCmd( deployment boshdir.Deployment, downloader Downloader, ui biui.UI, ) RunErrandCmd
func (RunErrandCmd) Run ¶
func (c RunErrandCmd) Run(opts RunErrandOpts) error
type RunErrandOpts ¶
type RunErrandOpts struct { Args RunErrandArgs `positional-args:"true" required:"true"` KeepAlive bool `long:"keep-alive" description:"Use existing VM to run an errand and keep it after completion"` DownloadLogs bool `long:"download-logs" description:"Download logs"` LogsDirectory DirOrCWDArg `long:"logs-dir" description:"Destination directory for logs" default:"."` // contains filtered or unexported fields }
type RuntimeConfigCmd ¶
type RuntimeConfigCmd struct {
// contains filtered or unexported fields
}
func NewRuntimeConfigCmd ¶
func NewRuntimeConfigCmd(ui boshui.UI, director boshdir.Director) RuntimeConfigCmd
func (RuntimeConfigCmd) Run ¶
func (c RuntimeConfigCmd) Run() error
type RuntimeConfigOpts ¶
type RuntimeConfigOpts struct {
// contains filtered or unexported fields
}
Runtime config
type SCPOpts ¶
type SCPOpts struct { Args SCPArgs `positional-args:"true" required:"true"` Recursive bool `` /* 149-byte string literal not displayed */ GatewayFlags // contains filtered or unexported fields }
type SSHOpts ¶
type SSHOpts struct { Args AllOrInstanceGroupOrInstanceSlugArgs `positional-args:"true"` Command []string `long:"command" short:"c" description:"Command"` RawOpts TrimmedSpaceArgs `long:"opts" description:"Options to pass through to SSH"` Results bool `long:"results" short:"r" description:"Collect results into a table instead of streaming"` GatewayFlags // contains filtered or unexported fields }
SSH instance
type Session ¶
type SessionContext ¶
type SessionContextImpl ¶
type SessionContextImpl struct {
// contains filtered or unexported fields
}
SessionContextImpl prefers options over config values
func NewSessionContextImpl ¶
func NewSessionContextImpl( opts BoshOpts, config cmdconf.Config, fs boshsys.FileSystem, ) *SessionContextImpl
func (SessionContextImpl) CACert ¶
func (c SessionContextImpl) CACert() string
func (SessionContextImpl) Credentials ¶
func (c SessionContextImpl) Credentials() cmdconf.Creds
func (SessionContextImpl) Deployment ¶
func (c SessionContextImpl) Deployment() string
func (SessionContextImpl) Environment ¶
func (c SessionContextImpl) Environment() string
type SessionImpl ¶
type SessionImpl struct {
// contains filtered or unexported fields
}
func NewSessionImpl ¶
func NewSessionImpl( context SessionContext, ui boshui.UI, printEnvironment bool, printDeployment bool, logger boshlog.Logger, ) *SessionImpl
func (SessionImpl) AnonymousDirector ¶
func (c SessionImpl) AnonymousDirector() (boshdir.Director, error)
func (SessionImpl) Credentials ¶
func (c SessionImpl) Credentials() cmdconf.Creds
func (*SessionImpl) Deployment ¶
func (c *SessionImpl) Deployment() (boshdir.Deployment, error)
func (SessionImpl) Environment ¶
func (c SessionImpl) Environment() string
type SnapshotsCmd ¶
type SnapshotsCmd struct {
// contains filtered or unexported fields
}
func NewSnapshotsCmd ¶
func NewSnapshotsCmd(ui boshui.UI, deployment boshdir.Deployment) SnapshotsCmd
func (SnapshotsCmd) Run ¶
func (c SnapshotsCmd) Run(opts SnapshotsOpts) error
type SnapshotsOpts ¶
type SnapshotsOpts struct { Args InstanceSlugArgs `positional-args:"true"` // contains filtered or unexported fields }
Snapshots
type StartCmd ¶
type StartCmd struct {
// contains filtered or unexported fields
}
func NewStartCmd ¶
func NewStartCmd(ui boshui.UI, deployment boshdir.Deployment) StartCmd
type StartOpts ¶
type StartOpts struct { Args AllOrInstanceGroupOrInstanceSlugArgs `positional-args:"true"` Force bool `long:"force" description:"No-op for backwards compatibility"` Canaries string `long:"canaries" description:"Override manifest values for canaries"` MaxInFlight string `long:"max-in-flight" description:"Override manifest values for max_in_flight"` // contains filtered or unexported fields }
type StemcellsCmd ¶
type StemcellsCmd struct {
// contains filtered or unexported fields
}
func NewStemcellsCmd ¶
func NewStemcellsCmd(ui boshui.UI, director boshdir.Director) StemcellsCmd
func (StemcellsCmd) Run ¶
func (c StemcellsCmd) Run() error
type StemcellsOpts ¶
type StemcellsOpts struct {
// contains filtered or unexported fields
}
Stemcells
type StopCmd ¶
type StopCmd struct {
// contains filtered or unexported fields
}
func NewStopCmd ¶
func NewStopCmd(ui boshui.UI, deployment boshdir.Deployment) StopCmd
type StopOpts ¶
type StopOpts struct { Args AllOrInstanceGroupOrInstanceSlugArgs `positional-args:"true"` Soft bool `long:"soft" description:"Stop process only (default)"` Hard bool `long:"hard" description:"Delete VM (but keep persistent disk)"` SkipDrain boshdir.SkipDrain `long:"skip-drain" description:"Skip running drain scripts"` Force bool `long:"force" description:"No-op for backwards compatibility"` Canaries string `long:"canaries" description:"Override manifest values for canaries"` MaxInFlight string `long:"max-in-flight" description:"Override manifest values for max_in_flight"` // contains filtered or unexported fields }
type SyncBlobsCmd ¶
type SyncBlobsCmd struct {
// contains filtered or unexported fields
}
func NewSyncBlobsCmd ¶
func NewSyncBlobsCmd(blobsDir boshreldir.BlobsDir, numOfParallelWorkers int) SyncBlobsCmd
func (SyncBlobsCmd) Run ¶
func (c SyncBlobsCmd) Run() error
type SyncBlobsOpts ¶
type SyncBlobsOpts struct { Directory DirOrCWDArg `long:"dir" description:"Release directory path if not current working directory" default:"."` ParallelOpt int `long:"parallel" description:"Sets the max number of parallel downloads" default:"5"` // contains filtered or unexported fields }
type TakeSnapshotCmd ¶
type TakeSnapshotCmd struct {
// contains filtered or unexported fields
}
func NewTakeSnapshotCmd ¶
func NewTakeSnapshotCmd(deployment boshdir.Deployment) TakeSnapshotCmd
func (TakeSnapshotCmd) Run ¶
func (c TakeSnapshotCmd) Run(opts TakeSnapshotOpts) error
type TakeSnapshotOpts ¶
type TakeSnapshotOpts struct { Args InstanceSlugArgs `positional-args:"true"` // contains filtered or unexported fields }
type TaskOpts ¶
type TaskOpts struct { Args TaskArgs `positional-args:"true"` Event bool `long:"event" description:"Track event log"` CPI bool `long:"cpi" description:"Track CPI log"` Debug bool `long:"debug" description:"Track debug log"` Result bool `long:"result" description:"Track result log"` All bool `long:"all" short:"a" description:"Include all task types (ssh, logs, vms, etc)"` // contains filtered or unexported fields }
Tasks
type TasksOpts ¶
type TempRootConfigurator ¶
type TempRootConfigurator interface {
PrepareAndSetTempRoot(path string, logger logger.Logger) error
}
func NewTempRootConfigurator ¶
func NewTempRootConfigurator(fs boshsys.FileSystem) TempRootConfigurator
type TrimmedSpaceArgs ¶
type TrimmedSpaceArgs []string
func (TrimmedSpaceArgs) AsStrings ¶
func (as TrimmedSpaceArgs) AsStrings() []string
type UAALoginStrategy ¶
type UAALoginStrategy struct {
// contains filtered or unexported fields
}
func NewUAALoginStrategy ¶
func (UAALoginStrategy) Try ¶
func (c UAALoginStrategy) Try() error
type UIDownloader ¶
type UIDownloader struct {
// contains filtered or unexported fields
}
func NewUIDownloader ¶
func NewUIDownloader( director boshdir.Director, sha1calc bicrypto.SHA1Calculator, timeService clock.Clock, fs boshsys.FileSystem, ui biui.UI, ) UIDownloader
func (UIDownloader) Download ¶
func (d UIDownloader) Download(blobstoreID, sha1, prefix, dstDirPath string) error
type UnignoreCmd ¶ added in v0.0.101
type UnignoreCmd struct {
// contains filtered or unexported fields
}
func NewUnignoreCmd ¶ added in v0.0.101
func NewUnignoreCmd(deployment boshdir.Deployment) UnignoreCmd
func (UnignoreCmd) Run ¶ added in v0.0.101
func (cmd UnignoreCmd) Run(opts UnignoreOpts) error
type UnignoreOpts ¶ added in v0.0.101
type UnignoreOpts struct { Args InstanceSlugArgs `positional-args:"true" required:"true"` // contains filtered or unexported fields }
type UpdateCloudConfigArgs ¶
type UpdateCloudConfigArgs struct {
CloudConfig FileBytesArg `positional-arg-name:"PATH" description:"Path to a cloud config file"`
}
type UpdateCloudConfigCmd ¶
type UpdateCloudConfigCmd struct {
// contains filtered or unexported fields
}
func NewUpdateCloudConfigCmd ¶
func NewUpdateCloudConfigCmd(ui boshui.UI, director boshdir.Director) UpdateCloudConfigCmd
func (UpdateCloudConfigCmd) Run ¶
func (c UpdateCloudConfigCmd) Run(opts UpdateCloudConfigOpts) error
type UpdateCloudConfigOpts ¶
type UpdateCloudConfigOpts struct { Args UpdateCloudConfigArgs `positional-args:"true" required:"true"` VarFlags OpsFlags // contains filtered or unexported fields }
type UpdateResurrectionArgs ¶ added in v0.0.61
type UpdateResurrectionArgs struct {
Enabled BoolArg `positional-arg-name:"on|off"`
}
type UpdateResurrectionCmd ¶ added in v0.0.61
type UpdateResurrectionCmd struct {
// contains filtered or unexported fields
}
func NewUpdateResurrectionCmd ¶ added in v0.0.61
func NewUpdateResurrectionCmd(director boshdir.Director) UpdateResurrectionCmd
func (UpdateResurrectionCmd) Run ¶ added in v0.0.61
func (c UpdateResurrectionCmd) Run(opts UpdateResurrectionOpts) error
type UpdateResurrectionOpts ¶ added in v0.0.61
type UpdateResurrectionOpts struct { Args UpdateResurrectionArgs `positional-args:"true" required:"true"` // contains filtered or unexported fields }
Instance management
type UpdateRuntimeConfigArgs ¶
type UpdateRuntimeConfigArgs struct {
RuntimeConfig FileBytesArg `positional-arg-name:"PATH" description:"Path to a runtime config file"`
}
type UpdateRuntimeConfigCmd ¶
type UpdateRuntimeConfigCmd struct {
// contains filtered or unexported fields
}
func NewUpdateRuntimeConfigCmd ¶
func NewUpdateRuntimeConfigCmd(ui boshui.UI, director boshdir.Director, releaseUploader ReleaseUploader) UpdateRuntimeConfigCmd
func (UpdateRuntimeConfigCmd) Run ¶
func (c UpdateRuntimeConfigCmd) Run(opts UpdateRuntimeConfigOpts) error
type UpdateRuntimeConfigOpts ¶
type UpdateRuntimeConfigOpts struct { Args UpdateRuntimeConfigArgs `positional-args:"true" required:"true"` VarFlags OpsFlags // contains filtered or unexported fields }
type UploadBlobsCmd ¶
type UploadBlobsCmd struct {
// contains filtered or unexported fields
}
func NewUploadBlobsCmd ¶
func NewUploadBlobsCmd(blobsDir boshreldir.BlobsDir) UploadBlobsCmd
func (UploadBlobsCmd) Run ¶
func (c UploadBlobsCmd) Run() error
type UploadBlobsOpts ¶
type UploadBlobsOpts struct { Directory DirOrCWDArg `long:"dir" description:"Release directory path if not current working directory" default:"."` // contains filtered or unexported fields }
type UploadReleaseArgs ¶
type UploadReleaseArgs struct {
URL URLArg `positional-arg-name:"URL" description:"Path to a local file or URL"`
}
type UploadReleaseCmd ¶
type UploadReleaseCmd struct {
// contains filtered or unexported fields
}
func NewUploadReleaseCmd ¶
func NewUploadReleaseCmd( releaseDirFactory func(DirOrCWDArg) (boshrel.Reader, boshreldir.ReleaseDir), releaseArchiveWriter boshrel.Writer, director boshdir.Director, releaseArchiveFactory func(string) boshdir.ReleaseArchive, ui boshui.UI, ) UploadReleaseCmd
func (UploadReleaseCmd) Run ¶
func (c UploadReleaseCmd) Run(opts UploadReleaseOpts) error
type UploadReleaseOpts ¶
type UploadReleaseOpts struct { Args UploadReleaseArgs `positional-args:"true"` Directory DirOrCWDArg `long:"dir" description:"Release directory path if not current working directory" default:"."` Rebase bool `long:"rebase" description:"Rebases this release onto the latest version known by the Director"` Fix bool `long:"fix" description:"Replaces corrupt and missing jobs and packages"` Name string `long:"name" description:"Name used in existence check (is not used with local release file)"` Version VersionArg `long:"version" description:"Version used in existence check (is not used with local release file)"` SHA1 string `long:"sha1" description:"SHA1 of the remote release (is not used with local files)"` Release boshrel.Release // contains filtered or unexported fields }
type UploadStemcellArgs ¶
type UploadStemcellArgs struct {
URL URLArg `positional-arg-name:"URL" description:"Path to a local file or URL"`
}
type UploadStemcellCmd ¶
type UploadStemcellCmd struct {
// contains filtered or unexported fields
}
func NewUploadStemcellCmd ¶
func NewUploadStemcellCmd( director boshdir.Director, stemcellArchiveFactory func(string) boshdir.StemcellArchive, ui biui.UI, ) UploadStemcellCmd
func (UploadStemcellCmd) Run ¶
func (c UploadStemcellCmd) Run(opts UploadStemcellOpts) error
type UploadStemcellOpts ¶
type UploadStemcellOpts struct { Args UploadStemcellArgs `positional-args:"true" required:"true"` Fix bool `long:"fix" description:"Replaces the stemcell if already exists"` Name string `long:"name" description:"Name used in existence check (is not used with local stemcell file)"` Version VersionArg `long:"version" description:"Version used in existence check (is not used with local stemcell file)"` SHA1 string `long:"sha1" description:"SHA1 of the remote stemcell (is not used with local files)"` // contains filtered or unexported fields }
type VMsOpts ¶
type VMsOpts struct { Details bool `long:"details" short:"i" description:"Show details including VM CID, persistent disk CID, etc."` DNS bool `long:"dns" description:"Show DNS A records"` Vitals bool `long:"vitals" description:"Show vitals"` Deployment string // contains filtered or unexported fields }
type ValueCPUTotal ¶
type ValueCPUTotal struct {
Total *float64
}
func (ValueCPUTotal) String ¶
func (t ValueCPUTotal) String() string
func (ValueCPUTotal) Value ¶
func (t ValueCPUTotal) Value() boshtbl.Value
type ValueDiskSize ¶
type ValueDiskSize struct {
Size boshdir.VMInfoVitalsDiskSize
}
func (ValueDiskSize) String ¶
func (t ValueDiskSize) String() string
func (ValueDiskSize) Value ¶
func (t ValueDiskSize) Value() boshtbl.Value
type ValueMemIntSize ¶
type ValueMemIntSize struct {
Size boshdir.VMInfoVitalsMemIntSize
}
func (ValueMemIntSize) String ¶
func (t ValueMemIntSize) String() string
func (ValueMemIntSize) Value ¶
func (t ValueMemIntSize) Value() boshtbl.Value
type ValueMemSize ¶
type ValueMemSize struct {
Size boshdir.VMInfoVitalsMemSize
}
func (ValueMemSize) String ¶
func (t ValueMemSize) String() string
func (ValueMemSize) Value ¶
func (t ValueMemSize) Value() boshtbl.Value
type ValueUptime ¶
type ValueUptime struct {
Secs *uint64
}
func (ValueUptime) String ¶
func (t ValueUptime) String() string
func (ValueUptime) Value ¶
func (t ValueUptime) Value() boshtbl.Value
type VarFlags ¶
type VarFlags struct { VarKVs []boshtpl.VarKV `long:"var" short:"v" value-name:"VAR=VALUE" description:"Set variable"` VarsFiles []boshtpl.VarsFileArg `long:"var-file" short:"l" value-name:"PATH" description:"Load variables from a YAML file"` VarsEnvs []boshtpl.VarsEnvArg `` /* 138-byte string literal not displayed */ }
Shared
func (VarFlags) AsVariables ¶
type VersionArg ¶
func (*VersionArg) UnmarshalFlag ¶
func (a *VersionArg) UnmarshalFlag(data string) error
Source Files ¶
- add_blob.go
- alias_env.go
- basic_deps.go
- basic_login_strategy.go
- blobs.go
- bool_arg.go
- build_manifest.go
- cancel_task.go
- clean_up.go
- cloud_check.go
- cloud_config.go
- cmd.go
- create_env.go
- create_release.go
- delete_cmd.go
- delete_deployment.go
- delete_disk.go
- delete_release.go
- delete_snapshot.go
- delete_snapshots.go
- delete_stemcell.go
- delete_vm.go
- deploy.go
- deployment.go
- deployment_deleter.go
- deployment_manifest_parser.go
- deployment_preparer.go
- deployments.go
- deployments_table.go
- dir_arg.go
- disks.go
- downloader.go
- env_factory.go
- environment.go
- environments.go
- errands.go
- events.go
- export_release.go
- factory.go
- file_bytes_arg.go
- file_bytes_with_path_arg.go
- finalize_release.go
- generate_job.go
- generate_package.go
- ignore.go
- info_table.go
- init_release.go
- inspect_release.go
- instance_table.go
- instance_values.go
- instances.go
- locks.go
- log_in.go
- log_out.go
- logs.go
- manifest.go
- ops_file_arg.go
- ops_flags.go
- opts.go
- recreate.go
- release_manager.go
- release_set_and_installation_manifest_parser.go
- release_tables.go
- releases.go
- remove_blob.go
- reset_release.go
- restart.go
- run_errand.go
- runtime_config.go
- scp.go
- session.go
- session_context.go
- session_factory.go
- session_interface.go
- snapshots.go
- ssh.go
- start.go
- stemcells.go
- stop.go
- sync_blobs.go
- take_snapshot.go
- task.go
- tasks.go
- temp_root_configurator.go
- trimmed_space_args.go
- uaa_login_strategy.go
- unignore.go
- update_cloud_config.go
- update_resurrection.go
- update_runtime_config.go
- upload_blobs.go
- upload_release.go
- upload_stemcell.go
- url_arg.go
- var_flags.go
- version.go
- version_arg.go
- vms.go
Click to show internal directories.
Click to hide internal directories.