github.com/kubesphere/s2irun@v3.2.1+incompatible/pkg/api/constants/labels.go (about)

     1  package constants
     2  
     3  // Docker image label constants
     4  const (
     5  	// OpenshiftNamespace is the namespace for Docker image labels used by OpenShift Origin.
     6  	OpenshiftNamespace = "io.openshift."
     7  
     8  	// DefaultNamespace is the default namespace for Docker image labels used and produced by S2I.
     9  	DefaultNamespace = OpenshiftNamespace + "s2i."
    10  
    11  	// KubernetesNamespace is the namespace for Docker image labels used by Kubernetes.
    12  	KubernetesNamespace = "io.k8s."
    13  
    14  	// KubernetesDescriptionLabel is the Docker image LABEL that provides an image description to Kubernetes.
    15  	KubernetesDescriptionLabel = KubernetesNamespace + "description"
    16  
    17  	// KubernetesDisplayNameLabel is the Docker image LABEL that provides a human-readable name for the image to Kubernetes.
    18  	KubernetesDisplayNameLabel = KubernetesNamespace + "display-name"
    19  
    20  	// AssembleInputFilesLabel is the Docker image LABEL that tells S2I which files wil be copied from builder to a runtime image.
    21  	AssembleInputFilesLabel = DefaultNamespace + "assemble-input-files"
    22  
    23  	AssembleInputFilesLabelLog = "assemble-input-files"
    24  
    25  	// AssembleUserLabel is the Docker image label that tells S2I which user should execute the assemble scripts.
    26  	AssembleUserLabel = DefaultNamespace + "assemble-user"
    27  
    28  	AssembleUserLabelLog = "assemble-user"
    29  
    30  	buildNamespace = DefaultNamespace + "build."
    31  
    32  	// BuildCommitRefLabel is the Docker image LABEL that S2I uses to record the source commit used to produce the S2I image.
    33  	//
    34  	// During a rebuild, this label is used by S2I to check out the appropriate commit from the source repository.
    35  	BuildCommitRefLabel = buildNamespace + "commit.ref"
    36  
    37  	// BuildImageLabel is the Docker image LABEL that S2I uses to record the builder image used to produce the S2I image.
    38  	//
    39  	// During a rebuild, this label is used by S2I to pull the appropriate builder image.
    40  	BuildImageLabel = buildNamespace + "image"
    41  
    42  	BuildImageLabelLog = "image"
    43  
    44  	// BuildSourceLocationLabel is the Docker image LABEL that S2I uses to record the URL of the source repository used to produce the S2I image.
    45  	//
    46  	// During a rebuild, this label is used by S2I to clone the appropriate source code repository.
    47  	BuildSourceLocationLabel = buildNamespace + "source-location"
    48  
    49  	BuildSourceLocationLabelLog = "source-location"
    50  
    51  	// BuildSourceContextDir is the Docker image LABEL that S2I uses to record the context directory in the source code repository to use for the  build.
    52  	//
    53  	// During a rebuild, this label is used by S2I to set the context directory within the source code for the S2I build.
    54  	BuildSourceContextDirLabel = buildNamespace + "source-context-dir"
    55  
    56  	// TODO: Deprecate BuilderVersionLabel?
    57  
    58  	// BuilderBaseVersionLabel is the Docker image LABEL that tells S2I the version of the base image used by the builder image.
    59  	BuilderBaseVersionLabel = OpenshiftNamespace + "builder-base-version"
    60  
    61  	// BuilderVersionLable is the  Docker image LABEL that tells S2I the version of the builder image.
    62  	BuilderVersionLabel = OpenshiftNamespace + "builder-version"
    63  
    64  	// DestinationLabel is the Docker image LABEL that tells S2I where to place the artifacts (scripts, sources) in the builder image.
    65  	DestinationLabel = DefaultNamespace + "destination"
    66  
    67  	// ScriptsURLLabel is the Docker image LABEL that tells S2I where to look for the S2I scripts.
    68  	// This label is also copied into the output image.
    69  	ScriptsURLLabel = DefaultNamespace + "scripts-url"
    70  )
    71  
    72  // Deprecated Docker image labels
    73  const (
    74  	// DeprecatedScriptsURLLabel is the Docker image LABEL that previously told S2I where to look for the S2I scripts.
    75  	//
    76  	// DEPRECATED - use ScriptsURLLabel instead.
    77  	DeprecatedScriptsURLLabel = "io.s2i.scripts-url"
    78  
    79  	// DeprecatedDestinationLabel is the Docker image LABEL that previously told S2I where to place the artifacts in the builder image.
    80  	//
    81  	// DEPRECATED - use DestinationLabel instead.
    82  	DeprecatedDestinationLabel = "io.s2i.destination"
    83  )