Getting Started
This guide will outline the initial setup that you would need to do to make use of the Governance App.
Prerequisites
You will need:
- 1 instance of Joget with the Governance App installed
- At least 1 or more instances of Joget that is reachable from the Governance App (whether publicly, or within the same network of the Governance App)
- Admin access to all the instances.
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.
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 a deployer in the installation can register Joget app and submit deployment.
| Field | Description |
|---|---|
| Installation ID | Auto-generated |
| Installation Name | Installation Name used for reference within the Governance App |
| Base URL | URL of the Joget instance. (Must be reachable to the Governance App & you as the user)
|
| 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 label for this installation |
| Deployer | The user who requested for this installation |
| Approver | The user who will be in charge of approving this installation |
New Request
Once the Environment and Installations have been created, users who have been assigned as 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
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 to.
Step 2:
Approve the application registration Approvals → App Registration Inbox
Deployment Request Approval Process
Step 1:
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.
| Field | Description |
|---|---|
| Deployment Request ID | Auto-generated |
| Source Installation | Source instance from where the application is to be imported from |
| Current Environment | The source environment of the installation that this application should be imported from |
| Source Base URL | Source instance URL to import the application |
| App ID | ID of the application to be imported |
| App Version | The version of the application to be imported |
| Target Installation | Target instance to where the application will be exported & installed to |
| Target Environment | The target environment of the installation that this application will be exported & installed to |
| Target Base URL | Target instance URL to export & install the application to |
| Approver | The user who will be approving this deployment |
| Description (reason) | Description of the deployment request |
Step 2:
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.
