CONTRIBUTING.md

Contributing to Big Bang

Thanks for taking the time to contribute to BigBang!

Table of Contents:

• Contributing to Big Bang
  • Developers Guide
  • Local Git Setup
    • Pre-commit hooks
      • Local Setup
        • Prereqs
        • Steps
      • Combining Multiple Commits
  • Iron Bank Images
  • Local Kubernetes cluster
  • Deploying Big Bang (Quick Start)
  • Testing Big Bang Development Changes
  • DNS
  • Secrets & Certificates
  • Merge requests process
    • Pipeline Stages
      • Linting
      • Smoke Testing
      • Infrastructure Testing
        • Network Creation
        • Cluster(s) Creation
        • Big Bang Installation
        • Big Bang Tests
      • Teardown

Developers Guide

Big Bang is designed in such a way as to be as easily deployed locally as it is in production. In fact, most contributions begin locally.

Iron Bank Images

Per the charter, all Big Bang packages will leverage container images from IronBank. In order to pull these images, ImagePullSecrets must be provided to BigBang. To obtain access to these images, follow the guides below. These steps should NOT be used for production since the API keys for a user are only valid when the user is logged into Registry1

1. Register for a free Ironbank account Here
2. Log into the Iron Bank Registry, in the top right click your Username and then User Profile to get access to your CLI secret/API keys.
3. When installing BigBang, set the Helm Values registryCredentials.username and registryCredentials.password to match your Registry1 username and API token

Local Kubernetes cluster