Skip to content

Commit 2bfa679

Browse files
authored
cmd: specify that deployment template commands are ECE specific (#232)
Adds text to specify that deployment template commands are ECE specific.
1 parent 46ad1cd commit 2bfa679

9 files changed

+14
-13
lines changed

cmd/platform/deployment-template/command.go

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,11 @@ import (
2626

2727
"github.com/elastic/cloud-sdk-go/pkg/input"
2828
"github.com/elastic/cloud-sdk-go/pkg/models"
29-
"github.com/elastic/cloud-sdk-go/pkg/util/cmdutil"
29+
sdkcmdutil "github.com/elastic/cloud-sdk-go/pkg/util/cmdutil"
3030
"github.com/pkg/errors"
3131
"github.com/spf13/cobra"
3232

33+
cmdutil "github.com/elastic/ecctl/cmd/util"
3334
"github.com/elastic/ecctl/pkg/ecctl"
3435
"github.com/elastic/ecctl/pkg/platform/deployment"
3536
)
@@ -43,7 +44,7 @@ const (
4344
// Command represents the top level deployment-template command.
4445
var Command = &cobra.Command{
4546
Use: "deployment-template",
46-
Short: "Manages deployment templates",
47+
Short: cmdutil.AdminReqDescription("Manages deployment templates"),
4748
PreRunE: cobra.MaximumNArgs(0),
4849
Run: func(cmd *cobra.Command, args []string) {
4950
cmd.Help()
@@ -122,7 +123,7 @@ var platformDeploymentTemplateCreateCmd = &cobra.Command{
122123
Short: "Creates a platform deployment template",
123124
PreRunE: cobra.MaximumNArgs(0),
124125
RunE: func(cmd *cobra.Command, args []string) error {
125-
if err := cmdutil.FileOrStdin(cmd, "file-template"); err != nil {
126+
if err := sdkcmdutil.FileOrStdin(cmd, "file-template"); err != nil {
126127
return err
127128
}
128129

@@ -155,7 +156,7 @@ var platformDeploymentTemplateUpdateCmd = &cobra.Command{
155156
Short: "Updates a platform deployment template",
156157
PreRunE: cobra.MinimumNArgs(1),
157158
RunE: func(cmd *cobra.Command, args []string) error {
158-
if err := cmdutil.FileOrStdin(cmd, "file-template"); err != nil {
159+
if err := sdkcmdutil.FileOrStdin(cmd, "file-template"); err != nil {
159160
return err
160161
}
161162
tc, err := parseTemplateFile(cmd.Flag("file-template").Value.String())

docs/ecctl_platform.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ ecctl platform [flags]
4242
* [ecctl](ecctl.md) - Elastic Cloud Control
4343
* [ecctl platform allocator](ecctl_platform_allocator.md) - Manages allocators (Available for ECE only)
4444
* [ecctl platform constructor](ecctl_platform_constructor.md) - Manages constructors (Available for ECE only)
45-
* [ecctl platform deployment-template](ecctl_platform_deployment-template.md) - Manages deployment templates
45+
* [ecctl platform deployment-template](ecctl_platform_deployment-template.md) - Manages deployment templates (Available for ECE only)
4646
* [ecctl platform enrollment-token](ecctl_platform_enrollment-token.md) - Manages tokens (Available for ECE only)
4747
* [ecctl platform info](ecctl_platform_info.md) - Shows information about the platform (Available for ECE only)
4848
* [ecctl platform instance-configuration](ecctl_platform_instance-configuration.md) - Manages instance configurations (Available for ECE only)

docs/ecctl_platform_deployment-template.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
## ecctl platform deployment-template
22

3-
Manages deployment templates
3+
Manages deployment templates (Available for ECE only)
44

55
### Synopsis
66

7-
Manages deployment templates
7+
Manages deployment templates (Available for ECE only)
88

99
```
1010
ecctl platform deployment-template [flags]

docs/ecctl_platform_deployment-template_create.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,5 +41,5 @@ ecctl platform deployment-template create -f <template file>.json [flags]
4141

4242
### SEE ALSO
4343

44-
* [ecctl platform deployment-template](ecctl_platform_deployment-template.md) - Manages deployment templates
44+
* [ecctl platform deployment-template](ecctl_platform_deployment-template.md) - Manages deployment templates (Available for ECE only)
4545

docs/ecctl_platform_deployment-template_delete.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,5 +39,5 @@ ecctl platform deployment-template delete <template id> [flags]
3939

4040
### SEE ALSO
4141

42-
* [ecctl platform deployment-template](ecctl_platform_deployment-template.md) - Manages deployment templates
42+
* [ecctl platform deployment-template](ecctl_platform_deployment-template.md) - Manages deployment templates (Available for ECE only)
4343

docs/ecctl_platform_deployment-template_list.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,5 +42,5 @@ ecctl platform deployment-template list [flags]
4242

4343
### SEE ALSO
4444

45-
* [ecctl platform deployment-template](ecctl_platform_deployment-template.md) - Manages deployment templates
45+
* [ecctl platform deployment-template](ecctl_platform_deployment-template.md) - Manages deployment templates (Available for ECE only)
4646

docs/ecctl_platform_deployment-template_pull.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,5 +40,5 @@ ecctl platform deployment-template pull --path <path> [flags]
4040

4141
### SEE ALSO
4242

43-
* [ecctl platform deployment-template](ecctl_platform_deployment-template.md) - Manages deployment templates
43+
* [ecctl platform deployment-template](ecctl_platform_deployment-template.md) - Manages deployment templates (Available for ECE only)
4444

docs/ecctl_platform_deployment-template_show.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,5 +40,5 @@ ecctl platform deployment-template show <template id> [flags]
4040

4141
### SEE ALSO
4242

43-
* [ecctl platform deployment-template](ecctl_platform_deployment-template.md) - Manages deployment templates
43+
* [ecctl platform deployment-template](ecctl_platform_deployment-template.md) - Manages deployment templates (Available for ECE only)
4444

docs/ecctl_platform_deployment-template_update.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,5 +40,5 @@ ecctl platform deployment-template update <template id> -f <template file>.json
4040

4141
### SEE ALSO
4242

43-
* [ecctl platform deployment-template](ecctl_platform_deployment-template.md) - Manages deployment templates
43+
* [ecctl platform deployment-template](ecctl_platform_deployment-template.md) - Manages deployment templates (Available for ECE only)
4444

0 commit comments

Comments
 (0)