From 040b7a44f05fef6fc494f7df9852d2207e60e7e2 Mon Sep 17 00:00:00 2001 From: Vaughn Dice Date: Thu, 1 Jul 2021 12:37:26 -0600 Subject: [PATCH 1/2] docs(README.md): add registry install notes in anticipation of v0.1.0 release Signed-off-by: Vaughn Dice --- README.md | 44 +++++++++++++++++++++++++++++++++++++------- 1 file changed, 37 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index d36f5b1..c64ccd2 100644 --- a/README.md +++ b/README.md @@ -133,20 +133,35 @@ that prevents the gateway from using this token for impersonating other gateways ### 3. Install the GitHub Gateway -For now, you can only obtain the Helm chart for the Brigade GitHub Gateway by -cloning this repository: +The Helm chart for the Brigade GitHub Gateway can be installed from source or +installed from the +[Brigadecore GitHub Container Regigistry](https://github.com/orgs/brigadecore/packages). -```console -$ git clone git@github.com:brigadecore/brigade-github-gateway.git +#### Install from GitHub Container Registry -$ cd brigade-github-gateway/charts/brigade-github-gateway +For now, we're using the [GitHub Container Registry](https://ghcr.io) (which is +an [OCI registry](https://helm.sh/docs/topics/registries/)) to host our Helm +chart. Helm 3 has _experimental_ support for OCI registries. In the event that +the Helm 3 dependency proves troublesome for Brigade users, or in the event that +this experimental feature goes away, or isn't working like we'd hope, we will +revisit this choice before going GA. + +To fetch the Brigade GitHub Gateway chart from the registry: + +```console + export HELM_EXPERIMENTAL_OCI=1 + helm3 chart pull ghcr.io/brigadecore/brigade-github-gateway:v0.1.0 + helm3 chart export ghcr.io/brigadecore/brigade-github-gateway:v0.1.0 -d ~/charts ``` +As this chart requires custom configuration as described above to function +properly, we'll need to create a chart values file with said config. + Use the following command to extract the full set of configuration options into a file you can modify: ```console -$ helm inspect values . > my-values.yaml +$ helm inspect values ~/charts/brigade-github-gateway > my-values.yaml ``` Edit `my-values.yaml`, making the following changes: @@ -169,12 +184,27 @@ Save your changes to `my-values.yaml` and use the following command to install the gateway using the above customizations: ```console -$ helm install brigade-github-gateway . \ +$ helm install brigade-github-gateway ~/charts/brigade-github-gateway \ --create-namespace \ --namespace brigade-github-gateway \ --values my-values.yaml ``` +#### Install from source + +To install the Brigade GitHub Gateway from source, start by cloning this +repository and navigating to the chart directory: + +```console +$ git clone git@github.com:brigadecore/brigade-github-gateway.git + +$ cd brigade-github-gateway/charts/brigade-github-gateway +``` + +Then, follow the steps similar to those shown above to create the chart values +file needed for installation. Just change the chart location, e.g. instead of +`~/charts/brigade-github-gateway`, you can supply `.`. + ### 4. (RECOMMENDED) Create a DNS Entry In the prerequisites section, we suggested that you reserve a domain or From f1332add5e8282c90a7098b3deb8b81efd355ac2 Mon Sep 17 00:00:00 2001 From: Vaughn Dice Date: Thu, 1 Jul 2021 12:43:46 -0600 Subject: [PATCH 2/2] address review feedback Signed-off-by: Vaughn Dice --- README.md | 25 ++----------------------- 1 file changed, 2 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index c64ccd2..a2815f7 100644 --- a/README.md +++ b/README.md @@ -133,12 +133,6 @@ that prevents the gateway from using this token for impersonating other gateways ### 3. Install the GitHub Gateway -The Helm chart for the Brigade GitHub Gateway can be installed from source or -installed from the -[Brigadecore GitHub Container Regigistry](https://github.com/orgs/brigadecore/packages). - -#### Install from GitHub Container Registry - For now, we're using the [GitHub Container Registry](https://ghcr.io) (which is an [OCI registry](https://helm.sh/docs/topics/registries/)) to host our Helm chart. Helm 3 has _experimental_ support for OCI registries. In the event that @@ -150,8 +144,8 @@ To fetch the Brigade GitHub Gateway chart from the registry: ```console export HELM_EXPERIMENTAL_OCI=1 - helm3 chart pull ghcr.io/brigadecore/brigade-github-gateway:v0.1.0 - helm3 chart export ghcr.io/brigadecore/brigade-github-gateway:v0.1.0 -d ~/charts + helm chart pull ghcr.io/brigadecore/brigade-github-gateway:v0.1.0 + helm chart export ghcr.io/brigadecore/brigade-github-gateway:v0.1.0 -d ~/charts ``` As this chart requires custom configuration as described above to function @@ -190,21 +184,6 @@ $ helm install brigade-github-gateway ~/charts/brigade-github-gateway \ --values my-values.yaml ``` -#### Install from source - -To install the Brigade GitHub Gateway from source, start by cloning this -repository and navigating to the chart directory: - -```console -$ git clone git@github.com:brigadecore/brigade-github-gateway.git - -$ cd brigade-github-gateway/charts/brigade-github-gateway -``` - -Then, follow the steps similar to those shown above to create the chart values -file needed for installation. Just change the chart location, e.g. instead of -`~/charts/brigade-github-gateway`, you can supply `.`. - ### 4. (RECOMMENDED) Create a DNS Entry In the prerequisites section, we suggested that you reserve a domain or