From eb75919c011b9af122601454be59e2352518f872 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marcel=20Wallschl=C3=A4ger?= Date: Mon, 28 Oct 2024 13:09:51 +0100 Subject: [PATCH] releasee 1.2.3-alpha (#219) --- README.md | 2 +- charts/geonode/Chart.yaml | 4 +- charts/geonode/README.md | 12 +-- charts/geonode/values.yaml | 8 +- docs/README.md | 101 ++++++++++++++++++++++++++ docs/list-of-releases-and-versions.md | 3 +- 6 files changed, 116 insertions(+), 14 deletions(-) create mode 100644 docs/README.md diff --git a/README.md b/README.md index 2475817..bb40ed4 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -![Version: 1.2.2](https://img.shields.io/badge/Version-1.2.2-informational?style=flat-square) +![Version: 1.2.3-alpha](https://img.shields.io/badge/Version-1.2.3-alpha-informational?style=flat-square) # Helm Chart for Geonode diff --git a/charts/geonode/Chart.yaml b/charts/geonode/Chart.yaml index 80d3efa..02518a3 100644 --- a/charts/geonode/Chart.yaml +++ b/charts/geonode/Chart.yaml @@ -1,7 +1,7 @@ apiVersion: v2 name: geonode-k8s -version: 1.2.2 -description: "Helm Chart for Geonode. Supported versions: Geonode: 4.3.0, Geoserver: 2.24.3-v1, pyCSW: 2.6.1" +version: 1.2.3-alpha +description: "Helm Chart for Geonode. Supported versions: Geonode: 4.3.1, Geoserver: 2.24.4-v1, pyCSW: 2.6.1" keywords: - geonode - geospatial diff --git a/charts/geonode/README.md b/charts/geonode/README.md index 5a056c2..3b98df4 100644 --- a/charts/geonode/README.md +++ b/charts/geonode/README.md @@ -1,8 +1,8 @@ # geonode-k8s -![Version: 1.2.2](https://img.shields.io/badge/Version-1.2.2-informational?style=flat-square) +![Version: 1.2.3-alpha](https://img.shields.io/badge/Version-1.2.3--alpha-informational?style=flat-square) -Helm Chart for Geonode. Supported versions: Geonode: 4.3.0, Geoserver: 2.24.3-v1, pyCSW: 2.6.1 +Helm Chart for Geonode. Supported versions: Geonode: 4.3.1, Geoserver: 2.24.4-v1, pyCSW: 2.6.1 **Homepage:** @@ -69,7 +69,7 @@ Helm Chart for Geonode. Supported versions: Geonode: 4.3.0, Geoserver: 2.24.3-v1 | geonode.haystack.engine_url | string | `"http://elasticsearch:9200/"` | hystack url | | geonode.haystack.search_results_per_page | string | `"200"` | hystack results per page | | geonode.image.name | string | `"geonode/geonode"` | used geonode image | -| geonode.image.tag | string | `"4.3.0"` | tag of used geonode image | +| geonode.image.tag | string | `"4.3.1"` | tag of used geonode image | | geonode.imagePullPolicy | string | `"IfNotPresent"` | image pull policy | | geonode.imagePullSecret | string | `""` | pull secret to use for geonode image | | geonode.ingress.annotations | object | `{}` | adds ingress annotations for nginx ingress class | @@ -144,14 +144,14 @@ Helm Chart for Geonode. Supported versions: Geonode: 4.3.0, Geoserver: 2.24.3-v1 | geonode.uwsgi.processes | int | `128` | Maximum number of workers allowed | | geonode.uwsgi.reload_on_rss | int | `2048` | Restart workers after this much resident memory | | geonode.uwsgi.worker_reload_mercy | int | `60` | How long to wait before forcefully killing workers | -| geonode.version | string | `"4.3.0"` | geonode version, used for some distinguassion between version of GeoNode | +| geonode.version | string | `"4.3.1"` | geonode version, used for some distinguassion between version of GeoNode | | geonodeFixtures | map of fixture files | `{"somefixture.json":"[\n {\n \"pk\": 0,\n \"model\": \"myapp.sample\"\n \"description\": \"nice little content\"\n }\n]\n"}` | Fixture files which shall be made available under /usr/src/geonode/geonode/fixtures (refer to https://docs.djangoproject.com/en/4.2/howto/initial-data/) | | geoserver.container_name | string | `"geoserver"` | geoserver container name | | geoserver.extraConfigMap | string | `""` | additional elements to include in the config map provided to GeoServer | | geoserver.extraPodEnv | string | `""` | Define this for extra GeoServer environment variables Format: extraPodEnv: | - name: KEY_1 value: "VALUE_1" - name: KEY_2 value: "VALUE_2" | | geoserver.force_reinit | bool | `true` | set force reinit true so that changing passwords etc. in Values.yaml will take effect after restarting the pod this on the other hand will increase pod initializing time, only change if you know what you are doing | | geoserver.image.name | string | `"geonode/geoserver"` | geoserver image docker image (default in zalf namespace because geonode one was not up to date) | -| geoserver.image.tag | string | `"2.24.3-v1"` | geoserver docker image tag | +| geoserver.image.tag | string | `"2.24.4-v1"` | geoserver docker image tag | | geoserver.imagePullPolicy | string | `"IfNotPresent"` | geoserver image pull policy | | geoserver.imagePullSecret | string | `""` | pull secret to use for geoserver image | | geoserver.port | int | `8080` | geoserver port | @@ -166,7 +166,7 @@ Helm Chart for Geonode. Supported versions: Geonode: 4.3.0, Geoserver: 2.24.3-v1 | geoserver.secret.extraSecrets | string | `""` | additional elements to include in the secret provided to GeoServer, if not using an existing secret | | geoserver_data.container_name | string | `"geoserver-data-dir"` | | | geoserver_data.image.name | string | `"geonode/geoserver_data"` | geoserver image docker image (default in zalf namespace because geonode one was not up to date) | -| geoserver_data.image.tag | string | `"2.23.3-v1"` | geoserver docker image tag | +| geoserver_data.image.tag | string | `"2.24.4-v1"` | geoserver docker image tag | | geoserver_data.imagePullPolicy | string | `"IfNotPresent"` | geoserver image pull policy | | global.accessMode | string | `"ReadWriteMany"` | storage access mode used by helm dependency pvc | | global.storageClass | string | `nil` | storageClass used by helm dependencies pvc | diff --git a/charts/geonode/values.yaml b/charts/geonode/values.yaml index 9dd4c38..09fb4f6 100644 --- a/charts/geonode/values.yaml +++ b/charts/geonode/values.yaml @@ -7,7 +7,7 @@ global: # geonode configuration geonode: # -- geonode version, used for some distinguassion between version of GeoNode - version: 4.3.0 + version: 4.3.1 # -- container name container_name: geonode # -- number of geonode replicas (! not working properly yet) @@ -21,7 +21,7 @@ geonode: # -- used geonode image name: geonode/geonode # -- tag of used geonode image - tag: "4.3.0" + tag: "4.3.1" # -- image pull policy imagePullPolicy: IfNotPresent # -- pull secret to use for geonode image @@ -345,7 +345,7 @@ geoserver: # -- geoserver image docker image (default in zalf namespace because geonode one was not up to date) name: geonode/geoserver # -- geoserver docker image tag - tag: "2.24.3-v1" + tag: "2.24.4-v1" # -- geoserver image pull policy imagePullPolicy: "IfNotPresent" # -- pull secret to use for geoserver image @@ -397,7 +397,7 @@ geoserver_data: # -- geoserver image docker image (default in zalf namespace because geonode one was not up to date) name: geonode/geoserver_data # -- geoserver docker image tag - tag: "2.23.3-v1" + tag: "2.24.4-v1" # -- geoserver image pull policy imagePullPolicy: "IfNotPresent" diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..bb40ed4 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,101 @@ + +![Version: 1.2.3-alpha](https://img.shields.io/badge/Version-1.2.3-alpha-informational?style=flat-square) + +# Helm Chart for Geonode + +- [GeoWhat?](#Geonode) +- [Geonode-k8s](#geonode-k8s) +- [Install Guilde](#install) + +**Homepage:** + +Geonode +------- + +Geonode is a geospatial content management system, a platform for the management and publication of geospatial data. It brings together mature +and stable open-source software projects under a consistent and easy-to-use interface allowing non-specialized users to share data and +create interactive maps. + +You can find the Sourcecode and more information about geonode under: +- Homepage: https://geonode.org/ +- Github: https://github.com/GeoNode/geonode +- Docs: https://docs.geonode.org + +Due to growing needs for high availability and scalability this repository aims at running Geonode with all required services in a cloud based manner. To due so we use Kubernetes (https://kubernetes.io/), a cloud management software, which runs on public and private clouds. As the Kubernetes echosystem can be confusing for people getting new to this field, there are packages for most services which are able to run on top of kubernetes. This packages are managed via helm (https://helm.sh/). + +Geonode-k8s +----------- + +This repository provides a helm chart for **geonode** including additional services as: +- geoserver: source server for sharing geospatial data (https://geoserver.org/) +- rabbitmq: message broker (scalable) +- postgresql database: using zalando postgres-operator for distributed database for geonode and postgis db for geoserver (https://github.com/zalando/postgres-operator) (scalable) +- memcached (optional): as django cache (scalable) +- nginx: webserver to deliver static content (scalable) +- pycsw: CSW interface (scalable) +This helm chart provides the possibility to run most of the services redundant to increase performance on the one hand and increase fail safe on the other hand. + +## Documentation + + +To get an overview of the available configuration check out the values [docs](charts/geonode/README.md). If you want to run the helm chart first on a minikube cluster check out the [minikube](docs/minikube-installation.md) guide. Also check the minikube-values.yaml for basic configuration. + +If you want to go straight for a production installation follow the [installation](#install) guide. + +Furhter docs you can find on [readthedocs](https://geonode-k8s.readthedocs.io/en/latest/). + +Install +------- + +## Prerequisites + +* A Kubernetes cluster (or [minikube](docs/minikube-installation.md)) +* [Helm](https://helm.sh/) + +The chart will automatically install required dependencies, i.e. a RabbitMQ broker and a Postgres database with `postgis` extensions installed, and link them up. If you want to run an older geonode version with geonode-k8s check the [release-to-version list](docs/list-of-releases-and-versions.md). + +## Install chart dependencies + +Update helm dependencies via: + +```bash +helm repo add geonode https://zalf-rdm.github.io/geonode-k8s/ +helm repo update +``` + +## Override desired values in your own override file +Define your own values.yaml to configure your geonode installation. Use the [docs](charts/geonode/README.md) to understand the parameters. + +```bash +vi my-values.yaml +``` + +## Install chart +```bash +helm upgrade --cleanup-on-fail --install --namespace geonode --create-namespace --values my-values.yaml geonode charts/geonode +``` + +## Delete Installation +```bash +helm delete --namespace geonode geonode geonode +``` + +## Contribution + +### Create an Issue + +You found a bug :lady_beetle:? +You have an idea how to improve :bulb:? +Feel free to [create an issue](https://github.com/zalf-rdm/geonode-k8s/issues/new/choose)! + + +### Documentation + +Ensure values.yaml documentation is up-to-date. +The [parameter documentation](charts/geonode/README.md) is generated via [`helm-docs`](https://github.com/norwoodj/helm-docs). +There is a pre-commit hook configuration so please ensure you install it into your local working copy via + +``` +pre-commit install +pre-commit install-hooks +``` diff --git a/docs/list-of-releases-and-versions.md b/docs/list-of-releases-and-versions.md index a358484..add9cc7 100644 --- a/docs/list-of-releases-and-versions.md +++ b/docs/list-of-releases-and-versions.md @@ -19,4 +19,5 @@ the table below shows an overview about the geonode-k8s release with the corespo | [1.1.1](https://github.com/zalf-rdm/geonode-k8s/releases/tag/geonode-k8s-1.1.1) | [4.2.2](https://github.com/GeoNode/geonode/releases/tag/4.2.2) | [geonode/geonode:4.2.2](https://hub.docker.com/r/geonode/geonode/tags) | [geonode/geoserver:2.23.3-v2](https://hub.docker.com/r/geonode/geoserver/tags) | | [1.2.0](https://github.com/zalf-rdm/geonode-k8s/releases/tag/geonode-k8s-1.2.0) | [4.3.0](https://github.com/GeoNode/geonode/releases/tag/4.3.0) | [geonode/geonode:4.3.0](https://hub.docker.com/r/geonode/geonode/tags) | [geonode/geoserver:2.24.3-v1](https://hub.docker.com/r/geonode/geoserver/tags) | [1.2.1](https://github.com/zalf-rdm/geonode-k8s/releases/tag/geonode-k8s-1.2.1) | [4.3.0](https://github.com/GeoNode/geonode/releases/tag/4.3.0) | [geonode/geonode:4.3.0](https://hub.docker.com/r/geonode/geonode/tags) | [geonode/geoserver:2.24.3-v1](https://hub.docker.com/r/geonode/geoserver/tags) | - [1.2.2](https://github.com/zalf-rdm/geonode-k8s/releases/tag/geonode-k8s-1.2.1) | [4.3.0](https://github.com/GeoNode/geonode/releases/tag/4.3.0) | [geonode/geonode:4.3.0](https://hub.docker.com/r/geonode/geonode/tags) | [geonode/geoserver:2.24.3-v1](https://hub.docker.com/r/geonode/geoserver/tags) | \ No newline at end of file + [1.2.2](https://github.com/zalf-rdm/geonode-k8s/releases/tag/geonode-k8s-1.2.1) | [4.3.0](https://github.com/GeoNode/geonode/releases/tag/4.3.0) | [geonode/geonode:4.3.0](https://hub.docker.com/r/geonode/geonode/tags) | [geonode/geoserver:2.24.3-v1](https://hub.docker.com/r/geonode/geoserver/tags) | + [1.2.3-alpha](https://github.com/zalf-rdm/geonode-k8s/releases/tag/geonode-k8s-1.2.1) | [4.3.1](https://github.com/GeoNode/geonode/releases/tag/4.3.1) | [geonode/geonode:4.3.1](https://hub.docker.com/r/geonode/geonode/tags) | [geonode/geoserver:2.24.4-v1](https://hub.docker.com/r/geonode/geoserver/tags) | \ No newline at end of file