NotifyBC

A versatile notification API server. See full documentation.

Docker Desktop Kubernetes deployment

To build and run in Kubernetes via Docker Desktop: Note: Kubernetes must be enabled in Docker Desktop.

kubectl config use-context docker-desktop
helm install dev helm -f helm/values.yaml -f helm/values.local.yaml

Accessing Logs with the Sidecar Container

This guide will help you access the log files from the notifybc application using a sidecar container. The sidecar is intended to be used only when you need to inspect logs and is not automatically deployed with the application.

1. Deploy the Sidecar

Run the following commands from the helm/ directory, replacing environment=test with the appropriate environment name (e.g., environment=dev, environment=prod).

helm upgrade --install notifybc-sidecar ./sidecar \
--set environment=test

2. Access the sidecar terminal via the OpenShift GUI.

Select the notifybc-log-sidecar pod and open the terminal tab.

3. Navigate to the logs directory

   cd /var/log/app/notifybc/app/
   ls -la

4. Search for the timestamps, events, or labels

less 20250102.app.access.log
grep "POST" 20250103.app.access.log

5. Clean up when done

helm uninstall notifybc-sidecar

License

Copyright 2016-present 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.