From 4352f5b9325a5d56155185d2651068a7e0e11678 Mon Sep 17 00:00:00 2001 From: Niels Abildgaard Date: Thu, 7 Mar 2024 08:41:26 +0100 Subject: [PATCH 1/2] Adjustments to prerequisites for guides clarifying what they require of the developer - Lagoon ssh keys as a prerequisite now also list where to create those keys - When creating a site, a git-url must be provided - it is now clarified that the repo it points to does not need to exist before running the tasks in the runbook. --- docs/runbooks/add-generic-site-to-platform.md | 7 +++++-- docs/runbooks/add-library-site-to-platform.md | 7 +++++-- docs/runbooks/remove-site-from-platform.md | 3 ++- 3 files changed, 12 insertions(+), 5 deletions(-) diff --git a/docs/runbooks/add-generic-site-to-platform.md b/docs/runbooks/add-generic-site-to-platform.md index 7f74cd52..01826447 100644 --- a/docs/runbooks/add-generic-site-to-platform.md +++ b/docs/runbooks/add-generic-site-to-platform.md @@ -15,8 +15,11 @@ which is used to develop the shared DPL install profile. permissions to the platforms azure infrastructure. * A running [dplsh](using-dplsh.md) with `DPLPLAT_ENV` set to the platform environment name. -* A Lagoon account on the Lagoon core with your ssh-key associated -* The git-url for the sites environment repository +* A Lagoon account on the Lagoon core with your ssh-key associated (created through + the Lagoon UI, on the Settings page) +* The git-url for the sites environment repository (you don't need to create this + repository - it will be created by the task below - but the URL must match the + Github repository that will be created) * A personal access-token that is allowed to pull images from the image-registry that hosts our images. * The platform environment name (Consult the [platform environment documentation](https://github.com/danskernesdigitalebibliotek/dpl-platform/wiki/Platform-Environments)) diff --git a/docs/runbooks/add-library-site-to-platform.md b/docs/runbooks/add-library-site-to-platform.md index 45707f4f..e9d5771a 100644 --- a/docs/runbooks/add-library-site-to-platform.md +++ b/docs/runbooks/add-library-site-to-platform.md @@ -76,8 +76,11 @@ Run `task env_repos:provision` to create the repository. Prerequisites: -* A Lagoon account on the Lagoon core with your ssh-key associated -* The git-url for the sites environment repository +* A Lagoon account on the Lagoon core with your ssh-key associated (created through + the Lagoon UI, on the Settings page) +* The git-url for the sites environment repository (you don't need to create this + repository - it will be created by the task below - but the URL must match the + Github repository that will be created) * A personal access-token that is allowed to pull images from the image-registry that hosts our images. * The platform environment name (Consult the [platform environment documentation](https://github.com/danskernesdigitalebibliotek/dpl-platform/wiki/Platform-Environments)) diff --git a/docs/runbooks/remove-site-from-platform.md b/docs/runbooks/remove-site-from-platform.md index f53668f2..ae7f11c4 100644 --- a/docs/runbooks/remove-site-from-platform.md +++ b/docs/runbooks/remove-site-from-platform.md @@ -8,7 +8,8 @@ Prerequisites: * The platform environment name * An user with administrative access to the environment repository -* A lagoon account with your ssh-key associated +* A lagoon account with your ssh-key associated (created through + the Lagoon UI, on the Settings page) * The site key (its key in [sites.yaml](../architecture/platform-environment-architecture.md#sitesyaml)) * An properly authenticated azure CLI (`az`) that has administrative access to the cluster running the lagoon installation From 511814a58a13c3ed464e8c1f7b54edaf8d66b2df Mon Sep 17 00:00:00 2001 From: Niels Abildgaard Date: Mon, 11 Mar 2024 21:19:41 +0100 Subject: [PATCH 2/2] Small typos fixed --- docs/architecture/alertmanager-setup.md | 2 +- .../modules/dpl-platform-env-repos/lagoon_integration.tf | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/architecture/alertmanager-setup.md b/docs/architecture/alertmanager-setup.md index 2c3f9583..b8f5bfde 100644 --- a/docs/architecture/alertmanager-setup.md +++ b/docs/architecture/alertmanager-setup.md @@ -1,6 +1,6 @@ # Alertmanager Setup -The We use the [alertmanager](architecture/adr-003-system-alerts.md) automatically +We use the [alertmanager](architecture/adr-003-system-alerts.md) which automatically ties to the metrics of Prometheus but in order to make it work the configuration and rules need to be setup. diff --git a/infrastructure/terraform/modules/dpl-platform-env-repos/lagoon_integration.tf b/infrastructure/terraform/modules/dpl-platform-env-repos/lagoon_integration.tf index 25cf352f..2f8481d6 100644 --- a/infrastructure/terraform/modules/dpl-platform-env-repos/lagoon_integration.tf +++ b/infrastructure/terraform/modules/dpl-platform-env-repos/lagoon_integration.tf @@ -1,4 +1,4 @@ -# Register a webhook pr repository that will let Lagoon react on pushes and +# Register a webhook per repository that will let Lagoon react on pushes and # pull-requests. resource "github_repository_webhook" "lagoon_deploy" { for_each = local.sites