...

Continuous Integration / Continuous Delivery (CI/CD) is a one of the supported method methods for JS7 - Rollout of Scheduling Objects.

• The scenarios are described with in 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.

Users who whish wish to automate the steps for rollout can use the following resources:

• The JS7 - REST Web Service API allows to perform the same operations for Git integration to be performed as offered from the JOC Cockpit GUI.
  • See Technical Documentation of the REST Web Service API
• 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 following examples assume that a local Git repository is set up in the test and prod environments , - see JS7 - How to set up Git Access and JS7 - How to set up a local Git Repository.

Find the documentation for related cmdlets from Documentation for the relevant cmdlets is provided in the  PowerShell CLI 2.0 - Cmdlets - Git Repository Integration article.

Steps to perform in the TEST Environment

The below example example below assumes that that:

• a top-level folder Accounting is used in the JOC Cockpit inventory,
• this folder is mapped to a sub-directory in the file system 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
• this This folder is created when setting up the repository, otherwise it will be created by the JOC Cockpit the first time that objects should are to be stored to in the repository.

Store Scheduling Objects to local Git Repository

...

Explanation:

• Line 2: A number of ways are offered how to connect to methods for connecting to the JOC Cockpit are available, 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.

...

The following OS and Git commands suggest implement a typical sequence of steps:

...

Example of a CI/CD Pipeline Script for TEST Environment

The below example example below includes use of the above cmdlets in a pipeline script.

...

There are a number of ways how to achieve of achieving this using Git commands:

• Some users might wish to cherry-pick individual commits from a test Git repository which is considered by the below exampleas shown in the example below.
• Some users might prefer to copy the complete test repository to a prod repository using branches.
• Some users might prefer to simplify rollout by use of a single repository and will therefore will skip this step.
  
  

# 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

...

• 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 in Update-JS7FromRepositoryItem.
• Line 8: Scheduling objects that are not deployed to a Controller such as schedules and calendars are released. Should If such objects be are 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 with a non-draft status from being released, for example objects that are not stored in the local repository but that which 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 with a non-draft status from being deployed, for example objects that are not stored in the local repository but that which have previously been deployed. For details see Publish-JS7DeployableItem.

Example of a CI/CD Pipeline Script for PROD Environment

The example below example includes shows use of the cmdlets described above cmdlets in a pipeline script.

Download PowerShell Script: Rollout-JS7ToProd.ps1

...

The above OS commands, Git commands and PowerShell cmdlets can be executed from JS7 workflows for the automation of a CI/CD pipeline.

...