snapshot

package

v1.57.0 Latest Latest Go to latest Published: Jul 17, 2023 License: Apache-2.0 Imports: 40 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/getoutreach/devenv

Documentation ¶

Overview ¶

Package snapshot This file is the entrypoint for the snapshot CLI command for devenv.

Index ¶

func NewCmdSnapshot(log logrus.FieldLogger) *cli.Command
type LoadLockfileOptions
type Options
- func NewOptions(log logrus.FieldLogger, b *box.Config) (*Options, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func NewCmdSnapshot ¶

func NewCmdSnapshot(log logrus.FieldLogger) *cli.Command

Types ¶

type LoadLockfileOptions ¶ added in v1.51.0

type LoadLockfileOptions struct {
	// contains filtered or unexported fields
}

type Options ¶

type Options struct {

	// KubernetesVersion is the version of Kubernetes to use when generating snapshots
	KubernetesVersion string
	// contains filtered or unexported fields
}

func NewOptions ¶

func NewOptions(log logrus.FieldLogger, b *box.Config) (*Options, error)

func (*Options) CreateSnapshot ¶

func (o *Options) CreateSnapshot(ctx context.Context) (string, error)

func (*Options) Generate ¶

func (o *Options) Generate(ctx context.Context, s *box.SnapshotGenerateConfig,
	skipUpload bool, channel box.SnapshotLockChannel, targetName string) error

Generate does spin up devenv, deploys applications and generates a snapshots for all targets, and finally and uploads them. If env UPLOAD_TO_LOCAL_SNAPSHOT_STORAGE is defined, then snapshots are stored instead in a local minIO instance, to be validated.

func (*Options) LoadLockFile ¶ added in v1.51.0

func (o *Options) LoadLockFile(ctx context.Context, options LoadLockfileOptions) (*box.SnapshotLock, error)

LoadLockFile reads lock file from target s3c

func (*Options) Upload ¶ added in v1.51.0

func (o *Options) Upload(ctx context.Context,
	s *box.SnapshotGenerateConfig,
	channel box.SnapshotLockChannel, targetName string,
	destS3client *s3.Client) error

Uploads file from local minIO to S3, effectively publishing the snapshots

Source Files ¶

View all Source files

snapshot.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL