Skip to content

Commit 0cab6ed

Browse files
AgentK9smira
authored andcommitted
docs: update troubleshooting.md
CLI is actually "members" not "member" Signed-off-by: K Birt <[email protected]> Signed-off-by: Andrey Smirnov <[email protected]>
1 parent 921e102 commit 0cab6ed

File tree

3 files changed

+9
-2
lines changed

3 files changed

+9
-2
lines changed

cmd/talosctl/cmd/talos/etcd.go

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,7 @@ var etcdAlarmListCmd = &cobra.Command{
8888
Use: "list",
8989
Short: "List the etcd alarms for the node.",
9090
Long: ``,
91+
Args: cobra.NoArgs,
9192
RunE: func(cmd *cobra.Command, args []string) error {
9293
return WithClient(func(ctx context.Context, c *client.Client) error {
9394
response, err := c.EtcdAlarmList(ctx)
@@ -110,6 +111,7 @@ var etcdAlarmDisarmCmd = &cobra.Command{
110111
Use: "disarm",
111112
Short: "Disarm the etcd alarms for the node.",
112113
Long: ``,
114+
Args: cobra.NoArgs,
113115
RunE: func(cmd *cobra.Command, args []string) error {
114116
return WithClient(func(ctx context.Context, c *client.Client) error {
115117
response, err := c.EtcdAlarmDisarm(ctx)
@@ -133,6 +135,7 @@ var etcdDefragCmd = &cobra.Command{
133135
Short: "Defragment etcd database on the node",
134136
Long: `Defragmentation is a maintenance operation that releases unused space from the etcd database file.
135137
Defragmentation is a resource heavy operation and should be performed only when necessary on a single node at a time.`,
138+
Args: cobra.NoArgs,
136139
RunE: func(cmd *cobra.Command, args []string) error {
137140
return WithClient(func(ctx context.Context, c *client.Client) error {
138141
if err := helpers.FailIfMultiNodes(ctx, "etcd defrag"); err != nil {
@@ -150,6 +153,7 @@ var etcdLeaveCmd = &cobra.Command{
150153
Use: "leave",
151154
Short: "Tell nodes to leave etcd cluster",
152155
Long: ``,
156+
Args: cobra.NoArgs,
153157
RunE: func(cmd *cobra.Command, args []string) error {
154158
return WithClient(func(ctx context.Context, c *client.Client) error {
155159
if err := helpers.FailIfMultiNodes(ctx, "etcd leave"); err != nil {
@@ -186,6 +190,7 @@ var etcdForfeitLeadershipCmd = &cobra.Command{
186190
Use: "forfeit-leadership",
187191
Short: "Tell node to forfeit etcd cluster leadership",
188192
Long: ``,
193+
Args: cobra.NoArgs,
189194
RunE: func(cmd *cobra.Command, args []string) error {
190195
return WithClient(func(ctx context.Context, c *client.Client) error {
191196
_, err := c.EtcdForfeitLeadership(ctx, &machine.EtcdForfeitLeadershipRequest{})
@@ -199,6 +204,7 @@ var etcdMemberListCmd = &cobra.Command{
199204
Use: "members",
200205
Short: "Get the list of etcd cluster members",
201206
Long: ``,
207+
Args: cobra.NoArgs,
202208
RunE: func(cmd *cobra.Command, args []string) error {
203209
return WithClient(func(ctx context.Context, c *client.Client) error {
204210
response, err := c.EtcdMemberList(ctx, &machine.EtcdMemberListRequest{
@@ -258,6 +264,7 @@ var etcdStatusCmd = &cobra.Command{
258264
Use: "status",
259265
Short: "Get the status of etcd cluster member",
260266
Long: `Returns the status of etcd member on the node, use multiple nodes to get status of all members.`,
267+
Args: cobra.NoArgs,
261268
RunE: func(cmd *cobra.Command, args []string) error {
262269
return WithClient(func(ctx context.Context, c *client.Client) error {
263270
response, err := c.EtcdStatus(ctx)

website/content/v1.10/introduction/troubleshooting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ It is always recommended to run an odd number of `etcd` members, as with 3 or mo
106106
Common troubleshooting steps:
107107

108108
- check `etcd` service state with `talosctl -n IP service etcd` for each control plane node
109-
- check `etcd` membership on each control plane node with `talosctl -n IP etcd member list`
109+
- check `etcd` membership on each control plane node with `talosctl -n IP etcd members`
110110
- check `etcd` logs with `talosctl -n IP logs etcd`
111111
- check `etcd` alarms with `talosctl -n IP etcd alarm list`
112112

website/content/v1.9/introduction/troubleshooting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ It is always recommended to run an odd number of `etcd` members, as with 3 or mo
106106
Common troubleshooting steps:
107107

108108
- check `etcd` service state with `talosctl -n IP service etcd` for each control plane node
109-
- check `etcd` membership on each control plane node with `talosctl -n IP etcd member list`
109+
- check `etcd` membership on each control plane node with `talosctl -n IP etcd members`
110110
- check `etcd` logs with `talosctl -n IP logs etcd`
111111
- check `etcd` alarms with `talosctl -n IP etcd alarm list`
112112

0 commit comments

Comments
 (0)