[DOCS] Jenkins docs for signing and verifying using a Jenkins pipeline #303
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
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: JasonPowr, lance The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
sabre1041
requested changes
Apr 27, 2024
docs/sign_and_verify_jenkins.md
Outdated
| ### Configuring Jenkins | ||
| To ensure the pipeline operates smoothly, the following Jenkins configurations are necessary: | ||
|
|
||
| 1) Install the Docker Pipeline Plugin: Verify that the Docker Pipeline plugin is installed and enabled. |
docs/sign_and_verify_jenkins.md
Outdated
| -d "grant_type=password" \ | ||
| -d "scope=openid" \ | ||
| -d "client_id=${env.OIDC_CLIENT_ID}" \ | ||
| ${env.OIDC_ISSUER_URL}/protocol/openid-connect/token | sed -E 's/.*"access_token":"([^"]*)".*/\\1/' > token.txt |
There was a problem hiding this comment.
Suggested change
| ${env.OIDC_ISSUER_URL}/protocol/openid-connect/token | sed -E 's/.*"access_token":"([^"]*)".*/\\1/' > token.txt | |
| ${env.OIDC_ISSUER_URL}/protocol/openid-connect/token | sed -E 's/.*"id_token":"([^"]*)".*/\\1/' > token.txt |
docs/sign_and_verify_jenkins.md
Outdated
| -d "client_id=${env.OIDC_CLIENT_ID}" \ | ||
| ${env.OIDC_ISSUER_URL}/protocol/openid-connect/token | sed -E 's/.*"access_token":"([^"]*)".*/\\1/' > token.txt | ||
| cosign sign -y --fulcio-url=${env.FULCIO_URL} --rekor-url=${env.REKOR_URL} --oidc-issuer=${env.OIDC_ISSUER_URL} --oidc-client-id=${env.OIDC_CLIENT_ID} --identity-token=token.txt ${env.IMG}:${env.TAG} | ||
| cosign verify --rekor-url=${env.REKOR_URL} --certificate-identity-regexp ${env.OIDC_USERNAME} --certificate-oidc-issuer-regexp ${env.OIDC_ISSUER} ${env.IMG}:${env.TAG} |
There was a problem hiding this comment.
Lets use the --certificate-identity flag since we know the concrete identity
docs/sign_and_verify_jenkins.md
Outdated
| stage("Sign & Verify Image") { | ||
| agent { | ||
| docker { | ||
| image 'registry.redhat.io/rhtas-tech-preview/cosign-rhel9:0.0.2' |
There was a problem hiding this comment.
Suggested change
| image 'registry.redhat.io/rhtas-tech-preview/cosign-rhel9:0.0.2' | |
| image 'registry.redhat.io/rhtas/cosign-rhel9:1.0.0' |
docs/sign_and_verify_jenkins.md
Outdated
| 4) Install the Credentials Plugin: Make sure the Credentials plugin is installed and enabled. | ||
|
|
||
| #### Setting Up Credentials | ||
| Credentials will need to be set using the credentials plugin, there are three in total that will need to be configured. |
There was a problem hiding this comment.
Suggested change
| Credentials will need to be set using the credentials plugin, there are three in total that will need to be configured. | |
| Credentials will need to be set using the credentials plugin. There are three credentials in total that will need to be configured. |
docs/sign_and_verify_jenkins.md
Outdated
| * Set an ID for these credentials; for ease, you can use `redhat_io_credentials` as the default ID. | ||
|
|
||
| * Cosign Credentials | ||
| * During the cosign signing process, cosign pushes the signed image to an image registry, because of this it needs credentials, which should be setup in a similar fashion to the above, in the example quay is the registry used and credentials (ID is defaulted to `quay_credentials`) are configured like so: |
There was a problem hiding this comment.
Suggested change
| * During the cosign signing process, cosign pushes the signed image to an image registry, because of this it needs credentials, which should be setup in a similar fashion to the above, in the example quay is the registry used and credentials (ID is defaulted to `quay_credentials`) are configured like so: | |
| * During the cosign signing process, cosign pushes the signed image to an image registry. As a result, credentials are needed which should be setup in a similar fashion to the above. In this example, quay.io is the registry used and credentials (ID is defaulted to `quay_credentials`) are configured like so: |
docs/sign_and_verify_jenkins.md
Outdated
| ``` | ||
|
|
||
| * OIDC Password | ||
| * A password, for the OIDC provider will also need to be configured using the credentials plugin (ID is defaulted to `oidc-password`) this should be setup in a similar fashion to the above, but it should be created as a `Secret text` as opposed to a `Username with Password` |
There was a problem hiding this comment.
Suggested change
| * A password, for the OIDC provider will also need to be configured using the credentials plugin (ID is defaulted to `oidc-password`) this should be setup in a similar fashion to the above, but it should be created as a `Secret text` as opposed to a `Username with Password` | |
| * A password for the OIDC provider will also need to be configured using the credentials plugin (ID is defaulted to `oidc-password`). This should be setup in a similar fashion to the above, but it should be created as a `Secret text` as opposed to a `Username with Password` |
docs/sign_and_verify_jenkins.md
Outdated
|
|
||
|
|
||
| #### Setting Up A Pipeline | ||
| To Create a pipeline, Dashboard > New item > Pipeline, Pipelines can be created using scm (Source Control Managment) but in this example we use a simple pipeline script, that signs and verify's an image, this example can be found below. |
There was a problem hiding this comment.
Suggested change
| To Create a pipeline, Dashboard > New item > Pipeline, Pipelines can be created using scm (Source Control Managment) but in this example we use a simple pipeline script, that signs and verify's an image, this example can be found below. | |
| To Create a pipeline, select Dashboard > New item > Pipeline. Pipelines can be created using scm (Source Control Management), but in this example, we use a simple pipeline script that signs and verify's an image. An example can be found below. |
JasonPowr
force-pushed
the
add-jenkin-docs
branch
from
376c6b0
to
387290c
Compare
|
I've had to update how the pipeline uses cosign credentials, as When deploying this it wasn't working (this time), I believe previously the config for docker within the pipeline was already authenticated with quay, meaning it was skipping the setp each time |
|
@JasonPowr what is the status of this PR? |
@lance This pr should be good to go, although there may be better documentation out there by now |
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.
Small doc related pr