Skip to content

Commit

Permalink
Apply misc. fixes to Server documentation (#1847)
Browse files Browse the repository at this point in the history
* Fix a typo in `Server` authorization policy docs

This applies a typo fix across the 2.12, 2.13, 2.14, 2.15, 2.16, and
2-edge docs. This removes an extra "_and_" in a sentence:

```diff
-- A `Server` describes and a set of pods, and a single port on those pods.
+- A `Server` describes a set of pods, and a single port on those pods.
```

Signed-off-by: katelyn martin <[email protected]>

* Fix broken anchor link

these `#accessPolicy` anchors don't work when clicking on the
`accessPolicy` links on the website here:
<https://linkerd.io/2.16/reference/authorization-policy/#server-spec>.

this commit fixes these links, in the `2.16` and `2-edge` docs. i did
not find this link broken elsewhere.

Signed-off-by: katelyn martin <[email protected]>

---------

Signed-off-by: katelyn martin <[email protected]>
  • Loading branch information
cratelyn committed Sep 26, 2024
1 parent 497439e commit c08a91b
Show file tree
Hide file tree
Showing 6 changed files with 8 additions and 8 deletions.
4 changes: 2 additions & 2 deletions linkerd.io/content/2-edge/reference/authorization-policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ policy in the cluster: [Server], [HTTPRoute], [ServerAuthorization],

The general pattern for authorization is:

- A `Server` describes and a set of pods, and a single port on those pods.
- A `Server` describes a set of pods, and a single port on those pods.
- Optionally, an `HTTPRoute` references that `Server` and describes a
subset of HTTP traffic to it.
- A `MeshTLSAuthentication` or `NetworkAuthentication` decribes who
Expand Down Expand Up @@ -77,7 +77,7 @@ A `Server` spec may contain the following top level fields:
{{< table >}}
| field| value |
|------|-------|
| `accessPolicy`| [accessPolicy](#accessPolicy) declares the policy applied to traffic not matching any associated authorization policies (defaults to `deny`). |
| `accessPolicy`| [accessPolicy](#accesspolicy) declares the policy applied to traffic not matching any associated authorization policies (defaults to `deny`). |
| `podSelector`| A [podSelector](#podselector) selects pods in the same namespace. |
| `port`| A port name or number. Only ports in a pod spec's `ports` are considered. |
| `proxyProtocol`| Configures protocol discovery for inbound connections. Supersedes the `config.linkerd.io/opaque-ports` annotation. Must be one of `unknown`,`HTTP/1`,`HTTP/2`,`gRPC`,`opaque`,`TLS`. Defaults to `unknown` if not set. |
Expand Down
2 changes: 1 addition & 1 deletion linkerd.io/content/2.12/reference/authorization-policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ policy in the cluster: [Server], [HTTPRoute], [ServerAuthorization],

The general pattern for authorization is:

- A `Server` describes and a set of pods, and a single port on those pods.
- A `Server` describes a set of pods, and a single port on those pods.
- Optionally, an `HTTPRoute` references that `Server` and describes a
subset of HTTP traffic to it.
- A `MeshTLSAuthentication` or `NetworkAuthentication` decribes who
Expand Down
2 changes: 1 addition & 1 deletion linkerd.io/content/2.13/reference/authorization-policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ policy in the cluster: [Server], [HTTPRoute], [ServerAuthorization],

The general pattern for authorization is:

- A `Server` describes and a set of pods, and a single port on those pods.
- A `Server` describes a set of pods, and a single port on those pods.
- Optionally, an `HTTPRoute` references that `Server` and describes a
subset of HTTP traffic to it.
- A `MeshTLSAuthentication` or `NetworkAuthentication` decribes who
Expand Down
2 changes: 1 addition & 1 deletion linkerd.io/content/2.14/reference/authorization-policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ policy in the cluster: [Server], [HTTPRoute], [ServerAuthorization],

The general pattern for authorization is:

- A `Server` describes and a set of pods, and a single port on those pods.
- A `Server` describes a set of pods, and a single port on those pods.
- Optionally, an `HTTPRoute` references that `Server` and describes a
subset of HTTP traffic to it.
- A `MeshTLSAuthentication` or `NetworkAuthentication` decribes who
Expand Down
2 changes: 1 addition & 1 deletion linkerd.io/content/2.15/reference/authorization-policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ policy in the cluster: [Server], [HTTPRoute], [ServerAuthorization],

The general pattern for authorization is:

- A `Server` describes and a set of pods, and a single port on those pods.
- A `Server` describes a set of pods, and a single port on those pods.
- Optionally, an `HTTPRoute` references that `Server` and describes a
subset of HTTP traffic to it.
- A `MeshTLSAuthentication` or `NetworkAuthentication` decribes who
Expand Down
4 changes: 2 additions & 2 deletions linkerd.io/content/2.16/reference/authorization-policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ policy in the cluster: [Server], [HTTPRoute], [ServerAuthorization],

The general pattern for authorization is:

- A `Server` describes and a set of pods, and a single port on those pods.
- A `Server` describes a set of pods, and a single port on those pods.
- Optionally, an `HTTPRoute` references that `Server` and describes a
subset of HTTP traffic to it.
- A `MeshTLSAuthentication` or `NetworkAuthentication` decribes who
Expand Down Expand Up @@ -77,7 +77,7 @@ A `Server` spec may contain the following top level fields:
{{< table >}}
| field| value |
|------|-------|
| `accessPolicy`| [accessPolicy](#accessPolicy) declares the policy applied to traffic not matching any associated authorization policies (defaults to `deny`). |
| `accessPolicy`| [accessPolicy](#accesspolicy) declares the policy applied to traffic not matching any associated authorization policies (defaults to `deny`). |
| `podSelector`| A [podSelector](#podselector) selects pods in the same namespace. |
| `port`| A port name or number. Only ports in a pod spec's `ports` are considered. |
| `proxyProtocol`| Configures protocol discovery for inbound connections. Supersedes the `config.linkerd.io/opaque-ports` annotation. Must be one of `unknown`,`HTTP/1`,`HTTP/2`,`gRPC`,`opaque`,`TLS`. Defaults to `unknown` if not set. |
Expand Down

0 comments on commit c08a91b

Please sign in to comment.