Introduction
Continuous Integration / Continuous Delivery (CI/CD) is a supported method for JS7 - Rollout of Scheduling Objects.
- The scenarios are described with the JS7 - Git Repository Interface.
- CI/CD includes to perform the following steps
- in a test environment
- to store scheduling objects of a JOC Cockpit inventory to a local Git repository,
- to add, to commit and to push changes to the remote Git repository.
- in a prod environment
- to copy (cherry-pick) changes from the remote test Git repository to the remote prod Git repository,
- to push changes from the remote prod Git repository to the local prod Git repository,
- to update the JOC Cockpit inventory from the local Git repository,
- to release and to deploy scheduling objects to Controllers and Agents.
- in a test environment
Users who whish to automate the
- The JS7 - REST Web Service API allows to perform the same operations for Git integration as offered from the JOC Cockpit GUI.
- The JS7 - PowerShell Module offers simplified access to the REST Web Service API for scripting purposes.
- The PowerShell examples when executed might prove to be instructive for logging of REST API calls when used with the
-debug
option.
- The PowerShell examples when executed might prove to be instructive for logging of REST API calls when used with the
The following examples assume that a local Git repository is set up in the test and prod environments, see JS7 - How to set up a local Git Repository.
Find the documentation for related cmdlets from PowerShell CLI 2.0 - Cmdlets - Git Repository Integration.
Steps to perform in the TEST Environment
The below example assumes that
- a top-level folder
Accounting
is used in the JOC Cockpit inventory, - this folder is mapped to a sub-directory with the same name and spelling in the file system, for example
- for Unix:
/var/sos-berlin.com/js7/joc/jetty_base/resources/joc/repositories/rollout/Accounting
- for Windows:
C:\ProgramData\sos-berlin.com\js7˜\joc\jetty_base\resources\joc\repositories\rollout\Accounting
- for Unix:
- this folder is created when setting up the repository otherwise it will be created by JOC Cockpit the first time that objects should be stored to the repository.
Store Scheduling Objects to local Git Repository
The following cmdlets are used:
Import-Module JS7 Connect-JS7 -Url http://root:root@test_host:4446 -Id 'Controller' | Out-Null # Cleanup local repository by removing existing objects Remove-JS7RepositoryItem -Folder '/Accounting' # Store scheduling objects of the given folder and exclude draft versions to be used Set-JS7RepositoryItem -Folder '/Accounting' -Recursive -NoDraft
Explanation:
- Line 2: A number of ways are offered how to connect to JOC Cockpit, see JS7 - How to connect to JOC Cockpit using the PowerShell Module.
- Line 5: The
Accounting
top-level folder and any sub-folders are removed from the local repository, for details see Remove-JS7RepositoryItem. This step is not required, however, it can be useful for consistency if scheduling objects that have been removed or renamed in the JOC Cockpit inventory. - Line 8: The
Accounting
top-level folder and any sub-folders are added to the local repository, see Set-JS7RepositoryItem.
Commit and push Changes to remote Git Repository
The following OS and Git commands suggest a typical sequence of steps:
Import-Module JS7 Connect-JS7 -Url http://root:root@test_host:4446 -Id 'Controller' | Out-Null # Add, commit and push changes to the remote Git repository Invoke-JS7GitRepositoryAdd -Folder '/Accounting' Invoke-JS7GitRepositoryCommit -Folder '/Accounting' -Message 'changes for release v1.13' Invoke-JS7GitRepositoryPush -Folder '/Accounting'
Example of a CI/CD Pipeline Script for TEST Environment
The below example includes use of the above cmdlets in a pipeline script.
Download PowerShell Script: Rollout-JS7FromTest.ps1
Steps to perform in the PROD Environment
Copy Changes from TEST to PROD Git Repository
There are a number of ways how to achieve this using Git commands:
# add the test repo as a remote repository git remote add oldrepo git@github.com:sos-berlin/js7-demo-inventory-rollout-test.git # get the test repo commits git remote update # examine the whole tree git log --all --oneline --graph --decorate # copy/cherry-pick the commits from the test repo into your local prod repo git cherry-pick <commit-hash> # check local prod repo git log # push changes to remote prod repo git push origin master # remove the reference to the test repo git remote remove oldrepo
Explanation:
- Line 11: The
<commit-hash>
identifies commits performed when pushing scheduling objects to the test repository. This step can be performed repeatedly to cherry-pick a number of commits.
Pull Changes to local Git Repository
The following OS and Git commands are used:
Import-Module JS7 Connect-JS7 -Url http://root:root@prod_host:4446 -Id 'Controller' | Out-Null # Pull changes from remote Git repository Invoke-JS7GitRepositoryPull -Folder '/Accounting'
Update JOC Cockpit Inventory from local Git Repository, Release and Deploy to Controller
The following cmdlets are used:
Import-Module JS7 Connect-JS7 -Url http://root:root@prod_host:4446 -Id 'Controller' | Out-Null # Update the JOC Cockpit inventory from the local repository of the given folder Update-JS7FromRepositoryItem -Folder '/Accounting' # Release scheduling objects of the given folder Publish-JS7ReleasableItem -Folder '/Accounting' -Recursive -NoReleased # Deploy scheduling objects from the given folder to the Controller Publish-JS7DeployableItem -ControllerId 'Controller' -Folder '/Accounting' -Recursive -NoDeployed
Explanation:
- Line 5: The JOC Cockpit inventory is updated from the local repository. This translates to the fact that objects with the same name are overwritten and that new objects are added. Updated objects are put to a draft status in the JOC Cockpit inventory. Find details from Update-JS7FromRepositoryItem.
- Line 8: Scheduling objects that are not deployed to a Controller such as schedules and calendars are released. Should such objects be included in the changes to the local repository then they are in a draft status and should be released. The
-NoReleased
parameter prevents scheduling objects in a non-draft status from being released, for example objects that are not stored in the local repository but that have previously been released. For details see Publish-JS7ReleasableItem. - Line 11: Scheduling objects are deployed to the given Controller. The
-NoDeployed
parameter prevents scheduling objects in a non-draft status from being deployed, for example objects that are not stored in the local repository but that have previously been deployed. For details see Publish-JS7DeployableItem.
Example of a CI/CD Pipeline Script for PROD Environment
The below example includes use of the above cmdlets in a pipeline script.
Download PowerShell Script: Rollout-JS7ToProd.ps1
Further Resources
The above OS commands, Git commands and PowerShell cmdlets can be executed from JS7 workflows for automation of a CI/CD pipeline.
- JS7 - How to run PowerShell scripts from jobs
- JS7 - How To - Jobs - PowerShell
- PowerShell CLI 2.0 - Cmdlets