public_git/kubernetes-operator
1
0
Fork 0
mirror of https://github.com/jenkinsci/kubernetes-operator.git synced 2026-10-19 09:10:58 +02:00
Code Issues Releases Wiki Activity

Grand Christmas Patch

Browse Source 
Fixed helm not creating role permissions #424
Added ability to use custom k8s cluster domain #461
Fixed propagation of JENKINS_OPTS to seed-job agent #462
Fixed updating last backup #421
This commit is contained in:
Sylwia Brant
2020-12-15 10:18:40 +01:00
parent 3a143a0831
commit 566ac9768f
25 changed files with 473 additions and 244 deletions
Download Patch File Download Diff File Expand all files Collapse all files
pkg/configuration/base/configmap.go
+1 -1
View File
@@ -24,7 +24,7 @@ func (r *ReconcileJenkinsBaseConfiguration) createInitConfigurationConfigMap(met
}
func (r *ReconcileJenkinsBaseConfiguration) createBaseConfigurationConfigMap(meta metav1.ObjectMeta) error {
configMap, err := resources.NewBaseConfigurationConfigMap(meta, r.Configuration.Jenkins)
configMap, err := resources.NewBaseConfigurationConfigMap(meta, r.Configuration.Jenkins, r.KubernetesClusterDomain)
if err != nil {
return err
}
pkg/configuration/base/resources/base_configuration_configmap.go
+15 -5
View File
@@ -126,7 +126,7 @@ if (kubernetes == null) {
add = true
kubernetes = new KubernetesCloud("kubernetes")
}
kubernetes.setServerUrl("https://kubernetes.default.svc.cluster.local:443")
kubernetes.setServerUrl("https://kubernetes.default.svc.%s:443")
kubernetes.setNamespace("%s")
kubernetes.setJenkinsUrl("%s")
kubernetes.setJenkinsTunnel("%s")
@@ -178,16 +178,24 @@ func GetBaseConfigurationConfigMapName(jenkins *v1alpha2.Jenkins) string {
}
// NewBaseConfigurationConfigMap builds Kubernetes config map used to base configuration.
func NewBaseConfigurationConfigMap(meta metav1.ObjectMeta, jenkins *v1alpha2.Jenkins) (*corev1.ConfigMap, error) {
func NewBaseConfigurationConfigMap(meta metav1.ObjectMeta, jenkins *v1alpha2.Jenkins, kubernetesClusterDomain string) (*corev1.ConfigMap, error) {
meta.Name = GetBaseConfigurationConfigMapName(jenkins)
jenkinsServiceFQDN, err := GetJenkinsHTTPServiceFQDN(jenkins)
clusterDomain, err := getClusterDomain(kubernetesClusterDomain)
if err != nil {
return nil, err
}
jenkinsSlavesServiceFQDN, err := GetJenkinsSlavesServiceFQDN(jenkins)
jenkinsServiceFQDN, err := GetJenkinsHTTPServiceFQDN(jenkins, kubernetesClusterDomain)
if err != nil {
return nil, err
}
jenkinsSlavesServiceFQDN, err := GetJenkinsSlavesServiceFQDN(jenkins, kubernetesClusterDomain)
if err != nil {
return nil, err
}
suffix := ""
if prefix, ok := GetJenkinsOpts(*jenkins)["prefix"]; ok {
suffix = prefix
}
groovyScriptsMap := map[string]string{
basicSettingsGroovyScriptName: fmt.Sprintf(basicSettingsFmt, constants.DefaultAmountOfExecutors),
enableCSRFGroovyScriptName: enableCSRF,
@@ -195,13 +203,15 @@ func NewBaseConfigurationConfigMap(meta metav1.ObjectMeta, jenkins *v1alpha2.Jen
enableMasterAccessControlGroovyScriptName: enableMasterAccessControl,
disableInsecureFeaturesGroovyScriptName: disableInsecureFeatures,
configureKubernetesPluginGroovyScriptName: fmt.Sprintf(configureKubernetesPluginFmt,
clusterDomain,
jenkins.ObjectMeta.Namespace,
fmt.Sprintf("http://%s:%d", jenkinsServiceFQDN, jenkins.Spec.Service.Port),
fmt.Sprintf("http://%s:%d%s", jenkinsServiceFQDN, jenkins.Spec.Service.Port, suffix),
fmt.Sprintf("%s:%d", jenkinsSlavesServiceFQDN, jenkins.Spec.SlaveService.Port),
),
configureViewsGroovyScriptName: configureViews,
disableJobDslScriptApprovalGroovyScriptName: disableJobDSLScriptApproval,
}
if jenkins.Spec.Master.DisableCSRFProtection {
delete(groovyScriptsMap, enableCSRFGroovyScriptName)
}
pkg/configuration/base/resources/pod.go
+53 -3
View File
@@ -2,6 +2,7 @@ package resources
import (
"fmt"
"strings"
"github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2"
"github.com/jenkinsci/kubernetes-operator/pkg/constants"
@@ -14,9 +15,9 @@ const (
// JenkinsMasterContainerName is the Jenkins master container name in pod
JenkinsMasterContainerName = "jenkins-master"
// JenkinsHomeVolumeName is the Jenkins home volume name
JenkinsHomeVolumeName = "jenkins-home"
jenkinsPath = "/var/jenkins"
JenkinsHomeVolumeName = "jenkins-home"
jenkinsPath = "/var/jenkins"
httpGetPath = "/login"
jenkinsScriptsVolumeName = "scripts"
// JenkinsScriptsVolumePath is a path where are scripts used to configure Jenkins
JenkinsScriptsVolumePath = jenkinsPath + "/scripts"
@@ -233,6 +234,8 @@ func NewJenkinsMasterContainer(jenkins *v1alpha2.Jenkins) corev1.Container {
envs = append(envs, jenkinsHomeEnvVar)
}
setLivenessAndReadinessPath(jenkins)
return corev1.Container{
Name: JenkinsMasterContainerName,
Image: jenkinsContainer.Image,
@@ -259,6 +262,53 @@ func NewJenkinsMasterContainer(jenkins *v1alpha2.Jenkins) corev1.Container {
}
}
func setLivenessAndReadinessPath(jenkins *v1alpha2.Jenkins) {
ReadinessProbePath := jenkins.Spec.Master.Containers[0].ReadinessProbe.HTTPGet.Path
LivenessProbePath := jenkins.Spec.Master.Containers[0].ReadinessProbe.HTTPGet.Path
if prefix, ok := GetJenkinsOpts(*jenkins)["prefix"]; ok {
if !strings.HasPrefix(ReadinessProbePath, prefix) {
jenkins.Spec.Master.Containers[0].ReadinessProbe.HTTPGet.Path = prefix + httpGetPath
}
if !strings.HasPrefix(LivenessProbePath, prefix) {
jenkins.Spec.Master.Containers[0].LivenessProbe.HTTPGet.Path = prefix + httpGetPath
}
} else {
if ReadinessProbePath != httpGetPath {
jenkins.Spec.Master.Containers[0].ReadinessProbe.HTTPGet.Path = httpGetPath
}
if LivenessProbePath != httpGetPath {
jenkins.Spec.Master.Containers[0].LivenessProbe.HTTPGet.Path = httpGetPath
}
}
}
// GetJenkinsOpts gets JENKINS_OPTS env parameter, parses it's values and returns it as a map`
func GetJenkinsOpts(jenkins v1alpha2.Jenkins) map[string]string {
envs := jenkins.Spec.Master.Containers[0].Env
jenkinsOpts := make(map[string]string)
for key, value := range envs {
if value.Name == "JENKINS_OPTS" {
jenkinsOptsEnv := envs[key]
jenkinsOptsWithDashes := jenkinsOptsEnv.Value
if len(jenkinsOptsWithDashes) == 0 {
return nil
}
jenkinsOptsWithEqOperators := strings.Split(jenkinsOptsWithDashes, " ")
for _, vx := range jenkinsOptsWithEqOperators {
opt := strings.Split(vx, "=")
jenkinsOpts[strings.ReplaceAll(opt[0], "--", "")] = opt[1]
}
return jenkinsOpts
}
}
return nil
}
// ConvertJenkinsContainerToKubernetesContainer converts Jenkins container to Kubernetes container
func ConvertJenkinsContainerToKubernetesContainer(container v1alpha2.Container) corev1.Container {
return corev1.Container{
pkg/configuration/base/resources/resources_test.go
+229
View File
@@ -0,0 +1,229 @@
package resources
import (
"testing"
"github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2"
"github.com/stretchr/testify/assert"
corev1 "k8s.io/api/core/v1"
)
var jenkins = v1alpha2.Jenkins{
Spec: v1alpha2.JenkinsSpec{
Master: v1alpha2.JenkinsMaster{
Containers: []v1alpha2.Container{
{
Env: []corev1.EnvVar{},
ReadinessProbe: &corev1.Probe{
Handler: corev1.Handler{
HTTPGet: &corev1.HTTPGetAction{},
},
},
LivenessProbe: &corev1.Probe{
Handler: corev1.Handler{
HTTPGet: &corev1.HTTPGetAction{},
},
},
},
},
},
},
}
func TestGetJenkinsOpts(t *testing.T) {
t.Run("JENKINS_OPTS is uninitialized", func(t *testing.T) {
jenkins.Spec.Master.Containers[0].Env =
[]corev1.EnvVar{
{Name: "", Value: ""},
}
opts := GetJenkinsOpts(jenkins)
assert.Equal(t, 0, len(opts))
})
t.Run("JENKINS_OPTS is empty", func(t *testing.T) {
jenkins.Spec.Master.Containers[0].Env =
[]corev1.EnvVar{
{Name: "JENKINS_OPTS", Value: ""},
}
opts := GetJenkinsOpts(jenkins)
assert.Equal(t, 0, len(opts))
})
t.Run("JENKINS_OPTS have --prefix argument ", func(t *testing.T) {
jenkins.Spec.Master.Containers[0].Env =
[]corev1.EnvVar{
{Name: "JENKINS_OPTS", Value: "--prefix=/jenkins"},
}
opts := GetJenkinsOpts(jenkins)
assert.Equal(t, 1, len(opts))
assert.NotContains(t, opts, "httpPort")
assert.Contains(t, opts, "prefix")
assert.Equal(t, opts["prefix"], "/jenkins")
})
t.Run("JENKINS_OPTS have --prefix and --httpPort argument", func(t *testing.T) {
jenkins.Spec.Master.Containers[0].Env =
[]corev1.EnvVar{
{Name: "JENKINS_OPTS", Value: "--prefix=/jenkins --httpPort=8080"},
}
opts := GetJenkinsOpts(jenkins)
assert.Equal(t, 2, len(opts))
assert.Contains(t, opts, "prefix")
assert.Equal(t, opts["prefix"], "/jenkins")
assert.Contains(t, opts, "httpPort")
assert.Equal(t, opts["httpPort"], "8080")
})
t.Run("JENKINS_OPTS have --httpPort argument", func(t *testing.T) {
jenkins.Spec.Master.Containers[0].Env =
[]corev1.EnvVar{
{Name: "JENKINS_OPTS", Value: "--httpPort=8080"},
}
opts := GetJenkinsOpts(jenkins)
assert.Equal(t, 1, len(opts))
assert.NotContains(t, opts, "prefix")
assert.Contains(t, opts, "httpPort")
assert.Equal(t, opts["httpPort"], "8080")
})
t.Run("JENKINS_OPTS have --httpPort=--8080 argument", func(t *testing.T) {
jenkins.Spec.Master.Containers[0].Env =
[]corev1.EnvVar{
{Name: "JENKINS_OPTS", Value: "--httpPort=--8080"},
}
opts := GetJenkinsOpts(jenkins)
assert.Equal(t, 1, len(opts))
assert.NotContains(t, opts, "prefix")
assert.Contains(t, opts, "httpPort")
assert.Equal(t, opts["httpPort"], "--8080")
})
}
func TestSetLivenessAndReadinessPath(t *testing.T) {
t.Run("JENKINS_OPTS uninitialized. Probes' paths default.", func(t *testing.T) {
jenkins.Spec.Master.Containers[0].Env = []corev1.EnvVar{}
jenkins.Spec.Master.Containers[0].ReadinessProbe =
&corev1.Probe{
Handler: corev1.Handler{
HTTPGet: &corev1.HTTPGetAction{
Path: "/login",
},
},
}
jenkins.Spec.Master.Containers[0].LivenessProbe =
&corev1.Probe{
Handler: corev1.Handler{
HTTPGet: &corev1.HTTPGetAction{
Path: "/login",
},
},
}
setLivenessAndReadinessPath(&jenkins)
assert.Equal(t, httpGetPath, jenkins.Spec.Master.Containers[0].ReadinessProbe.HTTPGet.Path)
assert.Equal(t, httpGetPath, jenkins.Spec.Master.Containers[0].LivenessProbe.HTTPGet.Path)
})
t.Run("JENKINS_OPTS initialized. Probes' paths default", func(t *testing.T) {
jenkins.Spec.Master.Containers[0].Env =
[]corev1.EnvVar{
{Name: "JENKINS_OPTS", Value: "--prefix=/jenkins"},
}
jenkins.Spec.Master.Containers[0].ReadinessProbe =
&corev1.Probe{
Handler: corev1.Handler{
HTTPGet: &corev1.HTTPGetAction{
Path: "/login",
},
},
}
jenkins.Spec.Master.Containers[0].LivenessProbe =
&corev1.Probe{
Handler: corev1.Handler{
HTTPGet: &corev1.HTTPGetAction{
Path: "/login",
},
},
}
setLivenessAndReadinessPath(&jenkins)
assert.Equal(t, "/jenkins/login", jenkins.Spec.Master.Containers[0].ReadinessProbe.HTTPGet.Path)
assert.Equal(t, "/jenkins/login", jenkins.Spec.Master.Containers[0].LivenessProbe.HTTPGet.Path)
})
t.Run("JENKINS_OPTS initialized. Probes' paths customized", func(t *testing.T) {
jenkins.Spec.Master.Containers[0].Env =
[]corev1.EnvVar{
{Name: "JENKINS_OPTS", Value: "--prefix=/jenkins"},
}
jenkins.Spec.Master.Containers[0].ReadinessProbe =
&corev1.Probe{
Handler: corev1.Handler{
HTTPGet: &corev1.HTTPGetAction{
Path: "/jenkins/login",
},
},
}
jenkins.Spec.Master.Containers[0].LivenessProbe =
&corev1.Probe{
Handler: corev1.Handler{
HTTPGet: &corev1.HTTPGetAction{
Path: "/jenkins/login",
},
},
}
setLivenessAndReadinessPath(&jenkins)
assert.Equal(t, "/jenkins/login", jenkins.Spec.Master.Containers[0].ReadinessProbe.HTTPGet.Path)
assert.Equal(t, "/jenkins/login", jenkins.Spec.Master.Containers[0].LivenessProbe.HTTPGet.Path)
})
t.Run("JENKINS_OPTS uninitialized. Probes' paths customized", func(t *testing.T) {
jenkins.Spec.Master.Containers[0].Env = []corev1.EnvVar{}
jenkins.Spec.Master.Containers[0].ReadinessProbe =
&corev1.Probe{
Handler: corev1.Handler{
HTTPGet: &corev1.HTTPGetAction{
Path: "/jenkins/login",
},
},
}
jenkins.Spec.Master.Containers[0].LivenessProbe =
&corev1.Probe{
Handler: corev1.Handler{
HTTPGet: &corev1.HTTPGetAction{
Path: "/jenkins/login",
},
},
}
setLivenessAndReadinessPath(&jenkins)
assert.Equal(t, "/login", jenkins.Spec.Master.Containers[0].ReadinessProbe.HTTPGet.Path)
assert.Equal(t, "/login", jenkins.Spec.Master.Containers[0].LivenessProbe.HTTPGet.Path)
})
}
pkg/configuration/base/resources/service.go
+16 -16
View File
@@ -50,8 +50,8 @@ func GetJenkinsSlavesServiceName(jenkins *v1alpha2.Jenkins) string {
}
// GetJenkinsHTTPServiceFQDN returns Kubernetes service FQDN used for expose Jenkins HTTP endpoint
func GetJenkinsHTTPServiceFQDN(jenkins *v1alpha2.Jenkins) (string, error) {
clusterDomain, err := getClusterDomain()
func GetJenkinsHTTPServiceFQDN(jenkins *v1alpha2.Jenkins, kubernetesClusterDomain string) (string, error) {
clusterDomain, err := getClusterDomain(kubernetesClusterDomain)
if err != nil {
return "", err
}
@@ -60,8 +60,8 @@ func GetJenkinsHTTPServiceFQDN(jenkins *v1alpha2.Jenkins) (string, error) {
}
// GetJenkinsSlavesServiceFQDN returns Kubernetes service FQDN used for expose Jenkins slave endpoint
func GetJenkinsSlavesServiceFQDN(jenkins *v1alpha2.Jenkins) (string, error) {
clusterDomain, err := getClusterDomain()
func GetJenkinsSlavesServiceFQDN(jenkins *v1alpha2.Jenkins, kubernetesClusterDomain string) (string, error) {
clusterDomain, err := getClusterDomain(kubernetesClusterDomain)
if err != nil {
return "", err
}
@@ -70,12 +70,12 @@ func GetJenkinsSlavesServiceFQDN(jenkins *v1alpha2.Jenkins) (string, error) {
}
// GetClusterDomain returns Kubernetes cluster domain, default to "cluster.local"
func getClusterDomain() (string, error) {
clusterDomain := "cluster.local"
if ok, err := isRunningInCluster(); !ok {
return clusterDomain, nil
} else if err != nil {
func getClusterDomain(kubernetesClusterDomain string) (string, error) {
isRunningInCluster, err := isRunningInCluster()
if !isRunningInCluster {
return kubernetesClusterDomain, nil
}
if err != nil {
return "", nil
}
@@ -86,11 +86,11 @@ func getClusterDomain() (string, error) {
return "", stackerr.WithStack(err)
}
clusterDomain = strings.TrimPrefix(cname, "kubernetes.default.svc")
clusterDomain = strings.TrimPrefix(clusterDomain, ".")
clusterDomain = strings.TrimSuffix(clusterDomain, ".")
kubernetesClusterDomain = strings.TrimPrefix(cname, "kubernetes.default.svc")
kubernetesClusterDomain = strings.TrimPrefix(kubernetesClusterDomain, ".")
kubernetesClusterDomain = strings.TrimSuffix(kubernetesClusterDomain, ".")
return clusterDomain, nil
return kubernetesClusterDomain, nil
}
func isRunningInCluster() (bool, error) {
@@ -99,7 +99,7 @@ func isRunningInCluster() (bool, error) {
if err == k8sutil.ErrNoNamespace || err == k8sutil.ErrRunLocal {
return false, nil
}
return true, nil
return false, stackerr.WithStack(err)
}
return false, stackerr.WithStack(err)
return true, nil
}