From 9f2e5b42404b89da15e678040e534fdee914248e Mon Sep 17 00:00:00 2001 From: Ilya Abnitski <124044159+abnitski-ilya@users.noreply.github.com> Date: Wed, 23 Oct 2024 20:34:48 +0200 Subject: [PATCH] Resolved issues in README.md Signed-off-by: Ilya Abnitski <124044159+abnitski-ilya@users.noreply.github.com> --- README.md | 40 ++++++++++++++++++++++++++++++++-------- 1 file changed, 32 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 146bef8..a82adcb 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Zowe zDevOps Jenkins plugin -## About the plugin +## About the plugin The Zowe zDevOps Jenkins Plugin by [IBA Group](https://ibagroupit.com/?utm_campaign=IBA_W-Mainframe&utm_source=jenkins&utm_medium=referral&utm_content=description_zdevops) is an open-source, secure , and reliable agent-less Jenkins plugin that makes it possible to perform most of the actual tasks on the mainframe, managing it with a modern native mainframe zOSMF REST API and the capabilities of available zOSMF SDKs. ## Main features @@ -27,7 +27,7 @@ Thank you for considering IBA Group for your mainframe needs. ## Before use - Plugin configuration After successfully installing the plugin, you need to configure it for further work - this will require a minimum of actions. -1. Move to “Manage Jenkins” -> “Configure System / System” -> scroll to the very bottom of the list of installed plugins and find the panel with the name - “z/OS Connection List” +1. Move to 'Manage Jenkins' -> 'Configure System / System' -> scroll to the very bottom of the list of installed plugins and find the panel with the name - 'z/OS Connection List' 2. This setting allows you to add all necessary z/OS systems and configure access to them. It is necessary to set the connection name (it is also the ID for declarative methods in the code). For the example: ```z/os-connection-name``` 3. The URL address and port of the required mainframe to connect via z/OSMF. Example: ```https://:``` @@ -70,7 +70,29 @@ stage ("stage-name") { ### allocateDS - Represents an action for allocating a dataset in a declarative style ```groovy -allocateDS dsn:"EXAMPLE.DATASET", dsOrg:"PS", primary:1, secondary:1, recFm:"FB" +zosmf ("z/os-connection-name") { + allocateDS( + // Mandatory Parameters below: + dsn: "EXAMPLE.DATASET", + dsOrg: "PS", + primary: 1, + secondary: 1, + recFm: "FB", + // Optional Parameters below: + volser:"YOURVOL", + unit:"SYSDA", + alcUnit:"TRK", + dirBlk:"5", + blkSize:"800", + lrecl:"80", + storClass:"STORAGECLASS", + mgntClass:"MGMTCLASS", + dataClass:"DATACLASS", + avgBlk:"10", + dsnType:"LIBRARY", + dsModel:"MODEL.DATASET.NAME" + ) +} ``` **Mandatory Parameters:** * ```dsn:"EXAMPLE.DATASET"``` - The name of the dataset to be allocated @@ -96,7 +118,9 @@ allocateDS dsn:"EXAMPLE.DATASET", dsOrg:"PS", primary:1, secondary:1, recFm:"FB" ### deleteDataset - Represents an action for deleting datasets and members in a declarative style ```groovy -deleteDataset dsn:"EXAMPLE.DATASET" +zosmf ("z/os-connection-name") { + deleteDataset dsn: "EXAMPLE.DATASET", member:"MEMBER" +} ``` **Mandatory Parameters:** * ```dsn:"EXAMPLE.DATASET"``` - Sequential or library dataset name for deletion @@ -135,7 +159,7 @@ Pipeline can be used either directly inside the ```Pipeline``` code block in the This pipeline example uses all currently available methods and functionality of the Zowe zDevOps plugin. **Steps to Execute the Pipeline:** -1. Add a zosmf connection in settings (“Manage Jenkins” -> “Configure System / System” -> z/OS Connection List). Enter a connection name, zosmf url, username and password. +1. Add a zosmf connection in settings ('Manage Jenkins' -> 'Configure System / System' -> z/OS Connection List). Enter a connection name, zosmf url, username and password. 2. Create a new Jenkins item -> ```Pipeline``` and open its configuration. 3. In the ```Pipeline``` section, paste the code from the example below and replace all the necessary variables with your data 4. Done, enjoy the minimal ready-made pipeline template! @@ -280,7 +304,7 @@ The plugin are packaged as self-contained .hpi files, which have all the ### [Zowe zDevOps plugin installation .hpi file](https://github.com/IBA-mainframe-dev/Global-Repository-for-Mainframe-Developers/blob/master/Jenkins%20zOS%20DevOps%20plugin%20installable%20hpi/zos-devops.hpi) Assuming a .hpi file has been downloaded, a logged-in Jenkins administrator may upload the file from within the web UI: -1. Navigate to the Manage Jenkins > Manage Plugins page in the web UI. +1. Navigate to the Manage Jenkins > Plugins page in the web UI. 2. Click on the Advanced tab. 3. Choose the .hpi file from your system or enter a URL to the archive file under the Deploy Plugin section. 4. Deploy the plugin file. @@ -291,8 +315,8 @@ Assuming a .hpi file has been downloaded, a logged-in Jenkins administrat 3. To generate the ```target``` dir with generated-sources - you have to run the Maven command: ```mvn localizer:generate``` 4. Next, you need to generate an installation file: .hpi or .jpi file (both are installation files for the Jenkins plugin). This can be done by executing Maven command ```mvn install``` or by ```mvn hpi:hpi```. 5. After building the .hpi/.jpi file, it should appear in a /build/libs/.hpi directory -6. Next you need to login into the Jenkins, move to the “Manage Jenkins” -> “Manage Plugins” -> “Advanced (tab)” -> “Deploy Plugin” (You can select a plugin file from your local system or provide a URL to install a plugin from outside the central plugin repository) -> Specify the path to the generated .hpi/.jpi file (or by dragging the file from Intellij IDEA project to the file upload field in the Jenkins). -7. Click “Deploy”, reboot Jenkins after installation. The Plugin is ready to go! +6. Next you need to login into the Jenkins, move to the 'Manage Jenkins' -> 'Plugins' -> 'Advanced settings (tab)' -> 'Deploy Plugin' (You can select a plugin file from your local system or provide a URL to install a plugin from outside the central plugin repository) -> Specify the path to the generated .hpi/.jpi file (or by dragging the file from Intellij IDEA project to the file upload field in the Jenkins). +7. Click 'Deploy', reboot Jenkins after installation. The Plugin is ready to go! ## How to run Jenkins plugin in Debug mode in a local Jenkins sandbox