jenkinsutil

Documentation

Index

• Constants
• Variables
• func FindJenkinsServers(f *ClientFactory, jenkinsSelector *JenkinsSelectorOptions) (map[string]*JenkinsServer, []string, error)
• type ClientFactory
• type JenkinsSelectorOptions
  • func (o *JenkinsSelectorOptions) AddFlags(cmd *cobra.Command)
• type JenkinsServer

Constants

const (
	// TriggerJenkinsServerEnv the environment variable used to choose the jenkins server to trigger
	TriggerJenkinsServerEnv = "TRIGGER_JENKINS_SERVER"

	// JenkinsSelector the default selector to find Jenkins services as Kubernetes Services
	JenkinsSelector = "app=jenkins-operator"

	// JenkinsNameLabel default label to indicate the name of the Jenkins service
	JenkinsNameLabel = "jenkins-cr"
)

Variables

var (
	// DefaultJenkinsSelector default selector options to use if finding Jenkins services
	DefaultJenkinsSelector = JenkinsSelectorOptions{
		Selector:  JenkinsSelector,
		NameLabel: JenkinsNameLabel,
	}
)

Functions

func FindJenkinsServers

func FindJenkinsServers(f *ClientFactory, jenkinsSelector *JenkinsSelectorOptions) (map[string]*JenkinsServer, []string, error)

FindJenkinsServers discovers the jenkins services

Types

type ClientFactory

type ClientFactory struct {
	Namespace             string
	Batch                 bool
	InCluster             bool
	DevelopmentJenkinsURL string
}

type JenkinsSelectorOptions

type JenkinsSelectorOptions struct {
	// JenkinsName the name of the Jenkins Operator Service for HTTP to use
	JenkinsName string

	// Selector label selector to find the Jenkins Operator Services
	Selector string

	// NameLabel label the label to find the name of the Jenkins service
	NameLabel string

	// DevelopmentJenkinsURL a local URL to use to talk to the jenkins server if the servers do not have Ingress
	// and you want to test out using the jenkins client locally
	DevelopmentJenkinsURL string
}

JenkinsSelectorOptions used to represent the options used to refer to a Jenkins. if nothing is specified it assumes the current team is using a static Jenkins server as its execution engine. otherwise we can refer to other additional Jenkins Apps to implement custom Jenkins servers

func (*JenkinsSelectorOptions) AddFlags

func (o *JenkinsSelectorOptions) AddFlags(cmd *cobra.Command)

AddFlags add the command flags for picking a custom Jenkins App to work with

type JenkinsServer

type JenkinsServer struct {
	// Name the name of the Jenkins server in the registry. Should be a valid kubernetes name
	Name string

	// URL the URL to connect to the Jenkins server
	URL string

	// SecretName the name of the Secret in the registry
	SecretName string
}

JenkinsServer represents a jenkins server discovered via Service selectors or via the trigger-pipeline secrets