Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add option to restrict seed job agent to only run builds that m… #1079

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: add option to restrict seed job agent to only run builds that m… #1079

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions api/v1alpha2/jenkins_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@ type JenkinsSpec struct {
// +optional
SeedJobAgentImage string `json:"seedJobAgentImage,omitempty"`

// SeedJobRestrictJobsToLabel defines whether to set restrict node to label setting on the agent
// +optional
SeedJobRestrictJobsToLabel bool `json:"seedJobRestrictJobsToLabel,omitempty"`

// ValidateSecurityWarnings enables or disables validating potential security warnings in Jenkins plugins via admission webhooks.
//+optional
ValidateSecurityWarnings bool `json:"validateSecurityWarnings,omitempty"`
Expand Down
1 change: 1 addition & 0 deletions chart/jenkins-operator/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@ Kubernetes native operator which fully manages Jenkins on Kubernetes
| jenkins.securityContext.fsGroup | int | `1000` | |
| jenkins.securityContext.runAsUser | int | `1000` | |
| jenkins.seedJobAgentImage | string | `""` | |
| jenkins.seedJobRestrictJobsToLabel | boolean | `false` | |
| jenkins.seedJobs | list | `[]` | |
| jenkins.serviceAccount.annotations | object | `{}` | |
| jenkins.terminationGracePeriodSeconds | int | `30` | |
Expand Down
4 changes: 4 additions & 0 deletions chart/jenkins-operator/crds/jenkins-crd.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3131,6 +3131,10 @@ spec:
by the seed job agent. If not defined jenkins/inbound-agent:4.9-1
will be used.
type: string
seedJobRestrictJobsToLabel:
description: SeedJobRestrictJobsToLabel defines whether the seed job agent
will be restricted to only running jobs with the seed job label.
type: boolean
seedJobs:
description: 'SeedJobs defines list of Jenkins Seed Job configurations
More info: https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/latest/configuration#configure-seed-jobs-and-pipelines'
Expand Down
3 changes: 3 additions & 0 deletions chart/jenkins-operator/templates/jenkins.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,4 +171,7 @@ spec:
{{- if .Values.jenkins.seedJobAgentImage }}
seedJobAgentImage: {{ .Values.jenkins.seedJobAgentImage }}
{{- end }}
{{- if .Values.jenkins.seedJobRestrictJobsToLabel }}
seedJobRestrictJobsToLabel: {{ .Values.jenkins.seedJobRestrictJobsToLabel }}
{{- end }}
{{- end }}
3 changes: 3 additions & 0 deletions chart/jenkins-operator/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,9 @@ jenkins:
# SeedJobAgentImage defines the image that will be used by the seed job agent. If not defined jenkins/inbound-agent:3248.v65ecb_254c298-6 will be used.
seedJobAgentImage: ""

# SeedJobRestrictJobsToLabel defines whether the seed job agent will be restricted to only running jobs with the seed job label.
seedJobRestrictJobsToLabel: false

# Resource limit/request for Jenkins
# See https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ for details
resources:
Expand Down
4 changes: 4 additions & 0 deletions config/crd/bases/jenkins.io_jenkins.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3135,6 +3135,10 @@ spec:
by the seed job agent. If not defined jenkins/inbound-agent:4.9-1
will be used.
type: string
seedJobRestrictJobsToLabel:
description: SeedJobRestrictJobsToLabel defines whether the seed job agent
will be restricted to only running jobs with the seed job label.
type: boolean
seedJobs:
description: 'SeedJobs defines list of Jenkins Seed Job configurations
More info: https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/latest/configuration#configure-seed-jobs-and-pipelines'
Expand Down
4 changes: 4 additions & 0 deletions deploy/crds/jenkins.io_jenkins_crd.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3131,6 +3131,10 @@ spec:
by the seed job agent. If not defined jenkins/inbound-agent:4.9-1
will be used.
type: string
seedJobRestrictJobsToLabel:
description: SeedJobRestrictJobsToLabel defines whether the seed job agent
will be restricted to only running jobs with the seed job label.
type: boolean
seedJobs:
description: 'SeedJobs defines list of Jenkins Seed Job configurations
More info: https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/latest/configuration#configure-seed-jobs-and-pipelines'
Expand Down
30 changes: 27 additions & 3 deletions pkg/configuration/user/seedjobs/seedjobs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import (
"reflect"
"text/template"

"github.com/go-logr/logr"
"github.com/jenkinsci/kubernetes-operator/api/v1alpha2"
"github.com/jenkinsci/kubernetes-operator/internal/render"
jenkinsclient "github.com/jenkinsci/kubernetes-operator/pkg/client"
Expand All @@ -17,8 +18,6 @@ import (
"github.com/jenkinsci/kubernetes-operator/pkg/groovy"
"github.com/jenkinsci/kubernetes-operator/pkg/log"
"github.com/jenkinsci/kubernetes-operator/pkg/notifications/reason"

"github.com/go-logr/logr"
stackerr "github.com/pkg/errors"
appsv1 "k8s.io/api/apps/v1"
corev1 "k8s.io/api/core/v1"
Expand Down Expand Up @@ -48,7 +47,8 @@ const (
// DefaultAgentImage is the default image used for the seed-job agent
defaultAgentImage = "jenkins/inbound-agent:3248.v65ecb_254c298-6"

creatingGroovyScriptName = "seed-job-groovy-script.groovy"
creatingGroovyScriptName = "seed-job-groovy-script.groovy"
agentModeGroovyScriptName = "seed-job-agent-mode-groovy-script.groovy"

homeVolumeName = "home"
homeVolumePath = "/home/jenkins/agent"
Expand All @@ -57,6 +57,18 @@ const (
workspaceVolumePath = "/home/jenkins/workspace"
)

var seedAgentSetModeScriptTemplate = template.Must(template.New(agentModeGroovyScriptName).Parse(`
import hudson.model.*
import jenkins.model.*
import hudson.slaves.*
import hudson.slaves.EnvironmentVariablesNodeProperty.Entry
import jenkins.model.Jenkins;

Jenkins jenkins = Jenkins.instance
def agent = jenkins.getNode("{{.AgentName}}")
agent.setMode(Node.Mode.EXCLUSIVE)
`))

var seedJobGroovyScriptTemplate = template.Must(template.New(creatingGroovyScriptName).Parse(`
import hudson.model.FreeStyleProject;
import hudson.plugins.git.GitSCM;
Expand Down Expand Up @@ -381,6 +393,18 @@ func (s *seedJobs) createAgent(jenkinsClient jenkinsclient.Jenkins, k8sClient cl
return stackerr.WithStack(err)
}

if s.Configuration.Jenkins.Spec.SeedJobRestrictJobsToLabel {
data := struct{ AgentName string }{AgentName: agentName}
setAgentModeScript, err := render.Render(seedAgentSetModeScriptTemplate, data)
if err != nil {
return err
}
_, err = jenkinsClient.ExecuteScript(setAgentModeScript)
if err != nil {
return err
}
}

secret, err := jenkinsClient.GetNodeSecret(agentName)
if err != nil {
return err
Expand Down
Loading