Documentation
¶
Index ¶
- Constants
- func Artifacts(pairs []BuilderImagePair) []*latest.Artifact
- func PrintAnalyzeJSON(out io.Writer, skipBuild bool, pairs []BuilderImagePair, ...) error
- func PrintAnalyzeOldFormat(out io.Writer, skipBuild bool, pairs []BuilderImagePair, ...) error
- type BuilderImagePair
- type Error
- type GeneratedBuilderImagePair
- type InitBuilder
- type Initializer
Constants ¶
View Source
const ErrorNoBuilder = Error("one or more valid builder configuration (Dockerfile or Jib configuration) must be present to build images with skaffold; please provide at least one build config and try again or run `skaffold init --skip-build`")
View Source
const NoBuilder = "None (image not built from these sources)"
NoBuilder allows users to specify they don't want to build an image we parse out from a Kubernetes manifest
Variables ¶
This section is empty.
Functions ¶
func Artifacts ¶ added in v1.5.0
func Artifacts(pairs []BuilderImagePair) []*latest.Artifact
func PrintAnalyzeJSON ¶
func PrintAnalyzeJSON(out io.Writer, skipBuild bool, pairs []BuilderImagePair, unresolvedBuilders []InitBuilder, unresolvedImages []string) error
printAnalyzeJSON takes the automatically resolved builder/image pairs, the unresolved images, and the unresolved builders, and generates a JSON string containing builder config information,
func PrintAnalyzeOldFormat ¶
func PrintAnalyzeOldFormat(out io.Writer, skipBuild bool, pairs []BuilderImagePair, unresolvedBuilders []InitBuilder, unresolvedImages []string) error
TODO(nkubala): make these private again once DoInit() relinquishes control of the builder/image processing
Types ¶
type BuilderImagePair ¶
type BuilderImagePair struct {
Builder InitBuilder
ImageName string
}
BuilderImagePair defines a builder and the image it builds
type GeneratedBuilderImagePair ¶ added in v1.5.0
type GeneratedBuilderImagePair struct {
BuilderImagePair
ManifestPath string
}
GeneratedBuilderImagePair pairs a discovered builder with a generated image name, and the path to the manifest that should be generated
type InitBuilder ¶
type InitBuilder interface {
// Name returns the name of the builder.
Name() string
// Describe returns the initBuilder's string representation, used when prompting the user to choose a builder.
// Must be unique between artifacts.
Describe() string
// ArtifactType returns the type of the artifact to be built.
ArtifactType() latest.ArtifactType
// ConfiguredImage returns the target image configured by the builder, or an empty string if no image is configured.
// This should be a cheap operation.
ConfiguredImage() string
// Path returns the path to the build file
Path() string
}
InitBuilder represents a builder that can be chosen by skaffold init.
type Initializer ¶
type Initializer interface {
// ProcessImages is the entrypoint call, and handles the pairing of all builders
// contained in the initializer with the provided images from the deploy initializer
ProcessImages([]string) error
// BuildConfig returns the processed build config to be written to the skaffold.yaml
BuildConfig() latest.BuildConfig
// PrintAnalysis writes the project analysis to the provided out stream
PrintAnalysis(io.Writer) error
// GenerateManifests generates image names and manifests for all unresolved pairs
GenerateManifests() (map[GeneratedBuilderImagePair][]byte, error)
}
func NewInitializer ¶
func NewInitializer(builders []InitBuilder, c config.Config) Initializer
Click to show internal directories.
Click to hide internal directories.