Chart and docs update, fix #113 (#135)

* target dependabot PR to devel branch

* Bump golang from 1.17.6-alpine3.15 to 1.17.7-alpine3.15 (#118)

Bumps golang from 1.17.6-alpine3.15 to 1.17.7-alpine3.15.

---
updated-dependencies:
- dependency-name: golang
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Yevgeniy Valeyev <[email protected]>

* Bump k8s.io/client-go from 0.19.3 to 0.23.4 (#119)

Bumps [k8s.io/client-go](https://github.com/kubernetes/client-go) from 0.19.3 to 0.23.4.
- [Release notes](https://github.com/kubernetes/client-go/releases)
- [Changelog](https://github.com/kubernetes/client-go/blob/master/CHANGELOG.md)
- [Commits](kubernetes/client-go@v0.19.3...v0.23.4)

---
updated-dependencies:
- dependency-name: k8s.io/client-go
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Yevgeniy Valeyev <[email protected]>

* Codecov (#125)

* target dependabot PR to devel branch (#124)

* Don’t limit codecov to PRs

* sanitise URL string in the log, fixes #126

* use request URI in log

* Bump github.com/aws/aws-sdk-go from 1.35.5 to 1.43.8 (#128)

* Bump github.com/aws/aws-sdk-go from 1.43.8 to 1.43.9 (#129)

* Bump github.com/aws/aws-sdk-go from 1.43.9 to 1.43.10 (#130)

Bumps [github.com/aws/aws-sdk-go](https://github.com/aws/aws-sdk-go) from 1.43.9 to 1.43.10.
- [Release notes](https://github.com/aws/aws-sdk-go/releases)
- [Changelog](https://github.com/aws/aws-sdk-go/blob/main/CHANGELOG.md)
- [Commits](aws/aws-sdk-go@v1.43.9...v1.43.10)

---
updated-dependencies:
- dependency-name: github.com/aws/aws-sdk-go
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump github.com/aws/aws-sdk-go from 1.43.10 to 1.43.11 (#131)

* run codeql on PRs and schedule

* security fix for golang/go#51112

* validate k8s response status before parsing config, fixes #113

* use helm-docs

* minor docs and chart update

* update only read the docs file

* update doc

* retire chart release notes

* bump appVersion

* bumpd appVersion

* update aio manifest

* adjust build triggers

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

.github/workflows/build.yml

@@ -12,11 +12,9 @@ on:
   push:
     branches:
       - master
-      - devel
   pull_request:
     branches:
       - master
-      - devel
 
 jobs:
   test:

.pre-commit-config.yaml

@@ -0,0 +1,14 @@
+repos:
+  - repo: https://github.com/norwoodj/helm-docs
+    rev: v1.7.0
+    hooks:
+      - id: helm-docs
+        args:
+          # Make the tool search for charts only under the `example-charts` directory
+          - --chart-search-root=charts/s3sync-service
+
+          # The `./` makes it relative to the chart-search-root set above
+          - --template-files=./docs-template.md
+
+          # Documentation output file, the path is relative to the chart repository
+          - --output-file=../../docs/helm-charts.md

charts/s3sync-service/.helmignore

@@ -2,6 +2,7 @@
 # This supports shell glob matching, relative path matching, and
 # negation (prefixed with !). Only one pattern per line.
 .DS_Store
+docs-template.md
 # Common VCS dirs
 .git/
 .gitignore

charts/s3sync-service/Chart.yaml

@@ -2,11 +2,10 @@ apiVersion: v2
 name: s3sync-service
 description: A Helm chart for deploying s3sync-service on Kubernetes
 type: application
-version: 0.0.10
-appVersion: 0.2.0
+version: 0.0.11
+appVersion: 0.2.2
 kubeVersion: ">=1.13.10-0"
 home: https://docs.s3sync-service.org/
-description: Realtime S3 sync service
 
 sources:
   - https://github.com/mazay/s3sync-service

charts/s3sync-service/README.md

@@ -0,0 +1,19 @@
+<!--
+s3sync-service - Realtime S3 synchronisation tool
+Copyright (c) 2020  Yevgeniy Valeyev
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ -->
+
+Please check the [documentation page](https://docs.s3sync-service.org/en/devel/helm-charts/).

docs/charts-release-notes.md → charts/s3sync-service/docs-template.md

@@ -16,28 +16,21 @@ You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
  -->
 
-# Release Notes
+{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
 
-## 0.0.10
+# Using the Helm Repository
 
-- The application version bumped to `0.2.0`
+The following command can be used to add the repository:
+```bash
+helm repo add s3sync-service https://charts.s3sync-service.org
+```
 
-## 0.0.9
+Please check [this page](running-on-k8s.md#helm) for examples.
 
-- The application version bumped to `0.1.2`, minor description fixes
+# Configuration
 
-## 0.0.8
+{{ template "chart.requirementsSection" . }}
 
-- Changed `kubeVersion` value to `">=1.13.10-0"` in order to support improper versioning of managed k8s services
+{{ template "chart.valuesSection" . }}
 
-## 0.0.7
-
-- Specified `kubeVersion: ">=1.13.10"`
-- Use `.Release.Name` for naming all resources created by the chart
-- Fixed container level `securityContext`
-- Introduced `.Values.httpServer.enable` and `.Values.httpServer.port` to replace `.Values.httpServerPort`
-- Added container health checks using embedded HTTP server resource at `/info`
-
-## 0.0.6
-
-First working version, minimal supported application version is `0.1.0`.
+{{ template "helm-docs.versionFooter" . }}

charts/s3sync-service/templates/deployment.yaml

@@ -14,9 +14,11 @@ spec:
         app: s3sync-service
     {{- if or .Values.podAnnotations .Values.prometheusExporter.enable }}
       annotations:
+        {{- if .Values.prometheusExporter.enable }}
         prometheus.io/path: {{ .Values.prometheusExporter.path | quote }}
         prometheus.io/port: {{ .Values.prometheusExporter.port | quote }}
         prometheus.io/scrape: "true"
+        {{- end }}
       {{- range $key, $value := .Values.podAnnotations }}
         {{ $key }}: {{ $value | quote }}
       {{- end }}
@@ -50,7 +52,7 @@ spec:
         command:
         - "./s3sync-service"
       {{- if .Values.configmap.watch }}
-        - "-configmap={{ if .Values.configmap.name }}{{ .Values.configmap.name }}{{ else }}{{ .Release.Namespace }}/{{ .Release.Name }}{{ end }}"
+        - "-configmap={{ .Release.Namespace }}/{{ .Release.Name }}"
       {{- else }}
         - "-config=/opt/s3sync-service/config.yml"
       {{- end }}

charts/s3sync-service/values.yaml

@@ -3,21 +3,29 @@
 # Declare variables to be passed into your templates.
 
 image:
-  repository: zmazay/s3sync-service
+  # -- docker repository, uses `quay.io` mirror by default
+  repository: quay.io/s3sync-service/s3sync-service
+  # -- image pull policy
   pullPolicy: IfNotPresent
-  # Overrides the image tag whose default is the chart appVersion.
+  # -- overrides the image tag whose default is the chart appVersion
   tag: ""
 
+# -- set to false if you not planning on using configmap watch functionality or want to create RBAC objects manually
 createRbac: true
+# -- ServiceAccount name if was created manually
 serviceAccountName: ""
 
+# -- might be useful when using private registry
 imagePullSecrets: []
 
+# -- extra pod annotations
 podAnnotations: {}
 
+# -- the [pod security context](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod)
 podSecurityContext: {}
   # fsGroup: 2000
 
+# -- the [container security context](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container)
 securityContext: {}
   # capabilities:
   #   drop:
@@ -26,6 +34,7 @@ securityContext: {}
   # runAsNonRoot: true
   # runAsUser: 1000
 
+# -- container [resources allocation](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/)
 resources: {}
   # limits:
   #   cpu: 100m
@@ -34,42 +43,65 @@ resources: {}
   #   cpu: 100m
   #   memory: 128Mi
 
+# -- [nodeSelector](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector) for the pod
 nodeSelector: {}
 
+# -- pod [tolerations](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/)
 tolerations: []
 
+# -- [affinity](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#affinity-and-anti-affinity) settings
 affinity: {}
 
 httpServer:
+  # -- enable the s3sync-service [http service](http-server.md)
   enable: true
+  # -- listen port for the s3sync http service
   port: 8090
 
 prometheusExporter:
+  # -- enable built-in prometheus exporter
   enable: true
+  # -- listen port for the built-in prometheus exporter
   port: 9350
+  # -- netrics path for the prometheus exporter
   path: /metrics
 
 configmap:
-  name: ""
+  # -- enable the [configmap watch](k8s-integration.md) feature
   watch: true
 
 config:
+  # -- [global](configuration.md#global-configuration-options) AWS access key ID settings
   access_key: ""
+  # -- [global](configuration.md#global-configuration-options) AWS secret access key settings
   secret_access_key: ""
+  # -- [global](configuration.md#global-configuration-options) AWS Region settings
   aws_region: us-east-1
+  # -- logging level
   loglevel: info
+  # -- the upload queue buffer, check the [documentation](configuration.md#global-configuration-options) for details
   upload_queue_buffer: 0
+  # -- number of the upload workers
   upload_workers: 10
+  # -- number of the checksum workers
   checksum_workers: 5
+  # -- [global](configuration.md#global-configuration-options) watch interval settings
   watch_interval: 1s
+  # -- [global](configuration.md#global-configuration-options) S3 retries settings
   s3_ops_retries: 5
+  # -- list of site configuration options, check the [documentation](configuration.md#site-configuration-options) for details
   sites: {}
 
 secret:
+  # -- k8s secret name containing `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`, this needed only if you want to create the secret separately
   name: ""
+  # -- AWS access Key ID, omit if you want to create the secret separately
   AWS_ACCESS_KEY_ID: ""
+  # -- AWS secret access key, omit if you want to create the secret separately
   AWS_SECRET_ACCESS_KEY: ""
 
+# -- the pod [volumes](https://kubernetes.io/docs/concepts/storage/volumes/) definitions
 volumes: {}
 
+# -- the [volumeMounts](https://kubernetes.io/docs/concepts/storage/volumes/#background) definitions
 volumeMounts: {}