Documentation for named ports. #1092
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 tasks
bcreane
reviewed
Sep 7, 2017
_includes/master/endpointport.md
Outdated
|
|
||
| | Field | Description | Accepted Values | Schema | Default | | ||
| |-------------|----------------------------------|-------------------|--------|------------| | ||
| | name | The name to attach to this port, alowing it to be referred to in [policy rules](./policy#entityrule). Names must be unique within an endpoint. | | string | | |
nelljerram
requested changes
Sep 8, 2017
_includes/master/endpointport.md
Outdated
| @@ -0,0 +1,13 @@ | |||
| An EndpointPort associates a name with a particular TCP/UDP port of the endpoint, allowing it to | |||
| be referenced as a named port in [policy rules]({{site.baseurl}}/{{page.version}}/reference/calicoctl/resources/policy#entityrule). | |||
There was a problem hiding this comment.
Does this link render correctly with a space (apparently) between the ] and the ( ? It's a useful TIL if so!
There was a problem hiding this comment.
No, there's no space, it's just how github renders it if the window is too small.
_includes/master/endpointport.md
Outdated
|
|
||
| | Field | Description | Accepted Values | Schema | Default | | ||
| |-------------|----------------------------------|-------------------|--------|------------| | ||
| | name | The name to attach to this port, allowing it to be referred to in [policy rules](./policy#entityrule). Names must be unique within an endpoint. | | string | | |
There was a problem hiding this comment.
If this shorter link works, can we use that above as well?
_includes/master/endpointport.md
Outdated
| > ** NOTE ** | ||
| > | ||
| > On their own, EndpointPort entries don't result in any change to the connectivity of the port. | ||
| > They only have an effect if they are referred to in policy. |
There was a problem hiding this comment.
Please adapt this according to current master, where the standard Note formatting has slightly changed. (E.g. look for alert-info in master/getting-started/bare-metal/bare-metal.md.)
_includes/master/ports.md
Outdated
| > Since each named port may refer to many endpoints (and Calico has to expand a named port into | ||
| > a set of endpoint/port combinations), using a named port is considerably more expensive in terms | ||
| > of CPU than using a simple numeric port. We recommend that they are used sparingly, only where | ||
| > the extra indirection is required. |
There was a problem hiding this comment.
Another Note to adapt to latest standard.
fasaxc
changed the title
nelljerram
approved these changes
Oct 13, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Add documentation for the new named ports feature projectcalico/felix#1534
Todos
Release Note