Skip to content

Latest commit

 

History

History
60 lines (48 loc) · 2.69 KB

README.md

File metadata and controls

60 lines (48 loc) · 2.69 KB
Raw

H-Drive-Email

Purpose

Run Locally

To run locally

  1. Ensure you have docker installed
  2. Create a local .env file (can use .env.example as a starting point. It's based on constants.py)
  3. Run docker build --no-cache -t h-drive-email .
  4. Once built, you can start it using docker run --env-file .env -p 8501:8501 h-drive-email
  5. Go to localhost:8501

Initial Setup in OpenShift

To quickly get you started in a new namespace, follow these steps.

  1. In the OpenShift Folder there is a full_config.yaml file
  2. Replace the two instances of <NAMESPACE> with the namespace you are installing this on (ie abc123-dev)
  3. In OpenShift, click the + button on the top bar
  4. Copy and Paste the YAML file into the page
  5. Click Create which will automatically create all the required components for the application to function:
    1. Deployment
    2. Service
    3. Route
    4. Network Policy
    5. ImageStream
  6. Follow the Github Action Setup steps below and trigger the workflow. This should then automatically cause the container to start. Since we are using an ImageStream with Auto Redeploy's configured in the Deployment, anytime you trigger the workflow it will automatically redeploy the application.

To Note:

  • Route is configured to require being on a BC Gov Network
  • The Environment Variables in OpenShift are in the Deployment.
  • The application will automatically restart with the latest image from the last build.yml run

GitHub Action Setup

The build.yml github action will build the Dockerfile and push it to the OpenShift ImageStream you have configured. The Deployment in OpenShift is configured to update when there is a new image available so it will restart. Before you can run the workflow, ensure you have these variables and secrets configured in the Repo:

  • OPENSHIFT_IMAGESTREAM_URL variable
    • Looks like: image-registry.apps.silver.devops.gov.bc.ca/NAMESPACE/ (including -dev, test, prod or tools)
  • OPENSHIFT_IMAGESTREAM_USERNAME secret
    • You can use the Pipeline user
  • OPENSHIFT_IMAGESTREAM_TOKEN secret
    • You can use the Pipeline Token (From pipeline-token-xxxxxxxx)

License

Copyright 2025 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.