about summary refs log tree commit diff
path: root/ops/github/README.org
diff options
context:
space:
mode:
authorFranck Cuny <franck@fcuny.net>2022-09-30 17:56:56 -0700
committerFranck Cuny <franck@fcuny.net>2022-09-30 17:56:56 -0700
commit31f7f2e1c90d131ba8138f72e13ddca24598ebfe (patch)
treeeb7f5683ff24a3ecfbdb7391b55a8e93f1262ac7 /ops/github/README.org
parentfix(home/element): I want the wayland version (diff)
downloadworld-31f7f2e1c90d131ba8138f72e13ddca24598ebfe.tar.gz
ops(github): terraform configuration to manage GitHub
Import current GitHub repositories into terraform. This should be the
main way (going forward) to interact with GitHub to create / manage the
repositories and ensuring I'm consistent in the ways I want to use it.
Diffstat (limited to 'ops/github/README.org')
-rw-r--r--ops/github/README.org15
1 files changed, 15 insertions, 0 deletions
diff --git a/ops/github/README.org b/ops/github/README.org
new file mode 100644
index 0000000..86c664a
--- /dev/null
+++ b/ops/github/README.org
@@ -0,0 +1,15 @@
+#+TITLE: Managing GitHub with terraform
+
+This terraform configuration is to manage my GitHub configuration (repositories, projects, branches, etc).
+
+There's nothing special regarding how to use this repository.
+
+#+begin_src sh
+GITHUB_TOKEN=(pass api/github/terraform) terraform plan
+GITHUB_TOKEN=(pass api/github/terraform) terraform apply
+#+end_src
+
+* Credentials
+A token is needed to interact with the API. It's available in =pass= (under =api/github/terraform=). The token needs admin access for repositories and being able to read the user.
+* State
+The state is stored in a [[https://console.cloud.google.com/storage/browser/world-tf-state/github?project=fcuny-homelab&pageState=(%22StorageObjectListTable%22:(%22f%22:%22%255B%255D%22))&prefix=&forceOnObjectsSortingFiltering=false][GCS bucket]].