commands

Documentation

Index

• Constants
• func BuildFilelist(dir string, ignores []string) (files []string, err error)
• func CreateTarball(w io.Writer, filePaths []string) error
• func IsValidNodeApp(dir string) (errs []error)
• func NewSpinner(txt string) (s *spinner.Spinner)
• func NewTable(out io.Writer) (t *tablewriter.Table)
• func PrettyBool(b bool) (s string)
• type AccountsCmd
• type AccountsCreateCmd
• type AccountsListCmd
  • func (c *AccountsListCmd) Run() (err error)
• type AppsCmd
• type AppsCreateCmd
  • func (c *AppsCreateCmd) Run() (err error)
• type AppsDeleteCmd
  • func (c *AppsDeleteCmd) Run() (err error)
• type AppsInfoCmd
  • func (c *AppsInfoCmd) Run() (err error)
• type AppsListCmd
  • func (c *AppsListCmd) Run() (err error)
• type CertsCmd
• type CertsRenewCmd
  • func (c *CertsRenewCmd) Run() (err error)
• type DeployCmd
  • func (c *DeployCmd) Run() (err error)
• type LoginCmd
  • func (c *LoginCmd) In() io.Reader
  • func (c *LoginCmd) Out() io.Writer
  • func (c *LoginCmd) Run() (err error)
• type LogoutCmd
  • func (c *LogoutCmd) Run() (err error)
• type LogsCmd
  • func (c *LogsCmd) Run() (err error)
• type PayloadValue
• type PsCmd
  • func (c *PsCmd) Run() (err error)
• type UploadResponse
• type VersionCmd
  • func (c *VersionCmd) Run() (err error)
• type WhoAmICmd
  • func (c *WhoAmICmd) Run() (err error)

Constants

const MaxFileSize = 1073741824 // 1GB

MaxFileSize is the tarball file size allowed to be uploaded in bytes.

Functions

func BuildFilelist

func BuildFilelist(dir string, ignores []string) (files []string, err error)

BuildFilelist builds a list of files to be tarballed, with optional ignores.

func CreateTarball

func CreateTarball(w io.Writer, filePaths []string) error

CreateTarball creates a tarball containing all the files in filePaths and writes it to w.

func IsValidNodeApp

func IsValidNodeApp(dir string) (errs []error)

IsValidNodeApp detects if a Node.js app is present in a given directory

func NewSpinner

func NewSpinner(txt string) (s *spinner.Spinner)

NewSpinner returns a nicely formatted spinner for display while users are waiting.

func NewTable

func NewTable(out io.Writer) (t *tablewriter.Table)

NewTable returns a table with sectionctl standard formatting

func PrettyBool

func PrettyBool(b bool) (s string)

PrettyBool pretty prints a bool value

Types

type AccountsCmd

type AccountsCmd struct {
	List AccountsListCmd `cmd help:"List accounts on Section." default:"1"`
}

AccountsCmd manages accounts on Section

type AccountsCreateCmd

type AccountsCreateCmd struct{}

AccountsCreateCmd handles creating apps on Section

type AccountsListCmd

type AccountsListCmd struct{}

AccountsListCmd handles listing accounts on Section

func (*AccountsListCmd) Run

func (c *AccountsListCmd) Run() (err error)

Run executes the command

type AppsCmd

type AppsCmd struct {
	List   AppsListCmd   `cmd help:"List apps on Section." default:"1"`
	Info   AppsInfoCmd   `cmd help:"Show detailed app information on Section."`
	Create AppsCreateCmd `cmd help:"Create new app on Section."`
	Delete AppsDeleteCmd `cmd help:"Delete an existing app on Section."`
}

AppsCmd manages apps on Section

type AppsCreateCmd

type AppsCreateCmd struct {
	AccountID int    `required short:"a" help:"ID of account to create the app under"`
	Hostname  string `required short:"d" help:"FQDN the app can be accessed at"`
	Origin    string `required short:"o" help:"URL to fetch the origin"`
	StackName string `required short:"s" help:"Name of stack to deploy"`
}

AppsCreateCmd handles creating apps on Section

func (*AppsCreateCmd) Run

func (c *AppsCreateCmd) Run() (err error)

Run executes the command

type AppsDeleteCmd

type AppsDeleteCmd struct {
	AccountID int `required short:"a" help:"ID of account the app belongs to"`
	AppID     int `required short:"i" help:"ID of the app to delete"`
}

AppsDeleteCmd handles deleting apps on Section

func (*AppsDeleteCmd) Run

func (c *AppsDeleteCmd) Run() (err error)

Run executes the command

type AppsInfoCmd

type AppsInfoCmd struct {
	AccountID int `required short:"a"`
	AppID     int `required short:"i"`
}

AppsInfoCmd shows detailed information on an app running on Section

func (*AppsInfoCmd) Run

func (c *AppsInfoCmd) Run() (err error)

Run executes the command

type AppsListCmd

type AppsListCmd struct {
	AccountID int `required short:"a"`
}

AppsListCmd handles listing apps running on Section

func (*AppsListCmd) Run

func (c *AppsListCmd) Run() (err error)

Run executes the command

type CertsCmd

type CertsCmd struct {
	Renew CertsRenewCmd `cmd help:"Renew a certificate for a domain."`
}

CertsCmd manages certificates on Section

type CertsRenewCmd

type CertsRenewCmd struct {
	AccountID int    `required short:"a"`
	Hostname  string `required`
}

CertsRenewCmd handles renewing a certificate

func (*CertsRenewCmd) Run

func (c *CertsRenewCmd) Run() (err error)

Run executes the command

type DeployCmd

type DeployCmd struct {
	AccountID      int           `required short:"a" help:"AccountID to deploy application to."`
	AppID          int           `required short:"i" help:"AppID to deploy application to."`
	Environment    string        `short:"e" default:"production" help:"Environment to deploy application to."`
	Debug          bool          `help:"Display extra debugging information about what is happening inside sectionctl."`
	Directory      string        `default:"." help:"Directory which contains the application to deploy."`
	ServerURL      *url.URL      `default:"https://aperture.section.io/new/code_upload/v1/upload" help:"URL to upload application to"`
	Timeout        time.Duration `default:"300s" help:"Timeout of individual HTTP requests."`
	SkipDelete     bool          `help:"Skip delete of temporary tarball created to upload app."`
	SkipValidation bool          `help:"Skip validation of the workload before pushing into Section. Use with caution."`
	AppPath        string        `default:"nodejs" help:"Path of NodeJS application in environment repository."`
}

DeployCmd handles deploying an app to Section.

func (*DeployCmd) Run

func (c *DeployCmd) Run() (err error)

Run deploys an app to Section's edge

type LoginCmd

type LoginCmd struct {
	// contains filtered or unexported fields
}

LoginCmd handles authenticating the CLI against Section's API

func (*LoginCmd) In

func (c *LoginCmd) In() io.Reader

In returns the input to read from

func (*LoginCmd) Out

func (c *LoginCmd) Out() io.Writer

Out returns the output to write to

func (*LoginCmd) Run

func (c *LoginCmd) Run() (err error)

Run executes the command

type LogoutCmd

type LogoutCmd struct{}

LogoutCmd handles revoking previously set up authentication

func (*LogoutCmd) Run

func (c *LogoutCmd) Run() (err error)

Run executes the command

type LogsCmd

type LogsCmd struct {
	AccountID    int    `required short:"a" help:"ID of account to query"`
	AppID        int    `required short:"i" help:"ID of app to query"`
	AppPath      string `default:"nodejs" help:"Path of NodeJS application in environment repository."`
	InstanceName string `default:"" help:"Specific instance of NodeJS application running on Section platform."`
	Number       int    `short:"n" default:100 help:"Number of log lines to fetch."`
	Follow       bool   `help:"Displays recent logs and leaves the session open for logs to stream in. --instance-name required."`
}

LogsCmd returns logs from an application on Section's delivery platform

func (*LogsCmd) Run

func (c *LogsCmd) Run() (err error)

Run executes the command

type PayloadValue

type PayloadValue struct {
	ID string `json:"section_payload_id"`
}

PayloadValue represents the value of a trigger update payload.

type PsCmd

type PsCmd struct {
	AccountID int    `required short:"a" help:"ID of account to query"`
	AppID     int    `required short:"i" help:"ID of app to query"`
	AppPath   string `default:"nodejs" help:"Path of NodeJS application in environment repository."`
}

PsCmd checks an application's status on Section's delivery platform

func (*PsCmd) Run

func (c *PsCmd) Run() (err error)

Run executes the command

type UploadResponse

type UploadResponse struct {
	PayloadID string `json:"payloadID"`
}

UploadResponse represents the response from a request to the upload service.

type VersionCmd

type VersionCmd struct{}

VersionCmd handles authenticating the CLI against Section's API

func (*VersionCmd) Run

func (c *VersionCmd) Run() (err error)

Run executes the `login` command

type WhoAmICmd

type WhoAmICmd struct{}

WhoAmICmd returns information about the currently authenticated user

func (*WhoAmICmd) Run

func (c *WhoAmICmd) Run() (err error)

Run executes the command