config

Documentation

Index

• Constants
• func HashSha(password string) string
• type AddonConfig
• type AdminSecretsConfig
  • func (c AdminSecretsConfig) String() (string, error)
• type AdminSecretsFlags
• type AdminSecretsService
  • func (s *AdminSecretsService) AddAdminSecretsValues(cmd *cobra.Command)
  • func (s *AdminSecretsService) NewAdminSecretsConfig() error
• type BranchBuild
• type Build
• type ChartMuseum
• type ChartMuseumSecret
• type ChatConfig
• type ExposeController
• type ExposeControllerConfig
• type Grafana
• type GrafanaSecret
• type HelmValuesConfig
  • func (c *HelmValuesConfig) AddExposeControllerValues(cmd *cobra.Command, ignoreDomain bool)
  • func (c HelmValuesConfig) String() (string, error)
• type HelmValuesConfigService
• type Image
• type IngressBasicAuth
• type IssueTrackerConfig
• type Jenkins
• type JenkinsAdminSecret
• type JenkinsGiteaServersValuesConfig
• type JenkinsGithubServersValuesConfig
• type JenkinsPipelineSecretsValuesConfig
• type JenkinsServersGlobalConfig
• type JenkinsServersValuesConfig
  • func (c *JenkinsServersValuesConfig) GetOrCreateFirstGitea() *JenkinsGiteaServersValuesConfig
• type JenkinsValuesConfig
• type Nexus
• type PipelineSecrets
• type Preview
• type PreviewEnvironmentConfig
• type PreviewValuesConfig
  • func (c PreviewValuesConfig) String() (string, error)
• type ProjectConfig
  • func LoadProjectConfig(projectDir string) (*ProjectConfig, string, error)
  • func (c *ProjectConfig) IsEmpty() bool
  • func (c *ProjectConfig) SaveConfig(fileName string) error
• type ProwValuesConfig
• type WikiConfig

Constants

const (
	// ProjectConfigFileName is the name of the project configuration file
	ProjectConfigFileName = "jenkins-x.yml"
)

Functions

func HashSha

func HashSha(password string) string

Types

type AddonConfig

type AddonConfig struct {
	Name    string `yaml:"name,omitempty"`
	Version string `yaml:"version,omitempty"`
}

type AdminSecretsConfig

type AdminSecretsConfig struct {
	IngressBasicAuth string           `yaml:"JXBasicAuth,omitempty"`
	ChartMuseum      *ChartMuseum     `yaml:"chartmuseum,omitempty"`
	Grafana          *Grafana         `yaml:"grafana,omitempty"`
	Jenkins          *Jenkins         `yaml:"jenkins,omitempty"`
	Nexus            *Nexus           `yaml:"nexus,omitempty"`
	PipelineSecrets  *PipelineSecrets `yaml:"PipelineSecrets,omitempty"`
}

func (AdminSecretsConfig) String

func (c AdminSecretsConfig) String() (string, error)

type AdminSecretsFlags

type AdminSecretsFlags struct {
	DefaultAdminPassword string
}

type AdminSecretsService

type AdminSecretsService struct {
	FileName string
	Secrets  AdminSecretsConfig
	Flags    AdminSecretsFlags
}

func (*AdminSecretsService) AddAdminSecretsValues

func (s *AdminSecretsService) AddAdminSecretsValues(cmd *cobra.Command)

func (*AdminSecretsService) NewAdminSecretsConfig

func (s *AdminSecretsService) NewAdminSecretsConfig() error

type BranchBuild

type BranchBuild struct {
	Build Build `yaml:"build,omitempty"`

	// which kind of pipeline - like release, pullRequest, feature
	Kind string `yaml:"kind,omitempty"`

	// display name
	Name string `yaml:"name,omitempty"`

	// List of sources to populate environment variables in all the steps if there is not already
	// an environment variable defined on that step
	EnvFrom []corev1.EnvFromSource `yaml:"envFrom,omitempty"`

	// List of environment variables to add to each step if there is not already a environemnt variable of that name
	Env []corev1.EnvVar `yaml:"env,omitempty"`

	ExcludePodTemplateEnv     bool `yaml:"excludePodTemplateEnv,omitempty"`
	ExcludePodTemplateVolumes bool `yaml:"excludePodTemplateVolumes,omitempty"`
}

type Build

type Build struct {
	// Steps are the steps of the build; each step is run sequentially with the
	// source mounted into /workspace.
	Steps []corev1.Container `yaml:"steps,omitempty"`

	// Volumes is a collection of volumes that are available to mount into the
	// steps of the build.
	Volumes []corev1.Volume `yaml:"volumes,omitempty"`

	// The name of the service account as which to run this build.
	ServiceAccountName string `yaml:"serviceAccountName,omitempty"`

	// NodeSelector is a selector which must be true for the pod to fit on a node.
	// Selector which must match a node's labels for the pod to be scheduled on that node.
	// More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/
	// +optional
	NodeSelector map[string]string `yaml:"nodeSelector,omitempty"`
}

type ChartMuseum

type ChartMuseum struct {
	ChartMuseumSecret ChartMuseumSecret `yaml:"secret"`
}

type ChartMuseumSecret

type ChartMuseumSecret struct {
	User     string `yaml:"BASIC_AUTH_USER"`
	Password string `yaml:"BASIC_AUTH_PASS"`
}

type ChatConfig

type ChatConfig struct {
	Kind             string `yaml:"kind,omitempty"`
	URL              string `yaml:"url,omitempty"`
	DeveloperChannel string `yaml:"developerChannel,omitempty"`
	UserChannel      string `yaml:"userChannel,omitempty"`
}

type ExposeController

type ExposeController struct {
	Config      ExposeControllerConfig `yaml:"config,omitempty"`
	Annotations map[string]string      `yaml:"Annotations,omitempty"`
}

type ExposeControllerConfig

type ExposeControllerConfig struct {
	Domain   string `yaml:"domain,omitempty"`
	Exposer  string `yaml:"exposer"`
	HTTP     string `yaml:"http"`
	TLSAcme  string `yaml:"tlsacme"`
	PathMode string `yaml:"pathMode"`
}

type Grafana

type Grafana struct {
	GrafanaSecret GrafanaSecret `yaml:"server"`
}

type GrafanaSecret

type GrafanaSecret struct {
	User     string `yaml:"adminUser"`
	Password string `yaml:"adminPassword"`
}

type HelmValuesConfig

type HelmValuesConfig struct {
	ExposeController *ExposeController                  `yaml:"expose,omitempty"`
	Jenkins          JenkinsValuesConfig                `yaml:"jenkins,omitempty"`
	Prow             ProwValuesConfig                   `yaml:"prow,omitempty"`
	PipelineSecrets  JenkinsPipelineSecretsValuesConfig `yaml:"PipelineSecrets,omitempty"`
}

func (*HelmValuesConfig) AddExposeControllerValues

func (c *HelmValuesConfig) AddExposeControllerValues(cmd *cobra.Command, ignoreDomain bool)

func (HelmValuesConfig) String

func (c HelmValuesConfig) String() (string, error)

type HelmValuesConfigService

type HelmValuesConfigService struct {
	FileName string
	Config   HelmValuesConfig
}

type Image

type Image struct {
	Repository string `yaml:"repository,omitempty"`
	Tag        string `yaml:"tag,omitempty"`
}

type IngressBasicAuth

type IngressBasicAuth struct {
	JXBasicAuth string `yaml:"JXBasicAuth"`
}

type IssueTrackerConfig

type IssueTrackerConfig struct {
	Kind    string `yaml:"kind,omitempty"`
	URL     string `yaml:"url,omitempty"`
	Project string `yaml:"project,omitempty"`
}

type Jenkins

type Jenkins struct {
	JenkinsSecret JenkinsAdminSecret `yaml:"Master"`
}

type JenkinsAdminSecret

type JenkinsAdminSecret struct {
	Password string `yaml:"AdminPassword"`
}

type JenkinsGiteaServersValuesConfig

type JenkinsGiteaServersValuesConfig struct {
	Name       string `yaml:"Name,omitempty"`
	Url        string `yaml:"Url,omitempty"`
	Credential string `yaml:"Credential,omitempty"`
}

type JenkinsGithubServersValuesConfig

type JenkinsGithubServersValuesConfig struct {
	Name string `yaml:"Name,omitempty"`
	Url  string `yaml:"Url,omitempty"`
}

type JenkinsPipelineSecretsValuesConfig

type JenkinsPipelineSecretsValuesConfig struct {
	DockerConfig string `yaml:"DockerConfig,flow,omitempty"`
}

type JenkinsServersGlobalConfig

type JenkinsServersGlobalConfig struct {
	EnvVars map[string]string `yaml:"EnvVars,omitempty"`
}

type JenkinsServersValuesConfig

type JenkinsServersValuesConfig struct {
	Gitea  []JenkinsGiteaServersValuesConfig  `yaml:"Gitea,omitempty"`
	GHE    []JenkinsGithubServersValuesConfig `yaml:"GHE,omitempty"`
	Global JenkinsServersGlobalConfig         `yaml:"Global,omitempty"`
}

func (*JenkinsServersValuesConfig) GetOrCreateFirstGitea

func (c *JenkinsServersValuesConfig) GetOrCreateFirstGitea() *JenkinsGiteaServersValuesConfig

GetOrCreateFirstGitea returns the first gitea server creating one if required

type JenkinsValuesConfig

type JenkinsValuesConfig struct {
	Servers JenkinsServersValuesConfig `yaml:"Servers,omitempty"`
}

type Nexus

type Nexus struct {
	DefaultAdminPassword string `yaml:"defaultAdminPassword,omitempty"`
}

type PipelineSecrets

type PipelineSecrets struct {
	MavenSettingsXML string `yaml:"MavenSettingsXML,omitempty"`
}

type Preview

type Preview struct {
	Image *Image `yaml:"image,omitempty"`
}

type PreviewEnvironmentConfig

type PreviewEnvironmentConfig struct {
	Disabled         bool `yaml:"disabled,omitempty"`
	MaximumInstances int  `yaml:"maximumInstances,omitempty"`
}

type PreviewValuesConfig

type PreviewValuesConfig struct {
	ExposeController *ExposeController `yaml:"expose,omitempty"`
	Preview          *Preview          `yaml:"preview,omitempty"`
}

func (PreviewValuesConfig) String

func (c PreviewValuesConfig) String() (string, error)

type ProjectConfig

type ProjectConfig struct {
	// List of global environment variables to add to each branch build and each step
	Env []corev1.EnvVar `yaml:"env,omitempty"`

	Builds              []*BranchBuild            `yaml:"builds,omitempty"`
	PreviewEnvironments *PreviewEnvironmentConfig `yaml:"previewEnvironments,omitempty"`
	IssueTracker        *IssueTrackerConfig       `yaml:"issueTracker,omitempty"`
	Chat                *ChatConfig               `yaml:"chat,omitempty"`
	Wiki                *WikiConfig               `yaml:"wiki,omitempty"`
	Addons              []*AddonConfig            `yaml:"addons,omitempty"`
	BuildPack           string                    `yaml:"buildPack,omitempty"`
	BuildPackGitURL     string                    `yaml:"buildPackGitURL,omitempty"`
	BuildPackGitURef    string                    `yaml:"buildPackGitRef,omitempty"`
	Workflow            string                    `yaml:"workflow,omitempty"`
}

func LoadProjectConfig

func LoadProjectConfig(projectDir string) (*ProjectConfig, string, error)

LoadProjectConfig loads the project configuration if there is a project configuration file

func (*ProjectConfig) IsEmpty

func (c *ProjectConfig) IsEmpty() bool

IsEmpty returns true if this configuration is empty

func (*ProjectConfig) SaveConfig

func (c *ProjectConfig) SaveConfig(fileName string) error

SaveConfig saves the configuration file to the given project directory

type ProwValuesConfig

type ProwValuesConfig struct {
	User       string `yaml:"user,omitempty"`
	HMACtoken  string `yaml:"hmacToken,omitempty"`
	OAUTHtoken string `yaml:"oauthToken,omitempty"`
}

type WikiConfig

type WikiConfig struct {
	Kind  string `yaml:"kind,omitempty"`
	URL   string `yaml:"url,omitempty"`
	Space string `yaml:"space,omitempty"`
}