From 90db64f64d3f9e13a518c963dac48358bce444ef Mon Sep 17 00:00:00 2001
From: Daniel Farrell <dfarrell@redhat.com>
Date: Fri, 25 Jun 2021 14:31:51 -0400
Subject: [PATCH] Add generated docs for both Helm charts

Add docs generated by helm-docs for each chart. The docs will be kept
up-to-date with CI and the contents of the docs can be improved in
future changes to inline commenting.

Signed-off-by: Daniel Farrell <dfarrell@redhat.com>
---
 submariner-k8s-broker/README.md | 26 +++++++++++++
 submariner-operator/README.md   | 68 +++++++++++++++++++++++++++++++++
 2 files changed, 94 insertions(+)
 create mode 100644 submariner-k8s-broker/README.md
 create mode 100644 submariner-operator/README.md

diff --git a/submariner-k8s-broker/README.md b/submariner-k8s-broker/README.md
new file mode 100644
index 0000000..8ec10c4
--- /dev/null
+++ b/submariner-k8s-broker/README.md
@@ -0,0 +1,26 @@
+# submariner-k8s-broker
+
+![Version: 0.6.0](https://img.shields.io/badge/Version-0.6.0-informational?style=flat-square) ![AppVersion: 0.6.0](https://img.shields.io/badge/AppVersion-0.6.0-informational?style=flat-square)
+
+Submariner Kubernetes Broker
+
+**Homepage:** <https://submariner-io.github.io/>
+
+## Maintainers
+
+| Name | Email | Url |
+| ---- | ------ | --- |
+| Contributors to the Submariner project | submariner-dev@googlegroups.com | https://submariner.io/ |
+
+## Source Code
+
+* <https://submariner-io.github.io/submariner-charts/charts>
+
+## Values
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| crd.create | bool | `true` |  |
+| rbac.create | bool | `true` |  |
+| serviceAccounts.client.create | bool | `true` |  |
+| serviceAccounts.client.name | string | `""` |  |
diff --git a/submariner-operator/README.md b/submariner-operator/README.md
new file mode 100644
index 0000000..ffcaf72
--- /dev/null
+++ b/submariner-operator/README.md
@@ -0,0 +1,68 @@
+# submariner-operator
+
+![Version: 0.7.0](https://img.shields.io/badge/Version-0.7.0-informational?style=flat-square) ![AppVersion: 0.7.0](https://img.shields.io/badge/AppVersion-0.7.0-informational?style=flat-square)
+
+Submariner enables direct networking between Pods and Services in different Kubernetes clusters
+
+**Homepage:** <https://submariner-io.github.io/>
+
+## Maintainers
+
+| Name | Email | Url |
+| ---- | ------ | --- |
+| Contributors to the Submariner project | submariner-dev@googlegroups.com | https://submariner.io/ |
+
+## Source Code
+
+* <https://submariner-io.github.io/submariner-charts/charts>
+
+## Values
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| broker.ca | string | `""` |  |
+| broker.globalnet | bool | `false` |  |
+| broker.insecure | bool | `false` |  |
+| broker.namespace | string | `"xyz"` |  |
+| broker.server | string | `"example.k8s.apiserver"` |  |
+| broker.token | string | `"test"` |  |
+| gateway.image.repository | string | `"quay.io/submariner/submariner-gateway"` |  |
+| gateway.image.tag | string | `"0.7.0"` |  |
+| ipsec.debug | bool | `false` |  |
+| ipsec.ikePort | int | `500` |  |
+| ipsec.natPort | int | `4500` |  |
+| ipsec.psk | string | `""` |  |
+| leadership.leaseDuration | int | `10` |  |
+| leadership.renewDeadline | int | `5` |  |
+| leadership.retryPeriod | int | `2` |  |
+| operator.affinity | object | `{}` |  |
+| operator.image.pullPolicy | string | `"IfNotPresent"` |  |
+| operator.image.repository | string | `"quay.io/submariner/submariner-operator"` |  |
+| operator.image.tag | string | `"0.7.0"` |  |
+| operator.resources | object | `{}` |  |
+| operator.tolerations | list | `[]` |  |
+| rbac.create | bool | `true` |  |
+| serviceAccounts.gateway.create | bool | `true` |  |
+| serviceAccounts.gateway.name | string | `""` |  |
+| serviceAccounts.globalnet.create | bool | `true` |  |
+| serviceAccounts.globalnet.name | string | `""` |  |
+| serviceAccounts.lighthouseAgent.create | bool | `true` |  |
+| serviceAccounts.lighthouseAgent.name | string | `""` |  |
+| serviceAccounts.lighthouseCoreDns.create | bool | `true` |  |
+| serviceAccounts.lighthouseCoreDns.name | string | `""` |  |
+| serviceAccounts.operator.create | bool | `true` |  |
+| serviceAccounts.operator.name | string | `""` |  |
+| serviceAccounts.routeAgent.create | bool | `true` |  |
+| serviceAccounts.routeAgent.name | string | `""` |  |
+| submariner.cableDriver | string | `"libreswan"` |  |
+| submariner.clusterCidr | string | `""` |  |
+| submariner.clusterId | string | `""` |  |
+| submariner.colorCodes | string | `"blue"` |  |
+| submariner.debug | bool | `false` |  |
+| submariner.globalCidr | string | `""` |  |
+| submariner.images.repository | string | `"quay.io/submariner"` |  |
+| submariner.images.tag | string | `"0.7.0"` |  |
+| submariner.natEnabled | bool | `false` |  |
+| submariner.serviceCidr | string | `""` |  |
+| submariner.serviceDiscovery | bool | `true` |  |
+| submariner.token | string | `""` |  |