Skip to content

Commit

Permalink
Minor formatting fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
VermaSh committed Mar 28, 2018
1 parent b02a9eb commit 0b5c76d
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
## 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)```
Expand All @@ -20,22 +21,24 @@ The NodeHelper API contains helper functions to query basic machine stats in rea

### 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

### 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 ```initialRun```
* ```boolean initialRun```
* This is used to add the project or any other required labels on the machine
* string ```labels```
* ```String labels```
* Labels you would like to be added to the machine. Seperate the labels for a single machine with spaces. Use "," if doing batch update. Or if they will be same across the machines supply only one set
* string ```machineNames```
* ```String machineNames```
* Can either enter a list of names or a single name. For list seperate them with ","
* boolean ```updateDescription```
* ```boolean updateDescription```
* If this is set true, the job will update labels and update description
* string ```projectlabel```
* ```String projectlabel```
* This limits which machines will be touched
* Use Cases:
* Update labels:
Expand Down

0 comments on commit 0b5c76d

Please sign in to comment.