cmd: Add deployment resource upgrade command (#76)

Adds a command which allows upgrading a stateless resource as specified
in the help and long description for commands. The supported type is any
of the stateless resource types, which for now are apm, appsearch and
kibana.

Signed-off-by: Marc Lopez <marc5.12@outlook.com>

Author: marclop

cmd/deployment/command.go

@@ -25,6 +25,7 @@ import (
 	cmdkibana "github.com/elastic/ecctl/cmd/deployment/kibana"
 	cmddeploymentnote "github.com/elastic/ecctl/cmd/deployment/note"
 	cmddeploymentplan "github.com/elastic/ecctl/cmd/deployment/plan"
+	cmddeploymentresource "github.com/elastic/ecctl/cmd/deployment/resource"
 )
 
 // Command is the deployment subcommand
@@ -44,5 +45,6 @@ func init() {
 		cmdkibana.Command,
 		cmdapm.Command,
 		cmddeploymentplan.Command,
+		cmddeploymentresource.Command,
 	)
 }

cmd/deployment/resource/command.go

@@ -0,0 +1,32 @@
+// Licensed to Elasticsearch B.V. under one or more contributor
+// license agreements. See the NOTICE file distributed with
+// this work for additional information regarding copyright
+// ownership. Elasticsearch B.V. licenses this file to you under
+// the Apache License, Version 2.0 (the "License"); you may
+// not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+package cmddeploymentresource
+
+import (
+	"github.com/spf13/cobra"
+)
+
+// Command is the deployment subcommand
+var Command = &cobra.Command{
+	Use:     "resource",
+	Short:   "Manages deployment resources",
+	PreRunE: cobra.MaximumNArgs(0),
+	Run: func(cmd *cobra.Command, args []string) {
+		cmd.Help()
+	},
+}

cmd/deployment/resource/upgrade.go

@@ -0,0 +1,74 @@
+// Licensed to Elasticsearch B.V. under one or more contributor
+// license agreements. See the NOTICE file distributed with
+// this work for additional information regarding copyright
+// ownership. Elasticsearch B.V. licenses this file to you under
+// the Apache License, Version 2.0 (the "License"); you may
+// not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+package cmddeploymentresource
+
+import (
+	"github.com/elastic/cloud-sdk-go/pkg/models"
+	"github.com/elastic/cloud-sdk-go/pkg/util/ec"
+	"github.com/spf13/cobra"
+
+	cmdutil "github.com/elastic/ecctl/cmd/util"
+	"github.com/elastic/ecctl/pkg/deployment/depresource"
+	"github.com/elastic/ecctl/pkg/ecctl"
+)
+
+// upgradeCmd is the deployment subcommand
+var upgradeCmd = &cobra.Command{
+	Use:     "upgrade <deployment id> --type <type> --ref-id <ref-id>",
+	Short:   "Upgrades a deployment resource",
+	Long:    upgradeLong,
+	PreRunE: cmdutil.MinimumNArgsAndUUID(1),
+	RunE: func(cmd *cobra.Command, args []string) error {
+		resType, _ := cmd.Flags().GetString("type")
+		refID, _ := cmd.Flags().GetString("ref-id")
+
+		res, err := depresource.UpgradeStateless(depresource.UpgradeStatelessParams{
+			API:          ecctl.Get().API,
+			DeploymentID: args[0],
+			Type:         resType,
+			RefID:        refID,
+		})
+
+		if err != nil {
+			return err
+		}
+
+		if track, _ := cmd.Flags().GetBool("track"); !track {
+			return nil
+		}
+
+		return depresource.TrackResources(depresource.TrackResourcesParams{
+			API:          ecctl.Get().API,
+			OutputDevice: ecctl.Get().Config.OutputDevice,
+			Resources: []*models.DeploymentResource{{
+				ID:    ec.String(res.ResourceID),
+				Kind:  ec.String(resType),
+				RefID: ec.String(refID),
+			}},
+		})
+	},
+}
+
+func init() {
+	Command.AddCommand(upgradeCmd)
+	upgradeCmd.Flags().BoolP("track", "t", false, cmdutil.TrackFlagMessage)
+	upgradeCmd.Flags().String("type", "", "Optional stateless deployment type to upgrade (kibana, apm, or appsearch)")
+	upgradeCmd.MarkFlagRequired("type")
+	upgradeCmd.Flags().String("ref-id", "", "Optional deployment RefId, if not set, the RefId will be auto-discovered")
+	upgradeCmd.MarkFlagRequired("ref-id")
+}

cmd/deployment/resource/upgrade_help.go

@@ -0,0 +1,23 @@
+// Licensed to Elasticsearch B.V. under one or more contributor
+// license agreements. See the NOTICE file distributed with
+// this work for additional information regarding copyright
+// ownership. Elasticsearch B.V. licenses this file to you under
+// the Apache License, Version 2.0 (the "License"); you may
+// not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+package cmddeploymentresource
+
+const (
+	upgradeLong = `Upgrades a stateless deployment resource so it matches the Elasticsearch
+deployment version. Only stateless resources are supported in the --type flag`
+)

docs/ecctl_deployment.md

@@ -47,6 +47,7 @@ ecctl deployment [flags]
 * [ecctl deployment list](ecctl_deployment_list.md)	 - Lists the platform's deployments
 * [ecctl deployment note](ecctl_deployment_note.md)	 - Manages a deployment's notes
 * [ecctl deployment plan](ecctl_deployment_plan.md)	 - Manages deployment plans
+* [ecctl deployment resource](ecctl_deployment_resource.md)	 - Manages deployment resources
 * [ecctl deployment restore](ecctl_deployment_restore.md)	 - Restores a previously shut down deployment and all of its associated sub-resources
 * [ecctl deployment search](ecctl_deployment_search.md)	 - Performs advanced deployment search using the Elasticsearch Query DSL
 * [ecctl deployment show](ecctl_deployment_show.md)	 - Shows the specified deployment resources

docs/ecctl_deployment_resource.md

@@ -0,0 +1,43 @@
+## ecctl deployment resource
+
+Manages deployment resources
+
+### Synopsis
+
+Manages deployment resources
+
+```
+ecctl deployment resource [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for resource
+```
+
+### Options inherited from parent commands
+
+```
+      --apikey string      API key to use to authenticate (If empty will look for EC_APIKEY environment variable)
+      --config string      Config name, used to have multiple configs in $HOME/.ecctl/<env> (default "config")
+      --force              Do not ask for confirmation
+      --format string      Formats the output using a Go template
+      --host string        Base URL to use
+      --insecure           Skips all TLS validation
+      --message string     A message to set on cluster operation
+      --output string      Output format [text|json] (default "text")
+      --pass string        Password to use to authenticate (If empty will look for EC_PASS environment variable)
+      --pprof              Enables pprofing and saves the profile to pprof-20060102150405
+  -q, --quiet              Suppresses the configuration file used for the run, if any
+      --timeout duration   Timeout to use on all HTTP calls (default 30s)
+      --trace              Enables tracing saves the trace to trace-20060102150405
+      --user string        Username to use to authenticate (If empty will look for EC_USER environment variable)
+      --verbose            Enable verbose mode
+```
+
+### SEE ALSO
+
+* [ecctl deployment](ecctl_deployment.md)	 - Manages deployments
+* [ecctl deployment resource upgrade](ecctl_deployment_resource_upgrade.md)	 - Upgrades a deployment resource
+

docs/ecctl_deployment_resource_upgrade.md

@@ -0,0 +1,46 @@
+## ecctl deployment resource upgrade
+
+Upgrades a deployment resource
+
+### Synopsis
+
+Upgrades a stateless deployment resource so it matches the Elasticsearch
+deployment version. Only stateless resources are supported in the --type flag
+
+```
+ecctl deployment resource upgrade <deployment id> --type <type> --ref-id <ref-id> [flags]
+```
+
+### Options
+
+```
+  -h, --help            help for upgrade
+      --ref-id string   Optional deployment RefId, if not set, the RefId will be auto-discovered
+  -t, --track           Tracks the progress of the performed task
+      --type string     Optional stateless deployment type to upgrade (kibana, apm, or appsearch)
+```
+
+### Options inherited from parent commands
+
+```
+      --apikey string      API key to use to authenticate (If empty will look for EC_APIKEY environment variable)
+      --config string      Config name, used to have multiple configs in $HOME/.ecctl/<env> (default "config")
+      --force              Do not ask for confirmation
+      --format string      Formats the output using a Go template
+      --host string        Base URL to use
+      --insecure           Skips all TLS validation
+      --message string     A message to set on cluster operation
+      --output string      Output format [text|json] (default "text")
+      --pass string        Password to use to authenticate (If empty will look for EC_PASS environment variable)
+      --pprof              Enables pprofing and saves the profile to pprof-20060102150405
+  -q, --quiet              Suppresses the configuration file used for the run, if any
+      --timeout duration   Timeout to use on all HTTP calls (default 30s)
+      --trace              Enables tracing saves the trace to trace-20060102150405
+      --user string        Username to use to authenticate (If empty will look for EC_USER environment variable)
+      --verbose            Enable verbose mode
+```
+
+### SEE ALSO
+
+* [ecctl deployment resource](ecctl_deployment_resource.md)	 - Manages deployment resources
+

pkg/deployment/depresource/upgrade_stateless.go

@@ -0,0 +1,79 @@
+// Licensed to Elasticsearch B.V. under one or more contributor
+// license agreements. See the NOTICE file distributed with
+// this work for additional information regarding copyright
+// ownership. Elasticsearch B.V. licenses this file to you under
+// the Apache License, Version 2.0 (the "License"); you may
+// not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+package depresource
+
+import (
+	"errors"
+
+	"github.com/elastic/cloud-sdk-go/pkg/api"
+	"github.com/elastic/cloud-sdk-go/pkg/client/deployments"
+	"github.com/elastic/cloud-sdk-go/pkg/models"
+	"github.com/hashicorp/go-multierror"
+
+	"github.com/elastic/ecctl/pkg/deployment/deputil"
+	"github.com/elastic/ecctl/pkg/util"
+)
+
+// UpgradeStatelessParams is consumed by UpgradeStateless
+type UpgradeStatelessParams struct {
+	*api.API
+
+	DeploymentID string
+	Type         string
+	RefID        string
+}
+
+// Validate ensures the parameters are usable by the consuming function.
+func (params UpgradeStatelessParams) Validate() error {
+	var merr = new(multierror.Error)
+
+	if params.API == nil {
+		merr = multierror.Append(merr, util.ErrAPIReq)
+	}
+
+	if len(params.DeploymentID) != 32 {
+		merr = multierror.Append(merr, deputil.NewInvalidDeploymentIDError(params.DeploymentID))
+	}
+
+	if params.Type == "" {
+		merr = multierror.Append(merr, errors.New("deployment resource type cannot be empty"))
+	}
+
+	return merr.ErrorOrNil()
+}
+
+// UpgradeStateless upgrades a stateless deployment resource like APM, Kibana
+// and AppSearch.
+func UpgradeStateless(params UpgradeStatelessParams) (*models.DeploymentResourceUpgradeResponse, error) {
+	if err := params.Validate(); err != nil {
+		return nil, err
+	}
+
+	res, err := params.V1API.Deployments.UpgradeDeploymentStatelessResource(
+		deployments.NewUpgradeDeploymentStatelessResourceParams().
+			WithStatelessResourceKind(params.Type).
+			WithDeploymentID(params.DeploymentID).
+			WithRefID(params.RefID),
+		params.AuthWriter,
+	)
+	if err != nil {
+		return nil, api.UnwrapError(err)
+	}
+
+	return res.Payload, nil
+}