artifacts

Documentation

Index

• Constants
• Variables
• type ChildModule
• type CloudFoundryConfig
• type ContainerizationOptionsConfig
  • func (co *ContainerizationOptionsConfig) Merge(newcoobj interface{}) bool
• type DotNetChildProject
• type DotNetConfig
• type EarArtifactConfig
• type GradleChildModule
• type GradleConfig
  • func (gc *GradleConfig) Merge(newgcobj interface{}) bool
• type ImageName
• type InvokeDetectConfig
• type JarArtifactConfig
• type JavaPackaging
• type MavenConfig
  • func (mc *MavenConfig) Merge(newmcobj interface{}) bool
• type NewImages
  • func (ni *NewImages) Merge(newniobj interface{}) bool
• type OriginalNameConfig
• type ServiceConfig
• type SpringBootConfig
  • func (sb *SpringBootConfig) Merge(newsbobj interface{}) bool
• type VCAPService
• type WarArtifactConfig

Constants

const (
	// ServiceDirPathType points to the service context directory.
	ServiceDirPathType transformertypes.PathType = "ServiceDirectories"
	// ServiceRootDirPathType points to the directory of the root project for a service.
	ServiceRootDirPathType transformertypes.PathType = "ServiceRootDirectory"
	// OriginalNameConfigType stores the original name of the app
	OriginalNameConfigType transformertypes.ConfigType = "OriginalName"
)

const (
	// CfManifestPathType defines the source artifact type of cf manifest
	CfManifestPathType transformertypes.PathType = "CfManifest"
	// CfRunningManifestPathType defines the source artifact type of a manifest of a running instance
	CfRunningManifestPathType transformertypes.PathType = "CfRunningManifest"
)

const (
	// ContainerBuildArtifactType represents the container build artifact type
	ContainerBuildArtifactType transformertypes.ArtifactType = "ContainerBuild"
	// BuildArtifactPathType defines the build artifact path
	BuildArtifactPathType transformertypes.PathType = "BuildArtifact"
)

const (
	// ContainerImageBuildShScriptPathType represents the image build script path type
	ContainerImageBuildShScriptPathType transformertypes.PathType = "ContainerImageBuildShScript"
	// ContainerImageBuildBatScriptPathType represents the image build script path type
	ContainerImageBuildBatScriptPathType transformertypes.PathType = "ContainerImageBuildBatScript"
	// ContainerImageBuildShScriptContextPathType represents the image build script path type
	ContainerImageBuildShScriptContextPathType transformertypes.PathType = "ContainerImageBuildShScriptContextScript"
	// ContainerImageBuildBatScriptContextPathType represents the image build script path type
	ContainerImageBuildBatScriptContextPathType transformertypes.PathType = "ContainerImageBuildBatScriptContextScript"
)

const (
	// ContainerImagesPushShScriptPathType represents the image push script path type
	ContainerImagesPushShScriptPathType transformertypes.PathType = "ContainerImagesPushShScript"
	// ContainerImagesPushBatScriptPathType represents the image push script path type
	ContainerImagesPushBatScriptPathType transformertypes.PathType = "ContainerImagesPushBatScript"
)

const (
	// DockerfilePathType defines the source artifact type of dockerfile
	DockerfilePathType transformertypes.PathType = "Dockerfile"

	// DockerfileContextPathType defines the source artifact type of dockerfile context
	DockerfileContextPathType transformertypes.PathType = "DockerfileContext"
)

const (
	// GradleConfigType stores the gradle config
	GradleConfigType transformertypes.ConfigType = "Gradle"
	// GradleSettingsFilePathType is the type for paths to settings.gradle files
	GradleSettingsFilePathType transformertypes.PathType = "GradleSettingsFile"
	// GradleBuildFilePathType stores the Gradle Build File file Path
	GradleBuildFilePathType transformertypes.PathType = "GradleBuildFile"
)

const (
	// JarArtifactType defines the jar artifact type
	JarArtifactType transformertypes.ArtifactType = "Jar"
	// JarConfigType defines the jar config type
	JarConfigType transformertypes.ConfigType = transformertypes.ConfigType(JarArtifactType)
	// JarPathType defines jar path type
	JarPathType transformertypes.PathType = transformertypes.PathType(JarArtifactType)

	// WarArtifactType defines war artifact type
	WarArtifactType transformertypes.ArtifactType = "War"
	// WarConfigType defines the war config type
	WarConfigType transformertypes.ConfigType = transformertypes.ConfigType(WarArtifactType)
	// WarPathType defines the war path type
	WarPathType transformertypes.PathType = transformertypes.PathType(WarArtifactType)

	// EarArtifactType defines the ear artifact type
	EarArtifactType transformertypes.ArtifactType = "Ear"
	// EarConfigType defines the ear config type
	EarConfigType transformertypes.ConfigType = transformertypes.ConfigType(EarArtifactType)
	// EarPathType defines the ear path type
	EarPathType transformertypes.PathType = transformertypes.PathType(EarArtifactType)

	// BuildContainerFileType defines the build container file type
	BuildContainerFileType transformertypes.PathType = "BuildContainerFile"

	// PomPackaging is used by parent pom.xml files in multi-module maven projects.
	// https://maven.apache.org/pom.html#Aggregation
	// https://www.baeldung.com/maven-multi-module
	PomPackaging JavaPackaging = "pom"
	// JarPackaging defines jar packaging
	JarPackaging JavaPackaging = "jar"
	// WarPackaging defines war packaging
	WarPackaging JavaPackaging = "war"
	// EarPackaging defines ear packaging
	EarPackaging JavaPackaging = "ear"
)

const (
	// KubernetesYamlsArtifactType is the name of the Kubernetes artifact type
	KubernetesYamlsArtifactType transformertypes.ArtifactType = "KubernetesYamls"

	// KubernetesYamlsInSourceArtifactType is the name of the Kubernetes artifact type
	KubernetesYamlsInSourceArtifactType transformertypes.ArtifactType = "KubernetesYamlsInSource"

	// KubernetesOrgYamlsInSourceArtifactType is the name of the Kubernetes original yamls artifact type
	KubernetesOrgYamlsInSourceArtifactType transformertypes.ArtifactType = "KubernetesOrgYamlsInSource"

	// KubernetesYamlsPathType is points to the kubernetes Yamls
	KubernetesYamlsPathType transformertypes.PathType = "KubernetesYamls"
)

const (
	// MavenConfigType stores the maven config
	MavenConfigType transformertypes.ConfigType = "Maven"
	// MavenPomPathType stores the Maven POM file Path
	MavenPomPathType transformertypes.PathType = "pomFiles"
	// MavenParentModulePomPathType stores the Maven's parent POM file Path
	MavenParentModulePomPathType transformertypes.PathType = "MavenParentModulePom"
	// MavenSubModulePomPathType stores the Maven's submodule POM file Path
	MavenSubModulePomPathType transformertypes.PathType = "MavenSubModulePom"
)

const CNBDetectedServiceArtifactType transformertypes.ArtifactType = "CNBDetectedService"

CNBDetectedServiceArtifactType is the name of the CNB artifact type

const (
	// CloudFoundryConfigType represents the cloud foundry service configuration
	CloudFoundryConfigType transformertypes.ConfigType = "CloudFoundryService"
)

const (
	// ContainerConfigType represents container config type
	ContainerConfigType transformertypes.ConfigType = "Container"
)

const (
	// ContainerImageBuildScriptArtifactType represents the image build script artifact type
	ContainerImageBuildScriptArtifactType transformertypes.ArtifactType = "ContainerImageBuildScript"
)

const (
	// ContainerImagesPushScriptArtifactType represents the image push script artifact type
	ContainerImagesPushScriptArtifactType transformertypes.ArtifactType = "ContainerImagesPushScript"
)

const (
	// ContainerizationOptionsConfigType represents containerization options config type
	ContainerizationOptionsConfigType transformertypes.ConfigType = "ContainerizationOptions"
)

const DockerfileArtifactType transformertypes.ArtifactType = "Dockerfile"

DockerfileArtifactType represents the Dockerfile artifact type

const DockerfileForServiceArtifactType transformertypes.ArtifactType = "DockerfileForService"

DockerfileForServiceArtifactType represents the Dockerfile artifact type with service information for populating IR

const (
	// DockerfileTemplateConfigConfigType stores the imagename for the dockerfile
	DockerfileTemplateConfigConfigType transformertypes.ConfigType = "DockerfileTemplateConfig"
)

const (
	// DotNetConfigType stores the dot net config
	DotNetConfigType transformertypes.ConfigType = "DotNet"
)

const (
	// ImageNameConfigType stores the imagename
	ImageNameConfigType transformertypes.ConfigType = "ImageName"
)

const (
	// InvokeDetectConfigType is the type for the InvokeDetect type artifact's configuration
	InvokeDetectConfigType transformertypes.ConfigType = "InvokeDetect"
)

const (
	// InvokeDetectPathType defines the path type (for use in artifacts) that indicates the directory
	// on which to run the detect function of another transformer.
	InvokeDetectPathType transformertypes.PathType = "InvokeDetect"
)

const NewImagesArtifactType transformertypes.ArtifactType = "NewImages"

NewImagesArtifactType represents New Image Artifact Type

const NewImagesConfigType transformertypes.ConfigType = "NewImages"

NewImagesConfigType represents New Image Config type

const ServiceArtifactType transformertypes.ArtifactType = "Service"

ServiceArtifactType stores the service artifact type name

const ServiceConfigType transformertypes.ConfigType = "Service"

ServiceConfigType stores service config type name

const (
	// SpringBootConfigType stores the springboot config
	SpringBootConfigType transformertypes.ConfigType = "SpringBoot"
)

Variables

var (
	// ConfigTypes stores the various config types
	ConfigTypes map[string]reflect.Type
)

Types

type ChildModule

type ChildModule struct {
	// Name is the name/artifact id of the child module (given in the child pom.xml)
	Name string `yaml:"name" json:"name"`
	// RelPomPath is the path to the child pom.xml (relative to the parent pom.xml)
	RelPomPath string `yaml:"pomPath" json:"pomPath"`
}

ChildModule represents the data for a Maven child pom.xml in a multi-module project

type CloudFoundryConfig

type CloudFoundryConfig struct {
	ServiceName string `yaml:"serviceName,omitempty"`
	ImageName   string `yaml:"imageName,omitempty"`
}

CloudFoundryConfig stores the configurations

type ContainerizationOptionsConfig

type ContainerizationOptionsConfig []string

ContainerizationOptionsConfig stores the containerization options config

func (*ContainerizationOptionsConfig) Merge

func (co *ContainerizationOptionsConfig) Merge(newcoobj interface{}) bool

Merge implements the Config interface allowing artifacts to be merged

type DotNetChildProject

type DotNetChildProject struct {
	// Name is the name of the child project
	Name string `yaml:"name" json:"name"`
	// OriginalName is the name of the child project before normalization
	OriginalName string `yaml:"originalName" json:"originalName"`
	// RelCSProjPath is the path to the child .csproj (relative to the parent .sln file)
	RelCSProjPath string `yaml:"csProjPath" json:"csProjPath"`
	// TargetFramework contains the target dot net core or dot net framework name and version
	TargetFramework string `yaml:"targetFramework" json:"targetFramework"`
}

DotNetChildProject represents the data for a child project in a multi-project dot net app

type DotNetConfig

type DotNetConfig struct {
	IsDotNetCore          bool                 `yaml:"isDotNetCore" json:"isDotNetCore"`
	DotNetAppName         string               `yaml:"dotNetAppName,omitempty" json:"dotNetAppName,omitempty"`
	IsSolutionFilePresent bool                 `yaml:"isSolutionFilePresent" json:"isSolutionFilePresent"`
	ChildProjects         []DotNetChildProject `yaml:"childProjects,omitempty" json:"childProjects,omitempty"`
}

DotNetConfig stores dot net related configuration information

type EarArtifactConfig

type EarArtifactConfig JarArtifactConfig

EarArtifactConfig defines a EarArtifactConfig struct

type GradleChildModule

type GradleChildModule struct {
	// Name is the name/artifact id of the child module
	Name string `yaml:"name" json:"name"`
	// RelBuildScriptPath is the path to the child build.gradle (relative to the root settings.gradle)
	RelBuildScriptPath string `yaml:"buildScriptPath" json:"buildScriptPath"`
}

GradleChildModule represents the data for a Gradle child project in a multi-module project

type GradleConfig

type GradleConfig struct {
	RootProjectName  string              `yaml:"rootProjectName,omitempty" json:"rootProjectName,omitempty"`
	PackagingType    JavaPackaging       `yaml:"packagingType" json:"packagingType"`
	IsGradlewPresent bool                `yaml:"isGradlewPresent" json:"isGradlewPresent"`
	ChildModules     []GradleChildModule `yaml:"childModules,omitempty" json:"childModules,omitempty"`
}

GradleConfig stores gradle related configuration information

func (*GradleConfig) Merge

func (gc *GradleConfig) Merge(newgcobj interface{}) bool

Merge implements the Config interface allowing artifacts to be merged

type ImageName

type ImageName struct {
	ImageName string `yaml:"imageName" json:"imageName"`
}

ImageName is the struct storing the ImageName

type InvokeDetectConfig

type InvokeDetectConfig struct {
	TransformerSelector metav1.LabelSelector `yaml:"transformerSelector" json:"transformerSelector"`
}

InvokeDetectConfig stores the configuration for an InvokeDetect artifact

type JarArtifactConfig

type JarArtifactConfig struct {
	Port               int32             `yaml:"port"`
	JavaVersion        string            `yaml:"javaVersion"`
	BuildContainerName string            `yaml:"buildContainerName"`
	DeploymentFilePath string            `yaml:"deploymentFilePath"`
	EnvVariables       map[string]string `yaml:"envVariables"`
}

JarArtifactConfig defines a JarArtifactConfig struct

type JavaPackaging

type JavaPackaging string

JavaPackaging represents JavaPackaging type

type MavenConfig

type MavenConfig struct {
	MavenAppName  string        `yaml:"mavenAppName,omitempty" json:"mavenAppName,omitempty"`
	PackagingType JavaPackaging `yaml:"packagingType" json:"packagingType"`
	MavenProfiles []string      `yaml:"mavenProfiles,omitempty" json:"mavenProfiles,omitempty"`
	IsMvnwPresent bool          `yaml:"isMvnwPresent" json:"isMvnwPresent"`
	ChildModules  []ChildModule `yaml:"childModules,omitempty" json:"childModules,omitempty"`
}

MavenConfig stores maven related configuration information

func (*MavenConfig) Merge

func (mc *MavenConfig) Merge(newmcobj interface{}) bool

Merge implements the Config interface allowing artifacts to be merged

type NewImages

type NewImages struct {
	ImageNames []string `yaml:"imageNames" json:"imageNames"`
}

NewImages represents the strut having configuration about new images

func (*NewImages) Merge

func (ni *NewImages) Merge(newniobj interface{}) bool

Merge implements the Config interface allowing artifacts to be merged

type OriginalNameConfig

type OriginalNameConfig struct {
	OriginalName string `yaml:"originalName,omitempty" json:"originalName,omitempty"`
}

OriginalNameConfig stores the original name of the app

type ServiceConfig

type ServiceConfig struct {
	ServiceName string `yaml:"serviceName"`
}

ServiceConfig stores config related to service

type SpringBootConfig

type SpringBootConfig struct {
	SpringBootVersion      string             `yaml:"springBootVersion,omitempty" json:"springBootVersion,omitempty"`
	SpringBootAppName      string             `yaml:"springBootAppName,omitempty" json:"springBootAppName,omitempty"`
	SpringBootProfiles     *[]string          `yaml:"springBootProfiles,omitempty" json:"springBootProfiles,omitempty"`
	SpringBootProfilePorts map[string][]int32 `yaml:"springBootProfilePorts,omitempty" json:"springBootProfilePorts,omitempty"`
}

SpringBootConfig stores spring boot related configuration information

func (*SpringBootConfig) Merge

func (sb *SpringBootConfig) Merge(newsbobj interface{}) bool

Merge implements the Config interface allowing artifacts to be merged

type VCAPService

type VCAPService struct {
	ServiceName        string                 `json:"name"`
	ServiceCredentials map[string]interface{} `json:"credentials"`
}

VCAPService defines the VCAP service data from JSON

type WarArtifactConfig

type WarArtifactConfig JarArtifactConfig

WarArtifactConfig defines a WarArtifactConfig struct