remote

Documentation

Index

• Constants
• func GetOriginalCWD(workingDirectoryCtrl filesystem.WorkingDirectoryInterface, manifestPath string) (string, error)
• type Builder
• type OktetoClientProvider
• type Params
• type Runner
  • func NewRunner(ioCtrl *io.Controller, builder Builder) *Runner
  • func (r *Runner) Run(ctx context.Context, params *Params) error

Constants

const (
	// TestCommand is the command to run test remotely
	TestCommand = "test"
	// DeployCommand is the command to deploy a dev environment remotely
	DeployCommand = "deploy"
	// DestroyCommand is the command to destroy a dev environment remotely
	DestroyCommand = "destroy"
)

Functions

func GetOriginalCWD

func GetOriginalCWD(workingDirectoryCtrl filesystem.WorkingDirectoryInterface, manifestPath string) (string, error)

GetOriginalCWD returns the original cwd from the manifest path

Types

type Builder

type Builder interface {
	Run(ctx context.Context, buildOptions *types.BuildOptions, ioCtrl *io.Controller) error
}

Builder is the interface to run the build of the Dockerfile to execute remote commands like deploy and destroy

type OktetoClientProvider

type OktetoClientProvider interface {
	Provide(opts ...okteto.Option) (types.OktetoInterface, error)
}

type Params

type Params struct {
	BuildEnvVars                 map[string]string
	DependenciesEnvVars          map[string]string
	OktetoCommandSpecificEnvVars map[string]string
	Manifest                     *model.Manifest
	Command                      string
	// CacheInvalidationKey is the value use to invalidate the cache. Defaults
	// to a random value which essentially means no-cache. Setting this to a
	// static or known value will reuse the build cache
	CacheInvalidationKey string
	TemplateName         string
	DockerfileName       string
	BaseImage            string
	// ContextAbsolutePathOverride is the absolute path for the build context. Optional.
	// If this values is not defined it will default to the folder location of the
	// okteto manifest which is resolved through params.ManifestPathFlag
	ContextAbsolutePathOverride string
	ManifestPathFlag            string
	// SSHAgentHostname hostname of the ssh-agent service
	SSHAgentHostname string
	// SSHAgentPort port of the ssh-agent service
	SSHAgentPort string
	Deployable   deployable.Entity
	CommandFlags []string
	Caches       []string
	Hosts        []model.Host
	// IgnoreRules are the ignoring rules added to this build execution.
	// Rules follow the .dockerignore syntax as defined in:
	// https://docs.docker.com/build/building/context/#syntax
	IgnoreRules []string
	// Artifacts are the files and or folder to export from this build operation.
	// They are the path INSIDE the build container relative to /okteto/src. They
	// will be exported to "{context_dir}/{artifact}"
	Artifacts []model.Artifact
	// UseOktetoDeployIgnoreFile if enabled loads the docker ignore file from an
	// .oktetodeployignore file. Disabled by default
	UseOktetoDeployIgnoreFile bool
}

Params struct to pass the necessary parameters to create the Dockerfile

type Runner

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

Runner struct in charge of creating the Dockerfile for remote execution of commands like deploy and destroy and running the build

func NewRunner

func NewRunner(ioCtrl *io.Controller, builder Builder) *Runner

NewRunner creates a new Runner for remote

func (*Runner) Run

func (r *Runner) Run(ctx context.Context, params *Params) error

Run This function is the one in charge of creating the Dockerfile needed to run remote execution of commands like destroy and deploy and triggers the build