package
1.5.0
Repository: https://github.com/openshift/source-to-image.git
Documentation: pkg.go.dev

# Packages

Package constants provides constants used across s2i.

# Functions

IsInvalidFilename verifies if the provided filename contains malicious characters.
NewDockerNetworkModeContainer creates a DockerNetworkMode value which instructs docker to place the container in the network namespace of an existing container.
RecordStageAndStepInfo records details about each build stage and step.

# Constants

DefaultBuilderPullPolicy specifies the default pull policy to use.
DefaultPreviousImagePullPolicy specifies policy for pulling the previously build Docker image when doing incremental build.
DefaultRuntimeImagePullPolicy specifies the default pull policy to use.
DockerNetworkModeBridge instructs docker to create a network namespace for this container connected to the docker0 bridge via a veth-pair.
DockerNetworkModeContainerPrefix is the string prefix used by NewDockerNetworkModeContainer.
DockerNetworkModeHost places the container in the default (host) network namespace.
DockerNetworkModeNetworkNamespacePrefix is the string prefix used when sharing a namespace from a CRI-O container.
PullAlways means that we always attempt to pull the latest image.
PullIfNotPresent means that we pull if the image isn't present on disk.
PullNever means that we never pull an image, but only use a local image.
StageAssemble runs the assemble steps.
StageBuild builds the source.
StageCommit commits the container.
StagePullImages pulls the docker images.
StageRetrieve retrieves artifacts.
StepAssembleBuildScripts runs the assemble scripts.
StepBuildDockerImage builds the Docker image for layered builds.
StepCommitContainer commits the container to the builder image.
StepPullBuilderImage pulls the builder image.
StepPullPreviousImage pulls the previous image for an incremental build.
StepPullRuntimeImage pull the runtime image.
StepRetrievePreviousArtifacts restores archived artifacts from the previous build.

# Structs

AuthConfig is our abstraction of the Registry authorization information for whatever docker client we happen to be based on.
BuildInfo contains information about the build process.
CGroupLimits holds limits used to constrain container resources.
Config contains essential fields for performing build.
ContainerConfig is the abstraction of the docker client provider (formerly go-dockerclient, now either engine-api or kube docker client) container.Config type that is leveraged by s2i or origin.
DockerConfig contains the configuration for a Docker connection.
EnvironmentSpec specifies a single environment variable.
FailureReason holds the type of failure that occurred during the build process.
Image is the abstraction of the docker client provider (formerly go-dockerclient, now either engine-api or kube docker client) Image type that is leveraged by s2i or origin.
InstallResult structure describes the result of install operation.
ProxyConfig holds proxy configuration.
Result structure contains information from build process.
StageInfo contains details about a build stage.
StepInfo contains details about a build step.
VolumeSpec represents a single volume mount point.

# Type aliases

DockerNetworkMode specifies the network mode setting for the docker container.
EnvironmentList contains list of environment variables.
PullPolicy specifies a type for the method used to retrieve the Docker image.
StageName is the identifier for each build stage.
StepFailureMessage holds the detailed message of a failure.
StepFailureReason holds the type of failure that occurred during the build process.
StepName is the identifier for each build step.
VolumeList contains list of VolumeSpec.