supportids

Documentation

Index

• Variables
• func CmdSupportIDs(is ISupportIDs) error
• type ISupportIDs
  • func New(settings *models.Settings) ISupportIDs
• type SSupportIDs
  • func (s *SSupportIDs) SupportIDs() (string, string, string, string, error)

Variables

var Cmd = models.Command{
	Name:      "support-ids",
	ShortHelp: "Print out various IDs related to an environment to be used when contacting Datica support",
	LongHelp: "<code>support-ids</code> is helpful when contacting Datica support by submitting a ticket at https://datica.com/support. " +
		"If you are having an issue with a CLI command or anything with your environment, it is helpful to run this command and copy the output into the initial correspondence with a Datica engineer. " +
		"This will help Datica identify the environment faster and help come to resolution faster. Here is a sample command\n\n" +
		"<pre>\ndatica -E \"<your_env_name>\" support-ids\n</pre>",
	CmdFunc: func(settings *models.Settings) func(cmd *cli.Cmd) {
		return func(cmd *cli.Cmd) {
			cmd.Action = func() {
				err := CmdSupportIDs(New(settings))
				if err != nil {
					logrus.Fatal(err.Error())
				}
			}
		}
	},
}

Cmd is the contract between the user and the CLI. This specifies the command name, arguments, and required/optional arguments and flags for the command.

Functions

func CmdSupportIDs

func CmdSupportIDs(is ISupportIDs) error

Types

type ISupportIDs

type ISupportIDs interface {
	SupportIDs() (string, string, string, string, error)
}

ISupportIDs

func New

func New(settings *models.Settings) ISupportIDs

New returns an instance of ISupportIDs

type SSupportIDs

type SSupportIDs struct {
	Settings *models.Settings
}

SSupportIDs is a concrete implementation of ISupportIDs

func (*SSupportIDs) SupportIDs

func (s *SSupportIDs) SupportIDs() (string, string, string, string, error)

SupportIDs prints out various IDs related to the associated environment to be used when contacting Datica support.