dockerfilegen

Documentation

Index

• Constants
• Variables
• func DefaultBuildEnvVars() []string
• func GenerateDockerfiles(params Params) error
• type Params
  • func DefaultParams(wd string) Params
  • func (p *Params) ConfigureFlags() (*pflag.FlagSet, error)

Constants

const (
	GenerateDockerfileOption           = "dockerfile"
	GenerateMustGatherDockerfileOption = "must-gather-dockerfile"
	DefaultDockerfileTemplateName      = "default"
	FuncUtilDockerfileTemplateName     = "func-util"
)

Variables

var (
	ErrUnexpected      = fmt.Errorf("unexpected")
	ErrIO              = fmt.Errorf("%w: system IO failed", ErrUnexpected)
	ErrBadConf         = fmt.Errorf("bad configuration")
	ErrUnsupportedRepo = fmt.Errorf("unsupported repo structure")
	ErrBadTemplate     = fmt.Errorf("bad template")
)

var DockerfileBuildImageTemplate embed.FS

var DockerfileDefaultTemplate embed.FS

var DockerfileFuncUtilTemplate embed.FS

var DockerfileMustGatherTemplate embed.FS

var DockerfileSourceImageTemplate embed.FS

var RPMsLockTemplateUbi8 embed.FS

Functions

func DefaultBuildEnvVars

func DefaultBuildEnvVars() []string

DefaultBuildEnvVars is default set of FIPS flags to be used per builds

func GenerateDockerfiles

func GenerateDockerfiles(params Params) error

GenerateDockerfiles will generate Dockerfile files

Types

type Params

type Params struct {
	RootDir                      string   `json:"root-dir" desc:"Root directory to start scanning, default to current working directory"`
	Includes                     []string `json:"includes" desc:"File or directory regex to include"`
	Excludes                     []string `json:"excludes" desc:"File or directory regex to exclude"`
	Generators                   string   `json:"generators" desc:"Generate something supported: [dockerfile, must-gather-dockerfile]"`
	Output                       string   `json:"output" desc:"Output directory"`
	DockerfilesDir               string   `json:"dockerfiles-dir" desc:"Dockerfiles output directory for project images relative to output flag"`
	DockerfilesTestDir           string   `json:"dockerfiles-test-dir" desc:"Dockerfiles output directory for test images relative to output flag"`
	DockerfilesBuildDir          string   `json:"dockerfiles-build-dir" desc:"Dockerfiles output directory for build image relative to output flag"`
	DockerfilesSourceDir         string   `json:"dockerfiles-source-dir" desc:"Dockerfiles output directory for source image relative to output flag"`
	ProjectFilePath              string   `json:"project-file" desc:"Project metadata file path"`
	DockerfileImageBuilderFmt    string   `json:"dockerfile-image-builder-fmt" desc:"Dockerfile image builder format"`
	AppFileFmt                   string   `json:"app-file-fmt" desc:"Target application binary path format"`
	RegistryImageFmt             string   `json:"registry-image-fmt" desc:"Container registry image format"`
	ImagesFromRepositories       []string `` /* 133-byte string literal not displayed */
	ImagesFromRepositoriesURLFmt string   `` /* 134-byte string literal not displayed */
	AdditionalPackages           []string `json:"additional-packages" desc:"Additional packages to be installed in the image"`
	AdditionalBuildEnvVars       []string `json:"additional-build-env" desc:"Additional env vars to be added to builder in the image"`
	TemplateName                 string   `json:"template-name" desc:"Dockerfile template name to use. Supported values are [default, func-util]"`
	RpmsLockFileEnabled          bool     `json:"generate-rpms-lock-file" desc:"Enable the creation of the rpms.lock.yaml file"`
}

func DefaultParams

func DefaultParams(wd string) Params

func (*Params) ConfigureFlags

func (p *Params) ConfigureFlags() (*pflag.FlagSet, error)