From 50ab508191f1166e4c93d8f80773ad00a5074f16 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vegard=20B=C3=B8nes?= Date: Tue, 30 Jun 2026 15:24:05 +0200 Subject: [PATCH 1/3] update docs --- README.md | 29 ++++--------------- docs/ci-cd.md | 16 ++++++++++ GETTING_STARTED.md => docs/getting-started.md | 0 3 files changed, 21 insertions(+), 24 deletions(-) create mode 100644 docs/ci-cd.md rename GETTING_STARTED.md => docs/getting-started.md (100%) diff --git a/README.md b/README.md index fc30247..118c690 100644 --- a/README.md +++ b/README.md @@ -6,40 +6,21 @@ Forti is a REST webservice that delivers weather and ocean forecast timeseries d The data sources to the service are irregular grids of data, produced by batch jobs. These batch jobs use a wide range of input datasets, and run a set of post-processing algorithms to both improve the forecast quality and to add additional forecast parameters. -The application is built with Go, although with some small parts in C++. +The application is built with Go, although with some small parts in C++. It is meant to be run as containers — each component has an associated Dockerfile. The code for the batch jobs that produce the datasets are not included in this repository. -## Usage +## Getting started -The application is meant to be run as containers. Each component has an associated Dockerfile. +[Getting started guide](docs/getting-started.md) ## Development ### Test -### Build - -For all components, except fortiup, a docker image is built and pushed on every commit. -They will all get the same tag, corresponding to the GitHub Actions `run_id`, which identifies a single workflow run. - -For example, you may end up with the following images in the registry. - -- fortiregistry.azurecr.io/xmlfrontend:337359 -- fortiregistry.azurecr.io/moxfrontend:337359 -- fortiregistry.azurecr.io/rawdataforecaster:337359 -- fortiregistry.azurecr.io/jsonfrontend:337359 -- fortiregistry.azurecr.io/correctedforecaster:337359 -- fortiregistry.azurecr.io/healthz:337359 - -In this case the docker tag, 337359, corresponds to the GitHub Actions run ID when building the project. -The run ID may be found by looking at the correct build on the [Actions](https://github.com/metno/forti/actions) page. - -For `fortiup`, a binary artifact is built and uploaded (rather than a docker image) when a tag matching `fortiup/*` is pushed. - -## Getting started +### CI/CD -[Getting started guide](GETTING_STARTED.md) +See [docs/ci-cd.md](docs/ci-cd.md) for details on how container images are built and tagged. ## Architecture diff --git a/docs/ci-cd.md b/docs/ci-cd.md new file mode 100644 index 0000000..1362c03 --- /dev/null +++ b/docs/ci-cd.md @@ -0,0 +1,16 @@ +# CI/CD + +## Container images + +For all components except `fortiup`, a Docker image is built and pushed to the registry on every commit. All images from a single workflow run share the same tag, corresponding to the GitHub Actions `run_id`. + +For example: + +- `fortiregistry.azurecr.io/xmlfrontend:337359` +- `fortiregistry.azurecr.io/moxfrontend:337359` +- `fortiregistry.azurecr.io/rawdataforecaster:337359` +- `fortiregistry.azurecr.io/jsonfrontend:337359` +- `fortiregistry.azurecr.io/correctedforecaster:337359` +- `fortiregistry.azurecr.io/healthz:337359` + +The tag (`337359` above) is the GitHub Actions run ID for the build. You can find the run ID for a specific commit on the [Actions](https://github.com/metno/forti/actions) page. diff --git a/GETTING_STARTED.md b/docs/getting-started.md similarity index 100% rename from GETTING_STARTED.md rename to docs/getting-started.md From d2aa529b7d51441f0f57b9d068bc1c8182499b91 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vegard=20B=C3=B8nes?= Date: Tue, 30 Jun 2026 15:25:55 +0200 Subject: [PATCH 2/3] remove reference to obsolete fortiup --- docs/ci-cd.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/ci-cd.md b/docs/ci-cd.md index 1362c03..ce6292a 100644 --- a/docs/ci-cd.md +++ b/docs/ci-cd.md @@ -2,7 +2,7 @@ ## Container images -For all components except `fortiup`, a Docker image is built and pushed to the registry on every commit. All images from a single workflow run share the same tag, corresponding to the GitHub Actions `run_id`. +A Docker image is built and pushed to the registry on every commit. All images from a single workflow run share the same tag, corresponding to the GitHub Actions `run_id`. For example: From d7ed25d048489f6c2c4ed46f78eb9d0870a7727f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vegard=20B=C3=B8nes?= Date: Tue, 30 Jun 2026 15:33:27 +0200 Subject: [PATCH 3/3] remove useless docs --- README.md | 4 ---- docs/ci-cd.md | 16 ---------------- 2 files changed, 20 deletions(-) delete mode 100644 docs/ci-cd.md diff --git a/README.md b/README.md index 118c690..0aa284a 100644 --- a/README.md +++ b/README.md @@ -18,10 +18,6 @@ The code for the batch jobs that produce the datasets are not included in this r ### Test -### CI/CD - -See [docs/ci-cd.md](docs/ci-cd.md) for details on how container images are built and tagged. - ## Architecture The application is made up of several binaries working together. diff --git a/docs/ci-cd.md b/docs/ci-cd.md deleted file mode 100644 index ce6292a..0000000 --- a/docs/ci-cd.md +++ /dev/null @@ -1,16 +0,0 @@ -# CI/CD - -## Container images - -A Docker image is built and pushed to the registry on every commit. All images from a single workflow run share the same tag, corresponding to the GitHub Actions `run_id`. - -For example: - -- `fortiregistry.azurecr.io/xmlfrontend:337359` -- `fortiregistry.azurecr.io/moxfrontend:337359` -- `fortiregistry.azurecr.io/rawdataforecaster:337359` -- `fortiregistry.azurecr.io/jsonfrontend:337359` -- `fortiregistry.azurecr.io/correctedforecaster:337359` -- `fortiregistry.azurecr.io/healthz:337359` - -The tag (`337359` above) is the GitHub Actions run ID for the build. You can find the run ID for a specific commit on the [Actions](https://github.com/metno/forti/actions) page.