add readme

zerotier · Jan 17, 2024 · fb55672 · fb55672
1 parent 5ebbdd5
commit fb55672
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 4 deletions.
diff --git a/charts/zerotier-ingress-helm/Chart.yaml b/charts/zerotier-ingress-helm/Chart.yaml
@@ -1,6 +1,6 @@
 apiVersion: v2
 name: zerotier-ingress-helm
-description: A Helm chart for Kubernetes
+description: A Helm chart to connect to private services in your Kubernetes cluster via ZeroTier
 
 # A chart can be either an 'application' or a 'library' chart.
 #
@@ -15,7 +15,7 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.1.0
+version: 0.1.1
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to

diff --git a/charts/zerotier-ingress-helm/README.md b/charts/zerotier-ingress-helm/README.md
@@ -0,0 +1,22 @@
+# ZeroTier Ingress Helm
+
+This chart enables connections to private services running inside your Kubernetes cluster over ZeroTierby combining an instance of ZeroTier with an instance of Nginx.
+
+## Adding the chart
+
+```
+helm repo add zerotier https://zerotier.github.io/helm-charts
+```
+
+## Configuring the Chart
+
+Create your values.yaml file.  The following fields are required:
+
+| Field Name | Description |
+| ---------- | ----------- |
+| nginx.listenPort | The port Nginx is configured to listen on (default 8000) |
+| nginx.proxyAddress | The URL of the upstream service.  (ex: `http://my-service.my-namespace.svc.cluster.local:1234`) |
+| zerotier.identity.public | The public ZeroTier identity. Use `zerotier-idtool` to generate an identity on a per-ingress basis.|
+| zerotier.identity.secret | The secret ZeroTier identity. Use `zerotier-idtool` to generate an identity on a per-ingress basis.|
+| zerotier.networkID | The network ID the ZeroTier instance will connect to. |
+
diff --git a/charts/zerotier-ingress-helm/values.yaml b/charts/zerotier-ingress-helm/values.yaml
@@ -9,7 +9,7 @@ nginx:
     # Overrides the image tag whose default is the chart appVersion.
     tag: ""
 
-  listenPort: 8080
+  listenPort: 8000
   # Set the proxy address
   # this should be the full host/port combination:  http://someservice.mynamespace.svc.cluster.local:1234
   proxyAddress: ""
@@ -37,7 +37,7 @@ zerotier:
   image:
     repository: zerotier/zerotier
     pullPolicy: IfNotPresent
-    tag: "1.12.2"
+    tag: ""
 
   # ZeroTier Identity
   # Create these values with `zerotier-idtool`