docs: update troubleshooting.md

CLI is actually "members" not "member" Signed-off-by: K Birt <[email protected]> Signed-off-by: Andrey Smirnov <[email protected]>
siderolabs · Jan 20, 2025 · 0cab6ed · 0cab6ed
1 parent 921e102
commit 0cab6ed
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 2 deletions.
diff --git a/cmd/talosctl/cmd/talos/etcd.go b/cmd/talosctl/cmd/talos/etcd.go
@@ -88,6 +88,7 @@ var etcdAlarmListCmd = &cobra.Command{
 	Use:   "list",
 	Short: "List the etcd alarms for the node.",
 	Long:  ``,
+	Args:  cobra.NoArgs,
 	RunE: func(cmd *cobra.Command, args []string) error {
 		return WithClient(func(ctx context.Context, c *client.Client) error {
 			response, err := c.EtcdAlarmList(ctx)
@@ -110,6 +111,7 @@ var etcdAlarmDisarmCmd = &cobra.Command{
 	Use:   "disarm",
 	Short: "Disarm the etcd alarms for the node.",
 	Long:  ``,
+	Args:  cobra.NoArgs,
 	RunE: func(cmd *cobra.Command, args []string) error {
 		return WithClient(func(ctx context.Context, c *client.Client) error {
 			response, err := c.EtcdAlarmDisarm(ctx)
@@ -133,6 +135,7 @@ var etcdDefragCmd = &cobra.Command{
 	Short: "Defragment etcd database on the node",
 	Long: `Defragmentation is a maintenance operation that releases unused space from the etcd database file.
 Defragmentation is a resource heavy operation and should be performed only when necessary on a single node at a time.`,
+	Args: cobra.NoArgs,
 	RunE: func(cmd *cobra.Command, args []string) error {
 		return WithClient(func(ctx context.Context, c *client.Client) error {
 			if err := helpers.FailIfMultiNodes(ctx, "etcd defrag"); err != nil {
@@ -150,6 +153,7 @@ var etcdLeaveCmd = &cobra.Command{
 	Use:   "leave",
 	Short: "Tell nodes to leave etcd cluster",
 	Long:  ``,
+	Args:  cobra.NoArgs,
 	RunE: func(cmd *cobra.Command, args []string) error {
 		return WithClient(func(ctx context.Context, c *client.Client) error {
 			if err := helpers.FailIfMultiNodes(ctx, "etcd leave"); err != nil {
@@ -186,6 +190,7 @@ var etcdForfeitLeadershipCmd = &cobra.Command{
 	Use:   "forfeit-leadership",
 	Short: "Tell node to forfeit etcd cluster leadership",
 	Long:  ``,
+	Args:  cobra.NoArgs,
 	RunE: func(cmd *cobra.Command, args []string) error {
 		return WithClient(func(ctx context.Context, c *client.Client) error {
 			_, err := c.EtcdForfeitLeadership(ctx, &machine.EtcdForfeitLeadershipRequest{})
@@ -199,6 +204,7 @@ var etcdMemberListCmd = &cobra.Command{
 	Use:   "members",
 	Short: "Get the list of etcd cluster members",
 	Long:  ``,
+	Args:  cobra.NoArgs,
 	RunE: func(cmd *cobra.Command, args []string) error {
 		return WithClient(func(ctx context.Context, c *client.Client) error {
 			response, err := c.EtcdMemberList(ctx, &machine.EtcdMemberListRequest{
@@ -258,6 +264,7 @@ var etcdStatusCmd = &cobra.Command{
 	Use:   "status",
 	Short: "Get the status of etcd cluster member",
 	Long:  `Returns the status of etcd member on the node, use multiple nodes to get status of all members.`,
+	Args:  cobra.NoArgs,
 	RunE: func(cmd *cobra.Command, args []string) error {
 		return WithClient(func(ctx context.Context, c *client.Client) error {
 			response, err := c.EtcdStatus(ctx)

diff --git a/website/content/v1.10/introduction/troubleshooting.md b/website/content/v1.10/introduction/troubleshooting.md
@@ -106,7 +106,7 @@ It is always recommended to run an odd number of `etcd` members, as with 3 or mo
 Common troubleshooting steps:
 
 - check `etcd` service state with `talosctl -n IP service etcd` for each control plane node
-- check `etcd` membership on each control plane node with `talosctl -n IP etcd member list`
+- check `etcd` membership on each control plane node with `talosctl -n IP etcd members`
 - check `etcd` logs with `talosctl -n IP logs etcd`
 - check `etcd` alarms with `talosctl -n IP etcd alarm list`
 

diff --git a/website/content/v1.9/introduction/troubleshooting.md b/website/content/v1.9/introduction/troubleshooting.md
@@ -106,7 +106,7 @@ It is always recommended to run an odd number of `etcd` members, as with 3 or mo
 Common troubleshooting steps:
 
 - check `etcd` service state with `talosctl -n IP service etcd` for each control plane node
-- check `etcd` membership on each control plane node with `talosctl -n IP etcd member list`
+- check `etcd` membership on each control plane node with `talosctl -n IP etcd members`
 - check `etcd` logs with `talosctl -n IP logs etcd`
 - check `etcd` alarms with `talosctl -n IP etcd alarm list`