Introduction
- The JS7 inventory holds scheduling objects such as JS7 - Workflows, JS7 - Calendars and Schedules etc. that are stored with the JS7 - Database.
- Users can integrate the JS7 inventory with Git repositories for JS7 - Rollout of Scheduling Objects. See the scenarios and use cases in the JS7 - Git Repository Interface article.
- The sections below explain the use of the operations for Git repositories that are available from the JOC Cockpit GUI. For automation see JS7 - How to rollout from test to prod environments in a CI/CD pipeline.
- Availability of Git integration is provided with the following JS7 releases:
- FEATURE AVAILABILITY STARTING FROM RELEASE 2.2.0
- FEATURE AVAILABILITY STARTING FROM RELEASE 2.3.0
Settings
The following JS7 - Settings are used for Git integration:
Explanation:
- Settings are used to determine which scheduling objects are considered
local
to an environment and which scheduling objects should be used forrollout
to subsequent environments such as in a sequence dev -> test -> prod. For details see JS7 - Git Repository Interface, chapter: Scheduling Object Mappings. - Settings for each scheduling object type determine whether they should be considered for
local
use or forrollout
to a remote Git repository:git_hold_workflows
: see JS7 - Workflowsgit_hold_resource_locks
: see JS7 - Resource Locksgit_hold_file_order_sources
: see JS7 - Job Resourcesgit_hold_notice_boards
: see JS7 - Notice Boardsgit_hold_script_includes
: see JS7 - Script Includesgit_hold_job_resources
: see JS7 - Job Resourcesgit_hold_calendars
: see JS7 - Calendarsgit_hold_schedules
: see JS7 - Schedules
Git Repositories
JS7 scheduling objects are transparently managed in a Git repository via the JOC Cockpit GUI and using the JS7 - REST Web Service API. In addition, tools such as Git Extensions and Git command line clients can be used for repository operations.
JOC Cockpit holds a number of local repositories inside the /local
and /rollout
subfolders of the JETTY_BASE/resources/joc/repositories
folders. Each top-level folder in the JS7 Configuration view can be mapped to a Git repository.
- The local repository for a JS7 top-level folder is created when a user performs the
checkout
orclone
operation for the Git repository via JOC Cockpit. - The local repository is persistent and is updated from the JOC Cockpit database (
store
operation) and from the remote Git repository (pull
operation). - The remote Git repository is updated from the local repository using the
push
operation. - The JS7 - Cleanup Service removes any local repositories if the JS7 top-level folder no longer exists, i.e. if a top-level folder has been dropped from JOC Cockpit.
The JS7 JOC Cockpit can be used to interface with remote Git repositories to store and to rollout its scheduling objects such as workflows and jobs.
- JS7 supports use of Git compliant servers to manage remote repositories such as GitLab, GitHub.
- JS7 makes use of a Git CLI Client that has to be provided by the user.
Basic Inventory Operations
All inventory operations are based on top-level folders that are mapped to Git repositories, see JS7 - Git Repository Interface, chapter: Folder Mappings. Basic inventory operations do not require a Git Client but are performed directly by JOC Cockpit.
The JOC Cockpit GUI provides the Repository action menu for selecting objects for local and rollout repository use as shown in the diagram below:
The operations available in the action menu are described in the following sections.
Store Objects to local Repository
This operation stores objects managed with the JOC Cockpit database to the file system which holds the local Git repository.
When storing objects local to the environment via the Repository->Local->Store to repository action then a popup window is displayed as shown in the next diagram:
When storing objects intended for rollout to other environments via the Repository->Rollout->Store to repository action then a popup window is displayed as shown here:
Explanation:
- Filter
- Filters can be applied to select only draft objects or objects that have been deployed or released.
- Valid objects that match the schema for their object type.
- Objects deployed to a Controller and to Agents include workflows, job resources etc.
- Objects released within JOC Cockpit include calendars and schedules.
- Filters can be applied to select only draft objects or objects that have been deployed or released.
- Handle recursively
- The checkbox allows selection of a top-level folder to include any sub-folders and objects.
- Tree
- The tree allows navigation of included folders and objects for selection. Individual selection of objects requires the
Handle recursively
checkbox to be unchecked. - The Object types offered, such as Workflows, Resource Locks etc., depend on the settings for the object type: see the Settings section.
- The tree allows navigation of included folders and objects for selection. Individual selection of objects requires the
Update Objects from local Repository
This operation updates the JOC Cockpit database from objects in the file system which holds the local Git repository.
When updating objects local to the environment via the Repository->Local->Update from repository action, then a popup window is displayed as shown in the next diagram:
When updating objects intended for rollout to other environments via the Repository->Rollout->Update from repository action then a popup window is displayed as shown here:
Explanation:
- Handle recursively
- The checkbox allows selection of a top-level folder to include any sub-folders and objects.
- Tree
- The Object types offered, such as Workflows, Resource Locks etc., depend on the settings for the object type: see the Settings section.
Delete Objects from local Repository
This operation deletes objects from the file system which holds the local Git repository.
When deleting objects local to the environment via the Repository->Local->Delete from repository action then a popup window is displayed as shown in the next diagram:
When deleting objects intended for rollout to other environments via the Repository->Rollout->Delete from repository action then a popup window is displayed as shown here:
Explanation:
- Handle recursively
- The checkbox allows selection of a top-level folder to include any sub-folders and objects.
- Tree
- The Object types offered, such as Workflows, Resource Locks etc., depend on the settings for the object type: see the Settings section.