Add / update Jenkins credential descriptions (#2058)

2025-09-16 09:26:22 +02:00 · 2020-09-23 13:22:51 +02:00
parent da147b16ce
commit 4d9d2e78d8
15 changed files with 50 additions and 42 deletions
--- a/resources/metadata/checkmarx.yaml
+++ b/resources/metadata/checkmarx.yaml
@@ -16,7 +16,7 @@ spec:
  inputs:
    secrets:
      - name: checkmarxCredentialsId
-        description: The technical user/password credential used to communicate with the Checkmarx backend
+        description: Jenkins 'Username with password' credentials ID containing username and password to communicate with the Checkmarx backend.
        type: jenkins
    resources:
      - name: checkmarx
--- a/resources/metadata/cloudFoundryCreateService.yaml
+++ b/resources/metadata/cloudFoundryCreateService.yaml
@@ -13,7 +13,7 @@ spec:
  inputs:
    secrets:
      - name: cfCredentialsId
-        description: Jenkins credentials ID containing user and password to authenticate to the Cloud Foundry API
+        description: Jenkins 'Username with password' credentials ID containing user and password to authenticate to the Cloud Foundry API.
        type: jenkins
        aliases:
          - name: cloudFoundry/credentialsId
--- a/resources/metadata/cloudFoundryCreateServiceKey.yaml
+++ b/resources/metadata/cloudFoundryCreateServiceKey.yaml
@@ -7,7 +7,7 @@ spec:
  inputs:
    secrets:
      - name: cfCredentialsId
-        description: Jenkins credentials ID containing user and password to authenticate to the Cloud Foundry API
+        description: Jenkins 'Username with password' credentials ID containing user and password to authenticate to the Cloud Foundry API.
        type: jenkins
    params:
      - name: cfApiEndpoint
--- a/resources/metadata/cloudFoundryDeleteService.yaml
+++ b/resources/metadata/cloudFoundryDeleteService.yaml
@@ -7,7 +7,7 @@ spec:
  inputs:
    secrets:
      - name: cfCredentialsId
-        description: Jenkins credentials ID containing user and password to authenticate to the Cloud Foundry API
+        description: Jenkins 'Username with password' credentials ID containing user and password to authenticate to the Cloud Foundry API.
        type: jenkins
    params:
      - name: cfApiEndpoint
--- a/resources/metadata/cloudFoundryDeploy.yaml
+++ b/resources/metadata/cloudFoundryDeploy.yaml
@@ -7,12 +7,12 @@ spec:
  inputs:
    secrets:
      - name: cfCredentialsId
-        description: "Jenkins credentials ID containing user and password to authenticate to the Cloud Foundry API"
+        description: Jenkins 'Username with password' credentials ID containing user and password to authenticate to the Cloud Foundry API.
        type: jenkins
        aliases:
          - name: cloudFoundry/credentialsId
      - name: dockerCredentialsId
-        description: "Jenkins credentials ID containing user and password to authenticate to the Docker registry"
+        description: Jenkins 'Username with password' credentials ID containing user and password to authenticate to the Docker registry.
        type: jenkins
    params:
      - name: apiEndpoint
--- a/resources/metadata/fortify.yaml
+++ b/resources/metadata/fortify.yaml
@@ -12,10 +12,10 @@ spec:
  inputs:
    secrets:
      - name: fortifyCredentialsId
-        description: "Jenkins 'Secret text' credentials ID containing token to authenticate to Fortify SSC."
+        description: Jenkins 'Secret text' credentials ID containing token to authenticate to Fortify SSC.
        type: jenkins
      - name: githubTokenCredentialsId
-        description: "Jenkins 'Secret text' credentials ID containing token to authenticate to GitHub."
+        description: Jenkins 'Secret text' credentials ID containing token to authenticate to GitHub.
        type: jenkins
    resources:
      - name: commonPipelineEnvironment
--- a/resources/metadata/kaniko.yaml
+++ b/resources/metadata/kaniko.yaml
@@ -6,6 +6,7 @@ spec:
  inputs:
    secrets:
      - name: dockerConfigJsonCredentialsId
+        description: Jenkins 'Secret file' credentials ID containing Docker config.json (with registry credential(s)). You can create it like explained in the Docker Success Center in the article about [how to generate a new auth in the config.json file](https://success.docker.com/article/generate-new-auth-in-config-json-file).
        type: jenkins
    params:
      - name: buildOptions
--- a/resources/metadata/kubernetesdeploy.yaml
+++ b/resources/metadata/kubernetesdeploy.yaml
@@ -27,11 +27,13 @@ spec:
  inputs:
    secrets:
      - name: kubeConfigFileCredentialsId
+        description: Jenkins 'Secret file' credentials ID containing kubeconfig file. Details can be found in the [Kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/).
        aliases:
          - name: kubeCredentialsId
            deprecated: true
        type: jenkins
      - name: kubeTokenCredentialsId
+        description: Jenkins 'Secret text' credentials ID containing token to authenticate to Kubernetes. This is an alternative way to using a kubeconfig file. Details can be found in the [Kubernetes documentation](https://kubernetes.io/docs/reference/access-authn-authz/authentication/).
        aliases:
          - name: k8sTokenCredentialsId
            deprecated: true
--- a/resources/metadata/malwareExecuteScan.yaml
+++ b/resources/metadata/malwareExecuteScan.yaml
@@ -7,7 +7,7 @@ spec:
  inputs:
    secrets:
      - name: malwareScanCredentialsId
-        description: The technical user/password credential used to communicate with the malwarescanning service
+        description: Jenkins 'Username with password' credentials ID containing the technical user/password credential used to communicate with the malwarescanning service.
        type: jenkins
    params:
      - name: host
--- a/resources/metadata/nexusUpload.yaml
+++ b/resources/metadata/nexusUpload.yaml
@@ -27,7 +27,7 @@ spec:
  inputs:
    secrets:
      - name: nexusCredentialsId
-        description: The technical username/password credential for accessing the nexus endpoint.
+        description: Jenkins 'Username with password' credentials ID containing the technical username/password credential for accessing the nexus endpoint.
        type: jenkins
        aliases:
          - name: nexus/credentialsId
--- a/resources/metadata/protecode.yaml
+++ b/resources/metadata/protecode.yaml
@@ -8,6 +8,16 @@ metadata:
        Triaging is now supported by the Protecode backend and also Piper does consider this information during the analysis of the scan results though product versions are not supported by Protecode. Therefore please make sure that the `fileName` you are providing does either contain a stable version or that it does not contain one at all. By ensuring that you are able to triage CVEs globally on the upload file's name without affecting any other artifacts scanned in the same Protecode group and as such triaged vulnerabilities will be considered during the next scan and will not fail the build anymore.
 spec:
  inputs:
+    secrets:
+      - name: protecodeCredentialsId
+        description: Jenkins 'Username with password' credentials ID containing username and password to authenticate to the Protecode system.
+        type: jenkins
+      - name: dockerConfigJsonCredentialsId
+        description: Jenkins 'Secret file' credentials ID containing Docker config.json (with registry credential(s)). You can create it like explained in the Docker Success Center in the article about [how to generate a new auth in the config.json file](https://success.docker.com/article/generate-new-auth-in-config-json-file).
+        type: jenkins
+        aliases:
+          - name: dockerCredentialsId
+            deprecated: true
    params:
      - name: excludeCVEs
        aliases:
@@ -189,14 +199,6 @@ spec:
          - PARAMETERS
          - STAGES
          - STEPS
-    secrets:
-      - name: protecodeCredentialsId
-        type: jenkins
-      - name: dockerConfigJsonCredentialsId
-        type: jenkins
-        aliases:
-          - name: dockerCredentialsId
-            deprecated: true
  outputs:
    resources:
      - name: influx
--- a/resources/metadata/sonar.yaml
+++ b/resources/metadata/sonar.yaml
@@ -5,6 +5,15 @@ metadata:
    cli command to scan the defined sources and publish the results to a SonarQube instance."
 spec:
  inputs:
+    secrets:
+      - name: sonarTokenCredentialsId
+        type: jenkins
+        description: "Jenkins 'Secret text' credentials ID containing the token used to authenticate
+          with the Sonar Server."
+      - name: githubTokenCredentialsId
+        type: jenkins
+        description: "Jenkins 'Secret text' credentials ID containing the token used to authenticate
+          with the Github Server."
    params:
      - name: instance
        type: string
@@ -228,15 +237,6 @@ spec:
        aliases:
          - name: maven/m2Path

-    secrets:
-      - name: sonarTokenCredentialsId
-        type: jenkins
-        description: "Jenkins 'Secret text' credentials ID containing the token used to authenticate
-          with the Sonar Server."
-      - name: githubTokenCredentialsId
-        type: jenkins
-        description: "Jenkins 'Secret text' credentials ID containing the token used to authenticate
-          with the Github Server."
  outputs:
    resources:
      - name: influx
--- a/resources/metadata/versioning.yaml
+++ b/resources/metadata/versioning.yaml
@@ -71,6 +71,16 @@ metadata:
    Define `buildTool: custom`, `filePath: <path to your *.yml/*.yaml file` as well as parameter `versionSource` to point to the parameter containing the version.
 spec:
  inputs:
+    secrets:
+      - name: gitHttpsCredentialsId
+        description: Jenkins 'Username with password' credentials ID containing username/password for http access to your git repository.
+        type: jenkins
+      - name: gitSshKeyCredentialsId
+        description: Jenkins 'SSH Username with private key' credentials ID ssh key for accessing your git repository. You can find details about how to generate an ssh key in the [GitHub documentation](https://docs.github.com/en/enterprise/2.15/user/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent).
+        type: jenkins
+        aliases:
+          - name: gitCredentialsId
+            deprecated: true
    params:
      - name: buildTool
        type: string
@@ -243,14 +253,6 @@ spec:
          - cloud
          - cloud_noTag
          - library
-    secrets:
-      - name: gitHttpsCredentialsId
-        type: jenkins
-      - name: gitSshKeyCredentialsId
-        type: jenkins
-        aliases:
-          - name: gitCredentialsId
-            deprecated: true
  outputs:
    resources:
      - name: commonPipelineEnvironment
--- a/resources/metadata/whitesource.yaml
+++ b/resources/metadata/whitesource.yaml
@@ -19,6 +19,13 @@ metadata:
        of the supported build tools per environment please refer to the [WhiteSource Unified Agent Documentation](https://whitesource.atlassian.net/wiki/spaces/WD/pages/33718339/Unified+Agent).
 spec:
  inputs:
+    secrets:
+      - name: userTokenCredentialsId
+        description: Jenkins 'Secret text' credentials ID containing Whitesource user token.
+        type: jenkins
+      - name: orgAdminUserTokenCredentialsId
+        description: Jenkins 'Secret text' credentials ID containing Whitesource org admin token.
+        type: jenkins
    params:
      - name: buildTool
        type: string
@@ -357,12 +364,6 @@ spec:
          - STEPS
        aliases:
          - name: npm/defaultNpmRegistry
-
-    secrets:
-      - name: userTokenCredentialsId
-        type: jenkins
-      - name: orgAdminUserTokenCredentialsId
-        type: jenkins
    resources:
      - name: buildDescriptor
        type: stash
--- a/resources/metadata/xsDeploy.yaml
+++ b/resources/metadata/xsDeploy.yaml
@@ -7,7 +7,7 @@ spec:
  inputs:
    secrets:
      - name: credentialsId
-        description: Jenkins username/password credential for accessing xs endpoint.
+        description: Jenkins 'Username with password' credentials ID containing username/password for accessing xs endpoint.
        type: jenkins
    params:
      - name: deployOpts