Skip to content

Commit 50907b2

Browse files
npalmgertjanmaas
andauthored
improve documentation (#32)
* 📚 improve documentation * 📚 improve documentation * #20 #21 - Improve docs, add readme, add hook generate terraform docs * #20 #21 - Improve docs, add readme, add hook generate terraform docs * Add status badges * Add status badges * Add status badges * Add status badges * Add readme for download module * Add readme for download module * Add suggestion for vscdoe plugins * Update README.md Co-authored-by: Gertjan Maas <[email protected]> * Update README.md Co-authored-by: Gertjan Maas <[email protected]> * Update modules/runners/README.md Co-authored-by: Gertjan Maas <[email protected]> * Update modules/runner-binaries-syncer/README.md Co-authored-by: Gertjan Maas <[email protected]> * Update modules/webhook/README.md Co-authored-by: Gertjan Maas <[email protected]> * Update modules/webhook/README.md Co-authored-by: Gertjan Maas <[email protected]> * Update modules/runners/README.md Co-authored-by: Gertjan Maas <[email protected]> * Update README.md Co-authored-by: Gertjan Maas <[email protected]> * Update README.md Co-authored-by: Gertjan Maas <[email protected]> * Update README.md Co-authored-by: Gertjan Maas <[email protected]> * Update README.md Co-authored-by: Gertjan Maas <[email protected]> * Update README.md Co-authored-by: Gertjan Maas <[email protected]> * Update README.md Co-authored-by: Gertjan Maas <[email protected]> * Update README.md Co-authored-by: Gertjan Maas <[email protected]> * Update README.md Co-authored-by: Gertjan Maas <[email protected]> * Update README.md Co-authored-by: Gertjan Maas <[email protected]> * Update README.md Co-authored-by: Gertjan Maas <[email protected]> * Update README.md Co-authored-by: Gertjan Maas <[email protected]> * Update examples/default/README.md Co-authored-by: Gertjan Maas <[email protected]> * Update examples/permissions-boundary/README.md Co-authored-by: Gertjan Maas <[email protected]> * Update modules/runner-binaries-syncer/README.md Co-authored-by: Gertjan Maas <[email protected]> * Update modules/runners/README.md Co-authored-by: Gertjan Maas <[email protected]> * Remove double download from docs * Remove link Co-authored-by: Gertjan Maas <[email protected]>
1 parent 061b339 commit 50907b2

File tree

17 files changed

+584
-65
lines changed

17 files changed

+584
-65
lines changed

.github/workflows/lambda-runner-binaries-syncer.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Lambda Runner Binaries Syncer
1+
name: Lambda Syncer
22
env:
33
lambda_name: runner-binaries-syncer
44
lambda_path: modules/runner-binaries-syncer/lambdas/runner-binaries-syncer

.github/workflows/lambda-webhook.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Lambda Agent Webhook
1+
name: Lambda Webhook
22
on:
33
push:
44
branches:

.github/workflows/terraform.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: "Terraform root module checks"
1+
name: "Terraform checks"
22
on:
33
push:
44
branches:

.pre-commit-config.yaml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
repos:
2+
- repo: git://github.com/antonbabenko/pre-commit-terraform
3+
rev: v1.30.0
4+
hooks:
5+
- id: terraform_fmt
6+
- id: terraform_tflint
7+
- id: terraform_docs
8+
- repo: git://github.com/pre-commit/pre-commit-hooks
9+
rev: v2.5.0
10+
hooks:
11+
- id: check-merge-conflict

.vscode/extensions.json

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
// See http://go.microsoft.com/fwlink/?LinkId=827846
3+
// for the documentation about the extensions.json format
4+
"recommendations": [
5+
// Extension identifier format: ${publisher}.${name}. Example: vscode.csharp
6+
"editorconfig.editorconfig",
7+
"yzhang.markdown-all-in-one",
8+
"mauve.terraform"
9+
]
10+
}

README.md

Lines changed: 93 additions & 39 deletions
Large diffs are not rendered by default.

docs/architecture.drawio

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
<mxfile host="Electron" modified="2020-05-12T08:11:10.930Z" agent="5.0 (Macintosh; Intel Mac OS X 10_15_3) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/13.0.3 Chrome/80.0.3987.163 Electron/8.2.1 Safari/537.36" etag="C6iqQcv9BustWJvTIf3e" version="13.0.3" type="device"><diagram id="L_F16tsUUGYpfsHa_sY0" name="Page-1">7Vttc5s4EP41nrn7kAwg3vzRL0mu1/aaNO1lel88spExDUaukGMnv/4kEBgk2SExzkuTtjNFi5Bg99lndyW5Awbz9RmBi9lnHKC4YxnBugOGHcsyu2aX/cclt7mk6wtBSKJAdNoILqM7JISGkC6jAKW1jhTjmEaLunCCkwRNaE0GCcGrercpjuuzLmCIFMHlBMaq9CoK6CyX+pa3kf+FonBWzGy64vvmsOgsviSdwQCvKiJw0gEDgjHNr+brAYq58gq95M+dbrlbvhhBCW3ygBHj7/Havfjv293kq/XD/wEvfh7xB/gwNzBeii/uXV0ywSDGy0C8OL0ttLHAUUIzjTp99o9NODA6Drsz4K1jy5EEcturC0y1xceoC+S2VxeY8vCmNL8pv2BFoLRqwxvS/EblBdk/0MdLGkcJGpTYM5gwJDCImE0GOMaEyRKcMO31Z3Qes5bJLleziKLLBZxwra6Y3zDZFCdUoN+0irZQPB+VoWfBr+frkDvaMVyl9nFI8HKRTfmB4V97d8QuR5PMmGwQSvA1Kl6sYwH295SjpT+N4lh64RtEaMQcoRdHIR+bYj4VFK0YTSkfkX1FlISfstYQGOLNdVMEMJ2hQHyOCl6BZz4rWldEAsxnCM8RJbesS3HXFY4lmMUWzdXGTV3byWWziov6BbVAQQ1hOfTGe9iFcCC9M33p+0M4I9NRAs3Rx/Pedfrh36Ou4ktDvEpiDJkjGeMogWKOqkehgNGNaGJCZzjECYxPNtI+s2ISlIrb9PmEuUEyQP1ElN4K9MAlxXW4bdV1ipdkgnaxAxCMC0mI6K6O4tP51+y0HUExpNFNnVx1hhCPnnPC2djctZyazd2uWx8if1Px1MacPULgbaWb4LHt83S79XmAxK0P688u8jfYYKvUSSO47bROBW9fl4yJSKqgTOPeChc4PXfgu1VHNbeygMxOks+XQ7Xg5o5Zd3Og8XNLqLvm55YnYeMxfq5VvKvo/fzL5TcO/xskcPfELh7DMYrPcRrRKIsDE/YeiFTM90nqUCdzpXth7TGmFM/34pAiabuPQuy2GWQvE5uKiXvnH5jgDFK0giqNazOBbZFQzhDYva7tDE+tyr1hRNhAubESjggpSGdeBoy+o3PlafZHjrnbsFAaeXfEL0FSwd19WQtMF7k6ptEaBdvSGIJyFOVJTJ81dekMXESjUKi/FWYBBqgxi2mpzOL5KrEUstZBp+biV2g8w/j6EZRSMRJKgh6vhLipYzy55qJ4nLULi2cggoQW/USMYE+eRnExjhoxbKfv2gp/PZ4rmqYbZkOuqBjSNIRx98xALK8ejsp6rxgi/0glA1EHcuWB/GOnUTLTVv6gpg9nEZ0tx0zWWyw6lhvzDH9M2FVIS7tWUFhjFy0DVlBY0AjJHUkJWaKg2EZS8ygIYl1ZUt6QqWWFGNpDnB6H4qv2JgxX5gug8oWm4PCc7SDbq96wfDUBRL+WKOUwI8vkJWUk95i3HmoKjBwgHbEbUozTdjryqDrEAfW6whJsc9C6wm4chvbNek49/8SwH5b1DA1nYHpvJuuJ4XwcwJZKKUMKOU+Y8OgJTF0xeQ6uejybOE0TFuNF0IltSbW0sXtZQ+5vG0+wrOFso5+LJWISy7i84AvUan7yx5Ap7xYFn1GawhD92T5dAdv2H1ik9QcmcNw3Q1fpr/QwxVm5xPNcXGXqkq0wSrm6s2wr4RfPn2i9pKUfQ6XHf+7cTy71V+7o+h/69/XVx4m9aFzP7Vm7mbZEZ/IQLa0ey6WdbYKdNHtP/zrNbp4uXgdPpyk6SIVYGLCC+Xxr1DLKlWZjuXjPC193XgikvBD41pNxrX4hTOXab4jMowRSpG5uvHGSbbr1Jox9ZBwbwBcK3pNQHcOrAcfxvEaEeiAO08dtzS4ZmuMb9B61dwOqtai9AZ7jmdZ+wHuCmKfWpGrM4/v671Hv94p6DvCfOeqpyOtl5k9r2OvzgySRJg7uiz/X6AHgPQx/lueZ5hsqb0E72HOljN/tPnN1W1TXr2XhDTTeKmz9ZNJ+ejZ/Uz2D1jdM9uJSoGZ97fKl2CFvttonOr84JswWMhA54ZuEqRhEy47ZNuKIRnM0GsM0e/YAEfgpWVCPGu+VeWfT/Yf2z2fut5aqHq/6vsjPyWrUn3lIR3uYYGsdVJ4KYIE8uoPj0gfqJ9iHWvXvxIYC7/K3B2KWTvV4/5ZCCLjArUF/z7KodKjaoEdSNd5K0bSrFNQdJflCQpgwE2T0Jpv3jZ8gAcXRkCc4QbKTQGqOGECK+vrT6u8l7qsqcW3nhZUZ1iOzskMbWGMvcJwuMB1FSUphMtHkeqeO7wBbg3OR7bVgP8f1a/azNWfffc3R90LWuv3Uo0EDgt4X5RvtfO78DUfTRVSWOnSlM2Fl7b5v8uBJYJOHaHqy1TPqL+jbEhxb2ma1Pf127tbTLLv7b9tmXUtqltV++C0MNUi/s+auJEsqK21XzbKelDXV3wu9229nkizZT5O1tGQ/1tz8ADt3183P2MHJ/w==</diagram></mxfile>
1+
<mxfile host="Electron" modified="2020-05-20T07:58:25.362Z" agent="5.0 (Macintosh; Intel Mac OS X 10_15_3) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/13.0.3 Chrome/80.0.3987.163 Electron/8.2.1 Safari/537.36" etag="yWFBKNvL56pLtAHCv6Ig" version="13.0.3" type="device"><diagram id="L_F16tsUUGYpfsHa_sY0" name="Page-1">7Vxbc5s4FP41ntl9SAYQNz/6kmS7TbdJ026m++KRjYxpMHJBjp38+hUgMLrYITa2k9ZpZooOQhI63/nOOZJIC/Smy6sYziafsIfClqF5yxbotwxDb+tt+l8qecolrmnnAj8OPFZpJbgLnhETakw6DzyUcBUJxiEJZrxwhKMIjQgng3GMF3y1MQ75XmfQR5LgbgRDWXofeGTC3sJwVvK/UOBPip51m73wFBaV2ZskE+jhRUUELlqgF2NM8qvpsofCdPKKecmfu1xztxxYjCJS5wEtxN/CpX3739fn0Rfju/sd3v44Sx9Im3mE4Zy9cef+jgp6IZ57bODkqZiNGQ4iks2o1aW/tMOe1rLonV5aOjcsQSCWHV6gy6W0DV4glh1eoIvN60L/ujjAikAqcc1rQv9aZYD0F3TxnIRBhHol9jQq9GPoBVQnPRzimMoiHNHZ607INKQlnV4uJgFBdzM4Smd1Qe2GysY4Igz9ulGU2cSnrVL0zNLr6dJPDe0cLhLz3I/xfJZ1+YHiX3l3QC8Ho0yZtBES4wdUDKxlAPrvMkVLdxyEoTDgRxSTgBpCJwz8tG2C064gK4VoTNIW6VsEkX+dlfpAYyNXdeHBZII89joyeBme017RsiJiYL5CeIpI/ESrFHdtZliMWUxWXKzM1DatXDapmKhbUAtk1OCXTa+sh14wA1Ib0+eu24eTeDyIoD74eNN5SD78e9aWbKmPF1GIITUkbRhEkPVRtSjkUbphRRyTCfZxBMOLlbRLtRh55cSt6lzjVCEZoH4gQp4YeuCcYB5uIRyisAtHD37WlKDmtZpI8DweoU3cARgfw9hHZFNFNjHpu27UbIxCSIJHnnpVamKP3qR0tEKEbVgcIuy2zTeRj5Q9tVJ2J47hU6UaY7n1/bTbfD9AYN7X1acX+QhWyCvnpBYYN2qngsYvc8pTcSJhUGH8ElNYHbvn2lUz1tdyhMhdAiOUTW0JzPoUYek8RQAFRxhMGRxHGI6AnG04QqkWW9LKzee7r6lxPCKGymPQww1OAhJkPmREx4HiinKvhQq8I5CqF1gYYkLwdI/8U4SDL9GP2TT77AQAXQJA5+YDFVxBghZQdhDKGGOdjxVjD3qvbVr9S6Nyrx/EtKFclVGKF8H9ZxYKtK6looFx9iN683VIKSGwOZYoIVRB5UvxEExm+XSMgyXy1gVIMcpRlIdHXVpUBUpwFgx8Nv0HYCWgAY6VdENmJceVSamQNQ5JOQe4R8MJxg9b0FFFhSjyOmkGlgIhxKOHVBQOs3KBhwxiMCZFPTbJ9MnLICzakX2RaXVtU+K+tQS0PcXUjXD0mhRT0bCuMa3vGPQYDu/jygS0aCJ/SSnokRuyxYbcc6tW/NRUyCJHLFcBmcyHVNaZzVqGHaYpxzCmVz4p9VqBJ0dKSuKswLNgnzi3MMkPsgxnHbdNA88LVXlSeUNkpAWiZuDj5Nxnb7Uzk9gikQCZSBQZkGOtB9lOCZDhyjEn+jlHSQqzeB69pTDnBfXyHqrAyMFjHLMmAVlNxzhbJUYW4BMdg3HRXhMds7b32jWUunTcC818XSjV16ye7vw2oVQIp0MPHiS30wR3dcAoSk1+8vLPMXhue66x6gY72psgG9MQkntt8yqMWN/UDrAKY60jp9s5ohJDu7tNV9vl2OaPPp28J+R9QkkCffRn82QGTNN9ZV7Y7enAsn8bMkt+JsfIB8sVqWMxma4K4/wgSZWRxXFRenH8EO79rFRpMrX+82xf28Rd2IOHf8jfD/cfR+asdh65Y86omwIVik00tFAuppSmDjZS9Av1eYpePV0MB4/HCdpLZloosGIR+R6xoZWL6tp8doo4f+WIEwgRJ3CNg/G0et1O5umvKJ4GESRI3uU5EfQG+667Q8mgcKada8Bl078jGVuaw8HKcpxaZLwn/lNHBIrNRDTFj+gUD+wCt8bigRUsLUc3doPlAbypnCnL3jQ9OnHyp0f0p3vwmBZwj+wxZeR1MvUnHPa66VmdQOFDd8WfrXUAcF6HP8NxdP03SrrBIWI5W8g07PaRc+4i538vi4Wg9tZo44e/dptn/RedZ9D4FtBOTAvkiLFZNmVcUG+FklV+czyZLaCg+CLdFE1YI0ruzLZNBySYosEQJtmze/DPh2RBNWqcd2addfdMmj8Cu9sKr3wK7dssP6ismP7MQlrKwxNrc6jyFAR188EzHJY2wH9C0N/C2W9EjgT+8tMQNoZW9euLNUkUsIHNGcaOKVVpblyjZ0Ke30jCtSmNVB2s+Rz7MKIKyshPVP77Ok9ziLCR36kBxUmaAxy42cg/nB17kKCu+muDU/78C61Hm9Yby2GMLUO+fatfoU1wnswwGQRRQmA0UgSSl5ZrAVNhBQ2eYLFdTn+m4usEV/FxQiFrXH/ySapejE57CQ1s9m78Qqfu6i6NS9rCAbty2WDXyMQRoCg2UfcQsaPxA3RNAawN7SybjnoHe+3hn8311+0sL4VpFqd9/zsvsoM/ceqmAE3IaE1bjtAOyqny914n/W0MsAX9KWKahvRHi6uP73NzXf0JA3DxPw==</diagram></mxfile>

docs/architecture.svg

Lines changed: 3 additions & 0 deletions
Loading

examples/default/README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Action runners deployment default example
2+
3+
This modules shows how to create GitHub action runners. Lambda release will be downloaded from GitHub.
4+
5+
## Usages
6+
7+
Steps for the full setup, such as creating a GitHub app can be found in the root module's [README](../../README.md). First download the Lambda releases from GitHub. Alternatively you can build the lamdas locally with Node or Docker, there is a simple build script in `<root>/.ci/build.sh`. In the `main.tf` you can simple remove the location of the lambda zip files, the default location will work in this case.
8+
9+
```bash
10+
cd lambdas-download
11+
terraform init
12+
terraform apply
13+
cd ..
14+
```
15+
16+
Before running Terraform, ensure the GitHub app is configured.
17+
18+
```bash
19+
terraform init
20+
terraform apply
21+
```

examples/default/lambdas-download/main.tf

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@ module "lambdas" {
33
lambdas = [
44
{
55
name = "webhook"
6-
tag = "v0.0.0-beta"
6+
tag = "v0.0.1"
77
},
88
{
99
name = "runners"
10-
tag = "v0.0.0-beta"
10+
tag = "v0.0.1"
1111
},
1212
{
1313
name = "runner-binaries-syncer"
14-
tag = "v0.0.0-beta"
14+
tag = "v0.0.1"
1515
}
1616
]
1717
}

0 commit comments

Comments
 (0)