runtime

Documentation

Overview

Package runtime provides workload deployment setup functionality that was previously part of the transport package.

Index

• type SetupResult
  • func Setup(ctx context.Context, transportType types.TransportType, runtime rt.Deployer, ...) (*SetupResult, error)

Types

type SetupResult

type SetupResult struct {
	ContainerName string
	TargetURI     string
	TargetPort    int
	TargetHost    string
}

SetupResult contains the results of setting up a workload

func Setup

func Setup(
	ctx context.Context,
	transportType types.TransportType,
	runtime rt.Deployer,
	containerName string,
	image string,
	cmdArgs []string,
	envVars, labels map[string]string,
	permissionProfile *permissions.Profile,
	k8sPodTemplatePatch string,
	isolateNetwork bool,
	ignoreConfig *ignore.Config,
	host string,
	targetPort int,
	targetHost string,
) (*SetupResult, error)

Setup prepares and deploys a workload for use with a transport. The runtime parameter provides access to container operations. The permissionProfile is used to configure container permissions (including network mode). The k8sPodTemplatePatch is a JSON string to patch the Kubernetes pod template. Returns the container name and target URI for configuring the transport.