Skip to content

Latest commit

 

History

History
379 lines (259 loc) · 13.8 KB

README.md

File metadata and controls

379 lines (259 loc) · 13.8 KB
Raw

Contributors Forks Stargazers Issues MIT License Lifecycle

Forestry Client Services' greenfield starter template and pull request based pipeline. For new and migrating products. Currently supports OpenShift with plans for Amazon Web Services.

Overview

Tantalis Integrated Common Document Generator Interface (TICDI) is a node.js application built with nestJS, and the main purpose is to act as an integration point between TANTALIS (TTLS) and the Common Document Generation Service (CDOGS). For CDOGS documentation, please refer to https://digital.gov.bc.ca/common-components/common-document-generation-service.

TICDI has an exposed endpoint at {hostname}/DTID/{DTID_NUMBER}/{FILE_NAME} (for example https://nr-ticdi-10.apps.silver.devops.gov.bc.ca/DTID/928437/test) that is initiated from the Tantalis application. This endpoint will trigger TICDI to consume a REST endpoint on Tantalis-API using a WebADE generated OAUTH token. TICDI users can then click the "Generate Document" button to generate a document via CDOGS.

The following OpenShift secrets are used:

  • nr-ticdi-api: The WebADE oauth token used to authenticate against the TTLS-API.
  • nr-ticdi-cdogs
    • service_client_id: GTOK* Service Client ID.
    • service_client_secret: GTOK Client Secret.

*GTOK: https://getok.nrs.gov.bc.ca/app/apps/TICDI

The Greenfield template (https://github.com/bcgov/greenfield-template/) was used to bootstrap the application.

TODO

  • Create OpenShift realm to handle authentication.
  • Grab WebADE oauth token without relying on secrets. Currently, we have to update the nr-ticdi-api secret daily with the latest token. We should be able to call a WebADE endpoint to do this for us before making calls to TTLS-API. In the meantime, this John Vestner provides us with these tokens daily. To apply the tokens:
  1. Login to c57b8f-dev in OpenShift and access the secrets within the workloads section (or just go to https://console.apps.silver.devops.gov.bc.ca/k8s/ns/c57b8f-dev/secrets)
  2. Select the "nr-ticdi-api" secret
  3. Click "Actions" in the top-right of the screen, and then select "Edit Secret"
  4. Click save
  5. Delete the ticdi pod

Github

GitHub Actions template to automate the process for testing, security scanning, code quality checking, image building and deploying for an application.

This project is in active development. Please visit our issues page to view or request features.

Currently, our most exciting offering is the GitHub Actions pipeline, which includes:

...and more on the way!

Pipeline Action

Local Setup

Create a .env file in /frontend with the following environment parameters:

  • service_client_id=
  • service_client_secret=
  • TTLS_API_KEY=

Getting Started

Included:

  • Documentation:
    • *.md
  • Workflows:
    • Pull Request-based (.github/workflows/pr-open.yml)
    • On Close (.github/workflows/pr-close.yml)
    • Main Merge (.github/workflows/main-merge.yml)
  • Misc:
    • nestjs
    • eslint
    • lint-staged

Not included:

  • Repository secrets
  • Environment secrets
  • Issues
  • Pull requests
  • JavaScript (transpiled/created to dist/)

Prerequisites

The following are required:

  • BC Government IDIR accounts for anyone submitting requests
  • GitHub accounts for all participating team members
  • Membership in the BCGov GitHub organization
  • Project namespaces (pick one):

Setting Up the GitHub Repository

Pull Request Handling

Squash merging is recommended for simplified histories ad ease of rollback.

Cleaning up merged branches is recommended for your DevOps Specialist's fragile sanity.

From GitHub:

  1. Select Settings (gear, top right) -> General (selected automatically)
  2. Scroll to Pull Requests
    • [check] Allow squash merging
    • [check] Automatically delete head branches

Closing Repo-Mountie Issues

repo-mountie is a BCGov bot that likes to spam us. Here are a few issues to expect.

Lets use common phrasing

  • Includes examples of inappropriate and preferred phrasing
  • The default branch should be named main
  • Close the issue

Add missing topics

  • Topics improve discoverability
  • Directions will be included
  • Close the issue

Action Secrets

Action Secrets are consumed by workflows, including 3rd party Actions. Please use Environment secrets for highly sensitive content.

Manage Action Secrets from your Repo > Settings > Secrets > Actions.

Required

GHTOKEN

  • Default token, not viewable, common to all repositories
  • Variable: {{ secrets.GHTOKEN }}

GHPROJECT_TOKEN (TODO: check that this is still in use)

  • Personal Access Token for writing to Pull Requests
  • Variable: {{ secrets.GHPROJECT_TOKEN }}

OC_SERVER

  • OpenShift server address
  • Variable: {{ secrets.OC_SERVER }}
  • Value (pick one of):
    • https://api.gold.devops.gov.bc.ca:6443
    • https://api.silver.devops.gov.bc.ca:6443

Optional

Provide these tokens or comment their jobs out:

  • ./github/workflows/pr-open.yml
  • ./github/workflows/main.yml

SNYK_TOKEN

  • Vulnerability, dependency and infrastructure code scanning
  • Acquire a free token at Snyk.io
  • Variable: {{ secrets.SNYK_TOKEN }}

SONAR_TOKEN

Environment Secrets

Secrets can be grouped into and protected by Environments. Features include:

  • Required reviewers
  • Wait timer
  • Deployment branches

Manage Environments and their Secrets from your Repo > Settings > Environments.

Environment: dev

Create a new Environment to hold the keys to our development deployment.

Environment name: dev

No protection rules are required yet:

  • [unchecked] Required reviewers
  • [unchecked] Wait timer
  • Deployment branches: All branches

Required

NAMESPACE

  • OpenShift Development namespace (see Prerequisites)
  • Variable: {{ secrets.NAMESPACE }}

OC_TOKEN

  • OpenShift pipeline account token (see Getting an OpenShift Account Token)
  • Variable: {{ secrets.OC_TOKEN }}

Getting an OpenShift Account Token

Please assume that your OpenShift platform team has provisioned a pipeline account.

  1. Login to your OpenShift cluster
  2. Select your DEV namespace (provided by the OpenShift platform team)
  3. Select Secrets (under Workloads for Administrator view)
  4. Select pipeline-token-... or a similarly privileged token
  5. Under Data, copy token
  6. Paste into the GitHub Environment Secret OC_TOKEN (see above)

Getting a Personal Access Token

TODO: verify still required

Generate a Personal Access Token in a GitHub account of your choosing. Personal or shared Service accounts can be used.

From GitHub:

  1. Select Settings (gear, top right) -> Developer settings -> Personal access tokens
  2. Create a new token with the following rights:
    • workflow
    • write:packages
  3. Paste into the GitHub Action Secret GHCR_TOKEN (see above)
  4. Update the “Log in to the Container registry” step in pr_open.yml as follows: 
    - name: Log in to the Container registry
    uses: docker/login-action@v1
    with:
      registry: ${{ env.REGISTRY }}
      username: ${{ secrets.GHCR_USERNAME }}
      password: ${{ secrets.GHCR_TOKEN }}

First Pipeline Run

By now all relevant tokens should be provided. We are going to assume that Synk and SonarCloud aren't on hand yet, so let's comment themout. Please revise as appropriate.

Steps in this section use a terminal. Several GUIs alternatives are avilable, but out of scope.

Required:

  • Git CLI installed and configured
  • Access to a command prompt:
    • Linux command terminal
    • MacOS command terminal
    • Windows Subsystem for Linux (WSL)

Create a Branch and Make Changes

  1. Create and switch to a new branch 
    git checkout -b <new-branch-name>
  2. Edit the following workflows
    • Pull Requests: .github/workflows/pr-open.yml
    • Main Merge: .github/workflows/main.yml
  3. Comment out the following jobs
    • snyk (PR only)
    • sonarcloud (both)
  4. Stage changes and create commits (repeat as necessary) 
    git add .github/workflows/
git commit -m "Pipeline: comment out snyk and sonarcloud"
  5. Push the commits 
    # First time only
git push -u origin <new-branch-name>

# Subsequent times
git push origin

Create a Pull Request

This is where things start to get exciting!

From your GitHub repository:

  1. Select Pull Requests
  2. Click New pull request (big green button)
    • Title: Pipeline: comment out snyk and sonarcloud
    • Body: Pipeline: comment out snyk and sonarcloud
    • Target Branch: <new-branch-name>
    • Source Branch: main
  3. Proceed according the the pipeline's directions!

Packages

Packages are available from your repository (link on right) or your organization's package lists.

E.g. https://github.com/orgs/bcgov/packages?repo_name=greenfield-template

Branch Protection

This is required to prevent direct pushes and merges to the default branch. One full pipeline run must be completed before Make sure that main is the default branch.

From GitHub:

  1. Select Settings (gear, top right) -> Branches (under Code and Automation)
  2. Click Add Rule or edit an existing rule
  3. Under Protect matching branches specify the following:
    • Branch name pattern: main
    • [check] Require a pull request before merging
      • [check] Require approvals (default = 1)
      • [check] Dismiss stale pull request approvals when new commits are pushed
      • [check] Require review from Code Owners
    • [check] Require status checks to pass before merging
      • [check] Require branches to be up to date before merging
      • Status checks that are required requires to the search box to select:
        • Build
        • Check
        • CodeQL
        • Deploy
        • Tests
        • Zap
        • Snyk (optional)
        • SonarCloud (optional)
    • [check] Require conversation resolution before merging
    • [check] Include administrators (optional)

Adding Team Members

Don't forget to add your team members!

From GitHub:

  1. Select Settings (gear, top right) -> Collaborators and teams (under Access)
  2. Click Add people or Add teams
  3. Use the search box to find people or teams
  4. Choose a role (one of)
    • Read
    • Triage
    • Write
    • Maintain
    • Admin
  5. Click Add

Troubleshooting

  • If failed to get authentication at the build docker image stage, check if updated to use the secrets GHCR token and username, the default GitHub token might not work

  • If failed to authenticate to openshfit at the deploy stage, check if the service account “pipeline” has the right ability to get project and do deploy

Notes

This repo provides a basic template to start up a new project using nodejs. It needs to be customized based on the project, for example, run tests for a different language and revised whatever secrets required.