Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add enable option to the service configuration. #190

Merged
merged 6 commits into from
Jul 30, 2024
Merged

Add enable option to the service configuration. #190

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
44a6231
featadd option to enable or disable service creation
garrettprimm Feb 7, 2024
f97d8d1
chore: add test to confirm that the Service is not created if disabled.
garrettprimm Feb 7, 2024
1ecd03a
feat: add check to only create service if service.enable is true
gprimm-abv Feb 7, 2024
29d5813
chore: add tests to confirm service.enable behaves as intended
gprimm-abv Feb 7, 2024
8555e92
feat: add the ability to optionally create a service for a workergroup
gprimm-abv Feb 7, 2024
b7cb8c4
Update README.md for service.enable config
garrettprimm Jul 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions helm-chart-sources/logstream-workergroup/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ This section covers the most likely values to override. To see the full scope of
|config.probes|true|enables (true) or disables (false) the liveness and readiness probes.|
|config.livenessProbe|see `values.yaml`|[livenessProbe](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#define-a-liveness-http-request) configuration|
|config.readinessProbe|see `values.yaml`|[readinessProbe](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#define-readiness-probes) configuration|
|service.enable|true|Enable creating Service resources. This is only applicable for logstream-workergroup deployments.|
|service.type|LoadBalancer|The type of service to create for the workergroup|
|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>|
Expand Down
2 changes: 2 additions & 0 deletions helm-chart-sources/logstream-workergroup/templates/service.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
{{- if .Values.service.enable }}
apiVersion: v1
kind: Service
metadata:
Expand Down Expand Up @@ -30,3 +31,4 @@ spec:
{{- if .Values.service.loadBalancerSourceRanges }}
loadBalancerSourceRanges: {{- toYaml .Values.service.loadBalancerSourceRanges | nindent 4 }}
{{- end -}}
{{- end }}
14 changes: 14 additions & 0 deletions helm-chart-sources/logstream-workergroup/tests/service_test.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,3 +69,17 @@ tests:
- equal:
path: spec.ports[0].nodePort
value: 30000

- it: Should configure the service by default if enable is not set
asserts:
- hasDocuments:
count: 1

- it: Should not configure the service when service.enable is set to false
set:
service:
enable: false
asserts:
- hasDocuments:
count: 0

1 change: 1 addition & 0 deletions helm-chart-sources/logstream-workergroup/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ nodeSelector: {}
# topologySpreadConstraints: []

service:
enable: true
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we add the description of this value to helm-chart-sources/logstream-workergroup/README.md

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added config values to the readme in the logstream-workergroup as requested

type: LoadBalancer
annotations: {}
# externalTrafficPolicy: Local
Expand Down
Loading