Pipeline: GCP Steps

[Enigo]

Repository URL

https://github.com/Enigo/pipeline-gcp

New Repository Name

pipeline-gcp-plugin

Description

Inspired by the pipeline-aws plugin I started creating gcp-pipeline plugin to cover the needs of those running GCP gcloud CLI tool in their pipelines.
It is just the first version with a step allowing to significantly reduce the complexity of calling various gcloud commands by executing auth under the hood.
I do intend to add more features.

GitHub users to have commit permission

@Enigo

Jenkins project users to have release permission

enigo

Issue tracker

GitHub issues

[jenkins-cert-app]

Security audit, information and commands

The security team is auditing all the hosting requests, to ensure a better security by default.

This message informs you that a Jenkins Security Scan was triggered on your repository.
It takes ~10 minutes to complete.

Commands

The bot will parse all comments, and it will check if any line start with a command.

Security team only:

• /audit-ok => the audit is complete, the hosting can continue 🎉.
• /audit-skip => the audit is not necessary, the hosting can continue 🎉.
• /audit-findings => the audit reveals some issues that require corrections ✏️.

Anyone:

• /request-security-scan => the findings from the Jenkins Security Scan were corrected, this command will re-scan your repository 🔍.
• /audit-review => the findings from the audit were corrected, this command will ping the security team to review the findings 👀. It's only applicable when the previous audit required changes.

Only one command can be requested per comment.

(automatically generated message, version: 1.27.1)

[github-actions]

Hello from your friendly Jenkins Hosting Checker

It appears you have some issues with your hosting request. Please see the list below and correct all issues marked Required. Your hosting request will not be approved until these issues are corrected. Issues marked with Warning or Info are just recommendations and will not stall the hosting process.

• ⛔ Required: Your baseline specified does not meet the minimum Jenkins version required, please update <jenkins.version>2.414.3</jenkins.version> to at least 2.426.3 in your pom.xml. Take a look at the baseline recommendations.
• ⛔ Required: The following usernames in 'Jenkins project users to have release permission' need to log into Artifactory: enigo (reports are re-synced hourly, wait to re-check for a bit after logging in)

You can re-trigger a check by editing your hosting request or by commenting /hosting re-check

[jenkins-cert-app]

The Jenkins Security Scan discovered 2 finding(s) 🔍.

Please follow the instructions below for every identified issues:

• Implement the recommended fix to address the issue.
• If you think it's a false positive, suppress the warning directly within the code.
• Alternative, you write an explanation here about why you think it's irrelevant. That will require a manual review, leading to a slower process.

After addressing the findings through one of the above methods:

• If all modifications have been made to the code, please initiate a new security scan by triggering the /request-security-scan command.
• If there are any unresolved findings (those not corrected or suppressed), request a review from the Jenkins security team by using the /audit-review command.

---

Jenkins: Plaintext password storage

You can find detailed information about this finding here.

WithGCPStep.java#28

Field should be reviewed whether it stores a password and is serialized to disk: credentialsFile

WithGCPStep.java#66

Field should be reviewed whether it stores a password and is serialized to disk: credentialsFile

[github-actions]

Hello from your friendly Jenkins Hosting Checker

It appears you have some issues with your hosting request. Please see the list below and correct all issues marked Required. Your hosting request will not be approved until these issues are corrected. Issues marked with Warning or Info are just recommendations and will not stall the hosting process.

• ⛔ Required: The following usernames in 'Jenkins project users to have release permission' need to log into Artifactory: enigo (reports are re-synced hourly, wait to re-check for a bit after logging in)

You can re-trigger a check by editing your hosting request or by commenting /hosting re-check

[jenkins-cert-app]

The Jenkins Security Scan did not find anything dangerous with your plugin, congratulations! 🎉

---

💡 The Security team recommends that you are setting up the scan in your repository by following our guide.

[github-actions]

Hello from your friendly Jenkins Hosting Checker

It looks like you have everything in order for your hosting request. A member of the Jenkins hosting team will check over things that I am not able to check(code review, README content, etc) and process the request as quickly as possible. Thank you for your patience.

Hosting team members can host this request with /hosting host

[NotMyFault]

Hey @Enigo,

I took a brief look over your hosting request and have some feedback for you:

• https://github.com/Enigo/gcp-pipeline/blob/master/ISSUE_TEMPLATE.md and https://github.com/Enigo/gcp-pipeline/blob/master/PULL_REQUEST_TEMPLATE.md can be removed. The jenkinsci organization ships the default template for all plugins once hosted.
• https://github.com/Enigo/gcp-pipeline/blob/311c53449afa51eb58b7a7e463468bb7dbc75514/pom.xml#L53 should match your jenkins.version baseline
• https://github.com/Enigo/gcp-pipeline/blob/311c53449afa51eb58b7a7e463468bb7dbc75514/src/main/java/io/jenkins/plugins/step/WithGCPStep.java#L6 javax' @Nonnull is deprecated in favor of edu.umd.cs.findbugs.annotations.NonNull

That doesn't work out well with the pipeline-syntax generator, you may want to adjust that. (ref. yourJenkins/job/yourJob/pipeline-syntax/)

• Ensure your plugin compiles with mvn clean verify package, and if not, make the necessary code changes.
• When working with credentials, see https://www.jenkins.io/doc/book/pipeline/jenkinsfile/#handling-credentials
  Don't store or load them from a file in any case, rather, your plugin should use the standards linked above.

[github-actions]

Hello from your friendly Jenkins Hosting Checker

It looks like you have everything in order for your hosting request. A member of the Jenkins hosting team will check over things that I am not able to check(code review, README content, etc) and process the request as quickly as possible. Thank you for your patience.

Hosting team members can host this request with /hosting host

[Enigo]

hi @NotMyFault
thanks for the review!
I fixed all but the last point (about credentials) - will get to it as well later this week. Will ping you once more once it is done/

I also renamed the artifact\project from gcp-pipeline to pipeline-gcp to adhere to the naming convention.

[Enigo]

/request-security-scan

[github-actions]

Hello from your friendly Jenkins Hosting Checker

It looks like you have everything in order for your hosting request. A member of the Jenkins hosting team will check over things that I am not able to check(code review, README content, etc) and process the request as quickly as possible. Thank you for your patience.

Hosting team members can host this request with /hosting host

[jenkins-cert-app]

The Jenkins Security Scan did not find anything dangerous with your plugin, congratulations! 🎉

---

💡 The Security team recommends that you are setting up the scan in your repository by following our guide.

[Enigo]

hi @NotMyFault
I've adjusted the code to work with the Secret file instead of a pre-stored file
Hopefully this solution is acceptable, coz I still need to get the actual file to execute the activate-service-account command. lmk

[NotMyFault]

/hosting host

[Enigo]

thanks for the review, @NotMyFault
should I now close this issue?

[NotMyFault]

Normally this is done automatically, but the process broke