Skip to content
This repository has been archived by the owner on Jul 11, 2023. It is now read-only.

docs(envoy): Document ports used by envoy #2825

Merged
merged 1 commit into from
Mar 15, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 10 additions & 1 deletion docs/content/docs/application_requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,13 @@ type: docs
# Application Requirements

## Application UIDs
Do not run applications with the user ID (UID) value of **1500**. This is **reserved** for the Envoy proxy sidecar container injected into pods by OSM's sidecar injector.
Do not run applications with the user ID (UID) value of **1500**. This is **reserved** for the Envoy proxy sidecar container injected into pods by OSM's sidecar injector.

## Ports
Do not use the following ports as they are used by the Envoy sidecar.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Do not use the following ports as they are used by the Envoy sidecar.
The following ports are used by the Envoy sidecar.

Copy link
Member

Choose a reason for hiding this comment

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

@draychev, I don't agree with the suggested wording, it is rather ambiguous when this section of the doc needs to be explicit.

| Port | Description |
| ------| ----------- |
| 15000 | Envoy Admin Port |
| 15001 | Envoy Outbound Listener Port |
| 15003 | Envoy Inbound Listener Port |
| 15010 | Envoy Prometheus Inbound Listener Port |
1 change: 0 additions & 1 deletion pkg/injector/health_probes.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ import (
)

const (
// TODO(draychev): Dynamically generate init/init-iptables.sh from these constants: https://github.com/openservicemesh/osm/issues/2243
livenessProbePort = int32(15901)
readinessProbePort = int32(15902)
startupProbePort = int32(15903)
Expand Down