| Layer | Technology |
|---|---|
| Presentation | Angular 13 |
| Business Logic | C Sharp - Dotnet Core 6.0 |
| Microservices | C Sharp - Dotnet Core 6.0 |
| Front End Web Server | Caddy |
| Application Server | Kestrel |
| Data Storage | MS Dynamics On Premise V9 |
| Authentication | ADFS, BC Services Card |
| Document Storage | S3 |
| Container Platform | OpenShift 4 |
| Zero Trust Security Policy Type | Kubernetes |
| Logging | Splunk, Console, and Kibana |
| CI/CD Pipeline | GitHub Actions, Kubernetes Pipelines (Tekton) |
- functional-tests: Source for BDD tests
- openshift: Various OpenShift related material, including instructions for setup and templates.
This application is meant to be deployed to RedHat OpenShift version 4. Full instructions to deploy to OpenShift are in the openshift directory.
Public Application
- .Net Core SDK (6.0)
- Node.js
- .NET Core IDE such as Visual Studio or VS Code
- JAG VPN with access to MS Dynamics
DevOps
- RedHat OpenShift tools
- Docker
- A familiarity with GitHub Actions and Tekton Pipelines
A MS Dynamics instance containing the necessary solution files is required. A S3 compatible object store is required for persistent files.
There are two main categories of Github Actions used in this project:
- Continuous Integration - these pipelines are used to integrate code from a Fork into the main "develop" line
- Continuous Delivery - these pipelines are used to assist in building code for delivery (deployment) in OpenShift.
An example of other Github Actions also used in the project is the stats action Code Cov uses.
-
OCP4_NAMESPACE - set to the full project identifier where images are stored. For example proj-tools.
-
OCP4_USERNAME - the username for a Service Account with access to read / write OCP4_NAMESPACE images
Note that this username must have the following role bindings set:
oc policy add-role-to-user system:image-builder system:serviceaccount:<namespace>:<username>
-
OCP4_PASSWORD - the TOKEN from the OpenShift secret for the username in OCP4_USERNAME
-
OCP4_REGISTRY - the hostname for the public image repository. You can get this by viewing the details for an image in the given project; only put the hostname portion.
There is also a series of Tekton (Kubernetes) pipelines:
To promote code to TEST, login to OpenShift and start the Kubernetes Pipeline for Promote to Test.
To promote code to TRAIN, login to OpenShift and start the Kubernetes Pipeline for Promote to Train.
To promote code to PROD, login to OpenShift and start the Kubernetes Pipeline for Promote to Prod. Not that this pipeline will also make a backup of the current PROD deployment.
If you wish to revert to the previous PROD deployment, login to OpenShift and start the Kubernetes Pipeline for Restore PROD from Backup.
This system makes use of Hangfire for scheduling. More information on Hangfire can be found at the website hangfire.io; the system uses a stock configuration of Hangfire.
To login to a hangfire dashboard, forward traffic from the OpenShift pod for the scheduler service and access https://localhost:8080
oc port-forward <POD NAME> 8080:8080
Please report any issues.
Pull requests are always welcome.
If you would like to contribute, please see our contributing guidelines.
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
Copyright 2022 Province of British Columbia
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
This repository is maintained by BC Attorney General.