diff --git a/charts/ziti-controller/README.md b/charts/ziti-controller/README.md index a5977e13c..6d2bd9f9a 100644 --- a/charts/ziti-controller/README.md +++ b/charts/ziti-controller/README.md @@ -166,12 +166,12 @@ ctrlPlane: ## Extra Security for the Management API -You can split the client and management APIs into separate cluster services by setting `managementApi.service.enabled=true`. With this configuration, you'll have an additional cluster service named `{release}-mgmt` that is the management API, and the client API will not have management features. +You can split the client and management APIs into separate cluster services by setting `managementApi.service.enabled=true`. With this configuration, you'll have an additional cluster service named `{release}-mgmt` that is the management API, and the client API will not have management features. -This Helm chart's values allow for both operational scenarios: combined and split. The default choice is to expose the combined client and management APIs as the cluster service named `{release}-client`, which is convenient because you can use the `ziti` CLI immediately. For additional security, you may shelter the management API by splitting these two sets of features, exposing them as separate API servers. After the split, you can access the management API in several ways: +This Helm chart's values allow for both operational scenarios: combined and split. The default choice is to expose the combined client and management APIs as the cluster service named `{release}-client`, which is convenient because you can use the `ziti` CLI immediately. For additional security, you may shelter the management API by splitting these two sets of features, exposing them as separate API servers. After the split, you can access the management API in several ways: -* deploy a tunneler to bind a Ziti service targeting {release}-mgmt.{namespace}.svc:{port}. -* `kubectl -n {namespace} port-forward deployments/{release}-mgmt 8443:{port}` +* deploy a tunneler to bind a Ziti service targeting {release}-mgmt.{namespace}.svc:{port}. +* `kubectl -n {namespace} port-forward deployments/{release}-mgmt 8443:{port}` The web console (ZAC) is always bound to the same web listener as the management API, so you can access it at that `/zac/` path on the same URL. diff --git a/charts/ziti-edge-tunnel/README.md b/charts/ziti-edge-tunnel/README.md index d33ada04a..e39337bae 100644 --- a/charts/ziti-edge-tunnel/README.md +++ b/charts/ziti-edge-tunnel/README.md @@ -5,11 +5,11 @@ Dial OpenZiti services with a tunneler daemonset -**Homepage:** +**Homepage:** <https://openziti.io> ## Source Code -* +* <https://github.com/openziti/ziti-tunnel-sdk-c> ## Requirements @@ -182,7 +182,7 @@ Once the image is present on every node, you can proceed to upgrade the tunneler | imagePullSecrets | list | `[]` | | | livenessProbe.exec.command[0] | string | `"/bin/bash"` | | | livenessProbe.exec.command[1] | string | `"-c"` | | -| livenessProbe.exec.command[2] | string | `"if (ziti-edge-tunnel tunnel_status | sed -E 's/(^received\\sresponse\\s<|>$)//g' | jq '.Success'); then true; else false; fi"` | | +| livenessProbe.exec.command[2] | string | `"if (ziti-edge-tunnel tunnel_status | sed -E 's/(^received\\sresponse\\s<|>$)//g' | jq '.Success'); then true; else false; fi"` | | | livenessProbe.failureThreshold | int | `3` | | | livenessProbe.initialDelaySeconds | int | `180` | | | livenessProbe.periodSeconds | int | `60` | | diff --git a/charts/ziti-router/README.md b/charts/ziti-router/README.md index 0063e1dc3..22be46c08 100644 --- a/charts/ziti-router/README.md +++ b/charts/ziti-router/README.md @@ -320,7 +320,7 @@ identity: | tunnel.lanIf | string | `"lo"` | interface device name for setting up INPUT firewall rules if fw enabled. It must be set but not needed in containers. Thus, it is set to lo by default | | tunnel.mode | string | `"none"` | run mode for the router's built-in tunnel component: host, tproxy, proxy, or none | | tunnel.proxyAdditionalK8sServices | list | `[]` | if tunnel mode is "proxy", create a separate cluster service for each Ziti service listed in "proxyServices" which k8sService == name | -| tunnel.proxyDefaultK8sService | object | `{"enabled":true,"type":"ClusterIP"}` | if tunnel mode is "proxy", create the a cluster service named {{ release }}-proxy-default listening on each "advertisedPort" defined in "proxyServices" | +| tunnel.proxyDefaultK8sService | object | `{"enabled":true,"type":"ClusterIP"}` | if tunnel mode is "proxy", create the a cluster service named {{ release }}-proxy-default listening on each "advertisedPort" defined in "proxyServices" | | tunnel.proxyServices | list | `[]` | list of Ziti services for which K8s services are to be created by this deployment, default is one cluster service port per Ziti service | | tunnel.resolver | string | `nil` | Ziti nameserver listener where OS must be configured to send DNS queries (default: udp://127.0.0.1:53) | | websocket.enableCompression | bool | `true` | enable compression on websocket |