Skip to content

Commit

Permalink
Merge pull request #129 from michalbiesek/readme-update
Browse files Browse the repository at this point in the history
Update `logstream-workergroup` Readme
  • Loading branch information
bdalpe authored Apr 13, 2023
2 parents 49d08bf + 17b19ca commit 2683dfc
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions helm-chart-sources/logstream-workergroup/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/`

# <span id="values"> Values to Override </span>
Expand All @@ -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|<pre>- name: tcpjson<br> port: 10001<br> protocol: TCP<br>- name: s2s<br> port: 9997<br> protocol: TCP<br>- name: http<br> port: 10080<br> protocol: TCP<br>- name: https<br> port: 10081<br> protocol: TCP<br>- name: syslog<br> port: 5140<br> protocol: TCP<br>- name: metrics<br> port: 8125<br> protocol: TCP<br>- name: elastic<br> port: 9200<br> protocol: TCP<br>- name: hec<br> port: 8088<br> protocol: TCP <br>- name: criblhttp<br> port: 10200<br> protocol: TCP<br>- name: cribltcp<br> port: 10300<br> protocol: TCP</pre>|The ports to make available both in the Deployment and the Service. Each "map" in the list needs the following values set: <dl><dt>name</dt><dd>A descriptive name of what the port is being used for.</dd><dt>port</dt><dd>The port to make available.</dd><dt>protocol</dt><dd>The protocol in use for this port (UDP/TCP).</dd></dl>|
|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. |
Expand Down Expand Up @@ -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`

Expand Down

0 comments on commit 2683dfc

Please sign in to comment.