👷 Implementation of Repository Management as Code

jasonBirchall commented 8 months ago

User Need

As a Developer, I want all of our repositories to be defined and managed through code using a language such as HCL, so that we can maintain their existence centrally, audit changes, and ensure consistency and security across our repositories.

Value

Defining repositories as code will enable us to manage repository settings, permissions, and configurations systematically. It will facilitate better auditing, versioning, and control, improving security and compliance.

Functional Requirements:

[ ] Define all repositories through code using a language like HCL to maintain their existence centrally.
[ ] Import all existing operations-engineering repositories into the Terraform state for management.
[ ] Utilise the existing Terraform setup in the operations-engineering mono repository for all repository declarations.
[ ] Ensure the repository declaration includes the creation of the repository, rules, permissions, and GitHub Actions secrets.
[ ] Implement a CI/CD pipeline that strictly handles all Infrastructure as Code (IAC) operations, disallowing local execution by users.
[ ] Create a CI/CD pipeline to ensure the congruence between the state defined in git and the actual state.

Non-Functional Requirements:

[ ] The implementation should be thoroughly documented, including how to add new repositories or modify existing ones.
[ ] Ensure the solution is maintainable and scalable to accommodate additional repositories or changes in existing ones.
[ ] Security best practices must be followed throughout the process to protect sensitive data and infrastructure.

Acceptance Criteria:

[ ] Successful import and management of all existing operations-engineering repositories within the Terraform state.
[ ] Documentation is provided detailing the process of adding, modifying, and managing repositories through code.
[ ] It's demonstrated that all IAC operations can only be performed through the CI/CD pipeline.
[ ] The CI/CD pipeline effectively reflects changes in git to the actual repository state and vice versa.

Notes:

Please consider any dependencies or prerequisites required for integrating with the existing Terraform setup.
Include a plan for how existing repositories will be migrated into this new system without disrupting current workflows.
Ensure a training or informational session is planned to acquaint the team with the new process and documentation.