Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The deployment process involves deploying back-end modules and front-end modules (UI modules).
The process for deploying for active development for back-end module involves Deploying via a Feature Branch.

...

Ensure the Rancher Pod is Running

Recent operational decisions have led to having the Rancher Pods being offline based on a schedule.

The Rancher Pod should be started before deploying.

The https://folio-dev-aggies-diku.ci.folio.org/ will show a 502 Bad Gateway when the Pod is down.

Use the Scale Up or Down a Pod via Manage Pods to bring the Pod up.
The How to Start/Activate Rancher Environment guide describes how to do this.

Deploying Feature Branches

A feature branch is simply a branch on Github that is to be deployed.
These branches are classified as a “feature branch” even if they are bug fixes or something else that is not a “feature”.

Deploying Back-end Module Feature Branch

Some of this the back-end module deplyoment feature branch process is still described in the (Deprecated) Deploy/Update back-end module from feature branch documentation.

...

The Aggies team deploys a back-end module using the Jenkins Feature Branch Deployment process as follows:

...

Info

To determine what has been run previously (and with what parameters) the job history should be used:

Confirming a Back-end Module Feature Branch is Deployed

The build process should show success, but one should also visit the Aggies Scratch Environment to confirm that the back-end module is correctly deployed, registered, and enabled.

...

Code Block
Camnuda BPM Module (mod-camunda-1.2.0-SNAPSHOT.d18c2f2)

Deploying Front-end Module Feature Branch

The feature branch is deployed using the platform-complete-aggies branch from the ui-workflow project. That branch should be updated to contain the desired state of the code that is intended to be deployed. This branch may be force-pushed to.

Info

Before deploying, make sure that the platform-complete-aggies branch is up to date with the desired code changes.

The feature branch is now deployed by modifying the package.json in the Platform Complete Aggies Rancher Branch.
The @folio/workflow must be set to the gitub repository and branch (such as my_custom_branch), like this:

Code Block
languagejson
"@folio/workflow": "https://github.com/folio-org/ui-workflow.git#my_custom_branch",
Note

The simpler approach of just using platform-complete-aggies branch from ui-workflow may not consistently due to potential build time caching.
To work-around this, the solution is to make a new commit hash in the Platform Complete Aggies Rancher Branch for every rebuild.
The method of updating the package.json file as described above achieves this result.

The Aggies team deploys a front-end module using the Deploy UI Bundle process as follows:

  1. The CLUSER is set to folio-dev.

  2. The NAMESPACE is set to aggies.

  3. The FOLIO_REPOSITORY is set to platform-complete.

  4. The FOLIO_BRANCH is set to aggies-rancher.

  5. The CONFIG_TYPE is set to development.

  6. The TENANT_ID is set to diku.

  7. The UI_BUNDLE_BUILD is usually checked (uncheck to select an existing bundle).

  8. The UI_BUNDLE_TAG is set left alone or blank except when UI_BUNDLE_BUILD is unchecked.

  9. The CUSTOM_HASH is set left alone.

  10. The CONSORTIA is left unchecked.

  11. The AGENT is set to jenkins-agent-java17.

  12. The REFRESH_PARAMETERS is left unchecked.

  13. Pushing the Build button will build the image.

Info

The reason for using the platform-complete-aggies branch for ui-workflow deployment is because the aggies-rancher branch in the platform-complete repository is set to point to the platform-complete-aggies branch in the ui-workflow repository.