From 2e827684a5ae782e57fce89d23f2a1b94b5a77f4 Mon Sep 17 00:00:00 2001 From: Jelle Hoffman Date: Thu, 15 May 2025 15:29:11 +0200 Subject: [PATCH 1/5] Adding readme file Signed-off-by: Jelle Hoffman --- README.md | 20 ++++++++++++++++++-- charts/gxf-platform/values.yaml | 1 - 2 files changed, 18 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 0c6ed91..66b2f39 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,18 @@ -# gxf-gitops -Gitops repo for GXF platform +# GXF gitops +Gitops repo for GXF platform and cucumber tests. This repo can also be used to run the platform and/or cucumber tests +locally. It is using K3D to start up a kubernetes cluster. + +# Requirements to run the GXF platform locally + + +# How to set up the GXF platform or cucumber tests locally +- Run the `setup.sh` script. + - When you add an argument to this setup script it will create a local K3D image-registry and will install the dev chart. + This dev chart will install a kubernetes dashboard and PgWeb instance on the just created kubernetes cluster + - This `setup.sh` script will also create the necessary secrets needed to deploy the GXF containers +- After the `setup.sh` script you can use the `port-forward.sh` script in the dev chart to get access to you kubernetes dashboard +- Now you can install the GXF platform by running the `template-apply.sh` script in the gxf-platform chart. + This will install the complete GXF platform to the just created kubernetes dashboard +- Now you can run the `template-apply.sh` in the gxf-cucumber chart. However, you need to supply a correct values file. + You can supply this values file by adding `--valuesFile ` + - To see extra logs of the cucumber tests you can have a look at `/tmp/k3dvolume`, there should be some logs present. diff --git a/charts/gxf-platform/values.yaml b/charts/gxf-platform/values.yaml index 1f1ebba..6c3313c 100644 --- a/charts/gxf-platform/values.yaml +++ b/charts/gxf-platform/values.yaml @@ -1,4 +1,3 @@ -imageTag: pr-1523 containers: - name: osgp-core memory: 768Mi From b0d6c0703489cd9a21aeffed4316d456cd66eaff Mon Sep 17 00:00:00 2001 From: Jelle Hoffman Date: Thu, 15 May 2025 15:31:38 +0200 Subject: [PATCH 2/5] Adding requirements Signed-off-by: Jelle Hoffman --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 66b2f39..0bb31d3 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,8 @@ Gitops repo for GXF platform and cucumber tests. This repo can also be used to r locally. It is using K3D to start up a kubernetes cluster. # Requirements to run the GXF platform locally - +- Unix file system: Linux, Mac or WSL +- Enough ram: at least 32GB # How to set up the GXF platform or cucumber tests locally - Run the `setup.sh` script. From c1ffc69be17b141699e1660c36301a5f9df5267b Mon Sep 17 00:00:00 2001 From: Jelle Hoffman Date: Thu, 15 May 2025 15:32:40 +0200 Subject: [PATCH 3/5] Bump chart version Signed-off-by: Jelle Hoffman --- charts/gxf-platform/Chart.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/charts/gxf-platform/Chart.yaml b/charts/gxf-platform/Chart.yaml index 0ac9da4..061a9e9 100644 --- a/charts/gxf-platform/Chart.yaml +++ b/charts/gxf-platform/Chart.yaml @@ -1,7 +1,7 @@ apiVersion: v2 description: GXF platform Helm chart name: gxf-platform -version: 0.0.3 +version: 0.0.4 maintainers: - name: developers email: gxf@lists.lfenergy.org From c5c89f774eaa8d656917530c9cc2e9c376d06be0 Mon Sep 17 00:00:00 2001 From: Jelle Hoffman Date: Thu, 15 May 2025 15:44:22 +0200 Subject: [PATCH 4/5] Update README.md Co-authored-by: Sander Verbruggen Signed-off-by: Jelle Hoffman --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0bb31d3..bcf7675 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ locally. It is using K3D to start up a kubernetes cluster. - Enough ram: at least 32GB # How to set up the GXF platform or cucumber tests locally -- Run the `setup.sh` script. +- Run the `setup.sh` script, this will download, install and then use `k3d` to create a local cluster named `test`. - When you add an argument to this setup script it will create a local K3D image-registry and will install the dev chart. This dev chart will install a kubernetes dashboard and PgWeb instance on the just created kubernetes cluster - This `setup.sh` script will also create the necessary secrets needed to deploy the GXF containers From 6e930e7da7371e9f7165e9768a367f245b8e1a65 Mon Sep 17 00:00:00 2001 From: Jelle Hoffman Date: Thu, 15 May 2025 15:45:31 +0200 Subject: [PATCH 5/5] Adding software requirements Signed-off-by: Jelle Hoffman --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index bcf7675..2e81554 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,10 @@ locally. It is using K3D to start up a kubernetes cluster. # Requirements to run the GXF platform locally - Unix file system: Linux, Mac or WSL - Enough ram: at least 32GB +- Installed software: + - Docker + - Helm + - Kubectl # How to set up the GXF platform or cucumber tests locally - Run the `setup.sh` script, this will download, install and then use `k3d` to create a local cluster named `test`.