From 48726f274b0b743208c6fdf2171756561ecbcf8e Mon Sep 17 00:00:00 2001 From: Awar Abdulkarim <48431495+NotAwar@users.noreply.github.com> Date: Sun, 23 Feb 2025 20:09:34 +0100 Subject: [PATCH 1/6] fix: Update quickstart.md Signed-off-by: Awar Abdulkarim <48431495+NotAwar@users.noreply.github.com> --- content/en/docs/v3.5/quickstart.md | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/content/en/docs/v3.5/quickstart.md b/content/en/docs/v3.5/quickstart.md index a1c4f3627..dd01f3396 100644 --- a/content/en/docs/v3.5/quickstart.md +++ b/content/en/docs/v3.5/quickstart.md @@ -1,9 +1,11 @@ --- -title: Quickstart +title: Quick start weight: 900 description: Get etcd up and running in less than 5 minutes! --- +## Prerequisites + Follow these instructions to locally install, run, and test a single-member cluster of etcd: @@ -45,12 +47,16 @@ cluster of etcd: Learn about more ways to configure and use etcd from the following pages: -- Explore the gRPC [API][]. -- Set up a [multi-machine cluster][clustering]. -- Learn how to [configure][] etcd. -- Find [language bindings and tools][integrations]. -- Use TLS to [secure an etcd cluster][security]. -- [Tune etcd][tuning]. +- ### Development + +- #### Explore the gRPC [API][]. +- #### Set up a [multi-machine cluster][clustering]. +- #### Learn how to [configure][] etcd. +- #### Find [language bindings and tools][integrations]. +- #### Use TLS to [secure an etcd cluster][security]. +- #### [Tune etcd][tuning]. + +- ### Operations [api]: /docs/{{< param version >}}/learning/api [clustering]: /docs/{{< param version >}}/op-guide/clustering From cbe135eb58f38eef095be92329231064233acbdd Mon Sep 17 00:00:00 2001 From: NotAwar Date: Sun, 23 Feb 2025 20:54:46 +0100 Subject: [PATCH 2/6] fix: update quickstart.md Signed-off-by: Awar Abdulkarim <48431495+NotAwar@users.noreply.github.com> --- content/en/docs/v3.5/quickstart.md | 111 ++++++++++++++++++++--------- 1 file changed, 76 insertions(+), 35 deletions(-) diff --git a/content/en/docs/v3.5/quickstart.md b/content/en/docs/v3.5/quickstart.md index dd01f3396..c95963c50 100644 --- a/content/en/docs/v3.5/quickstart.md +++ b/content/en/docs/v3.5/quickstart.md @@ -6,57 +6,98 @@ description: Get etcd up and running in less than 5 minutes! ## Prerequisites -Follow these instructions to locally install, run, and test a single-member -cluster of etcd: +Before you begin, ensure you have the following: - 1. Install etcd from pre-built binaries or from source. For details, see - [Install][]. + 1. **etcd Installed** + Build or download etcd from [Install][] and verify that the `etcd` binary is in your system’s PATH. + {{% alert color="warning" %}}**Important**: Ensure that you perform the last + step of the installation instructions to verify that `etcd` is in your path. + {{% /alert %}} - {{% alert color="warning" %}}**Important**: Ensure that you perform the last - step of the installation instructions to verify that `etcd` is in your path. - {{% /alert %}} + 2. **Terminal Access** + You’ll need two terminal windows: one to run the etcd server and one to interact with it using `etcdctl`. - 2. Launch `etcd`: +## Getting Started - ```console - $ etcd - {"level":"info","ts":"2021-09-17T09:19:32.783-0400","caller":"etcdmain/etcd.go:72","msg":... } - ⋮ - ``` +Choose the workflow that best fits your role: - {{% alert color="info" %}}**Note**: The output produced by `etcd` are - [logs](../op-guide/configuration/#logging) — info-level logs can - be ignored. {{% /alert %}} +### Developer Workflow - 3. From **another terminal**, use `etcdctl` to set a key: +**Objective:** Quickly set up a local etcd cluster for development and testing. - ```console - $ etcdctl put greeting "Hello, etcd" - OK - ``` + 1. **Set Up a Local Cluster** + Use our [Set up a local cluster][] page to quickly spin up an etcd instance. Follow along by first launching etcd: - 4. From the same terminal, retrieve the key: + ```console + $ etcd + {"level":"info","ts":"2021-09-17T09:19:32.783-0400","caller":"etcdmain/etcd.go:72","msg":... } + ⋮ + ``` - ```console - $ etcdctl get greeting - greeting - Hello, etcd - ``` + {{% alert color="info" %}}**Note**: The output produced by `etcd` are + [logs](../op-guide/configuration/#logging) — info-level logs can + be ignored. {{% /alert %}} + + 2. **Interact with etcd** + In a separate terminal, run the following commands to set and retrieve a key: + + ```console + $ etcdctl put greeting "Hello, etcd" + OK + ``` + + ```console + $ etcdctl get greeting + greeting + Hello, etcd + ``` + + 3. **Explore the Developer Guide** + Once your local cluster is running, refer to the [Developer guide][] for integration and development tips. + +### Operator Workflow + +**Objective:** Configure and manage an etcd cluster for production. + + 1. **Install etcd** + Follow the detailed instructions in the [Install][] to install and configure etcd for production use. + + 2. **Run and Monitor etcd** + Start etcd in one terminal and review the logs to confirm it’s running properly: + + ```console + $ etcd + {"level":"info","ts":"...","msg": "..."} + ``` + + 3. **Configure and Secure etcd** + Check out the Operator Guide for steps on clustering, securing with TLS, and performance tuning. + 4. **Troubleshooting & Maintenance** + If issues arise, consult the Troubleshooting section for common problems and solutions. ## What's next? Learn about more ways to configure and use etcd from the following pages: -- ### Development +- ### **Development:** + +Continue with the [Developer guide][], which includes the [Set up a local cluster][] page, [API][] references, and integration examples. + +- #### Explore the gRPC [API][] + +- #### Find [language bindings and tools][integrations] + +- ### **Operations:** + +Proceed to the [Operations guide][] for advanced configuration, clustering, security, and performance tuning. + +- #### Set up a [multi-machine cluster][clustering] + +- #### Use TLS to [secure an etcd cluster][security] -- #### Explore the gRPC [API][]. -- #### Set up a [multi-machine cluster][clustering]. -- #### Learn how to [configure][] etcd. -- #### Find [language bindings and tools][integrations]. -- #### Use TLS to [secure an etcd cluster][security]. -- #### [Tune etcd][tuning]. +- #### [Tune etcd][tuning] -- ### Operations +- #### Learn how to [configure][] etcd [api]: /docs/{{< param version >}}/learning/api [clustering]: /docs/{{< param version >}}/op-guide/clustering From eb99def62cc448bec6d9c18f701beb6942f7bd98 Mon Sep 17 00:00:00 2001 From: Awar Abdulkarim <48431495+NotAwar@users.noreply.github.com> Date: Thu, 27 Feb 2025 20:12:19 +0100 Subject: [PATCH 3/6] fix: Update quickstart.md based on feedback Signed-off-by: Awar Abdulkarim <48431495+NotAwar@users.noreply.github.com> --- content/en/docs/v3.5/quickstart.md | 35 ++++++++++++++---------------- 1 file changed, 16 insertions(+), 19 deletions(-) diff --git a/content/en/docs/v3.5/quickstart.md b/content/en/docs/v3.5/quickstart.md index c95963c50..2cb596240 100644 --- a/content/en/docs/v3.5/quickstart.md +++ b/content/en/docs/v3.5/quickstart.md @@ -10,9 +10,6 @@ Before you begin, ensure you have the following: 1. **etcd Installed** Build or download etcd from [Install][] and verify that the `etcd` binary is in your system’s PATH. - {{% alert color="warning" %}}**Important**: Ensure that you perform the last - step of the installation instructions to verify that `etcd` is in your path. - {{% /alert %}} 2. **Terminal Access** You’ll need two terminal windows: one to run the etcd server and one to interact with it using `etcdctl`. @@ -34,10 +31,6 @@ Choose the workflow that best fits your role: ⋮ ``` - {{% alert color="info" %}}**Note**: The output produced by `etcd` are - [logs](../op-guide/configuration/#logging) — info-level logs can - be ignored. {{% /alert %}} - 2. **Interact with etcd** In a separate terminal, run the following commands to set and retrieve a key: @@ -71,7 +64,8 @@ Choose the workflow that best fits your role: ``` 3. **Configure and Secure etcd** - Check out the Operator Guide for steps on clustering, securing with TLS, and performance tuning. + Check out the [Operations guide][] for steps on [clustering][], securing with TLS, and performance tuning. + 4. **Troubleshooting & Maintenance** If issues arise, consult the Troubleshooting section for common problems and solutions. @@ -79,30 +73,33 @@ Choose the workflow that best fits your role: Learn about more ways to configure and use etcd from the following pages: -- ### **Development:** +### **Development:** + +Continue with the [Developer guide][dev-guide], which includes the [Set up a local cluster][] page, [API][] references, and integration examples. -Continue with the [Developer guide][], which includes the [Set up a local cluster][] page, [API][] references, and integration examples. +- Explore the gRPC [API][] -- #### Explore the gRPC [API][] +- Find [language bindings and tools][integrations] -- #### Find [language bindings and tools][integrations] +### **Operations:** -- ### **Operations:** +Proceed to the [Operations guide][op-guide] for advanced configuration, clustering, security, and performance tuning. -Proceed to the [Operations guide][] for advanced configuration, clustering, security, and performance tuning. +- Set up a [multi-machine cluster][clustering] -- #### Set up a [multi-machine cluster][clustering] +- Use TLS to [secure an etcd cluster][security] -- #### Use TLS to [secure an etcd cluster][security] +- [Tune etcd][tuning] -- #### [Tune etcd][tuning] +- Learn how to [configure][] etcd -- #### Learn how to [configure][] etcd -[api]: /docs/{{< param version >}}/learning/api +[API]: /docs/{{< param version >}}/learning/api [clustering]: /docs/{{< param version >}}/op-guide/clustering [configure]: /docs/{{< param version >}}/op-guide/configuration [integrations]: /docs/{{< param version >}}/integrations [security]: /docs/{{< param version >}}/op-guide/security [tuning]: /docs/{{< param version >}}/tuning [Install]: ../install/ +[dev-guide]: /docs/{{< param version >}}/dev-guide +[op-guide]: /docs/{{< param version >}}/op-guide From 09cf698b70fad70a105ac56808a2ce4dd13f74a6 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 24 Feb 2025 16:03:36 +0000 Subject: [PATCH 4/6] Bump hugo-extended from 0.143.1 to 0.144.2 Bumps [hugo-extended](https://github.com/jakejarvis/hugo-extended) from 0.143.1 to 0.144.2. - [Commits](https://github.com/jakejarvis/hugo-extended/compare/v0.143.1...v0.144.2) --- updated-dependencies: - dependency-name: hugo-extended dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Signed-off-by: Awar Abdulkarim <48431495+NotAwar@users.noreply.github.com> --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index f7320b5f3..4080918d1 100644 --- a/package.json +++ b/package.json @@ -19,7 +19,7 @@ "devDependencies": { "autoprefixer": "^10.4.20", "docsy": "github:google/docsy#semver:0.11.0", - "hugo-extended": "0.143.1", + "hugo-extended": "0.144.2", "mkdirp": "^3.0.1", "netlify-cli": "^18.0.1", "postcss": "^8.5.1", From 383a9abc52dee6edd3e1473ca09ae3c6c8740baa Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 25 Feb 2025 03:11:40 +0000 Subject: [PATCH 5/6] Bump netlify-cli from 18.1.0 to 19.0.0 Bumps [netlify-cli](https://github.com/netlify/cli) from 18.1.0 to 19.0.0. - [Release notes](https://github.com/netlify/cli/releases) - [Changelog](https://github.com/netlify/cli/blob/main/CHANGELOG.md) - [Commits](https://github.com/netlify/cli/compare/v18.1.0...v19.0.0) --- updated-dependencies: - dependency-name: netlify-cli dependency-type: direct:development update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] Signed-off-by: Awar Abdulkarim <48431495+NotAwar@users.noreply.github.com> --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 4080918d1..d9933ff87 100644 --- a/package.json +++ b/package.json @@ -21,7 +21,7 @@ "docsy": "github:google/docsy#semver:0.11.0", "hugo-extended": "0.144.2", "mkdirp": "^3.0.1", - "netlify-cli": "^18.0.1", + "netlify-cli": "^19.0.0", "postcss": "^8.5.1", "postcss-cli": "^11.0.0" } From 621363244cffffd0787eef3ba39699214c483ffb Mon Sep 17 00:00:00 2001 From: Awar Abdulkarim <48431495+NotAwar@users.noreply.github.com> Date: Thu, 27 Feb 2025 23:51:19 +0100 Subject: [PATCH 6/6] fix: change title to Quickstart Signed-off-by: Awar Abdulkarim <48431495+NotAwar@users.noreply.github.com> --- content/en/docs/v3.5/quickstart.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/v3.5/quickstart.md b/content/en/docs/v3.5/quickstart.md index 2cb596240..da444b374 100644 --- a/content/en/docs/v3.5/quickstart.md +++ b/content/en/docs/v3.5/quickstart.md @@ -1,5 +1,5 @@ --- -title: Quick start +title: Quickstart weight: 900 description: Get etcd up and running in less than 5 minutes! ---