Getting Started

This guide will outline the initial setup that you would need to do to make use of the Governance Center.

Prerequisites

You will need:

  • 1 instance of Joget with the Governance Center installed
  • At least 1 or more instances of Joget that are reachable from the Governance Center (whether publicly, or within the same network of the Governance Center) 
  • Admin access to all the instances. 


Upon importing the Governance Center, you will need the following plugins for the Governance Center to work:


Upon launching the Governance Center, you will need the following setups to proceed:


Step 1: Create a new environment

Identify the environment you wish to create. Example: Production, Staging, Development, Testing, etc

Create a new environment by navigating to Administration→ Manage Environment → New

Only users with admin role can create an Environment.

Figure 1: Manage Environment Form


Step 2: Create a new Installation

Register installations, identify to which environment they belong, and identify the users who can register Joget apps and submit deployment requests for this installation. 

Create a new installation by navigating to Administration→ Manage Installations→ New

An environment can contain one or more installations.

Only users with an admin role can create an Installation.

Only users who are added as deployers in the installation can register Joget app and submit deployment.


Figure 2: Manage Installation Form


FieldDescription
Installation IDAuto-generated
Installation NameInstallation Name used for reference within the Governance Center
Base URL

URL of the Joget instance. (Must be reachable to the Governance Center & you as the user)

  • must include the /jw as the base URL as well
Installation Admin ID

Username for the user with admin privilege in the installation Joget instance

Installation Admin Password

Password for the user with admin privilege in the installation Joget instance

Environment

The environment name for this installation.

Selectbox with options are retrieved from Manage Installations

Deployer

The user who requested this installation. 

Multi Select Box that allows multiple selections. Selection options are retrieved from Users

Approver

The user who will be in charge of approving this installation.

Multi Select Box that allows multiple selections. Selection options are retrieved from Users

New Request

Once the Environment and Installations have been created, users who have been assigned as a Deployer will be able to perform 2 processes under the New Request UI category:

  1. App Registration Approval Process
  2. Deployment Request Approval Process

App Registration Approval Process

Step 1: Register for a new Joget App

Register a Joget app by navigating to New Request → Register App

Choose the installation and installation approver and the Environment will be auto-completed.

Choose the app owner and to whom the application is to be assigned.


Figure 3: App Registration Form

FieldDescription
App IDAuto-generated
Installation

Define which installation should the App be registered.
Select box with options are retrieved from Manage Installations

Installation Approver

Define the Installation Approver.

Selectbox that displays relevant installation approver users available based on the selection of the Installation field. 

Environment

Define which environment the App would be registered to.

Selectbox that displays relevant environments from Manage Environment based on the selection of the Installation field.

App NameSelectbox that displays relevant Apps available based on the selection of the Installation field.
App Criticality

Define the criticality of the App.
Selectbox with the following available options:

  • Very High
  • High
  • Medium
  • Low
  • Very Low
App AvailabilityDefine the availability of the App.
App PurposeDefine the purpose of the App
Contact Type

Define the contact type.

Selectbox with the following available options:

  • Owner
  • Business Contact
  • Technical Contact
App Owner

Define the owner of the App.

Selectbox that displays relevant users who are identified as App Owner in the Manage User Role

Assign To

Define whether the App is assigned to an individual App Developer/Designer or a Group of Users

Selectbox with the following available options:

  • group  (selecting this option will display the Group field)
  • individual (selecting this option will display theApp Developer/Designer field)
Set Pipeline?

Define whether the App will be deployed by following a sequence of installations.

A single Checkbox that when ticked, will display the Pipeline (Please Select in order) field.

Pipeline (Please Select in order)

Define which installation the App would be deployed in sequence. 

Multi Select Box that allows multiple selections. Selection options are retrieved from Manage Installations

This field will be displayed if the checkbox in Set Pipeline? field is ticked.

Group

Define which user group the deployed is assigned to.

Selectbox that displays all available Groups

App Developer/Designer

Define which user is assigned to.

Multi Select Box that allows multiple selections that display relevant users who are identified as App Developer in Manage User Role

Step 2: Approver Checks App Registration Inbox

Approve the application registration by navigating to Approvals → App Registration Inbox 

Figure 4: App Registration Inbox



Deployment Request Approval Process

Step 1: Submit a New Deployment

Submit New Deployment New Request → Submit Deployment

Choose the source installation which contains the application you want to transfer to the target installation

Choose the target installation that will receive the application from the source installation after the deployment has been approved.

Figure 5: Deployment Request Form


FieldDescription
Deployment Request IDAuto-generated
Source InstallationSource instance from where the application is to be imported from
Current EnvironmentThe source environment of the installation that this application should be imported from
Source Base URLSource instance URL to import the application 
App IDID of the application to be imported
App VersionThe version of the application to be imported
Target InstallationTarget instance to where the application will be exported & installed to
Target EnvironmentThe target environment of the installation that this application will be exported & installed to
Target Base URLTarget instance URL to export & install the application to
ApproverThe user who will be approving this deployment
Description (reason)Description of the deployment request




Step 2: Approver Checks Deployment Inbox

Approve the Deployment  Approvals → Deployment Inbox

You will be able to see your deployments overview in the list here once it is approved by the approver. 


Figure 7: Deployment Request Inbox



  • No labels