github.com/jaylevin/jenkins-library@v1.230.4/resources/metadata/vaultRotateSecretId.yaml (about)

     1  metadata:
     2    name: vaultRotateSecretId
     3    description: Rotate Vault AppRole Secret ID
     4    longDescription: This step takes the given Vault secret ID and checks whether it needs to be renewed and if so it will update the secret ID in the configured secret store.
     5  spec:
     6    inputs:
     7      params:
     8        - name: secretStore
     9          type: string
    10          description: "The store to which the secret should be written back to"
    11          scope:
    12            - PARAMETERS
    13            - STAGES
    14            - STEPS
    15          default: "jenkins"
    16          possibleValues:
    17            - jenkins
    18            - ado
    19        - name: jenkinsUrl
    20          type: string
    21          description: "The jenkins url"
    22          scope:
    23            - PARAMETERS
    24            - STAGES
    25            - STEPS
    26          secret: true
    27          resourceRef:
    28            - type: vaultSecret
    29              name: jenkinsVaultSecretName
    30              default: jenkins
    31          aliases:
    32            - name: url
    33        - name: jenkinsCredentialDomain
    34          type: string
    35          description: The jenkins credential domain which should be used
    36          scope:
    37            - PARAMETERS
    38            - STAGES
    39            - STEPS
    40          default: "_"
    41        - name: jenkinsUsername
    42          type: string
    43          description: "The jenkins username"
    44          scope:
    45            - PARAMETERS
    46            - STAGES
    47            - STEPS
    48          secret: true
    49          aliases:
    50            - name: userId
    51          resourceRef:
    52            - type: vaultSecret
    53              name: jenkinsVaultSecretName
    54              default: jenkins
    55        - name: jenkinsToken
    56          type: string
    57          description: "The jenkins token"
    58          scope:
    59            - PARAMETERS
    60            - STAGES
    61            - STEPS
    62          secret: true
    63          aliases:
    64            - name: token
    65          resourceRef:
    66            - type: vaultSecret
    67              name: jenkinsVaultSecretName
    68              default: jenkins
    69        - name: vaultAppRoleSecretTokenCredentialsId
    70          type: string
    71          description: The Jenkins credential ID or Azure DevOps variable name for the Vault AppRole Secret ID credential
    72          scope:
    73            - GENERAL
    74            - PARAMETERS
    75            - STAGES
    76            - STEPS
    77          mandatory: true
    78        - name: vaultServerUrl
    79          type: string
    80          scope:
    81            - GENERAL
    82            - PARAMETERS
    83            - STAGES
    84            - STEPS
    85          description: The URL for the Vault server to use
    86          mandatory: true
    87        - name: vaultNamespace
    88          type: string
    89          scope:
    90            - GENERAL
    91            - PARAMETERS
    92            - STAGES
    93            - STEPS
    94          description: The Vault namespace that should be used (optional)
    95        - name: daysBeforeExpiry
    96          type: int
    97          description: The amount of days before expiry until the secret ID gets rotated
    98          scope:
    99            - PARAMETERS
   100            - STAGES
   101            - STEPS
   102          default: 15
   103        - name: adoOrganization
   104          type: string
   105          scope:
   106            - GENERAL
   107            - PARAMETERS
   108            - STAGES
   109            - STEPS
   110          description: The Azure DevOps organization name
   111        - name: adoPersonalAccessToken
   112          aliases:
   113            - name: token
   114          type: string
   115          scope:
   116            - PARAMETERS
   117            - STAGES
   118            - STEPS
   119          description: The Azure DevOps personal access token
   120          secret: true
   121          mandatoryIf:
   122            - name: secretStore
   123              value: ado
   124          resourceRef:
   125            - type: vaultSecret
   126              name: azureDevOpsVaultSecretName
   127              default: azure-dev-ops
   128        - name: adoProject
   129          type: string
   130          scope:
   131            - PARAMETERS
   132            - STAGES
   133            - STEPS
   134          description: The Azure DevOps project ID. Project name also can be used
   135        - name: adoPipelineId
   136          type: int
   137          scope:
   138            - PARAMETERS
   139            - STAGES
   140            - STEPS
   141          description: The Azure DevOps pipeline ID. Also called as definition ID