ZFGBB-RFC1: Implement GitOps Workflow

[gm112]

Request for Comments (RFC)

Justification for the Use of Kubernetes in ZFGBB Project

Abstract

This RFC explains why Kubernetes is the best choice for the ZFGBB project, focusing on secure, turn-key consistent environments for both local development and production.

---

1. Introduction

We need a secure, consistent environment for ZFGBB development and production. Kubernetes offers:

• Consistency between local and production environments.
• Security for sensitive information, like secrets.
• Scalability and automation for handling resources.

2. Local Development Environment

In the local environment, Kubernetes will:

• Run Postgres and a ZFGBB instance in a local cluster, replicating production.
• Ensure the local setup mirrors production to reduce configuration mismatches.

3. Production Environment on Linode

In production, Kubernetes will run on a Linode server:

• GitHub Runner: Handles CI/CD on Linode, keeping secrets out of Git.
• Secrets Management: Secrets are pulled directly from the Linode machine running the GitHub Runner, never stored in Git.

4. GitOps for Consistency

• Single Source of Truth: Git holds both code and Kubernetes configuration (YAML files), ensuring consistency across environments.
• Declarative Configuration: Kubernetes makes sure the system matches the state defined in Git, avoiding manual errors.

5. Security

• No Secrets in Git: Secrets are managed on the machine running the GitHub Runner (Linode), keeping them out of version control.
• Access Control: Git and Kubernetes manage who can change code and configurations, providing an audit trail.

6. Scalability and Reliability

• Local: Kubernetes ensures local services like Postgres and ZFGBB are running correctly and can scale.
• Production: Kubernetes automatically handles scaling and recovery, ensuring uptime.

7. Implementation Plan

1. Set up local Kubernetes cluster for development (Postgres + ZFGBB).
2. Deploy Kubernetes on Linode for production, with GitHub Runner for CI/CD.
3. Secure secrets on the Linode machine, not in Git.
4. Store Kubernetes configuration in Git to keep environments consistent.
5. Automate deployments with CI/CD using the GitHub Runner.

8. Conclusion

Kubernetes provides a secure, scalable, and consistent environment for ZFGBB. With GitOps, we ensure code and configurations are synchronized, and sensitive information is safely handled.