Merge pull request #18 from oliverbaehler/master

[housekeeping] Bugfixes & Documentation

.github/workflows/docs.yml

@@ -0,0 +1,39 @@
+name: Helm Documentation
+on: push
+jobs:
+  documentation:
+    runs-on: ubuntu-latest
+    container:
+      image: alpine
+    steps:
+      - name: Install Dependencies
+        run: |
+          apk add jq git curl
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Fetch history
+        run: git fetch --prune --unshallow
+
+      - name: Install Helm Docs
+        run: |
+          curl -s -L -o /usr/local/bin/helm-docs.tar.gz "https://github.com/norwoodj/helm-docs/releases/download/$(curl --silent "https://api.github.com/repos/norwoodj/helm-docs/releases/latest" | jq -r .tag_name)/helm-docs_$(curl --silent "https://api.github.com/repos/norwoodj/helm-docs/releases/latest" | jq -r .tag_name | cut -d "v" -f2-)_Linux_x86_64.tar.gz"
+          cd /usr/local/bin/ && tar xfv helm-docs.tar.gz
+          chmod +x ./helm-docs
+
+      - name: Update Documentation
+        run: |
+          git status
+          CHARTS_ROOT="./charts"
+          if [ -d "${CHARTS_ROOT}" ]; then
+            ## Generate Documentation
+            helm-docs
+            ## Push Changes
+            git config user.name "$GITHUB_ACTOR"
+            git config user.email "[email protected]"
+            git add -A
+            git commit -sam "Update Documentation" || true
+            git push || true
+          else
+            echo -e "\n\e[33m-- Root Direcoty not found: $CHART_ROOT\e[0m" && exit 0;
+          fi

.github/workflows/release.yml

@@ -4,47 +4,8 @@ on:
     branches:
       - master
 jobs:
-  documentation:
-    runs-on: ubuntu-latest
-    container:
-      image: alpine
-    steps:
-      - name: Install Dependencies
-        run: |
-          apk add jq git curl
-      - name: Checkout
-        uses: actions/checkout@v2
-
-      - name: Fetch history
-        run: git fetch --prune --unshallow
-
-      - name: Install Helm Docs
-        run: |
-          curl -s -L -o /usr/local/bin/helm-docs.tar.gz "https://github.com/norwoodj/helm-docs/releases/download/$(curl --silent "https://api.github.com/repos/norwoodj/helm-docs/releases/latest" | jq -r .tag_name)/helm-docs_$(curl --silent "https://api.github.com/repos/norwoodj/helm-docs/releases/latest" | jq -r .tag_name | cut -d "v" -f2-)_Linux_x86_64.tar.gz"
-          cd /usr/local/bin/ && tar xfv helm-docs.tar.gz
-          chmod +x ./helm-docs
-
-      - name: Update Documentation
-        run: |
-          git status
-          CHARTS_ROOT="./charts"
-          if [ -d "${CHARTS_ROOT}" ]; then
-            ## Generate Documentation
-            helm-docs
-            ## Push Changes
-            git config user.name "$GITHUB_ACTOR"
-            git config user.email "[email protected]"
-            git add -A
-            git commit -sam "Update Documentation" || true
-            git push || true
-          else
-            echo -e "\n\e[33m-- Root Direcoty not found: $CHART_ROOT\e[0m" && exit 0;
-          fi
-
   release:
     runs-on: ubuntu-latest
-    needs:
-      - documentation
     steps:
       - name: Checkout
         uses: actions/checkout@v2

.gitignore

@@ -26,7 +26,3 @@ Sessionx.vim
 .idea/
 .intellij/
 *.iml
-
-# Custom Files
-charts/manifests/plugin/values-generator/charts/
-charts/manifests/plugin/values-generator/Chart.lock

CONTRIBUTING.md

@@ -25,7 +25,7 @@ See git help commit:
 With these steps you can make a contribution:
 
   1. Fork this repository, develop and test your changes on that fork.
-  2. All commits have a meaningful description and are signed off as described above and also verified.
+  2. All commits have a meaningful description, are signed off as described above and verified.
   3. Submit a pull request from your fork to this project.
 
 ## Code reviews
@@ -42,6 +42,7 @@ All submissions, including submissions by project members, require review. We us
 
 To have consistent README documentations for each chart we use the [helm-docs plugin](https://github.com/norwoodj/helm-docs). Make sure to write the chart README in a compatible format. Helm-Docs is executed on Push events.
 
+**NOTE**: When creating your own `README.md.gotmpl`, don't forget to add it to your `.helmignore` file.
 
 ## Release Action
 
@@ -59,6 +60,8 @@ Unit Tests can be created on a chart basis. Unit Tests are optional.
 
 Your PR has to fulfill the following points, to be considered:
 
+  * Chart should use [Bedag Manifests Library](./charts/manifests/README.md), if possible
+  * Make use of [Artifacthub Annotations](https://github.com/artifacthub/hub/blob/master/docs/helm_annotations.md)
   * CI Jobs for linting must pass.
   * The title of the PR starts with the chart name (e.g. `[chart_name] Additional options for SecurityContext`)
   * Changes must follow [Helm best practices](https://helm.sh/docs/chart_best_practices/).
@@ -85,23 +88,3 @@ Currently these are the only requirements to add a new chart:
   * **Only Helm Version 3+ Charts ([ApiVersion 2](https://helm.sh/docs/topics/v2_v3_migration/)) are accepted/supported.**
   * The chart has it's on `README.md` describing it's configuration options with default values. The documentation should also cover  some basic configuration examples.
   * Follow a best practice structure for the layout of the chart  directory (A good reference is [bitnami's blog](https://docs.bitnami.com/tutorials/production-ready-charts/) on this topic)
-
-## Recommendations
-
-We have some recommendations for creating a new chart.
-
-### Chart Schema
-
-A [Chart Schema](https://helm.sh/docs/topics/charts#schema-files) helps improving the value validations of the given chart values. But it's also used in solutions, where you can deploy charts over a gui. For example [Rancher](https://rancher.com/products/rancher/) uses the Chart Schema to render a user friendly page, where you can change the chart values. To get a good first layout of your values you might want to use [this Helm Plugin](https://github.com/karuppiah7890/helm-schema-gen). It automatically creates the schema file according to your values file.
-
-Install the Plugin
-
-```
-helm plugin install https://github.com/karuppiah7890/helm-schema-gen
-```
-
-Generate Schema file
-
-```
-helm schema-gen values.yaml
-```

charts/manifests/.helmignore

@@ -24,4 +24,3 @@
 
 # Custom
 README.md.gotmpl
-plugin/

charts/manifests/Chart.yaml

@@ -2,7 +2,7 @@ apiVersion: v2
 name: manifests
 description: "Bedag's Manifest chart. Library full of basic kubernetes manifests."
 type: library
-version: 0.4.0
+version: 0.4.1
 icon: "https://www.bedag.ch/wGlobal/wGlobal/layout/images/logo.svg"
 keywords:
 - Bedag

charts/manifests/README.md

@@ -1,6 +1,6 @@
 # Manifests Library
 
-![Version: 0.3.0](https://img.shields.io/badge/Version-0.3.0-informational?style=flat-square) ![Type: library](https://img.shields.io/badge/Type-library-informational?style=flat-square)
+![Version: 0.4.1](https://img.shields.io/badge/Version-0.4.1-informational?style=flat-square) ![Type: library](https://img.shields.io/badge/Type-library-informational?style=flat-square)
 
 This library's purpose is to have more flexibility as chart author but at the same time have kubernetes manifests managed in a central library. This way you can avoid big surprises when Kubernetes has breaking changes in any of their APIs. Currently we support a base set of resources. Resources may be added as soon as we see or get a request that there's a need for it. This chart is still under development and testing, since it's rather complex. Feel free to use it. Our goal is to get it as reliable as possible.
 
@@ -39,6 +39,12 @@ Major Changes to functions are documented with the version affected. **Before up
 | :----------- | :---------------- | :--------------------- | :-------------- |
 |||||
 
+## Requirements
+
+| Repository | Name | Version |
+|------------|------|---------|
+| https://buttahtoast.github.io/helm-charts/ | library | ~0.3.0 |
+
 # Documentation
 
 For Artifacthub Users: The entire documentation can be found in the GitHub Repository.
@@ -53,8 +59,6 @@ We recommend looking thirst through the **Kubernetes Manifests** section.
   * **[Values](./templates/values/README.md)**
   * **[Utilities](./templates/utils/README.md)**
 
-## Requirements
+## Quickstart
 
-| Repository | Name | Version |
-|------------|------|---------|
-| https://buttahtoast.github.io/helm-charts/ | library | ~0.3.0 |
+[See this page for a quickstart](./templates/Quickstart.md)

charts/manifests/README.md.gotmpl

@@ -41,6 +41,17 @@ Major Changes to functions are documented with the version affected. **Before up
 |||||
 
 
+{{/*
+  Chart Sources
+*/}}
+{{ template "chart.sourcesSection" . }}
+
+{{/*
+  Chart Requirements
+*/}}
+{{ template "chart.requirementsSection" . }}
+
+
 # Documentation
 
 For Artifacthub Users: The entire documentation can be found in the GitHub Repository.
@@ -55,12 +66,6 @@ We recommend looking thirst through the **Kubernetes Manifests** section.
   * **[Values](./templates/values/README.md)**
   * **[Utilities](./templates/utils/README.md)**
 
-{{/*
-  Chart Sources
-*/}}
-{{ template "chart.sourcesSection" . }}
+## Quickstart
 
-{{/*
-  Chart Requirements
-*/}}
-{{ template "chart.requirementsSection" . }}
+[See this page for a quickstart](./templates/Quickstart.md)