Skip to main content
Private Cloud as a Service Platform Technical Documentation

Reusable services list

Find details on the following services or tools you can use as part of your project in bcgov.

On this page

Backup Container

Backup Container is a simple, containerized backup solution used to backup one or more supported databases to a secondary location. The code and documentation was originally pulled from HETS Project.

Features

You can use the following databases:

  • MongoDB
  • PostgresSQL
  • MSSQL (MSSQL requires the NFS DB volume is shared with the database for backups to function correctly)
  • MariaDB

You can run Backup Container for supported databases separately or in a mixed environment.

For more information on Backup Container, see the following pages:

BC Address Geocoder

The BC Address Geocoder REST API lets you integrate real-time standardization, validation and geocoding of physical addresses into your applications. See the Data Catalogue for information on aspects of the REST API that aren't covered in the OpenAPI definition.

The Geocoder helps you validate and geocode addresses (including public and related business occupants); find physical sites, intersections and occupants; and find sites, intersections and occupants near a point or within an area. The current baseUrl for the online geocoder is https://geocoder.api.gov.bc.ca/.

The URL allows both public and gated access. Gated access requires an APIkey. To get a sandbox APIkey with a maximum rate of 1000 requests per minute, visit the Geocoder API console. You can get an unrestricted APIkey for use in government applications by opening a ticket with the Data Systems & Services request system.

For more information on the BC Address Geocoder, see the following pages:

Common Document Generation Service

Use the Common Document Generation Service (CDOGS) to generate PDF or XML-based documents (ex: docx, xlsx, pptx, odt, ods, odp, and html). The CDOGS API can merge complex datasets into document templates. It supports any XML-based document templates including but not limited to Microsoft Office, LibreOffice, and OpenOffice.

For more information on CDOGS, see the following pages:

Common Hosted Email Service

Use the Common Hosted Email Service (CHES) to send emails programmatically. For more information on CHES, see the following pages:

Common Object Management Service

Using the Common Object Management Service (COMS), take advantage of more cost-effective storage solutions for your new or existing business applications with an authorization and authentication method that suits your application’s business requirements. COMS is a secure REST API that lets you connect your application to any S3 bucket.

For more information on COMS, see the following pages:

Get Token

Get Token (also known as GETOK) is a self-serve web interface that provides onboarding and access management of API services using OAuth client credentials.

For more information, visit:

nr-get-token repository

Fathom

Fathom analytics provide simple website statistics without tracking or storing personal data. fathom-openshift is a set of OpenShift configurations to set up an instance of the Fathom web analytics server.

For more information, see the following pages:

go-crond

go-crond is a cron daemon written in Go for use in Docker images. For more information, see the following pages:

Matomo OpenShift

Matomo is a comprehensive web analytics server and an alternative to Google Analytics when data ownership and privacy compliance are a concern.

Matomo OpenShift provides a set of OpenShift configurations to set up an instance of the Matomo web analytics server. For more information, see the following pages:

OWASP ZAP Security Vulnerability Scanning

The OWASP Zed Attack Proxy (ZAP) automatically finds security vulnerabilities in web applications. For more information, see the following pages:

Pathfinder Single Sign-On Keycloak

The Pathfinder Single Sign-On (SSO) team provides the Common Hosted Single Sign-On (CSS) App. This is a self-service app that allows you to integrate with BC government approved login services (identity providers).

The Pathfinder SSO service is built on the foundations of Keycloak/Redhat SSO.

SonarQube in the BC Gov Private Cloud PaaS

SonarQube® is an automatic code review tool you can use to detect bugs, vulnerabilities and code smells in your code. It can integrate with your existing workflow to enable continuous code inspection across your project branches and pull requests.

When a piece of code does not comply with a rule, an issue is logged on the snapshot. An issue can be logged on a source file or a unit test file.

SonarQube is a community-supported service. We also encourage teams to switch to using the SonarQube SaaS service.

For more information, see the SonarQube repository.

SonarQube on OpenShift

The SonarQube repository contains all the resources you might need to deploy a SonarQube server instance in a B.C. government OpenShift environment and integrate SonarQube scanning into your Jenkins pipeline.

This work was inspired by the OpenShift Demos SonarQube for OpenShift.

For more information, see the following pages:

For information on upgrading plugins, see the following pages:

You can also integrate a ZAP plugin for SonarQube.

WeasyPrint HTML to PDF/PNG Microservice

The docker-weasyprint project bundles WeasyPrint into a simple, OpenShift-compatible, HTML to PDF/PNG microservice with a simple REST interface.

For more information, see the following pages:

Related links: