jenkins-helper

Files

API Functions (NodeHelper.groovy)

The NodeHelper API contains helper functions to query basic machine stats in real time, add new machines, update/overwrite labels.

• Get CPU count String getCpuCount(String computerName)
• Get Installed memory Tuple getMemory(String computerName)
• Get OS information Tuple getOsInfo(String computerName)
• Get Kernel information Tuple getOsKernelInfo(String computerName)
• Get Endian String getEndian(String computerName)
• Get Location String getLocation(String computerName)
• Get Description String getDescription(String computerName)
• Get Home directory String getHomeDirectoryPath(String computerName)
• Get free space in the home directory String getSpaceLeftInGb(String computerName)
• Get Total installed disk space String getTotalSpace(String computerName)
• Get Labels String getLabels(String computerName)
• Add new Node String addNewNode(String newNodeName,String newNodeDescription,String newNodeRemoteFS,int newNodeNumExecutors,Mode newNodeMode,String newNodeLabelString,def launcher)
• Add Label String addLabel(String computerName, String label)
• Append Label String appendlabel(String computerName, String label)
• Node Exists static boolean nodeIsOnline(String nodeLabel)

Space Monitoring (WorkspaceInfo.groovy)

Iterates over online nodes on Jenkins and prints the contents of the workspace directory along with the space they occupy

• The computers it iterates over can be limited by input parameter, projectLabel
• As of now, it only works for linux, aix, and mac

Create New Node (CreateNewNode.groovy)

Used to create new nodes with any basic labels

• This job expects 3 parameters
  • String machineNames
    • Comma seperated host names of the machine(s)
  • String machineIPs
    • Comma seperated IP address of the machine(s)
  • String labelStrings
    • Labels you would like to be added to the machine.
    • Each label must be separated by spaces and labels for different machines must be separated by ,
    • If identical labels need to be applied to all the machines, only one set of labels need to be supplied

Update Machine Identifiers (UpdateMachineIdentifiers.groovy)

Used to update machine labels and description

• The computers it iterates over can be limited by input parameter, projectLabel
• The job expects 5 input parameters
  • boolean overWriteLabels
    • Does excatly as the name suggests, completely wipes previous labels
    • If set true, you do not need to pass a projectLabel
  • String labels
    • Labels you would like to be added to the machine.
    • Each label must be separated by spaces and labels for different machines must be separated by ,
    • If identical labels need to be applied to all the machines, only one set of labels need to be supplied
    • Use Cases:
      • Multiple machines, unique labels: machine1Label1 machine1Label2, machine2Label1 machine2Label2
      • Single or multiple machines, identical labels: Label1 Label2
  • String machineNames
    • Can either enter a list of names or a single name. For list seperate them with ","
  • boolean updateDescription
    • If this is set true, the job will update description
    • This has higher precedence than overWriteLabels
  • String projectlabel
    • This limits which machines will be touched
• Use Cases:
  • Update labels:
    • Objective: add default labels(os, arch, and kernel)
    • Procedure: overWriteLabels is not set and only the machine name(s) is supplied
  • Overwrite Labels:
    • Objective: overwrite previous labels with new ones
    • Procedure: overWriteLabels is set and machine name(s) + labels are supplied
  • Append labels:
    • Objective: want to add a custom label.
    • Procedure: supply labels and machine names
  • Update description:
    • It adds CPU count, Disk space and installed RAM to the description
    • Procedure: have updateDescription parameter checked

How-to

Setup

Here are the instructions on how to add the library to Jenkins

Usuage

To use the API in a Jenkins job you'll need to add @Library('NodeHelper') _ to import the API.

TODOs

• A job that pulls machine list from a inventory file and validates the names with those already on Jenkins. It also adds any labels mentioned in the inventory file to the machine on Jenkins, issue
• CPU Information for a ZOS, issue
• Logic to get Hypervisor information, issue
• Move strings out to a config file, issue