Skip to content

Commit

Permalink
docs: add port wait info to service config docs (#2151)
Browse files Browse the repository at this point in the history
## Description:
Received feedback that it's not clear port ready checks are performed on
service ports. While the info exists in `PortSpec` docs, this adds the
info to `ServiceConfig` which is the most commonly referenced doc for
new users.

## Is this change user facing?
YES
  • Loading branch information
tedim52 authored Feb 12, 2024
1 parent d2cac10 commit 431396f
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions docs/docs/api-reference/starlark-reference/service-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,10 @@ config = ServiceConfig(
flake_output = "containerImage",
)

# The ports that the container should listen on, identified by a user-friendly ID that can be used to select the port again in the future.
# If no ports are provided, no ports will be exposed on the host machine, unless there is an EXPOSE in the Dockerfile
# The ports that the container should listen on, identified by a user-friendly ID that can be used to select the port again in the future.
# Kurtosis will automatically perform a check to ensure all declared UDP and TCP ports are open and ready for traffic and connections upon startup.
# You may specify a custom wait timeout duration or disable the feature entirely, learn more via PortSpec docs
# If no ports are provided, no ports will be exposed on the host machine, unless there is an EXPOSE in the Dockerfile.
# OPTIONAL (Default: {})
ports = {
"grpc": PortSpec(
Expand Down

0 comments on commit 431396f

Please sign in to comment.