Merge pull request #111 from sagikazarmark/improve-sftpgo-ingress-docs

Improve sftpgo ingress docs
sagikazarmark · Jul 31, 2021 · 154c80e · 154c80e
2 parents f0f9e0c + 07e5b16
commit 154c80e
Show file tree

Hide file tree

Showing 3 changed files with 46 additions and 41 deletions.
diff --git a/charts/sftpgo/Chart.yaml b/charts/sftpgo/Chart.yaml
@@ -1,7 +1,7 @@
 apiVersion: v2
 type: application
 name: sftpgo
-version: 0.9.0
+version: 0.9.1
 appVersion: 2.1.0
 kubeVersion: ">=1.16.0-0"
 description: Fully featured and highly configurable SFTP server with optional FTP/S and WebDAV support.
@@ -19,8 +19,8 @@ maintainers:
     url: https://sagikazarmark.hu
 annotations:
   artifacthub.io/changes: |
-    - kind: added
-      description: Support for topology spread constraints
+    - kind: changed
+      description: Improved documentation
   artifacthub.io/images: |
     - name: sftpgo
       image: ghcr.io/drakkan/sftpgo:v2.1.0

diff --git a/charts/sftpgo/README.md b/charts/sftpgo/README.md
@@ -1,6 +1,6 @@
 # sftpgo
 
-![version: 0.9.0](https://img.shields.io/badge/version-0.9.0-informational?style=flat-square) ![type: application](https://img.shields.io/badge/type-application-informational?style=flat-square) ![app version: 2.1.0](https://img.shields.io/badge/app%20version-2.1.0-informational?style=flat-square) ![kube version: >=1.16.0-0](https://img.shields.io/badge/kube%20version->=1.16.0--0-informational?style=flat-square) [![artifact hub](https://img.shields.io/badge/artifact%20hub-sftpgo-informational?style=flat-square)](https://artifacthub.io/packages/helm/sagikazarmark/sftpgo)
+![version: 0.9.1](https://img.shields.io/badge/version-0.9.1-informational?style=flat-square) ![type: application](https://img.shields.io/badge/type-application-informational?style=flat-square) ![app version: 2.1.0](https://img.shields.io/badge/app%20version-2.1.0-informational?style=flat-square) ![kube version: >=1.16.0-0](https://img.shields.io/badge/kube%20version->=1.16.0--0-informational?style=flat-square) [![artifact hub](https://img.shields.io/badge/artifact%20hub-sftpgo-informational?style=flat-square)](https://artifacthub.io/packages/helm/sagikazarmark/sftpgo)
 
 Fully featured and highly configurable SFTP server with optional FTP/S and WebDAV support.
 
@@ -136,16 +136,16 @@ require at least one port.
 | service.ports.http.nodePort | int | `nil` | REST API node port (when applicable). |
 | service.externalTrafficPolicy | string | `nil` | Route external traffic to node-local or cluster-wide endoints. Useful for [preserving the client source IP](https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/#preserving-the-client-source-ip). |
 | services | object | `{}` | Additional services exposing servers (SFTP, FTP, WebDAV, HTTP) individually. The schema matches the one under the `service` key. Additional services need at least one port. |
-| ui.ingress.enabled | bool | `false` | Create an Ingress for the user and admin Web UI. |
-| ui.ingress.className | string | `""` | Ingress class name. See [Kubernetes Ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/) for details. |
-| ui.ingress.annotations | object | `{}` | Annotations to be added to the Ingress. |
-| ui.ingress.hosts | list | `[]` | List of virtual hosts. See [Kubernetes Ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/) for details. |
-| ui.ingress.tls | list | `[]` | List of TLS secrets. See [Kubernetes Ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/) for details. |
-| api.ingress.enabled | bool | `false` | Create an Ingress for the API and health endpoint. |
-| api.ingress.className | string | `""` | Ingress class name. See [Kubernetes Ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/) for details. |
-| api.ingress.annotations | object | `{}` | Annotations to be added to the Ingress. |
-| api.ingress.hosts | list | `[]` | List of virtual hosts. See [Kubernetes Ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/) for details. sftpgo does not change the path for the API endpoint if httpd.web_root is set. So, we need to rewrite to the root path. |
-| api.ingress.tls | list | `[]` | List of TLS secrets. See [Kubernetes Ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/) for details. |
+| ui.ingress.enabled | bool | `false` | Enable [ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/). |
+| ui.ingress.className | string | `""` | Ingress [class name](https://kubernetes.io/docs/concepts/services-networking/ingress/#ingress-class). |
+| ui.ingress.annotations | object | `{}` | Annotations to be added to the ingress. |
+| ui.ingress.hosts | list | See [values.yaml](values.yaml). | Ingress host configuration. |
+| ui.ingress.tls | list | See [values.yaml](values.yaml). | Ingress TLS configuration. |
+| api.ingress.enabled | bool | `false` | Enable [ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/). |
+| api.ingress.className | string | `""` | Ingress [class name](https://kubernetes.io/docs/concepts/services-networking/ingress/#ingress-class). |
+| api.ingress.annotations | object | `{}` | Annotations to be added to the ingress. |
+| api.ingress.hosts | list | See [values.yaml](values.yaml). | Ingress host configuration. |
+| api.ingress.tls | list | See [values.yaml](values.yaml). | Ingress TLS configuration. |
 | resources | object | No requests or limits. | Container resource [requests and limits](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/). See the [API reference](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#resources) for details. |
 | autoscaling | object | Disabled by default. | Autoscaling configuration (see [values.yaml](values.yaml) for details). |
 | nodeSelector | object | `{}` | [Node selector](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector) configuration. |

diff --git a/charts/sftpgo/values.yaml b/charts/sftpgo/values.yaml
@@ -164,54 +164,59 @@ services: {}
   #   externalTrafficPolicy:
 
 ui:
-  # Ingress for the Web UIs (user and admin interface)
   ingress:
-    # -- Create an Ingress for the user and admin Web UI.
+    # -- Enable [ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/).
     enabled: false
-    # -- Ingress class name. See [Kubernetes Ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/) for details.
+
+    # -- Ingress [class name](https://kubernetes.io/docs/concepts/services-networking/ingress/#ingress-class).
     className: ""
-    # -- Annotations to be added to the Ingress.
+
+    # -- Annotations to be added to the ingress.
     annotations: {}
       # kubernetes.io/ingress.class: nginx
       # kubernetes.io/tls-acme: "true"
 
-    # -- List of virtual hosts. See [Kubernetes Ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/) for details.
-    hosts: []
-    #  - host: chart-example.local
-    #    # Change httpd.web_root in the sftpgo configuration if you change the path
-    #    paths:
-    #      - path: /
-    #        pathType: ImplementationSpecific
-
-    # -- List of TLS secrets. See [Kubernetes Ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/) for details.
+    # -- Ingress host configuration.
+    # @default -- See [values.yaml](values.yaml).
+    hosts:
+      - host: chart-example.local
+        # Change httpd.web_root in the sftpgo configuration if you change the path
+        paths:
+          - path: /
+            pathType: ImplementationSpecific
+
+    # -- Ingress TLS configuration.
+    # @default -- See [values.yaml](values.yaml).
     tls: []
     #  - secretName: chart-example-tls
     #    hosts:
     #      - chart-example.local
 
 api:
-  # Ingress for the API endpoint
   ingress:
-    # -- Create an Ingress for the API and health endpoint.
+    # -- Enable [ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/).
     enabled: false
-    # -- Ingress class name. See [Kubernetes Ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/) for details.
+
+    # -- Ingress [class name](https://kubernetes.io/docs/concepts/services-networking/ingress/#ingress-class).
     className: ""
-    # -- Annotations to be added to the Ingress.
+
+    # -- Annotations to be added to the ingress.
     annotations: {}
       # nginx.ingress.kubernetes.io/rewrite-target: /$1
       # kubernetes.io/ingress.class: nginx
       # kubernetes.io/tls-acme: "true"
 
-    # -- List of virtual hosts. See [Kubernetes Ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/) for details.
-
-    # sftpgo does not change the path for the API endpoint if httpd.web_root is set. So, we need to rewrite to the root path.
-    hosts: []
-    #  - host: chart-example.local
-    #    paths:
-    #      - path: /api/(.*)
-    #        pathType: ImplementationSpecific
-
-    # -- List of TLS secrets. See [Kubernetes Ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/) for details.
+    # -- Ingress host configuration.
+    # @default -- See [values.yaml](values.yaml).
+    hosts:
+      - host: chart-example.local
+        # SFTPGo does not change the path for the API endpoint if httpd.web_root is set. So, we need to rewrite to the root path.
+        paths:
+          - path: /api/(.*)
+            pathType: ImplementationSpecific
+
+    # -- Ingress TLS configuration.
+    # @default -- See [values.yaml](values.yaml).
     tls: []
     #  - secretName: chart-example-tls
     #    hosts: