Migrate Jenkins deployment from Bash to Groovy #253
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Otherwise the gid grepper pod will keep running unnecessarily. This implementation should also be easier to migrate to groovy later. Because it is only a single command. An alternative would have been to use kubectl wait --for=condition=complete pod/tmp-docker-gid-grepper instead of until.
This makes explicit which values need to be changed per tests and otherwise relies on defaults. This way it became obvious that b38f42d (accidentally?) introduced a change that resulted in most of the Jenkins config to be only executed when config.registry.url was set.
This also implements config.jenkins.helm.values, allow for full customization of Jenkins helm deployment
* JCasC was not necessary * sidecars.configAutoReload.enabled might reduce number of Jenkins reboots (or might not be necessary at all) * Update PATH to current agent image (jenkins/inbound-agent:3261.v9c670a_4748a_9-1 as of chart 5.5.11) * Elaborate on comments
After they moved there from ApplicationConfigurator in #241
This allows for better logging. Right now, our build on Jenkins returns empty string when grepping and cutting. This lead to the insight that pretty print of the override JSON causes the gid grepper command to return empty. 🙄
nihussmann
force-pushed
the
feature/cleanup-gidgrepper
branch
from
c1ed4ea to
4e6eddf
Compare
nihussmann
reviewed
Jan 2, 2025
|
|
||
| if (newConfig.application.baseUrl) { | ||
| newConfig.jenkins.ingress = new URL(injectSubdomain('jenkins', | ||
| newConfig.application.baseUrl as String, newConfig.application.urlSeparatorHyphen as Boolean)).host |
There was a problem hiding this comment.
Suggested change
| newConfig.application.baseUrl as String, newConfig.application.urlSeparatorHyphen as Boolean)).host | |
| newConfig.application.baseUrl, newConfig.application.urlSeparatorHyphen)).host |
nihussmann
reviewed
Jan 2, 2025
| HelmConfigWithValues helm = new HelmConfigWithValues( | ||
| chart: 'jenkins', | ||
| repoURL: 'https://charts.jenkins.io', | ||
| version: '5.5.11') |
There was a problem hiding this comment.
Suggested change
| version: '5.5.11') | |
| version: '5.7.26') |
Maybe we can test and update jenkins to latest? 5.5.11(27 Aug, 2024) -> 5.7.26(22 Dec, 2024). According to the documentation, this should not be a major change. https://github.com/jenkinsci/helm-charts/blob/main/charts/jenkins/CHANGELOG.md
nihussmann
reviewed
Jan 2, 2025
| @@ -51,96 +68,193 @@ class Jenkins extends Feature { | |||
|
|
|||
| @Override | |||
| void enable() { | |||
|
|
|||
| if (config.jenkins.internal) { | |||
| // Mark the first node for Jenkins and agents. See jenkins/values.yaml "agent.workingDir" for details. | |||
There was a problem hiding this comment.
Suggested change
| // Mark the first node for Jenkins and agents. See jenkins/values.yaml "agent.workingDir" for details. | |
| // Mark the first node for Jenkins and agents. See jenkins/values.ftl.yaml "agent.workingDir" for details. |
nihussmann
reviewed
Jan 2, 2025
| } | ||
| } | ||
|
|
||
| if (!gid) { | ||
| log.warn 'Unable to determine Docker Group ID (GID). Jenkins Agent pods will run as root user (UID 0)!\n' + |
There was a problem hiding this comment.
perhaps brackets would be better for the uniformity between the logging commands
nihussmann
reviewed
Jan 2, 2025
| } | ||
| } | ||
|
|
||
| if (!gid) { | ||
| log.warn 'Unable to determine Docker Group ID (GID). Jenkins Agent pods will run as root user (UID 0)!\n' + |
There was a problem hiding this comment.
Suggested change
| log.warn 'Unable to determine Docker Group ID (GID). Jenkins Agent pods will run as root user (UID 0)!\n' + | |
| log.warn('Unable to determine Docker Group ID (GID). Jenkins Agent pod will run as root user (UID 0)!\n' + |
nihussmann
reviewed
Jan 2, 2025
| new Tuple2('jenkins-admin-password', config.jenkins.password)) | ||
|
|
||
| def helmConfig = config.jenkins.helm | ||
| def templatedMap = templateToMap(HELM_VALUES_PATH, |
There was a problem hiding this comment.
I already rebased onto main and refactored this and the fileSystemUtils part like in the other features. This came with #251. Just for your information. So nothing to do here.
nihussmann
reviewed
Jan 2, 2025
| "Group docker not found in /etc/group:\n${etcGroup}" | ||
| return '' | ||
| } else { | ||
| log.debug("Using Docker Group ID (GID) ${gid} for Jenkins Agent pods") |
There was a problem hiding this comment.
just wondering if it is one or muliple pod/s here?
nihussmann
reviewed
Jan 2, 2025
| import org.junit.jupiter.api.Test | ||
| import org.mockito.ArgumentCaptor | ||
|
|
nihussmann
reviewed
Jan 2, 2025
|
|
||
| @Test | ||
| void 'Additional helm values are merged with default values'() { | ||
| config.jenkins.helm.values = [ |
There was a problem hiding this comment.
good that you thought of this directly and implemented it straight away
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Reducing the burden of our bash legacy.
This also introduces some other minor improvements
value.ftl.yaml, no more imperative helmingvalue.ftl.yamlConfig.groovyconfig.jenkins.helm.valuesallows for full customization of Jenkins helm deploymentnamespacevariables in Jenkins, ScmManager and RegistryApplication.setNamespaceListToConfig()to return redundantdefaultnamespaces 🤔 which this PR fixedApplicationConfiguratortoConfigin Typed Config for GOP #241