Skip to content

Commit

Permalink
docs: added docs for public ports (#2449)
Browse files Browse the repository at this point in the history
Co-authored-by: leoporoli <[email protected]>
  • Loading branch information
h4ck3rk3y and leoporoli authored May 14, 2024
1 parent f1c4d06 commit ee7a7c0
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions docs/docs/api-reference/starlark-reference/service-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,27 @@ config = ServiceConfig(
wait = "4s"
),
},

# The deterministic public ports that Kurtosis will expose from the container to the machine
# This only applies to Docker; the port ids here must be a subset of `ports`
# If no ports are provided; normal ports behavior will happen and the exposed ports will be randomly allocated
# This doesn't work on Kubernetes!!!
# OPTIONAL (Default: {})
public_ports = {
"grpc": PortSpec(
# The port number which we want to expose
# MANDATORY
number = 3000,

# Transport protocol for the port (can be either "TCP" or "UDP")
# Optional (DEFAULT:"TCP")
transport_protocol = "TCP",

# Application protocol for the port
# Optional
application_protocol = "http"
)
},

# A mapping of path_on_container_where_contents_will_be_mounted -> Directory object or file artifact name
# For more info on what a Directory object is, see below
Expand Down

0 comments on commit ee7a7c0

Please sign in to comment.