Skip to content

Commit 16cd206

Browse files
Bump markdownlint to latest version (#2068)
1 parent 172c361 commit 16cd206

File tree

1,190 files changed

+38724
-33963
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,190 files changed

+38724
-33963
lines changed

.devcontainer/on-create.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ scurl https://htmltest.wjdp.uk | bash
1414
sudo mv bin/htmltest /usr/local/bin
1515

1616
# markdownlint
17-
sudo npm install -g markdownlint-cli@0.26.0
17+
sudo npm install -g markdownlint-cli@0.39.0
1818

1919
# gcloud
2020
echo "deb [signed-by=/usr/share/keyrings/cloud.google.gpg] https://packages.cloud.google.com/apt cloud-sdk main" \

linkerd.io/.markdownlint.blog.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,5 @@ line_length:
99
tables: false
1010
no-trailing-punctuation:
1111
punctuation: '.,;:'
12+
no-duplicate-heading:
13+
siblings_only: true

linkerd.io/.markdownlint.yaml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,6 @@ line_length:
66
code_blocks: false
77
tables: false
88
no-trailing-punctuation:
9-
punctuation: ".,;:"
10-
no-duplicate-header: false
9+
punctuation: '.,;:'
10+
no-duplicate-heading:
11+
siblings_only: true
File renamed without changes.

linkerd.io/content/2-edge/common-errors/failfast.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,15 @@ title: Failfast
33
description: Failfast means that no endpoints are available.
44
---
55

6-
If Linkerd reports that a given service is in the _failfast_ state, it
7-
means that the proxy has determined that there are no available endpoints
8-
for that service. In this situation there's no point in the proxy trying
9-
to actually make a connection to the service - it already knows that it
10-
can't talk to it - so it reports that the service is in failfast and
11-
immediately returns an error from the proxy.
6+
If Linkerd reports that a given service is in the _failfast_ state, it means
7+
that the proxy has determined that there are no available endpoints for that
8+
service. In this situation there's no point in the proxy trying to actually make
9+
a connection to the service - it already knows that it can't talk to it - so it
10+
reports that the service is in failfast and immediately returns an error from
11+
the proxy.
1212

13-
The error will be either a 503 or a 504; see below for more information,
14-
but if you already know that the service is in failfast because you saw
15-
it in the logs, that's the important part.
13+
The error will be either a 503 or a 504; see below for more information, but if
14+
you already know that the service is in failfast because you saw it in the logs,
15+
that's the important part.
1616

17-
To get out of failfast, some endpoints for the service have to
18-
become available.
17+
To get out of failfast, some endpoints for the service have to become available.

linkerd.io/content/2-edge/common-errors/http-502.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ title: HTTP 502 Errors
33
description: HTTP 502 means connection errors between proxies.
44
---
55

6-
The Linkerd proxy will return a 502 error for connection errors between
7-
proxies. Unfortunately it's fairly common to see an uptick in 502s when
8-
first meshing a workload that hasn't previously been used with a mesh,
9-
because the mesh surfaces errors that were previously invisible!
6+
The Linkerd proxy will return a 502 error for connection errors between proxies.
7+
Unfortunately it's fairly common to see an uptick in 502s when first meshing a
8+
workload that hasn't previously been used with a mesh, because the mesh surfaces
9+
errors that were previously invisible!
1010

1111
There's actually a whole page on [debugging 502s](../tasks/debugging-502s/).

linkerd.io/content/2-edge/common-errors/http-503-504.md

Lines changed: 16 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,25 +3,23 @@ title: HTTP 503 and 504 Errors
33
description: HTTP 503 and 504 mean overloaded workloads.
44
---
55

6-
503s and 504s show up when a Linkerd proxy is trying to make so many
7-
requests to a workload that it gets overwhelmed.
6+
503s and 504s show up when a Linkerd proxy is trying to make so many requests to
7+
a workload that it gets overwhelmed.
88

9-
When the workload next to a proxy makes a request, the proxy adds it
10-
to an internal dispatch queue. When things are going smoothly, the
11-
request is pulled from the queue and dispatched almost immediately.
12-
If the queue gets too long, though (which can generally happen only
13-
if the called service is slow to respond), the proxy will go into
14-
_load-shedding_, where any new request gets an immediate 503. The
15-
proxy can only get _out_ of load-shedding when the queue shrinks.
9+
When the workload next to a proxy makes a request, the proxy adds it to an
10+
internal dispatch queue. When things are going smoothly, the request is pulled
11+
from the queue and dispatched almost immediately. If the queue gets too long,
12+
though (which can generally happen only if the called service is slow to
13+
respond), the proxy will go into _load-shedding_, where any new request gets an
14+
immediate 503. The proxy can only get _out_ of load-shedding when the queue
15+
shrinks.
1616

17-
Failfast also plays a role here: if the proxy puts a service into
18-
failfast while there are requests in the dispatch queue, all the
19-
requests in the dispatch queue get an immediate 504 before the
20-
proxy goes into load-shedding.
17+
Failfast also plays a role here: if the proxy puts a service into failfast while
18+
there are requests in the dispatch queue, all the requests in the dispatch queue
19+
get an immediate 504 before the proxy goes into load-shedding.
2120

22-
To get out of failfast, some endpoints for the service have to
23-
become available.
21+
To get out of failfast, some endpoints for the service have to become available.
2422

25-
To get out of load-shedding, the dispatch queue has to start
26-
emptying, which implies that the service has to get more capacity
27-
to process requests or that the incoming request rate has to drop.
23+
To get out of load-shedding, the dispatch queue has to start emptying, which
24+
implies that the service has to get more capacity to process requests or that
25+
the incoming request rate has to drop.
Lines changed: 23 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,37 @@
11
---
22
title: Protocol Detection Errors
3-
description: Protocol detection errors indicate that Linkerd doesn't understand the
3+
description:
4+
Protocol detection errors indicate that Linkerd doesn't understand the
45
protocol in use.
56
---
67

78
Linkerd is capable of proxying all TCP traffic, including TLS connections,
8-
WebSockets, and HTTP tunneling. In most cases where the client speaks first
9-
when a new connection is made, Linkerd can detect the protocol in use,
10-
allowing it to perform per-request routing and metrics.
9+
WebSockets, and HTTP tunneling. In most cases where the client speaks first when
10+
a new connection is made, Linkerd can detect the protocol in use, allowing it to
11+
perform per-request routing and metrics.
1112

12-
If your proxy logs contain messages like `protocol detection timed out after
13-
10s`, or you're experiencing 10-second delays when establishing connections,
14-
you're probably running a situation where Linkerd cannot detect the protocol.
15-
This is most common for protocols where the server speaks first, and the
16-
client is waiting for information from the server. It may also occur with
17-
non-HTTP protocols for which Linkerd doesn't yet understand the wire format of
18-
a request.
13+
If your proxy logs contain messages like
14+
`protocol detection timed out after 10s`, or you're experiencing 10-second
15+
delays when establishing connections, you're probably running a situation where
16+
Linkerd cannot detect the protocol. This is most common for protocols where the
17+
server speaks first, and the client is waiting for information from the server.
18+
It may also occur with non-HTTP protocols for which Linkerd doesn't yet
19+
understand the wire format of a request.
1920

2021
You'll need to understand exactly what the situation is to fix this:
2122

22-
- A server-speaks-first protocol will probably need to be configured as a
23-
`skip` or `opaque` port, as described in the [protocol detection
24-
documentation](../features/protocol-detection/#configuring-protocol-detection).
23+
- A server-speaks-first protocol will probably need to be configured as a `skip`
24+
or `opaque` port, as described in the
25+
[protocol detection documentation](../features/protocol-detection/#configuring-protocol-detection).
2526

26-
- If you're seeing transient protocol detection timeouts, this is more likely
27-
to indicate a misbehaving workload.
27+
- If you're seeing transient protocol detection timeouts, this is more likely to
28+
indicate a misbehaving workload.
2829

29-
- If you know the protocol is client-speaks-first but you're getting
30-
consistent protocol detection timeouts, you'll probably need to fall back on
31-
a `skip` or `opaque` port.
30+
- If you know the protocol is client-speaks-first but you're getting consistent
31+
protocol detection timeouts, you'll probably need to fall back on a `skip` or
32+
`opaque` port.
3233

33-
Note that marking ports as `skip` or `opaque` has ramifications beyond
34-
protocol detection timeouts; see the [protocol detection
35-
documentation](../features/protocol-detection/#configuring-protocol-detection)
34+
Note that marking ports as `skip` or `opaque` has ramifications beyond protocol
35+
detection timeouts; see the
36+
[protocol detection documentation](../features/protocol-detection/#configuring-protocol-detection)
3637
for more information.

linkerd.io/content/2-edge/features/access-logging.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,17 @@ configures access logging.
1313

1414
HTTP access logging is disabled by default because it has a performance impact,
1515
compared to proxies without access logging enabled. Enabling access logging may
16-
increase tail latency and CPU consumption under load. The severity of
17-
this performance cost may vary depending on the traffic being proxied, and may
18-
be acceptable in some environments.
16+
increase tail latency and CPU consumption under load. The severity of this
17+
performance cost may vary depending on the traffic being proxied, and may be
18+
acceptable in some environments.
1919

2020
{{< note >}}
21+
2122
The proxy's HTTP access log is distinct from proxy debug logging, which is
22-
configured separately. See the documentation on [modifying the proxy log
23-
level](../tasks/modifying-proxy-log-level/) for details on configuring the
24-
proxy's debug logging.
23+
configured separately. See the documentation on
24+
[modifying the proxy log level](../tasks/modifying-proxy-log-level/) for details
25+
on configuring the proxy's debug logging.
26+
2527
{{< /note >}}
2628

2729
## Access Log Formats
@@ -30,8 +32,9 @@ The value of the `config.linkerd.io/access-log` annotation determines the format
3032
of HTTP access log entries, and can be either "apache" or "json".
3133

3234
Setting the `config.linkerd.io/access-log: "apache"` annotation configures the
33-
proxy to emit HTTP access logs in the [Apache Common Log
34-
Format](https://en.wikipedia.org/wiki/Common_Log_Format). For example:
35+
proxy to emit HTTP access logs in the
36+
[Apache Common Log Format](https://en.wikipedia.org/wiki/Common_Log_Format). For
37+
example:
3538

3639
```text {class=disable-copy}
3740
10.42.0.63:51160 traffic.booksapp.serviceaccount.identity.linkerd.cluster.local - [2022-08-23T20:28:20.071809491Z] "GET http://webapp:7000/ HTTP/2.0" 200
@@ -57,6 +60,7 @@ to emit access logs in a JSON format. For example:
5760
The HTTP access log is written to the proxy container's `stderr` stream, while
5861
the proxy's standard debug logging is written to the proxy container's `stdout`
5962
stream. Currently, the `kubectl logs` command will always output both the
60-
container's `stdout` and `stderr` streams. However, [KEP
61-
3289](https://github.com/kubernetes/enhancements/pull/3289) will add support for
62-
separating a container's `stdout` or `stderr` in the `kubectl logs` command.
63+
container's `stdout` and `stderr` streams. However,
64+
[KEP 3289](https://github.com/kubernetes/enhancements/pull/3289) will add
65+
support for separating a container's `stdout` or `stderr` in the `kubectl logs`
66+
command.

0 commit comments

Comments
 (0)