Skip to content

Commit dc9ed2c

Browse files
authored
Update commands description (#148)
1 parent 1e933ec commit dc9ed2c

7 files changed

+11
-14
lines changed

internal/cli/atlas_clusters_indexes.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ func AtlasClustersIndexesBuilder() *cobra.Command {
2323
cmd := &cobra.Command{
2424
Use: "indexes",
2525
Aliases: []string{"index"},
26-
Short: description.Indexes,
26+
Short: description.ClustersIndexes,
2727
}
2828
cmd.AddCommand(AtlasClustersIndexesCreateBuilder())
2929

internal/cli/atlas_whitelist_create.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ func (opts *atlasWhitelistCreateOpts) newWhitelist() *atlas.ProjectIPWhitelist {
7171
return projectIPWhitelist
7272
}
7373

74-
// mongocli atlas whitelist(s) create value --type cidrBlock|ipAddress [--comment comment] [--projectId projectId]
74+
// mongocli atlas whitelist(s) create [entry] --type cidrBlock|ipAddress [--comment comment] [--projectId projectId]
7575
func AtlasWhitelistCreateBuilder() *cobra.Command {
7676
opts := &atlasWhitelistCreateOpts{}
7777
cmd := &cobra.Command{

internal/cli/ops_manager_automation_update.go

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ import (
1818
"fmt"
1919

2020
"github.com/mongodb/mongocli/internal/config"
21-
"github.com/mongodb/mongocli/internal/description"
2221
"github.com/mongodb/mongocli/internal/file"
2322
"github.com/mongodb/mongocli/internal/flags"
2423
"github.com/mongodb/mongocli/internal/store"
@@ -57,14 +56,13 @@ func (opts *opsManagerAutomationUpdateOpts) Run() error {
5756
return nil
5857
}
5958

60-
// mongocli om cluster(s) update --projectId projectId --file myfile.yaml
59+
// mongocli om automation update --projectId projectId --file myfile.json
6160
func OpsManagerAutomationUpdateBuilder() *cobra.Command {
6261
opts := &opsManagerAutomationUpdateOpts{
6362
fs: afero.NewOsFs(),
6463
}
6564
cmd := &cobra.Command{
6665
Use: "update",
67-
Short: description.UpdateOMCluster,
6866
Hidden: true,
6967
PreRunE: func(cmd *cobra.Command, args []string) error {
7068
return opts.PreRunE(opts.initStore)

internal/cli/ops_manager_clusters_shutdown.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ func OpsManagerClustersShutdownBuilder() *cobra.Command {
8181
opts := &opsManagerClustersShutdownOpts{}
8282
cmd := &cobra.Command{
8383
Use: "shutdown [name]",
84-
Short: description.ShutdownOMCluster,
84+
Short: description.ShutdownCluster,
8585
Args: cobra.ExactArgs(1),
8686
PreRunE: func(cmd *cobra.Command, args []string) error {
8787
if err := opts.PreRunE(opts.initStore); err != nil {

internal/cli/ops_manager_clusters_startup.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ func OpsManagerClustersStartupBuilder() *cobra.Command {
8181
opts := &opsManagerClustersStartupOpts{}
8282
cmd := &cobra.Command{
8383
Use: "startup [name]",
84-
Short: description.StartUpOMCluster,
84+
Short: description.StartUpCluster,
8585
Args: cobra.ExactArgs(1),
8686
PreRunE: func(cmd *cobra.Command, args []string) error {
8787
if err := opts.PreRunE(opts.initStore); err != nil {

internal/cli/ops_manager_clusters_update.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ func OpsManagerClustersUpdateBuilder() *cobra.Command {
8080
}
8181
cmd := &cobra.Command{
8282
Use: "update",
83-
Short: description.UpdateOMCluster,
83+
Short: description.UpdateCluster,
8484
PreRunE: func(cmd *cobra.Command, args []string) error {
8585
return opts.PreRunE(opts.initStore)
8686
},

internal/description/description.go

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,18 +37,18 @@ const (
3737
ListSnapshots = "List continuous snapshots for a project."
3838
Logs = "Download host logs."
3939
Clusters = "Manage clusters for your project."
40-
ClustersIndexes = "Manage cluster indexes for your project."
40+
ClustersIndexes = "Manage cluster rolling indexes for your project."
4141
ClustersLong = "The clusters command provides access to your cluster configurations. You can create, edit, and delete clusters."
4242
CreateCluster = "Create a MongoDB cluster."
43-
Indexes = "Rolling index management"
4443
CreateIndex = "Create a rolling index for your MongoDB cluster."
4544
ApplyCluster = "Apply a new cluster configuration."
4645
DeleteCluster = "Delete a cluster."
4746
DescribeCluster = "Describe a cluster."
4847
ListClusters = "List clusters for a project."
49-
UpdateCluster = "Update a MongoDB cluster in Atlas."
48+
UpdateCluster = "Update a MongoDB cluster."
5049
PauseCluster = "Pause a running MongoDB cluster in Atlas."
5150
StartCluster = "Start a paused MongoDB cluster in Atlas."
51+
WatchCluster = "Watch for a cluster to be available."
5252
Processes = "Manage MongoDB processes for your project."
5353
ListProcesses = "List MongoDB processes for a project."
5454
DBUsers = "Manage database users for your project."
@@ -69,9 +69,8 @@ const (
6969
DescribeWhitelist = "Describe an Atlas whitelist."
7070
ListWhitelist = "List Atlas whitelist for a project."
7171
CloudManager = "Cloud Manager operations."
72-
ShutdownOMCluster = "Shutdown a Cloud Manager cluster."
73-
StartUpOMCluster = "Startup a Cloud Manager cluster."
74-
UpdateOMCluster = "Update a Cloud Manager cluster."
72+
ShutdownCluster = "Shutdown a cluster."
73+
StartUpCluster = "Start up a cluster."
7574
ConfigDescription = "Configure a profile. This let you store access settings to your cloud."
7675
ConfigSetDescription = "Configure specific properties of the profile."
7776
IAM = "Authentication operations."

0 commit comments

Comments
 (0)