Configuring the Jenkins plugin

The Agile Service Manager software includes the Jenkins plugin, which you install on your Jenkins server using the Jenkins Plugin Manager Advanced installation wizard. From the Jenkins server, the plugin gathers and sends information to the Jenkins Observer.

Install the Jenkins plugin

1. Log in to your Jenkins server with a user ID that has administration (management) permissions.
2. Navigate to Manage Jenkins > Manage Plugins and select the Advanced tab.
3. In the Upload Plugin section, upload and install the provided plugin (asm-observer-plugin-<version>.hpi)

Configure the Jenkins plugin

4. Navigate to Manage Jenkins > Configure System and select the Agile Service Manager plugin.
5. Enter the Jenkins Observer URL obtained earlier in the Observer URL field.
6. Create credentials for Agile Service Manager using the Manage Jenkins > Credentials configuration page.
   Enter the credentials and the certificate details obtained earlier from the (or as the) cluster administrator.

   Auth Credentials

   Enter the username and password to authenticate with the Jenkins Observer at API level.

   Click ADD.

   Certificate

   Enter the PKCS12 format certificate to secure the communication between the Jenkins plugin and the observer using SSL.

   Click ADD.

   See the Jenkins site for more detailed information on using the Jenkins Credentials feature: https://jenkins.io/doc/book/using/using-credentials/

7. Optional: Enter a Default Tenant ID.
   The tenant to be used as default when sending information to Agile Service Manager (if it is not overridden in the build).
8. Optional: Enter a Default Job ID.
   The default job ID to be used when sending information to Agile Service Manager (if it is not overridden in the build). This represents the ID of the job the observer is running to process your information.
9. Click TEST CONNECTION to attempt to establish a connection with the observer using the configured credentials.
   If successful, a Connection successful! message is displayed. If unsuccessful, an error is returned.

   Note: The connection test does not verify the default job and tenant IDs.

Configuring your Jenkins build to notify Agile Service Manager

10. Create an instance of the Agile Service Manager observer communication object using the default credentials set during the configuration steps.

    def <my observer> = ASM.newObserver()

    Tip:

    Override credentials

    To override any configured credentials (that is, the Jenkins credentials ID rather than the actual credentials themselves), you can use the following syntax:

    def <my observer> = ASM.newObserver 
    authCredsId: 'asm-auth-credentials-id', certCredsId: 'asm-cert-credentials-id'
    

11. Send a build notification using the following syntax:

    ASM.notifyASM asmObserver: <my observer>

    Tip:

    You can override the default values for the tenant and job IDs:

    ASM.notifyASM tenantId: '<tenantId>', jobId: '<jobId>', asmObserver: <my observer>

    You can integrate the Jenkins plugin with the Artifactory component using the modules information to model any artifacts the build has published to the repository:

    ASM.notifyASM asmObserver: <my observer>, artModules: <buildInfoObject>.getModules()

def asm = ASM.newObserver()
def buildInfo = Artifactory.newBuildInfo()
buildInfo.env.capture = true

… your build logic here …

post {
    always {
      script {
            try {
                 ASM.notifyASM asmObserver: asm, artModules: buildInfo.getModules()
            } catch (err) {
                echo "An error ocurred sending a notification to ASM:  ${err}"
            }
          }
      }
   }
}