commands

Documentation

Index

• Constants
• Variables
• func BuildCommand() cli.Command
• func BuildServerCommand() cli.Command
• func ConfigCommand(command string) cli.Command
• func ConfigureCommand() cli.Command
• func CreateCommand() cli.Command
• func DeleteCommand() cli.Command
• func DeployCommand() cli.Command
• func GetCommand() cli.Command
• func GetCommands(commands map[string]cli.Command) []cli.Command
• func InitCommand() cli.Command
• func InspectCommand() cli.Command
• func InvokeCommand() cli.Command
• func ListCommand() cli.Command
• func MigrateCommand() cli.Command
• func PushCommand() cli.Command
• func StartCommand() cli.Command
• func StopCommand() cli.Command
• func UnsetCommand() cli.Command
• func UpdateCommand() cli.Command
• func UseCommand() cli.Command
• func ValidateFuncName(name string) error
• func VersionCommand() cli.Command
• type BuildServerCmd
• type Cmd
• type Message

Constants

const (
	FnInvokeEndpointAnnotation = "fnproject.io/fn/invokeEndpoint"
	CallIDHeader               = "Fn-Call-Id"
)

FnInvokeEndpointAnnotation is the annotation that exposes the fn invoke endpoint as defined in models/fn.go

const (
	MigrateSuccessMessage = "Successfully migrated func.yaml and created a back up func.yaml.bak"
	MigrateFailureMessage = "you have an up to date func.yaml file and do not need to migrate"
)

Variables

var Commands = Cmd{
	"build":        BuildCommand(),
	"build-server": BuildServerCommand(),
	"bump":         common.BumpCommand(),
	"invoke":       InvokeCommand(),
	"configure":    ConfigureCommand(),
	"create":       CreateCommand(),
	"delete":       DeleteCommand(),
	"deploy":       DeployCommand(),
	"get":          GetCommand(),
	"init":         InitCommand(),
	"inspect":      InspectCommand(),
	"list":         ListCommand(),
	"migrate":      MigrateCommand(),
	"push":         PushCommand(),
	"start":        StartCommand(),
	"stop":         StopCommand(),
	"unset":        UnsetCommand(),
	"update":       UpdateCommand(),
	"use":          UseCommand(),
}

Commands map of all top-level commands

var ConfigCmds = Cmd{
	"apps":      app.SetConfig(),
	"functions": fn.SetConfig(),
}

var ConfigGetCmds = Cmd{
	"apps":      app.GetConfig(),
	"functions": fn.GetConfig(),
}

var ConfigListCmds = Cmd{
	"apps":      app.ListConfig(),
	"functions": fn.ListConfig(),
}

var ConfigSetCmds = Cmd{
	"apps":      app.SetConfig(),
	"functions": fn.SetConfig(),
}

var ConfigUnsetCmds = Cmd{
	"apps":      app.UnsetConfig(),
	"functions": fn.UnsetConfig(),
}

var CreateCmds = Cmd{
	"apps":      app.Create(),
	"functions": fn.Create(),
	"triggers":  trigger.Create(),
	"context":   context.Create(),
}

var DeleteCmds = Cmd{
	"apps":      app.Delete(),
	"functions": fn.Delete(),
	"context":   context.Delete(),
	"triggers":  trigger.Delete(),
	"config":    ConfigCommand("delete"),
}

var GetCmds = Cmd{
	"config": ConfigCommand("get"),
}

var InspectCmds = Cmd{
	"apps":      app.Inspect(),
	"context":   context.Inspect(),
	"functions": fn.Inspect(),
	"triggers":  trigger.Inspect(),
}

var InvokeFnFlags = []cli.Flag{
	cli.StringFlag{
		Name:  "endpoint",
		Usage: "Specify the function invoke endpoint for this function, the app-name and func-name parameters will be ignored",
	},
	cli.StringFlag{
		Name:  "content-type",
		Usage: "The payload Content-Type for the function invocation.",
	},
	cli.BoolFlag{
		Name:  "display-call-id",
		Usage: "whether display call ID or not",
	},
	cli.StringFlag{
		Name:  "output",
		Usage: "Output format (json)",
	},
}

InvokeFnFlags used to invoke and fn

var ListCmds = Cmd{
	"config":    ConfigCommand("list"),
	"apps":      app.List(),
	"functions": fn.List(),
	"triggers":  trigger.List(),
	"contexts":  context.List(),
}

var RegionsWithOldKMSEndpoints = map[ociCommon.Region]struct{}{
	ociCommon.RegionPHX:           {},
	ociCommon.RegionIAD:           {},
	ociCommon.RegionFRA:           {},
	ociCommon.RegionLHR:           {},
	ociCommon.RegionCAToronto1:    {},
	ociCommon.RegionAPSeoul1:      {},
	ociCommon.RegionAPTokyo1:      {},
	ociCommon.RegionAPMumbai1:     {},
	ociCommon.RegionEUZurich1:     {},
	ociCommon.RegionSASaopaulo1:   {},
	ociCommon.RegionAPSydney1:     {},
	ociCommon.RegionMEJeddah1:     {},
	ociCommon.RegionEUAmsterdam1:  {},
	ociCommon.RegionAPMelbourne1:  {},
	ociCommon.RegionAPOsaka1:      {},
	ociCommon.RegionCAMontreal1:   {},
	ociCommon.RegionUSLangley1:    {},
	ociCommon.RegionUSLuke1:       {},
	ociCommon.RegionUSGovAshburn1: {},
	ociCommon.RegionUSGovChicago1: {},
	ociCommon.RegionUSGovPhoenix1: {},
	ociCommon.RegionUKGovLondon1:  {},
}

var UnsetCmds = Cmd{
	"config":  ConfigCommand("unset"),
	"context": context.Unset(),
}

var UpdateCmds = Cmd{
	"apps":      app.Update(),
	"functions": fn.Update(),
	"context":   context.Update(),
	"server":    server.Update(),
	"trigger":   trigger.Update(),
}

var UseCmds = Cmd{
	"context": context.Use(),
}

Functions

func BuildCommand

func BuildCommand() cli.Command

BuildCommand returns build cli.command

func BuildServerCommand

func BuildServerCommand() cli.Command

BuildServerCommand returns build server cli.command

func ConfigCommand

func ConfigCommand(command string) cli.Command

ConfigCommand returns config cli.command dependant on command parameter

func ConfigureCommand

func ConfigureCommand() cli.Command

ConfigureCommand returns configure cli.command

func CreateCommand

func CreateCommand() cli.Command

CreateCommand returns create cli.command

func DeleteCommand

func DeleteCommand() cli.Command

DeleteCommand returns delete cli.command

func DeployCommand

func DeployCommand() cli.Command

DeployCommand returns deploy cli.command

func GetCommand

func GetCommand() cli.Command

GetCommand returns get cli.command

func GetCommands

func GetCommands(commands map[string]cli.Command) []cli.Command

GetCommands returns a list of cli.commands

func InitCommand

func InitCommand() cli.Command

InitCommand returns init cli.command

func InspectCommand

func InspectCommand() cli.Command

InspectCommand returns inspect cli.command

func InvokeCommand

func InvokeCommand() cli.Command

InvokeCommand returns call cli.command

func ListCommand

func ListCommand() cli.Command

ListCommand returns list cli.command

func MigrateCommand

func MigrateCommand() cli.Command

func PushCommand

func PushCommand() cli.Command

PushCommand returns push cli.command

func StartCommand

func StartCommand() cli.Command

StartCommand returns start server cli.command

func StopCommand

func StopCommand() cli.Command

StopCommand returns stop server cli.command

func UnsetCommand

func UnsetCommand() cli.Command

UnsetCommand returns unset cli.command

func UpdateCommand

func UpdateCommand() cli.Command

UpdateCommand returns update cli.command

func UseCommand

func UseCommand() cli.Command

UseCommand returns use cli.command

func ValidateFuncName

func ValidateFuncName(name string) error

ValidateFuncName checks if the func name is valid, the name can't contain a colon and must be all lowercase

func VersionCommand

func VersionCommand() cli.Command

VersionCommand

Types

type BuildServerCmd

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

type Cmd

type Cmd map[string]cli.Command

Cmd is a mapping from a commands name to its corresponding structure

type Message

type Message struct {
	Description      string `mandatory:"true" json:"description"`
	ImageDigest      string `mandatory:"true" json:"imageDigest"`
	KmsKeyId         string `mandatory:"true" json:"kmsKeyId"`
	KmsKeyVersionId  string `mandatory:"true" json:"kmsKeyVersionId"`
	Metadata         string `mandatory:"true" json:"metadata"`
	Region           string `mandatory:"true" json:"region"`
	RepositoryName   string `mandatory:"true" json:"repositoryName"`
	SigningAlgorithm string `mandatory:"true" json:"signingAlgorithm"`
}

Message defines the struct of container image signature payload