Skip to content

Commit cc7b5ad

Browse files
authored
Merge pull request #7837 from knabben/remove-disable-no-echo
⚠️ Removing deprecated (--disable-no-echo) flag and renaming docs
2 parents cb4e781 + 4405fcd commit cc7b5ad

File tree

4 files changed

+8
-12
lines changed

4 files changed

+8
-12
lines changed

cmd/clusterctl/cmd/describe_cluster.go

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,6 @@ type describeClusterOptions struct {
6262
showClusterResourceSets bool
6363
showTemplates bool
6464
echo bool
65-
disableNoEcho bool
6665
grouping bool
6766
disableGrouping bool
6867
color bool
@@ -92,9 +91,9 @@ var describeClusterClusterCmd = &cobra.Command{
9291
# e.g. un-group all the machines with Ready=true instead of showing a single group node.
9392
clusterctl describe cluster test-1 --grouping=false
9493
95-
# Describe the cluster named test-1 disabling automatic echo suppression
96-
# e.g. show the infrastructure machine objects, no matter if the current state is already reported by the machine's Ready condition.
97-
clusterctl describe cluster test-1 --disable-no-echo`),
94+
# Describe the cluster named test-1 showing the MachineInfrastructure and BootstrapConfig objects
95+
# also when their status is the same as the status of the corresponding machine object.
96+
clusterctl describe cluster test-1 --echo`),
9897

9998
Args: func(cmd *cobra.Command, args []string) error {
10099
if len(args) != 1 {
@@ -126,10 +125,6 @@ func init() {
126125

127126
describeClusterClusterCmd.Flags().BoolVar(&dc.echo, "echo", false, ""+
128127
"Show MachineInfrastructure and BootstrapConfig when ready condition is true or it has the Status, Severity and Reason of the machine's object.")
129-
describeClusterClusterCmd.Flags().BoolVar(&dc.disableNoEcho, "disable-no-echo", false, ""+
130-
"Disable hiding of a MachineInfrastructure and BootstrapConfig when ready condition is true or it has the Status, Severity and Reason of the machine's object.")
131-
_ = describeClusterClusterCmd.Flags().MarkDeprecated("disable-no-echo",
132-
"use --echo instead.")
133128
describeClusterClusterCmd.Flags().BoolVar(&dc.grouping, "grouping", true,
134129
"Groups machines when ready condition has the same Status, Severity and Reason.")
135130
describeClusterClusterCmd.Flags().BoolVar(&dc.disableGrouping, "disable-grouping", false,
@@ -165,7 +160,7 @@ func runDescribeCluster(cmd *cobra.Command, name string) error {
165160
ShowTemplates: dc.showTemplates,
166161
ShowMachineSets: dc.showMachineSets,
167162
AddTemplateVirtualNode: true,
168-
Echo: dc.echo || dc.disableNoEcho,
163+
Echo: dc.echo,
169164
Grouping: dc.grouping && !dc.disableGrouping,
170165
})
171166
if err != nil {

docs/book/src/clusterctl/commands/describe-cluster.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,18 +23,18 @@ bootstrap object linked to a machine, unless their state differs from the machin
2323

2424
## Customizing the visualization
2525

26-
By default the visualization generated by `clusterctl describe cluster` hides details for the sake
26+
By default, the visualization generated by `clusterctl describe cluster` hides details for the sake
2727
of simplicity and shortness. However, if required, the user can ask for showing all the detail:
2828

2929
By using the `--disable-grouping` flag, the user can force the visualization to show all the machines
3030
on separated lines, no matter if they have the same state or not:
3131

3232
![](../../images/describe-cluster-disable-grouping.png)
3333

34-
By using the `--disable-no-echo` flag, the user can force the visualization to show infrastructure machines and
34+
By using the `--echo` flag, the user can force the visualization to show infrastructure machines and
3535
bootstrap objects linked to machines, no matter if they have the same state or not:
3636

37-
![](../../images/describe-cluster-disable-no-echo.png)
37+
![](../../images/describe-cluster-echo.png)
3838

3939
It is also possible to force the visualization to show all the conditions for an object (instead of showing
4040
only the ready condition). e.g. with `--show-conditions KubeadmControlPlane` you get:

docs/book/src/developer/providers/v1.3-to-v1.4.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ maintainers of providers and consumers of our Go API.
2525
- `CloneTemplate` and `CloneTemplateInput` has been removed.
2626
- The option `--list-images` from `init` subcommand has been removed.
2727
- `exp/runtime/server.NewServer` has been removed.
28+
- `--disable-no-echo` option from `clusterctl describe cluster` subcommand has been removed
2829

2930
### API Changes
3031

0 commit comments

Comments
 (0)