JS7 JobScheduler

Space shortcuts

Page tree

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 41 Next »

Introduction

  • JS7 JOC Cockpit can be configured to interface with Git repositories to store and to rollout its configuration 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.
  • Configuration objects can be versioned (tagged) with Git and can be rolled out to different JS7 environments via Git. This allows to create and to test workflows in a development environment and to perform rollouts to a production environment by use of a Git repository.
  • A connection to a Git repository is considered an additional option to manage versions and rollouts of JS7 configuration objects.
  • The Git Repository Interface is made available in two steps:
    • FEATURE AVAILABILITY STARTING FROM RELEASE 2.3.0  
    • Release 2.3.0: Make JS7 objects available from the file system to allow use of Git tools.
    • Release 2.4.0: Offer the GUI functionality from JOC Cockpit to manage JS7 objects with Git.

Object Mappings

Configuration Objects

Rollout Objects

JS7 configuration objects that independent from a specific environment (dev, test, prod) and that can be rolled out across environments include

  • Workflows
  • Locks
  • File Order Sources
  • Notice Boards

Such objects can be managed with JS7 in a way that allows to re-use the objects - without any changes - across rollout environments such as dev, test, prod.

Local Objects

The following configuration objects typically hold values that are specific for an individual environment (dev, test, prod) and therefore usually are added to a separate repository. Such objects should not be rolled out across environments.

  • Job Resources
  • Calendars
  • Schedules

Configuration Mappings

The JS7 inventory is organized by folders.

  • Folders hold configuration objects such as workflows etc. and any level of sub-folders.
  • Folders are the basic unit for JS7 - Permissions, for example, users can be granted access to specific folders only.
  • Folders allow to perform bulk operations such as to deploy, to release, to remove and to rename configuration objects.

Folders can be mapped to Git repositories managed by the same or by different Git servers like this:



The mapping of folder objects to repositories implies

  • user access:
    • users with JS7 access permissions to manage folders and to access the Git repository can manage configuration objects in JOC Cockpit and can commit, push, pull configuration objects to/from Git,
    • users with JS7 access permissions to manage folders but without access to the Git repository can manage configuration objects in JOC Cockpit,
    • users with JS7 access permissions to view folders do not require Git access.
  • folder usage:
    • if a single Git repository should be used then all folders have to be available from a single root folder,
    • for use with a number of Git repositories each folder maps to a different repository,
    • folders can remain without Git integration for local management and deployment.

JOC Cockpit maps folders to Git repositories and stores the respective Git repository URL for each folder in its inventory.

Git Access

User Access

User access is available in line with JOC Cockpit security levels used for deployment of workflows, see JS7 - Security Architecture:

  • Security level LOW maps to use of a single Git account used by all users. Credentials are stored with the JS7 database.
  • Security level MEDIUM maps to use of an individual Git account per user. Credentials are stored with the JS7 database.
  • Security level HIGH does not allow to store Git credentials with JOC Cockpit. Operations on the remote Git repository have to be performed with tools external to JOC Cockpit such as Git Extensions.

The following credentials are stored with a user's profile:

  • git_account
    • account that is used to connect to a Git server
  • git_key
    • the user's private key for Git access
  • git_access_token
    • the access token for Git access that works as an alternative to use of a private key

If repositories are used from a number of Git servers that require different sets of user credentials then separate user accounts in JOC Cockpit have to be used.

Repository Access

  • The JS7 - REST Web Service API executes a set of Git operations by use of the Git Command Line Client.
  • Any operations to add configuration objects to a repository, to stage, commit, push, pull and to merge objects are available from the JS7 REST Web Service API.
  • The JOC Cockpit offers the user interface for respective Git operations.
  • Users are free to use additional tools such as Git Extensions to manage repositories.

Git Operations

Management

JS7 configuration objects are transparently managed in a Git repository via 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 JETTY_BASE/resources/joc/repositories folder. Each root-level folder in the JS7 Configuration view can be mapped to a Git repository. 

  • The local repository for a JS7 root-level folder is created when a user performs the checkout/clone 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 by use of the push operation.
  • The JS7 - Cleanup Service removes any local repositories if the JS7 root-level folder no longer exists, i.e. if a root-level folder is dropped from JOC Cockpit.

The following operations are available:

  • git-checkout
    • checks out a specific branch or tag from the Git repository to the local repository
  • git-clone
    • initially clones a Git repository to a local repository
  • git-add
    • adds or updates (stage) a new or modified configuration object on the filesystem to the local repository
  • git-reset
    • unstages a modification from the local repository, the modified file in the filesystem remains unchanged and still contains the modification
  • git-delete
    • removes an already added configuration object from the local repository
  • git-commit
    • commits newly staged configuration objects to a local repository
  • git-push
    • pushes changes from the local repository to the remote Git repository

Versioning

Versioning of JS7 configuration objects is performed by use of the tagging capabilities of Git. 

The JS7 REST Web Service API manages the Git tagging process.

The following operations are available:

  • git-tag
    • tags a commit with a version label
  • git-push
    • see above

Rollout

Rollout between different JS7 instances is performed by use of the Git functionality.

The JS7 REST Web Service API manages the processes for checkout and cloning.

The following operations are available:

  • git-checkout
    • checks out a specific branch or tag from the Git repository to the local repository
  • git-clone
    • initially clones a Git repository to a local repository
  • git-pull
    • pulls recent changes from the Git repository to the local repository

JOC Cockpit REST Web Service API Operations

The synchronization of configuration objects between the JOC Cockpit database and the repositories are managed by the JS7 JOC REST Web Service API.

The following REST Web Service operations are available:

  • ./inventory/repository/read
    • reads file tree of the local repository file system folder and updates the JOC Cockpit database
  • ./inventory/repository/store
    • stores a set of configuration objects from the JOC Cockpit database to the file system folder of the local repository
  • ./inventory/repository/delete
    • deletes a set of configuration objects from the file system folder of the local repository
  • ./inventory/repository/update
    • adds or updates a set of configuration objects in the JOC Cockpit database with the configuration objects from the local repositories file system folder

Use Cases

Single Client - Multiple Repositories (dev, test, prod)

Scenario

  • Architecture
    • A dedicated JOC Cockpit instance is used with Controller and Agents for each rollout environment such as dev, test, prod.
    • A Git repository is used per folder and per rollout environment (dev, test, prod), each JOC Cockpit instance is acting on a specific repository per rollout environment.
    • The Git repository is used to hold a copy of JS7 configuration objects and, depending on the rollout environment, to create versions of JS7 configuration objects.
  • Users
    • All users act in the same JOC Cockpit instance of the respective rollout environment that is a single client to the Git server.
    • Changes to the Git repositories are performed by the users' individual accounts and are added to the remote repositories.
  • Rollout
    • Deployments are performed from a single source (JOC Cockpit) to each Controller and Agents per rollout environment (dev, test, prod).
    • The Git repositories are used to checkout branches and to rollout JS7 configuration objects to different Controllers and Agents, such as dev => test => prod.
    • The Git repository can be used to fallback to previous versions of configuration objects, however, only one version is available with a given JOC Cockpit instance at a given point in time.
    • After an update of configurations objects in a given JOC Cockpit instance the updated configuration objects have to be deployed anew.

Repositories marked as "env" are specific for an environment and are excluded from rollout. Repositories marked as "rollout" are environment-independent and are forwarded across scheduling environments.


Repository Operations

  • management
  • versioning
  • rollout

Requirements

  • The JOC Cockpit database holds the configuration objects:
    • each JOC Cockpit instance is connected to its own database,
    • each Git Repository is mapped to an individual JOC Cockpit instance,
    • the database can be updated from a Git branch.
  • each Git branch makes use of its own version of configuration objects.

Multiple Clients - Multiple Repositories (dev, test, prod)

Scenario

  • Architecture
    • A dedicated JOC Cockpit instance is used with each Controller and Agents for each user in the dev rollout environment.
    • A dedicated JOC Cockpit instance is used with each Controller and Agents for all users in the test and prod rollout environments.
    • Individual Git repositories are used per folder and per rollout environment(dev, test, prod) by JOC Cockpit instances, each instance is acting on a specific repository per rollout environment.
    • The Git repository is used to hold a copy of JS7 configuration objects, depending on the rollout environment, to create versions of JS7 configuration objects.
  • Users
    • Users act in individual JOC Cockpit instances of the dev rollout environment as multiple clients to the Git server.
    • Users act in the same JOC Cockpit instance of the test and prod rollout environment as a single client to the Git server.
    • Changes to the Git repositories are performed by the users' individual accounts.
  • Rollout
    • Deployments are performed from a multiple sources (JOC Cockpit) to the connected Controller and Agents per rollout environment (dev, test, prod).
    • The Git repositories are used to checkout branches and to rollout JS7 configuration objects to different Controllers and Agents, such as dev => test => prod.
    • The Git repository can be used to fallback (pull) to previous versions of configuration objects, however, only one version is available with a given JOC Cockpit instance at a given point in time.
    • After an update of configurations objects in a given JOC Cockpit instance the updated configuration objects have to be deployed anew.

Repositories marked as "env" are specific for an environment and are excluded from rollout. Repositories marked as "rollout" are environment-independent and are forwarded across scheduling environments.


Repository Operations

  • management
  • versioning
  • rollout

Requirements

  • The JOC Cockpit database holds the configuration objects:
    • each JOC Cockpit instance is connected to its own database.
    • each Git Repository is connected to one or more JOC Cockpit instances, e.g. dev rollout.
  • Each Git branch makes use of its own versions of configuration objects.
  • Each user (client) makes use of an individual JS7 instance using JOC Cockpit and database, Controller and Agents.

Transfer between Environments (dev, test, prod)

Scenario

  • Use Case
    • Each environment makes use of an individual JS7 instance using JOC Cockpit and database, Controller and Agents.
    • Environment dev: 
      • A configuration object, e.g. a workflow, is created or changed by a developer
      • when finished and tested (deployed) by the developer in his environment the configuration object will be stored to the local dev repository
      • the change to the local repository will be commited and pushed to the remote dev repository
    • Environment test:
      • A test user with access to the developers env repository, pulls the current changes.
      • The current changes will be copied from the developers env repository (source) to the test users test repository (target).
      • The test user updates his JOC instance with the current changes from his local test repository.
      • The test user deploys the changed workflow to his environment and runs the desired tests.
      • When finished and approved the current changes from the test users local test repository are commited and pushed to the remote test repository
        • additionally the latest commit can be tagged with a label, e.g. "v2_approved"
    • Environment prod:
      • A production user with access to the test users test repository, pulls the current changes and checks out the tag "v2_approved".
      • The current changes will be copied from the test users test repository (source) to the production users prod repository (target).
      • The production user updates his JOC instance with the current changes from his local prod repository and checks the updated changes before deployment.
      • When checked, the current changes from the production users local prod repository are commited and pushed to the remote prod repository
      • The new change will be tagged with a label, e.g. "v2"
      • The production user deploys the changed workflow to the production environment.

Requirements

  • The JOC REST Web Service API will provide web services to interact with the local filesystem of the local git repository.
    • Web Serivce APIs
      • read
      • store
      • update
      • delete
  • The JOC REST Web Service API will provide web services to interact with the local git repositories.
    • The Web Serivce APIs will make use the git CLI.
      • Git Commands
        • add
        • restore
        • reset
        • commit
        • checkout
  • The JOC REST Web Service API will provide web services to interact with remote git repositories.
    • The Web Serivce APIs will make use the git CLI. 
      • Git Commands
        • clone
        • push
        • pull
  • The JOC REST Web Service API will provide web services to interact between local git repositories (read source/target, copy source/target) to support transfer of configuration objects between environments (dev, test, prod).
    • All 3rd party git tool cover the interaction between local (clone) git repositories and remote (origin) git repositories also.
    • Most 3rd party git tools do not cover interaction between local repositories, e.g. local dev → local test



  • No labels