jib

Documentation

Index

• Constants
• Variables
• func GenerateGradleArgs(task string, imageName string, a *latest.JibGradleArtifact, skipTests bool) []string
• func GenerateMavenArgs(goal string, imageName string, a *latest.JibMavenArtifact, skipTests bool) []string
• func GetDependenciesGradle(ctx context.Context, workspace string, a *latest.JibGradleArtifact) ([]string, error)
• func GetDependenciesMaven(ctx context.Context, workspace string, a *latest.JibMavenArtifact) ([]string, error)
• type Jib
  • func ValidateJibConfig(path string) []Jib
  • func (j Jib) ConfiguredImage() string
  • func (j Jib) CreateArtifact(manifestImage string) *latest.Artifact
  • func (j Jib) Describe() string
  • func (j Jib) Name() string
  • func (j Jib) Path() string

Constants

const (
	// JibGradle the name of the Jib Gradle Plugin
	JibGradle = "Jib Gradle Plugin"
	// JibMaven the name of the Jib Maven Plugin
	JibMaven = "Jib Maven Plugin"
)

const MinimumJibGradleVersion = "1.4.0"

Skaffold-Jib depends on functionality introduced with Jib-Gradle 1.4.0

const MinimumJibMavenVersion = "1.4.0"

Skaffold-Jib depends on functionality introduced with Jib-Maven 1.4.0

Variables

var GradleCommand = util.CommandWrapper{Executable: "gradle", Wrapper: "gradlew"}

GradleCommand stores Gradle executable and wrapper name

var MavenCommand = util.CommandWrapper{Executable: "mvn", Wrapper: "mvnw"}

MavenCommand stores Maven executable and wrapper name

var (
	ValidateJibConfigFunc = ValidateJibConfig
)

For testing

Functions

func GenerateGradleArgs

func GenerateGradleArgs(task string, imageName string, a *latest.JibGradleArtifact, skipTests bool) []string

GenerateGradleArgs generates the arguments to Gradle for building the project as an image.

func GenerateMavenArgs

func GenerateMavenArgs(goal string, imageName string, a *latest.JibMavenArtifact, skipTests bool) []string

GenerateMavenArgs generates the arguments to Maven for building the project as an image.

func GetDependenciesGradle

func GetDependenciesGradle(ctx context.Context, workspace string, a *latest.JibGradleArtifact) ([]string, error)

GetDependenciesGradle finds the source dependencies for the given jib-gradle artifact. All paths are absolute.

func GetDependenciesMaven

func GetDependenciesMaven(ctx context.Context, workspace string, a *latest.JibMavenArtifact) ([]string, error)

GetDependenciesMaven finds the source dependencies for the given jib-maven artifact. All paths are absolute.

Types

type Jib

type Jib struct {
	BuilderName string `json:"-"`
	Image       string `json:"image,omitempty"`
	FilePath    string `json:"path,omitempty"`
	Project     string `json:"project,omitempty"`
}

Jib holds information about a Jib project

func ValidateJibConfig

func ValidateJibConfig(path string) []Jib

ValidateJibConfig checks if a file is a valid Jib configuration. Returns the list of Config objects corresponding to each Jib project built by the file, or nil if Jib is not configured.

func (Jib) ConfiguredImage

func (j Jib) ConfiguredImage() string

ConfiguredImage returns the target image configured by the builder, or empty string if no image is configured

func (Jib) CreateArtifact

func (j Jib) CreateArtifact(manifestImage string) *latest.Artifact

CreateArtifact creates an Artifact to be included in the generated Build Config

func (Jib) Describe

func (j Jib) Describe() string

Describe returns the initBuilder's string representation, used when prompting the user to choose a builder.

func (Jib) Name

func (j Jib) Name() string

Name returns the name of the builder

func (Jib) Path

func (j Jib) Path() string

Path returns the path to the build definition