cmd/deployment/show.go

// 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 cmddeployment

import (
	"encoding/json"

	"github.com/elastic/cloud-sdk-go/pkg/api/deploymentapi"
	"github.com/elastic/cloud-sdk-go/pkg/api/deploymentapi/deputil"
	"github.com/elastic/cloud-sdk-go/pkg/models"
	sdkcmdutil "github.com/elastic/cloud-sdk-go/pkg/util/cmdutil"
	"github.com/spf13/cobra"

	cmdutil "github.com/elastic/ecctl/cmd/util"
	"github.com/elastic/ecctl/pkg/ecctl"
)

const showExample = `
* Shows kibana resource information from a given deployment:
  ecctl deployment show <deployment-id> --kind kibana

* Shows apm resource information from a given deployment with a specified ref-id.
  ecctl deployment show <deployment-id> --kind apm --ref-id apm-server

* Return the current deployment state as a valid update payload.
  ecctl deployment show <deployment id> --generate-update-payload > update.json`

var showCmd = &cobra.Command{
	Use:     "show <deployment-id>",
	Short:   "Shows the specified deployment resources",
	Example: showExample,
	PreRunE: sdkcmdutil.MinimumNArgsAndUUID(1),
	RunE: func(cmd *cobra.Command, args []string) error {
		resourceKind, _ := cmd.Flags().GetString("kind")
		planLogs, _ := cmd.Flags().GetBool("plan-logs")
		planDefaults, _ := cmd.Flags().GetBool("plan-defaults")
		planHistory, _ := cmd.Flags().GetBool("plan-history")
		metadata, _ := cmd.Flags().GetBool("metadata")
		settings, _ := cmd.Flags().GetBool("settings")
		plans, _ := cmd.Flags().GetBool("plans")
		showPlans := planLogs || planDefaults || plans || planHistory

		refID, _ := cmd.Flags().GetString("ref-id")

		generatePayload, _ := cmd.Flags().GetBool("generate-update-payload")

		clearTransient := false

		if generatePayload {
			showPlans, settings, clearTransient = true, true, true
			resourceKind, refID = "", ""
		}

		// The idea here is that the default of clear-transient depends on the value of `generate-update-payload`. If
		// `generate-update-payload` is true then we want `clear-transient` to default to true. If the flag value
		// has been passed in we want to use that value instead.
		if cmd.Flags().Changed("clear-transient") {
			clearTransient, _ = cmd.Flags().GetBool("clear-transient")
		}

		getParams := deploymentapi.GetParams{
			API:          ecctl.Get().API,
			DeploymentID: args[0],
			RefID:        refID,
			QueryParams: deputil.QueryParams{
				ShowPlans:        showPlans,
				ShowPlanLogs:     planLogs,
				ShowPlanDefaults: planDefaults,
				ShowPlanHistory:  planHistory,
				ShowMetadata:     metadata,
				ShowSettings:     settings,
				ClearTransient:   clearTransient,
			},
		}

		res, err := deploymentapi.GetResource(deploymentapi.GetResourceParams{
			GetParams: getParams,
			Kind:      resourceKind,
		})
		if err != nil {
			return err
		}

		if !generatePayload {
			return ecctl.Get().Formatter.Format("deployment/show", res)
		}

		enc := json.NewEncoder(ecctl.Get().Config.OutputDevice)
		enc.SetIndent("", "  ")
		return enc.Encode(
			deploymentapi.NewUpdateRequest(res.(*models.DeploymentGetResponse)),
		)
	},
}

func init() {
	initShowFlags()
}

func initShowFlags() {
	Command.AddCommand(showCmd)
	cmdutil.AddKindFlag(showCmd, "Optional", true)
	showCmd.Flags().String("ref-id", "", "Optional deployment kind RefId, if not set, the RefId will be auto-discovered")
	showCmd.Flags().Bool("plans", false, "Shows the deployment plans")
	showCmd.Flags().Bool("plan-logs", false, "Shows the deployment plan logs")
	showCmd.Flags().Bool("plan-defaults", false, "Shows the deployment plan defaults")
	showCmd.Flags().Bool("plan-history", false, "Shows the deployment plan history")
	showCmd.Flags().BoolP("metadata", "m", false, "Shows the deployment metadata")
	showCmd.Flags().BoolP("settings", "s", false, "Shows the deployment settings")
	showCmd.Flags().Bool("generate-update-payload", false, "Outputs JSON which can be used as an argument for the --file flag with the update command.")
	showCmd.Flags().Bool("clear-transient", false, "Removes the transient field in order to make read - edit - write loop safer. The default value of clear-transient depends on the value of generate-update-payload. If generate-update-payload is true then clear-transient defaults to true. Otherwise defaults to false.")
}