Environment & Installation

Getting started

This guide will outline the initial setup required to use the Governance Center.

Prerequisites

These are the prerequisites you will need before starting to use the governance centre:

• 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.

Download

Download the latest version of the Governance Center here. Version 2 of the app requires Joget DX 8.1.10 or above. Before installing the latest version of the Governance Center App, delete all prior versions first.

Required plugins

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

• API Builder Addon For DX
• Governed API Plugins(governed-api-plugins-8.0-SNAPSHOT)
• Governed Plugins(governed-plugins)

User roles

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

• At least 1 or more users are assigned as App Owner in the Manage User Role.
• At least 1 user is assigned as App Developer in the Manage User Role, or 1 user is assigned in a Groups.

Licensing

The expiry date for the Governance Center App license is displayed on the top right of the App Composer. 

If the app license has expired, click the Expiry hyperlink and follow these steps:

1. In the App License page, copy the governanceApp App ID and paste it into the App ID parameter of the Joget App License Request for App License page.
   
2. Fill in the required parameters and click Submit. You will receive an email with a license code.
   
3. Copy the license code and paste the it in the App License parameter of the App License page.
   
4. Click Submit. The license approval SLA (Service Level Agreement) is 24 hours.

Create a new environment

Identify the environment you wish to create, such as a Production, Staging, Development or Testing environment. Then, create a new environment by navigating to Administration > Manage Environment > New.

You will see the following:

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.

You will see the following fields:

Where:

• Installation ID: Auto-generated
• Installation Name: Installation 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 Master ID: Username for the user with admin privileges in the installation Joget instance.
• Installation Master Password: Password for the user with admin privileges in the installation Joget instance.
• Login As: the default user role that will be used to authenticate and interact with the installed Joget instance.
• Environment: The environment name for this installation (Selectbox with options retrieved from Manage Installations).
• Deployer: The user who requested this installation (Multi Select Box that allows multiple selections, options retrieved from Users).
• Approver: The user in charge of approving this installation (Multi Select Box that allows multiple selections, options 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:

• App Registration Approval Process
• Deployment Request Approval Process

App registration approval process

1. Register a Joget app by navigating to New Request > Register App.
2. Choose the installation and installation approver, and the Environment will be auto-completed.
3. Choose the app owner and to whom the application is to be assigned.

You will see the following fields:

Where:

• App ID: Auto-generated
• Installation: Define which installation the App should be registered to (Select box with options retrieved from Manage Installations)
• Installation Approver: Define the Installation Approver (Select box that displays relevant installation approvers based on the selection of the Installation field)
• Environment: Define which environment the App would be registered to (Select box that displays relevant environments from Manage Environment based on the selection of the Installation field)
• App Name: Select box that displays relevant Apps available based on the selection of the Installation field.
• App Criticality: Define the criticality of the App (Select box with options: Very High, High, Medium, Low, Very Low)
• App Availability: Define the availability of the App.
• App Purpose: Define the purpose of the App.
• Contact Type: Define the contact type (Select box with options: Owner, Business Contact, Technical Contact)
• App Owner: Define the owner of the App (Select box that displays relevant users 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 (Select box with options: group, individual; selecting "group" displays the Group field, selecting "individual" displays the App Developer/Designer field)
• Set Pipeline? (Select in order): Define whether the App will be deployed by following a sequence of installations (Single Checkbox, when ticked, displays the Pipeline field)
• Pipeline (Please Select in order): Define which installation the App would be deployed to in sequence (Multi Select Box that allows multiple selections, options retrieved from Manage Installations; this field is displayed if the Set Pipeline? field is ticked)
• Group: Define which user group the deployment is assigned to (Select box that displays all available Groups)
• App Developer/Designer: Define which user is assigned to (Multi Select Box that displays relevant users identified as App Developer in Manage User Role)

Now, approve the application registration by navigating to Approvals > App Registration Inbox 

Deployment request approval process

1. Submit New Deployment New Request > Submit Deployment.
2. Choose the source installation which contains the application you want to transfer to the target installation.
3. Choose the target installation that will receive the application from the source installation after the deployment has been approved.

You will see the following fields:

Where:

Now, Approve the Deployment Approvals > Deployment Inbox. Once the approver has approved the deployments, you can see your deployment overview in the list here.