Skip to content

Commit cf17c39

Browse files
fix: add missing blank lines around shortcode alert content
Hugo requires blank lines between alert shortcode tags and their content. Without them, the alert content is not rendered correctly. Fixes #1144 Signed-off-by: Nick Nikolakakis <nicknikolakakis@gmail.com> Signed-off-by: Nick Nikolakakis <nonicked@protonmail.com>
1 parent 4caf96f commit cf17c39

28 files changed

Lines changed: 116 additions & 0 deletions

content/en/docs/v3.4/how-to-migrate.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,13 @@ etcd v2.Y releases store data in the v2store, which supports the legacy API v2.
1313
This document focus on how to migrate existing data from the v2store to the v3store. For a detailed guideline of migrating from API v2 to API v3, please refer to [Migrate applications from using API v2 to API v3](https://etcd.io/docs/v3.4/op-guide/v2-migration/).
1414

1515
{{% alert color="warning" %}}
16+
1617
⚠️ **Deprecated functionality:**
1718

1819
The `etcdctl migrate` command was removed in etcd v3.5.0 ([pull/12971](https://github.com/etcd-io/etcd/pull/12971)). If your etcd cluster is already running v3.5 or higher, you can no longer migrate v2store to v3store using this method.
1920

2021
You **must use etcdctl v3.4 or earlier** to perform the migration (View note from [CHANGELOG-3.5](https://github.com/ahrtr/etcd/blob/main/CHANGELOG/CHANGELOG-3.5.md#etcdctl-v3-3)). However please take appropriate precautions when using it, as it is no longer officially supported or tested in recent releases.
22+
2123
{{% /alert %}}
2224

2325
## Pre-requisites

content/en/docs/v3.4/op-guide/v2-migration.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,11 @@ First, all members in the etcd cluster must converge to the same state. This can
4141
Second, migrate the v2 keys into v3 with the [migrate][migrate_command] (`ETCDCTL_API=3 etcdctl migrate`) command. The migrate command writes keys in the v2 store to a user-provided transformer program and reads back transformed keys. It then writes transformed keys into the mvcc store. This usually takes at most tens of seconds.
4242

4343
{{% alert title="known issue" color="warning" %}}
44+
4445
The migrate command has a known issue that new members added after the migration do not receive existing data if no .snap file exists.
4546
The workaround is to perform a snapshot restore after the migration.
4647
For more information see [GitHub issue](https://github.com/etcd-io/etcd/issues/8804).
48+
4749
{{% /alert %}}
4850

4951
Restart the etcd members and everything should just work.

content/en/docs/v3.5/op-guide/configuration.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,13 @@ You can configure etcd through the following:
1313
- **[Configuration file](#configuration-file)**
1414

1515
{{% alert color="warning" %}}
16+
1617
<i class="fas fa-exclamation-triangle mr-1"></i> **Caution**: If you mix-and-match configuration options, then the following
1718
rules apply.
1819

1920
- Command-line flags take precedence over environment variables.
2021
- If you provide a _configuration file_ all command-line flags and environment variables are **ignored**.
22+
2123
{{% /alert %}}
2224

2325
## Command-line flags
@@ -27,10 +29,12 @@ Flags are presented below using the format `--flag-name DEFAULT_VALUE`.
2729
The list of flags provided below may not be up-to-date due to ongoing development changes. For the latest available flags, run `etcd --help` or refer to the [etcd help][].
2830

2931
{{% alert color="info" %}}
32+
3033
**Note**: For details concerning new, updated, and deprecated {{< param version >}} flags,
3134
see [CHANGELOG-{{< psubstr version 1 >}}.md][changelog].
3235

3336
[changelog]: https://github.com/etcd-io/etcd/blob/main/CHANGELOG/CHANGELOG-{{< psubstr version 1 >}}.md
37+
3438
{{% /alert %}}
3539

3640
### Member
@@ -227,7 +231,9 @@ The list of flags provided below may not be up-to-date due to ongoing developmen
227231
### v2 Proxy
228232

229233
{{% alert color="warning" %}}
234+
230235
**<i class="fas fa-exclamation-triangle mr-1"></i> Note**: flags will be deprecated in v3.6.
236+
231237
{{% /alert %}}
232238

233239

@@ -272,7 +278,9 @@ The list of flags provided below may not be up-to-date due to ongoing developmen
272278
### Unsafe features
273279

274280
{{% alert color="warning" %}}
281+
275282
**<i class="fas fa-exclamation-triangle mr-1"></i> Warning**: using unsafe features may break the guarantees given by the consensus protocol!
283+
276284
{{% /alert %}}
277285

278286
```nocode

content/en/docs/v3.5/op-guide/monitoring.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,9 @@ Now Prometheus will scrape etcd metrics every 10 seconds.
139139
There is a set of [default alerts](https://github.com/etcd-io/etcd/tree/master/contrib/mixin) for etcd v3 clusters for Prometheus.
140140

141141
{{% alert title="Note" color="info" %}}
142+
142143
Note that `job` labels may need to be adjusted to fit a particular need. The rules were written to apply to a single cluster so it is recommended to choose labels unique to a cluster.
144+
143145
{{% /alert %}}
144146

145147
### Grafana
@@ -164,7 +166,9 @@ Sample dashboard:
164166
In v3.5 etcd has added support for distributed tracing using [OpenTelemetry](https://github.com/open-telemetry).
165167

166168
{{% alert title="Note" color="info" %}}
169+
167170
This feature is still experimental and can change at any time.
171+
168172
{{% /alert %}}
169173

170174
To enable this experimental feature, pass the `--experimental-enable-distributed-tracing=true` to the etcd server, along with the `--experimental-distributed-tracing-sampling-rate=<number>` flag to choose how many samples to collect per million spans, the default sampling rate is `0`.
@@ -180,7 +184,9 @@ Configure the distributed tracing by starting etcd server with the following opt
180184
Before enabling the distributed tracing, make sure to have the OpenTelemetry endpoint, if that address differs to the default one, override with the `--experimental-distributed-tracing-address` flag. Due to OpenTelemetry having different ways of running, refer to the [collector documentation](https://opentelemetry.io/docs/collector/getting-started/) to learn more.
181185

182186
{{% alert title="Note" color="info" %}}
187+
183188
There is a resource overhead, as with any observability signal, according to our initial measurements that overhead could be between 2% - 4% CPU overhead.
189+
184190
{{% /alert %}}
185191

186192
[grafana]: http://grafana.org/

content/en/docs/v3.5/op-guide/supported-platform.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,12 +56,14 @@ prints a warning message and exits immediately unless the environment variable
5656
`ETCD_UNSUPPORTED_ARCH` is set to the target architecture.
5757

5858
{{% alert title="32-bit systems" color="warning" %}}
59+
5960
etcd has **known issues** on 32-bit systems due to a bug in the Go runtime.
6061
For more information see the [Go issue #599][go-issue] and the [atomic package
6162
bug note][go-atomic].
6263

6364
[go-atomic]: https://golang.org/pkg/sync/atomic/#pkg-note-BUG
6465
[go-issue]: https://github.com/golang/go/issues/599
66+
6567
{{% /alert %}}
6668

6769
[etcd maintainers]: https://github.com/etcd-io/etcd/blob/main/OWNERS

content/en/docs/v3.6/benchmarks/etcd-3-watch-memory-benchmark.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@ description: Performance measures for etcd watchers
55
---
66

77
{{% alert title="Note" color="info" %}}
8+
89
The watch features are under active development, and their memory usage may change as that development progresses. We do not expect it to significantly increase beyond the figures stated below.
10+
911
{{% /alert %}}
1012

1113
A primary goal of etcd is supporting a very large number of watchers doing a massively large amount of watching. etcd aims to support O(10k) clients, O(100K) watch streams (O(10) streams per client) and O(10M) total watchings (O(100) watching per stream). The memory consumed by each individual watching accounts for the largest portion of etcd's overall usage, and is therefore the focus of current and future optimizations.

content/en/docs/v3.6/downgrades/downgrade_3_5.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,9 @@ Before [starting a downgrade](#downgrade-procedure), read through the rest of th
1616
content/en/docs/v3.5/op-guide/authentication/rbac.md
1717

1818
{{% alert title="Note" color="info" %}}
19+
1920
If your cluster enables auth, rolling downgrade from 3.5 isn't supported because 3.5 [changes a format of WAL entries related to auth](https://github.com/etcd-io/etcd/pull/11943). You can follow the [authentification instructions](../../op-guide/authentication/rbac/) to disable auth, and delete all users first.
21+
2022
{{% /alert %}}
2123

2224
Highlighted breaking changes from 3.5 to 3.4:
@@ -26,7 +28,9 @@ Highlighted breaking changes from 3.5 to 3.4:
2628
If you are using any of the following flags in your 3.5 configurations, make sure to remove, rename, or change the default value when downgrading to 3.4.
2729

2830
{{% alert title="Note" color="info" %}}
31+
2932
The diff is based on version 3.5.14 and v.3.4.33. The actual diff would be dependent on your patch version, check with `diff <(etcd-3.5/bin/etcd -h | grep \\-\\-) <(etcd-3.4/bin/etcd -h | grep \\-\\-)` first.
33+
3034
{{% /alert %}}
3135

3236
```diff

content/en/docs/v3.6/downgrades/downgrade_3_6.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,9 @@ Highlighted breaking changes from v3.6 to v3.5:
2020
If you are using any of the following flags in your v3.6 configurations, make sure to remove, rename, or change the default value when downgrading to v3.5.
2121

2222
{{% alert title="Note" color="info" %}}
23+
2324
The diff is based on version v3.6.0 and v.3.5.18. The actual diff would be dependent on your patch version, check with `diff <(etcd-3.6/bin/etcd -h | grep \\-\\-) <(etcd-3.5/bin/etcd -h | grep \\-\\-)` first.
25+
2426
{{% /alert %}}
2527

2628
```diff
@@ -223,7 +225,9 @@ COMMENT
223225
```
224226

225227
{{% alert title="Note" color="info" %}}
228+
226229
Once downgrade is enabled, the cluster will remain operating with v3.5 protocol even if all the servers are still running the v3.6 binary, unless the downgrade is canceled with `etcdctl downgrade cancel`
230+
227231
{{% /alert %}}
228232

229233
#### Step 5: stop one existing etcd server
@@ -309,7 +313,9 @@ COMMENT
309313
```
310314

311315
{{% alert title="Note" color="info" %}}
316+
312317
You will see the `DOWNGRADE ENABLED` is false for the v3.5 server, because the downgrade info is not implemented in v3.5 status endpoint, downgrade is still enabled for the cluster at this point.
318+
313319
{{% /alert %}}
314320

315321
#### Step 7: repeat *step 5* and *step 6* for rest of the members

content/en/docs/v3.6/feature-gates/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,8 +103,10 @@ A *Beta* feature means:
103103
discovering new hard-to-spot bugs through wider adoption.
104104

105105
{{% alert title="Note" color="info" %}}
106+
106107
Please do try *Beta* features and give feedback on them!
107108
After they exit beta, it may not be practical for us to make more changes.
109+
108110
{{% /alert %}}
109111

110112
A *General Availability* (GA) feature is also referred to as a *stable* feature. It means:

content/en/docs/v3.6/install.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,9 @@ source by following these steps:
7272
## Installation via OS packages
7373

7474
{{% alert title="Warning" color="warning" %}}
75+
7576
etcd installations through OS package managers can deliver outdated versions since they are not being automatically maintained nor officially supported by etcd project. Therefore use OS packages with caution.*
77+
7678
{{% /alert %}}
7779

7880
There are various ways of installing etcd on different operating systems and these are just some examples how it can be done.
@@ -97,7 +99,9 @@ $ etcd --version
9799
## Linux
98100

99101
{{% alert title="Warning" color="warning" %}}
102+
100103
Although installing etcd through many major Linux distributions' official repositories and package managers is possible, the published versions can be significantly outdated. So, installing this way is strongly discouraged.
104+
101105
{{% /alert %}}
102106
103107
The recommended way to install etcd on Linux is either through [pre-built binaries](#install-pre-built-binaries) or by using Homebrew.

0 commit comments

Comments
 (0)