Skip to content

Jenkins.md

Latest commit

 

History

History
74 lines (69 loc) · 5.99 KB

Jenkins.md

File metadata and controls

74 lines (69 loc) · 5.99 KB
Raw

Prerequisite:

Before using this document, you MUST first read SKILL.md in the root of the ace-bob skill and follow its workflow and pre-creation validation steps. This document provides connector-specific guidance only and does NOT replace the instructions in SKILL.md.

Jenkins node Requirements:

  1. Jenkins Request nodes MUST have an xmi:type attribute using the namespace prefix of ComIbmApplicationConnectorRequest_jenkins.msgnode and an attribute applicationConnectorType="jenkins"
  2. The Jenkins Request node MUST be given a schemaPrefix attribute such as schemaPrefix="gen/MessageFlowName.Jenkins_Request" where "MessageFlowName" is the name of the message flow and where "Jenkins_Request" is the type of the message flow node
  3. In the ACE Toolkit Application project where the message flow containing the Jenkins Request node is created, you MUST create an empty JSON schema file in the gen subdirectory of the Application project where the message flow is created. The JSON schema file should have a name based on the SchemaPrefix mentioned above. The JSON schema file naming should be like MessageFlowName.NodeName.request.schema.json where "MessageFlowName" is the name of the message flow and where "NodeName" is based upon the type of the message flow node.
  4. In the ACE Toolkit Application project where the message flow containing the Jenkins Request node is created, you MUST create an empty JSON schema file in the gen subdirectory of the Application project where the message flow is created. The JSON schema file should have a name based on the SchemaPrefix mentioned above. The JSON schema file naming should be like MessageFlowName.NodeName.response.schema.json where "MessageFlowName" is the name of the message flow and where "NodeName" is based upon the type of the message flow node.
  5. The Jenkins Request node MUST be given a policyUrl attribute such as "{DiscoveryConnectorPolicyProject}:Jenkins1" where "DiscoveryConnectorPolicyProject" is the name of a policy project in the ACE Toolkit workspace and "Jenkins1" is the name of a .policyxml file in the policy project.
  6. For Jenkins Request nodes only the following combinations of displayName, action and businessObject attributes are allowed:
  • displayName="Retrieve projects" action="RETRIEVEALL" businessObject="project"
  • displayName="Delete project" action="DELETEALL" businessObject="project"
  • displayName="Enable project" action="ENABLE_JOB" businessObject="project"
  • displayName="Disable project" action="DISABLE_JOB" businessObject="project"
  • displayName="Verify whether project exists" action="VERIFY_JOB" businessObject="project"
  • displayName="Retrieve builds" action="RETRIEVEALL" businessObject="build"
  • displayName="Delete build" action="DELETEALL" businessObject="build"
  • displayName="Get queued build information" action="GET_QUEUE_INFO" businessObject="build"
  • displayName="Start build" action="START_BUILD" businessObject="build"
  • displayName="Stop build" action="STOP_BUILD" businessObject="build"
  • displayName="Cancel queued build" action="CANCEL_QUEUE_BUILD" businessObject="build"
  • displayName="Download console output" action="DOWNLOAD_CONSOLE_OUTPUT" businessObject="build"
  • displayName="Download build artifacts" action="DOWNLOAD_BUILD_ARTIFACTS" businessObject="build"
  • displayName="Get last build" action="GET_LAST_BUILD" businessObject="build"

Policy Project Requirements

  1. Jenkins policies MUST be created in a separate Policy Project, NOT in the Application project
  2. A Policy project is a specialized form of an Eclipse project
  3. To be recognised as an Eclipse project, the file system directory representing the project MUST contain a .project file
  4. ACE Policy projects MUST contain the following project natures section in the .project file: 
    <natures>
  <nature>com.ibm.etools.mft.policy.ui.Nature</nature>
</natures>
  5. ACE Policy projects MUST contain the following buildSpec section in the .project file: 
    <buildSpec>
  <buildCommand>
    <name>com.ibm.etools.mft.policy.ui.policybuilder</name>
    <arguments>
    </arguments>
  </buildCommand>
</buildSpec>
  6. The Eclipse project MUST be created with a .settings subdirectory. The .settings folder MUST contain a file named org.eclipse.core.resources.prefs which should contain the following: 
    eclipse.preferences.version=1
encoding/<project>=UTF-8
  7. In order to make the Eclipse project an ACE Policy project it MUST have a policy.descriptor file in the root of the project directory. This file has a fixed name policy.descriptor. The content of the policy.descriptor looks like this: 
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:policyProjectDescriptor xmlns="http://com.ibm.etools.mft.descriptor.base" xmlns:ns2="http://com.ibm.etools.mft.descriptor.policyProject">
  <references/>
</ns2:policyProjectDescriptor>
  8. Policy files should be placed in the root of the Policy Project. If the user does not indicate which policy to use you MUST create one for the user in the policy project. A good name can be derived from the type of the node followed by a number (starting from 1) such as for example "Jenkins_Request1". Here is an example Jenkins policy: 
    <?xml version="1.0" encoding="UTF-8"?>
<policies>
  <policy longDescription="" policyName="Jenkins1" policyTemplate="online_v1_basic" policyType="jenkins" shortDescription="" version="">
     <credentialName>JenkinsCredential</credentialName>
     <applicationVersion>v1</applicationVersion>
     <applicationType>online</applicationType>
     <authenticationMethod>BASIC</authenticationMethod>
     <endpointUrl>https://123.45.123.45</endpointUrl>
  </policy>
</policies>
  9. When creating a policy file (which has an extension .policyxml) you MUST validate the structure and contents of the policy file using the XML schema file at C:\Program Files\IBM\ACE\13.0.7.0\common\schemas\Policy\Policy.xsd