dpc-sdp / bay Goto Github PK

Bay is the hosting and infrastructure layer for Single Digital Presence, delivered using amazee.io Lagoon.

• About
  • amazee.io Lagoon
• Use
• Contribute
• Support
• License
• Attribution

Bay is a fully managed platform and hosting environment that provides an open Platform as a Service model managed by SDP. It:

• is an open-source hosting platform based on Lagoon.
• allows agencies to build, test and deliver websites via the cloud.
• is a Kubernetes-based (OpenShift) Docker container hosting platform with auto-scaling, auto-recovery and high-availability at core.
• is based on open-source project Lagoon.

Lagoon solves what developers are dreaming about: A system that allows developers to locally develop their code and their services with Docker and run the exact same system in production. The same Docker images, the same service configurations and the same code.

Learn more from https://docs.lagoon.sh/

Using the nginx image, you can lock down access to your application with using a pre-shared key added at your CDN.

Set these environment variables in your nginx deployment:

• BAY_INGRESS_HEADER defines the header which has the pre-shared key.
• BAY_INGRESS_PSK is the token / PSK value.
• BAY_INGRESS_ENABLED is a toggle for this feature, must be set to "true".

In your CDN configuration, set the header defined in BAY_INGRESS_HEADER with the token defined in BAY_INGRESS_PSK.

• Cloudfront

Once deployed, if the header is missing in the request nginx will return a 405 Not Allowed HTTP response.

Bay images are available in both amd64 and arm64 architectures.

GitHub Actions is the platform used for CI/CD processes.

The process of building images is controlled in the GitHub Actions workflow (build-deploy-bay-images)[./.github/workflows/build-deploy.yml]

Images are built using Docker's buildx image builder in combination with the bake command and the corresponding bake file (gh-actions-bake.hcl)[./gh-actions-bake.hcl]

A matrix strategy is employed to concurrently build the images.

Note The matrix relies on the (repository variable)[https://docs.github.com/en/actions/learn-github-actions/variables#creating-configuration-variables-for-a-repository] IMAGES

These variables are set as either GitHub Actions secrets or variables on the repository. IMAGES A JSON array object consisting of the names of the images to build. REGISTRY_TOKEN Required for container registry access. REGISTRY_USER Required for container registry access.

The workflow makes use of the (docker/metadata-action)[https://github.com/docker/metadata-action]. This Action takes the IMAGES variable as an input and creates the labels for the images.

This Action outputs a bake file inherited by the projects (bake file)[./gh-actions-bake.hcl] and provides the labels and tags used by the build process.

Published images are scanned using Trivy and any CVEs identified are reported in the repositories (Security Advisories)[https://github.com/dpc-sdp/bay/security/advisories].

Open an issue on GitHub or submit a pull request with suggested changes.

GitHub Actions is configured via the build-deploy workflow to build images for pull requests when they are opened and receive updates. These images are tagged with the PR number i.e. pr-86.

Digital Engagement, Department of Premier and Cabinet, Victoria, Australia is a maintainer of this package.

This project is licensed under GPL2

Single Digital Presence offers government agencies an open and flexible toolkit to build websites quickly and cost-effectively.

The Department of Premier and Cabinet partnered with Salsa Digital to deliver Single Digital Presence. As long-term supporters of open government approaches, they were integral to the establishment of SDP as an open source platform.