Skip to content

Commit 9b5f4e5

Browse files
committed
fix: update quickstart.md
1 parent f1294c0 commit 9b5f4e5

File tree

1 file changed

+76
-35
lines changed

1 file changed

+76
-35
lines changed

content/en/docs/v3.5/quickstart.md

Lines changed: 76 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -6,57 +6,98 @@ description: Get etcd up and running in less than 5 minutes!
66

77
## Prerequisites
88

9-
Follow these instructions to locally install, run, and test a single-member
10-
cluster of etcd:
9+
Before you begin, ensure you have the following:
1110

12-
1. Install etcd from pre-built binaries or from source. For details, see
13-
[Install][].
11+
1. **etcd Installed**
12+
Build or download etcd from [Install][] and verify that the `etcd` binary is in your system’s PATH.
13+
{{% alert color="warning" %}}**Important**: Ensure that you perform the last
14+
step of the installation instructions to verify that `etcd` is in your path.
15+
{{% /alert %}}
1416

15-
{{% alert color="warning" %}}**Important**: Ensure that you perform the last
16-
step of the installation instructions to verify that `etcd` is in your path.
17-
{{% /alert %}}
17+
2. **Terminal Access**
18+
You’ll need two terminal windows: one to run the etcd server and one to interact with it using `etcdctl`.
1819

19-
2. Launch `etcd`:
20+
## Getting Started
2021

21-
```console
22-
$ etcd
23-
{"level":"info","ts":"2021-09-17T09:19:32.783-0400","caller":"etcdmain/etcd.go:72","msg":... }
24-
25-
```
22+
Choose the workflow that best fits your role:
2623

27-
{{% alert color="info" %}}**Note**: The output produced by `etcd` are
28-
[logs](../op-guide/configuration/#logging) — info-level logs can
29-
be ignored. {{% /alert %}}
24+
### Developer Workflow
3025

31-
3. From **another terminal**, use `etcdctl` to set a key:
26+
**Objective:** Quickly set up a local etcd cluster for development and testing.
3227

33-
```console
34-
$ etcdctl put greeting "Hello, etcd"
35-
OK
36-
```
28+
1. **Set Up a Local Cluster**
29+
Use our [Set up a local cluster][] page to quickly spin up an etcd instance. Follow along by first launching etcd:
3730

38-
4. From the same terminal, retrieve the key:
31+
```console
32+
$ etcd
33+
{"level":"info","ts":"2021-09-17T09:19:32.783-0400","caller":"etcdmain/etcd.go:72","msg":... }
34+
35+
```
3936

40-
```console
41-
$ etcdctl get greeting
42-
greeting
43-
Hello, etcd
44-
```
37+
{{% alert color="info" %}}**Note**: The output produced by `etcd` are
38+
[logs](../op-guide/configuration/#logging) — info-level logs can
39+
be ignored. {{% /alert %}}
40+
41+
2. **Interact with etcd**
42+
In a separate terminal, run the following commands to set and retrieve a key:
43+
44+
```console
45+
$ etcdctl put greeting "Hello, etcd"
46+
OK
47+
```
48+
49+
```console
50+
$ etcdctl get greeting
51+
greeting
52+
Hello, etcd
53+
```
54+
55+
3. **Explore the Developer Guide**
56+
Once your local cluster is running, refer to the [Developer guide][] for integration and development tips.
57+
58+
### Operator Workflow
59+
60+
**Objective:** Configure and manage an etcd cluster for production.
61+
62+
1. **Install etcd**
63+
Follow the detailed instructions in the [Install][] to install and configure etcd for production use.
64+
65+
2. **Run and Monitor etcd**
66+
Start etcd in one terminal and review the logs to confirm it’s running properly:
67+
68+
```console
69+
$ etcd
70+
{"level":"info","ts":"...","msg": "..."}
71+
```
72+
73+
3. **Configure and Secure etcd**
74+
Check out the Operator Guide for steps on clustering, securing with TLS, and performance tuning.
75+
4. **Troubleshooting & Maintenance**
76+
If issues arise, consult the Troubleshooting section for common problems and solutions.
4577

4678
## What's next?
4779

4880
Learn about more ways to configure and use etcd from the following pages:
4981

50-
- ### Development
82+
- ### **Development:**
83+
84+
Continue with the [Developer guide][], which includes the [Set up a local cluster][] page, [API][] references, and integration examples.
85+
86+
- #### Explore the gRPC [API][]
87+
88+
- #### Find [language bindings and tools][integrations]
89+
90+
- ### **Operations:**
91+
92+
Proceed to the [Operations guide][] for advanced configuration, clustering, security, and performance tuning.
93+
94+
- #### Set up a [multi-machine cluster][clustering]
95+
96+
- #### Use TLS to [secure an etcd cluster][security]
5197

52-
- #### Explore the gRPC [API][].
53-
- #### Set up a [multi-machine cluster][clustering].
54-
- #### Learn how to [configure][] etcd.
55-
- #### Find [language bindings and tools][integrations].
56-
- #### Use TLS to [secure an etcd cluster][security].
57-
- #### [Tune etcd][tuning].
98+
- #### [Tune etcd][tuning]
5899

59-
- ### Operations
100+
- #### Learn how to [configure][] etcd
60101

61102
[api]: /docs/{{< param version >}}/learning/api
62103
[clustering]: /docs/{{< param version >}}/op-guide/clustering

0 commit comments

Comments
 (0)