Add capi-templates & terraform-backend-mongodb charts and docs (#38)

* Add capi-templates chart for GKE

* Update

* Configure legacy app for validated image on Windows 2022

* Moved empty chart to docs

* Update deployment with right indentation

* Add generic webapp chart

* Update email on capi-templates chart

* Add terraform-backend-mongodb chart

* Format invalid indentation in capi-templates values file

* Remove unnecesary new chart

* Move traefic and s3gw to upstream docs

* Move CloudBees CI, MariaDB, NATS, Podinfo, Redis, Traefik, Argo CD, Concourse

* Move MongoDB Percona, Prometheus, ReportPortal, SonarQube, Kasten, Elasticsearch, Cloudbees CI

* Dump version of longhorn

* Update letsencrypt chart to add optional selfsigned issuer

* Move cert-manager, epinio, harbor, ingress-nginx, jenkins, longhorn

* Update actions used in PKG pipeline

* Create CONTRIBUTING.md file

* Migrate RabbitMQ, Rancher, Sealed Secrets to docs upstream

* Create VitePress site

* Add docs content

* Fill doc indexes

* Add npm in pipelines

* Fix links and change npm install

* Update package lock with npm 11.5.1

Author: devpro

.github/workflows/ci.yml

@@ -27,20 +27,30 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout git repository
-        uses: actions/checkout@v3.1.0
+        uses: actions/checkout@v4
         with:
           # note: important to have chart-testing work (see https://github.com/helm/chart-testing/issues/186)
           fetch-depth: 0
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: npm
+      - name: Install Node.js dependencies
+        run: npm install
+      - name: Build with VitePress
+        run: npm run docs:build
       - name: Install Helm
-        uses: azure/setup-helm@v3
+        uses: azure/setup-helm@v4.3.0
         with:
-          version: 3.10.1
+          version: latest
       - name: Install Python
-        uses: actions/setup-python@v4.3.0
+        uses: actions/setup-python@v5.3.0
         with:
-          python-version: 3.11
-      - name: Install chart-testing
-        uses: helm/chart-testing-action@v2.3.1
+          python-version: '3.x'
+          check-latest: true
+      - name: Set up chart-testing
+        uses: helm/chart-testing-action@v2.7.0
       - name: Add dependency chart repositories
         run: ./scripts/add_helm_repo.sh
       - name: List changed charts
@@ -53,6 +63,7 @@ jobs:
             echo "changed_charts=$charts" >> $GITHUB_OUTPUT
           fi
       - name: Lint charts
+        if: steps.list-changed.outputs.changed == 'true'
         run: ct lint $CHARTS_DIRECTORIES_ARG --target-branch ${{ github.event.repository.default_branch }}
       # TODO: Enable when https://github.com/stackrox/kube-linter/issues/575 is fixed
       # - name: Scan yamls

.github/workflows/pkg.yml

@@ -14,7 +14,8 @@ name: PKG
 
 on:
   push:
-    branches: [ "main" ]
+    branches:
+      - main
   workflow_dispatch:
 
 permissions:
@@ -27,45 +28,58 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout git repository
-        uses: actions/checkout@v3.1.0
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: npm
+      - name: Install Node.js dependencies
+        run: npm install
+      - name: Build with VitePress
+        run: npm run docs:build
       # https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address
       - name: Configure Git
         run: |
           git config user.name "$GITHUB_ACTOR"
           git config user.email "$GITHUB_ACTOR@users.noreply.github.com"
       - name: Install Helm
-        uses: azure/setup-helm@v3
+        uses: azure/setup-helm@v4.3.0
         with:
-          version: 3.10.1
+          version: latest
       - name: Add dependency chart repositories
         run: ./scripts/add_helm_repo.sh
       - name: Host charts repository on GitHub Pages
-        uses: helm/chart-releaser-action@v1.5.0
+        uses: helm/chart-releaser-action@v1.7.0
         env:
           CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
       # important: it needs to be done in the same pipeline as another pages workflow won't be triggered by the pust on the gh-pages branch
       # (tried with a PAT and several options but didn't work)
       - name: Checkout gh-pages branch
-        uses: actions/checkout@v3.1.0
+        uses: actions/checkout@v4
         with:
           ref: gh-pages
       - name: Setup Go environment
-        uses: actions/setup-go@v3.3.1
+        uses: actions/setup-go@v5
       - name: Generate index.html
         run: |
-          go install github.com/halkeye/helm-repo-html@v0.0.8
+          go install github.com/halkeye/helm-repo-html@v0.2.1
           /home/runner/go/bin/helm-repo-html
       - name: Setup Pages
-        uses: actions/configure-pages@v1
+        uses: actions/configure-pages@v5
       - name: Build with Jekyll
         uses: actions/jekyll-build-pages@v1
         with:
           source: ./
           destination: ./_site
+      - name: Copy docs to website folder
+        run: |
+          mkdir -p _site/docs
+          cp -r docs/.vitepress/dist/* _site/docs/
       - name: Upload artifact
-        uses: actions/upload-pages-artifact@v1
+        uses: actions/upload-pages-artifact@v3
   deploy:
     environment:
       name: github-pages
@@ -75,4 +89,4 @@ jobs:
     steps:
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@v1
+        uses: actions/deploy-pages@v4

.gitignore

@@ -6,3 +6,10 @@ temp*.yaml
 temp.sh
 /charts/temp/
 values_*.y*ml
+
+# NPM packages
+node_modules/
+
+# VitePress local files
+docs/.vitepress/dist
+docs/.vitepress/cache

.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+  "files.exclude": {
+    "**/.vitepress/cache": true,
+    "**/.vitepress/dist": true
+  }
+}

CONTRIBUTING.md

@@ -0,0 +1,53 @@
+# Contribution guide
+
+## File organization
+
+[Helm Chart Releaser](https://github.com/helm/chart-releaser) doesn't support multiple chart directories ou multiple levels so all charts must be in `charts` repository.
+
+## Code validation
+
+Lint charts with [helm/chart-testing](https://github.com/helm/chart-testing) (with workaround described at [issue #464](https://github.com/helm/chart-testing/issues/464)):
+
+```bash
+docker run --rm -it --workdir=/data --volume $(pwd):/data quay.io/helmpack/chart-testing:v3.7.1 \
+  /bin/sh -c "git config --global --add safe.directory /data ; ./scripts/add_helm_repo.sh ; ct lint --target-branch main"
+```
+
+(not yet available because of [Issue #575](https://github.com/stackrox/kube-linter/issues/575)) Lint charts with [stackrox/kube-linter](https://github.com/stackrox/kube-linter) ([docs](https://docs.kubelinter.io/)):
+
+```bash
+docker run --rm -v $(pwd)/charts:/charts -v $(pwd)/.kube-linter.yaml:/etc/config.yaml \
+  stackrox/kube-linter lint /charts --config /etc/config.yaml
+```
+
+## Chart repository references
+
+* Cloud Native components
+  * [Cloud Native Interactive Landscape](https://landscape.cncf.io/)
+* Documentation
+  * [Rancher How-to Guides > Helm Charts > Creating Apps](https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/helm-charts-in-rancher/create-apps)
+* Examples
+  * [argoproj/argocd-example-apps](https://github.com/argoproj/argocd-example-apps)
+  * [helm/charts](https://github.com/helm/charts)
+  * [rancher/rodeo](https://github.com/rancher/rodeo)
+* Official repositories
+  * [argoproj/argo-helm](https://github.com/argoproj/argo-helm)
+  * [aws/eks-charts](https://github.com/aws/eks-charts)
+  * [bitnami/charts](https://github.com/bitnami/charts)
+  * [elastic/helm-charts](https://github.com/elastic/helm-charts)
+  * [grafana/helm-charts](https://github.com/grafana/helm-charts)
+  * [prometheus-community/helm-charts](https://github.com/prometheus-community/helm-charts)
+  * [rancher/charts](https://github.com/rancher/charts)
+  * [rancher/helm3-charts](https://github.com/rancher/helm3-charts)
+
+## Documentation website
+
+The documentation is built with [VitePress](https://vitepress.dev/) ([code](https://github.com/vuejs/vitepress)) and VitePress plugins: [VitePress Sidebar](https://github.com/jooy2/vitepress-sidebar).
+
+It was generated by `npm add -D vitepress`, `npx vitepress init`, `npm i -D vitepress-sidebar`.
+
+Run locally the website with:
+
+```bash
+npm run docs:dev
+```

README.md

@@ -3,108 +3,10 @@
 [![CI](https://github.com/devpro/helm-charts/actions/workflows/ci.yml/badge.svg)](https://github.com/devpro/helm-charts/actions/workflows/ci.yml)
 [![PKG](https://github.com/devpro/helm-charts/actions/workflows/pkg.yml/badge.svg)](https://github.com/devpro/helm-charts/actions/workflows/pkg.yml)
 
-Helm charts to ease the deployment of containers on Kubernetes clusters and get information on widely used components.
-
-## Quickstart
-
-* Visit [devpro.github.io/helm-charts](https://devpro.github.io/helm-charts/)
-
-## Catalog
-
-* Applications
-  * [Cow Demo](charts/cow-demo/README.md) 🗸
-  * [Devpro Sales Portal](charts/devpro-salesportal/README.md) 🗸
-  * [Drupal](charts/drupal/README.md)
-  * [E Corp Demo](charts/ecorp-demo/README.md) 🗸
-  * [Game 2048](charts/game-2048/README.md) 🗸
-  * [HobbyFarm](charts/hobbyfarm/README.md) 🗸
-  * [Podinfo](charts/podinfo/README.md) 🗸
-  * [WordPress](charts/wordpress/README.md) 🗸
-* Authentication / Identity
-  * [Keycloak](charts/keycloak/README.md) 🗸
-  * [Kratos](charts/kratos/README.md) 🗸
-* Cloud providers
-  * [Azure Storage](charts/azure-storage/README.md) 🗸
-  * [Outscale](charts/outscale/README.md)
-* Data stores
-  * [Elasticsearch](charts/elasticsearch/README.md) 🗸
-  * [MariaDB](charts/mariadb/README.md) 🗸
-  * [memcached](charts/memcached/README.md)
-  * [MongoDB (Bitnami)](charts/mongodb-bitnami/README.md) 🗸
-  * [MongoDB Community](charts/mongodb-community/README.md) 🗸
-  * [PostgreSQL](charts/postgresql/README.md) 🗸
-  * [RabbitMQ](charts/rabbitmq/README.md) 🗸
-  * [Redis](charts/redis/README.md) 🗸
-* Networking & Messaging
-  * [cert-manager](charts/cert-manager/README.md) 🗸
-  * [Consul](charts/consul/README.md)
-  * [external-dns](charts/external-dns/README.md)
-  * [HAProxy](charts/haproxy/README.md)
-  * [Istio](charts/istio/README.md)
-  * [Kafka](charts/kafka/README.md)
-  * [Kong](charts/kong/README.md)
-  * [Let's Encrypt](charts/letsencrypt/README.md) 🗸
-  * [Linkerd](charts/linkerd/README.md)
-  * [MetalLB](charts/metallb/README.md)
-  * [MQTT](charts/mqtt/README.md)
-  * [NATS](charts/nats/README.md) 🗸
-  * [NGINX Ingress Controller](charts/ingress-nginx/README.md) 🗸
-  * [Traefik](charts/traefik/README.md) 🗸
-* Management
-  * [Rancher](charts/rancher/README.md) 🗸
-  * [Rancher Cluster Templates](charts/rancher-cluster-templates/README.md) 🗸
-* Observability
-  * [Elastic Stack](charts/elastic-stack/README.md)
-  * [Grafana Stack](charts/grafana-stack/README.md) 🗸
-  * [OpenTelemetry Collector](charts/opentelemetry-collector/README.md) 🗸
-  * [Prometheus](charts/prometheus/README.md) 🗸
-  * Splunk
-* Platforms
-  * [Epinio](charts/epinio/README.md) 🗸
-* Secrets
-  * [Sealed Secrets](charts/sealed-secrets/README.md) 🗸
-* Security
-  * [NeuVector](charts/neuvector/README.md) 🗸
-  * [Rancher CIS Benchmark](charts/rancher-cis-benchmark/README.md) 🗸
-* Serverless
-  * [Knative](charts/knative/README.md)
-* Storage
-  * [Kasten K10](charts/kasten-k10/README.md) 🗸
-  * [Longhorn](charts/longhorn/README.md) 🗸
-  * [MinIO](charts/minio/README.md) 🗸
-  * [s3gw](charts/s3gw/README.md) 🗸
-  * [NFS-Ganesha](charts/nfs-ganesha/README.md) 🗸
-* Supply Chain (Software Factory)
-  * [ArgoCD](charts/argo-cd/README.md) 🗸
-  * [Argo Rollouts](charts/argo-rollouts/README.md)
-  * [Artifactory](charts/artifactory/README.md)
-  * [Azure DevOps Agent](charts/azure-devops-agent/README.md)
-  * [CloudBees CI](charts/cloudbees-ci/README.md) 🗸
-  * [Concourse](charts/concourse/README.md)
-  * [Drone](charts/drone/README.md)
-  * [GitLab](charts/gitlab/README.md) 🗸
-  * [GitLab Runner](charts/gitlab-runner/README.md) 🗸
-  * [Harbor](charts/harbor/README.md) 🗸
-  * [Jenkins](charts/jenkins/README.md) 🗸
-  * [Jira](charts/jira/README.md)
-  * [Nexus](charts/nexus/README.md)
-  * [R2Devops](charts/r2devops/README.md) 🗸
-  * [Promyze](charts/promyze/README.md) 🗸
-  * [SonarQube](charts/sonarqube/README.md) 🗸
-  * [Tekton](charts/tekton/README.md)
-* Testing
-  * [Report Portal](charts/reportportal/README.md) 🗸
-
-Limitation: [Helm Chart Releaser](https://github.com/helm/chart-releaser) doesn't support multiple chart directories ou multiple levels so all charts must be in `charts` repository
-
-## Best pratices
-
-* [Operations](docs/operations.md)
+This repository provides a list of community, vendor and home Helm charts to easily configure and run workloads in Kubernetes clusters.
+Feel free to [contribute](CONTRIBUTING.md)!
 
-## Samples
-
-* [DevOpsDays Geneva 2023](samples/devopsdays-geneva-2023/README.md)
-* [SUSE Exchange Paris 2023](samples/suse-exchange-paris-2023/README.md)
+Latest chart versions are available from [devpro.github.io/helm-charts](https://devpro.github.io/helm-charts/).
 
 ## Usage
 
@@ -184,40 +86,7 @@ helm:
 * Setup Continuous Deployment
   * Configure GitOps repositories and deploy backing services and applications
 
-## Local setup
-
-### How to validate a code change
-
-* Lint charts with [helm/chart-testing](https://github.com/helm/chart-testing)
-
-```bash
-# runs in a container (with workaround described at https://github.com/helm/chart-testing/issues/464)
-docker run --rm -it --workdir=/data --volume $(pwd):/data quay.io/helmpack/chart-testing:v3.7.1 /bin/sh -c "git config --global --add safe.directory /data ; ./scripts/add_helm_repo.sh ; ct lint --target-branch main"
-```
-
-* (not yet available because of [Issue #575](https://github.com/stackrox/kube-linter/issues/575)) Lint charts with [stackrox/kube-linter](https://github.com/stackrox/kube-linter) ([docs](https://docs.kubelinter.io/))
-
-```bash
-# runs in a container
-docker run --rm -v $(pwd)/charts:/charts -v $(pwd)/.kube-linter.yaml:/etc/config.yaml stackrox/kube-linter lint /charts --config /etc/config.yaml
-```
+## Samples
 
-## References
-
-* Cloud Native components
-  * [Cloud Native Interactive Landscape](https://landscape.cncf.io/)
-* Documentation
-  * [Rancher How-to Guides > Helm Charts > Creating Apps](https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/helm-charts-in-rancher/create-apps)
-* Examples
-  * [argoproj/argocd-example-apps](https://github.com/argoproj/argocd-example-apps)
-  * [helm/charts](https://github.com/helm/charts)
-  * [rancher/rodeo](https://github.com/rancher/rodeo)
-* Official repositories
-  * [argoproj/argo-helm](https://github.com/argoproj/argo-helm)
-  * [aws/eks-charts](https://github.com/aws/eks-charts)
-  * [bitnami/charts](https://github.com/bitnami/charts)
-  * [elastic/helm-charts](https://github.com/elastic/helm-charts)
-  * [grafana/helm-charts](https://github.com/grafana/helm-charts)
-  * [prometheus-community/helm-charts](https://github.com/prometheus-community/helm-charts)
-  * [rancher/charts](https://github.com/rancher/charts)
-  * [rancher/helm3-charts](https://github.com/rancher/helm3-charts)
+* [DevOpsDays Geneva 2023](samples/devopsdays-geneva-2023/README.md)
+* [SUSE Exchange Paris 2023](samples/suse-exchange-paris-2023/README.md)