Skip to content

Commit 2b22b08

Browse files
committed
Add README notes indicating how to deploy a service with nothing exposed
1 parent 4dcc9c8 commit 2b22b08

File tree

1 file changed

+22
-1
lines changed

1 file changed

+22
-1
lines changed

charts/k8s-service/README.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -486,6 +486,27 @@ The `/*` rule which routes to port 3000 will always be used even when accessing
486486
evaluated first when routing requests.
487487

488488

489+
## How do I deploy a worker service?
490+
491+
Worker services typically do not have a RPC or web server interface to access it. Instead, worker services act on their
492+
own and typically reach out to get the data they need. These services should be deployed without any ports exposed.
493+
However, by default `k8s-service` will deploy an internally exposed service with port 80 open.
494+
495+
To disable the default port, you can use the following `values.yaml` inputs:
496+
497+
```
498+
containerPorts:
499+
http:
500+
disabled: true
501+
502+
service:
503+
enabled: false
504+
```
505+
506+
This will override the default settings such that only the `Deployment` resource is created, with no ports exposed on
507+
the container.
508+
509+
489510
## How do I check the status of the rollout?
490511

491512
This Helm Chart packages your application into a `Deployment` controller. The `Deployment` controller will be
@@ -1013,7 +1034,7 @@ spec:
10131034
spec:
10141035
containers:
10151036
... The first entry relates to the application ...
1016-
- name: datadog
1037+
- name: datadog
10171038
image: datadog/agent:latest
10181039
env:
10191040
- name: DD_API_KEY

0 commit comments

Comments
 (0)