Skip to content

Latest commit

 

History

History
93 lines (54 loc) · 4.51 KB

README.md

File metadata and controls

93 lines (54 loc) · 4.51 KB

OCP-on-NERC Github configuration

This repository contains OpenTofu plan to manage the OCP-on-NERC GitHub organization.

How does it work?

When a commit is pushed to the main branch (e.g., when a pull request merges), that triggers the .github/workflows/apply.yaml workflow. This workflow acquires necessary credentials from GithHub secrets and from the "Org Config Management" GitHub app, and then uses OpenTofu to apply the requested configuration.

How do I...

Add a new organization member?

  1. Open members.csv
  2. Add a new row of the form <username>,<role>, where <role> in almost all cases should be member.

Add a new team?

  1. Open teams.csv
  2. Add a new row of the form <team_name>,<description>,<privacy>, where <privacy> can be either closed (visible to all members of the organization) or secret (visible to organization owners and members of this team)

Add an organization member to a team?

  1. Open team-members/<team>.csv
  2. Add a new line of the form <username>,<role>, where <role> should be member.

Add a new repository?

  1. Open repositories.tf

  2. Add a new block of the form:

    module "repo_<repository_name_slug>" {
  source      = "./modules/common_repository"
  name        = "<repository_name>"
  description = "<repository_description"
}

Add a new label to all managed repositories?

  1. Open modules/common_repository/labels.csv

  2. Add a new line of the form <name>,<color>,<description>

Where <repository_name_slug> is <repository_name> transformed to be a valid identifier in most common languages: a single word consisting of only alphanumerics and underscores. So e.g. github-config would become github_config, and .gitjub would become something like dotgithub (_github would also work).

The common_repository module

This module will create:

  • A repository with issues enabled and wikis and projects disabled
  • Branch protection rules for the main branch requiring at least 2 approvals for pull requests and restricting force pushes to members of the nerc-org-admins team
  • A standard set of labels

See the README file for the common_repository module for more information about customizing repository configuration (including how to make a repository private and how to add collaborators).

Suggested local pre-commit checks

You should ensure that you run tofu fmt before submitting a pull request. The easiest way of doing this is by installing the pre-commit tool on your local system and then running pre-commit install. This will configure .git/hooks/pre-commit to run the pre-commit tool whenever you create a new commit. If there are formatting changes, this will abort the commit and apply the necessary changes to your files. You can then add the modified files and update the commit.

Prerequisites for applying the configuration

In general, you won't need to do this: the configuration is applied when a pull request merges to the main branch. These instructions will be useful if is necessary to apply changes manually (this can happen, for example, if someone makes changes to the organization through the GitHub web UI rather than through this repository).

  1. Ensure that you have either Terraform or OpenTofu installed. There are packages for both available on Fedora:

    dnf install opentofu

  2. Acquire S3 credentials.

    OpenTofu maintains state information about the target infrastructure; you need this state in order to plan and apply the configuration. We store this information in an S3 bucket provided by the NERC. You need appropriate AWS credentials in order for OpenTofu to access the cached state. These should be provided in the AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables.

  3. Acquire GitHub credentials.

    In order to apply the configuration, OpenTofu needs administrative access to our organization. You will need a token with at least admin:org and repo privileges for the innabox organization. This should be provided in the GITHUB_TOKEN environment variable.

Additional documentation