From 3c3b0e932cc60fc5b4521bdcfe25b211ac09f108 Mon Sep 17 00:00:00 2001 From: michalbiesek Date: Thu, 13 Apr 2023 13:31:01 +0200 Subject: [PATCH] Update `logstream-workergroup` Readme - fix typo: `documenation ==> documentation` - fix typo: `definied ==> defined` - fix order id in Prerequisites section - remove duplicate space --- helm-chart-sources/logstream-workergroup/README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/helm-chart-sources/logstream-workergroup/README.md b/helm-chart-sources/logstream-workergroup/README.md index 4a08250..6ad8ee9 100644 --- a/helm-chart-sources/logstream-workergroup/README.md +++ b/helm-chart-sources/logstream-workergroup/README.md @@ -21,7 +21,7 @@ This chart does **not** deploy a leader node – it depends on that node's alrea # Prerequisites 1. Helm (preferably v3) installed – instructions are [here](https://helm.sh/docs/intro/install/). -1. Cribl helm repo configured. To do this: +2. Cribl helm repo configured. To do this: `helm repo add cribl https://criblio.github.io/helm-charts/` # Values to Override @@ -44,8 +44,8 @@ This section covers the most likely values to override. To see the full scope of |service.loadBalancerIP|none (IP Address)|The IP address to use for the load balancer service interface, if the type is set to LoadBalancer. Check with your Kubernetes setup to see if this is supported. | |service.ports|
- name: tcpjson
  port: 10001
  protocol: TCP
- name: s2s
  port: 9997
  protocol: TCP
- name: http
  port: 10080
  protocol: TCP
- name: https
  port: 10081
  protocol: TCP
- name: syslog
  port: 5140
  protocol: TCP
- name: metrics
  port: 8125
  protocol: TCP
- name: elastic
  port: 9200
  protocol: TCP
- name: hec
  port: 8088
  protocol: TCP 
- name: criblhttp
  port: 10200
  protocol: TCP
- name: cribltcp
  port: 10300
  protocol: TCP
|The ports to make available both in the Deployment and the Service. Each "map" in the list needs the following values set:
name
A descriptive name of what the port is being used for.
port
The port to make available.
protocol
The protocol in use for this port (UDP/TCP).
| |service.annotations|{}|Annotations for the service component – this is where you'll want to put load-balancer-specific configuration directives.| -|service.externalTrafficPolicy|see `values.yaml`|Request the client source IP be preserved by setting the value to `Local`. Consult the [Kubernetes documenation](https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/#preserving-the-client-source-ip) for more information.| -|service.loadBalancerSourceRanges|see `values.yaml`|Allows for third-party load balancers to restrict access the definied IP ranges. Consult the [Kubernetes documenation](https://kubernetes.io/docs/concepts/services-networking/service/#aws-nlb-support) for more information.| +|service.externalTrafficPolicy|see `values.yaml`|Request the client source IP be preserved by setting the value to `Local`. Consult the [Kubernetes documentation](https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/#preserving-the-client-source-ip) for more information.| +|service.loadBalancerSourceRanges|see `values.yaml`|Allows for third-party load balancers to restrict access the defined IP ranges. Consult the [Kubernetes documentation](https://kubernetes.io/docs/concepts/services-networking/service/#aws-nlb-support) for more information.| |ingress|see `values.yaml`|Ingress controller configuration| |ingress.enable|false|Enable creating Ingress resources| |criblImage.tag|"3.4.0"|The container image tag to pull from. By default, this will use the version equivalent to the chart's `appVersion` value. But you can override this with "latest" to get the latest release, or with a version number (e.g., "3.4.0") to pull a specific version of Cribl Stream. | @@ -81,7 +81,7 @@ We recommend that you use the same version of the Cribl Stream code on leader n # Install -* To install the chart with the release name "logstream-wg": +* To install the chart with the release name "logstream-wg": `helm install logstream-wg cribl/logstream-workergroup`