faas

Documentation

Index

• Constants
• Variables
• func CreateFaasResource(input CreateFaaSResourceInput) error
• func CreateLambdaRole(input *CreateFaaSResourceInput) (string, string, error)
• func DeleteFaaSRepo(cfg aws.Config, name string) error
• func DeleteFaaSResource(cfg aws.Config) error
• func DeleteFaaSResourceRole(cfg aws.Config) error
• func DetachFaaSPolicies(cfg aws.Config) error
• func ListLambdas() error
• func ProvisionFaasRepo(input CreateFaaSResourceInput) error
• func ReadLambdaConfig() (*viper.Viper, error)
• func TryMakeFaaSResource(client *lambda.Client, functionCode types.FunctionCode, defaultTimeout int32, ...) (bool, error)
• func ValidateFunctionName(input string) error
• type CreateFaaSResourceInput
• type DeleteRepositoryPayload
• type DockerImage
• type LambdaLanguage
• type LambdaRuntime
• type Payload

Constants

const COMPOSE_TEMPLATE string = `services:
  lambda:
    build: .
    ports:
      - 9000:8080
    env_file:
      - .env`

const DOCKERFILE_TEMPLATE string = `FROM %s:%s

%s

CMD [ "%s" ]`

const FAAS_CONFIG_FILE string = "faas.yaml"

const GOLANG_DOCKERFILE_COPY string = `COPY bootstrap ${LAMBDA_TASK_ROOT}`

const JAVA_DOCKERFILE_COPY string = `COPY target/classes ${LAMBDA_TASK_ROOT}
COPY target/dependency/* ${LAMBDA_TASK_ROOT}/lib/`

const NODEJS_DOCKERFILE_COPY string = `COPY node_modules ${LAMBDA_TASK_ROOT}/node_modules
COPY dist ${LAMBDA_TASK_ROOT}/dist
COPY package.json ${LAMBDA_TASK_ROOT}`

const PYTHON_DOCKERFILE_COPY string = `COPY app.py ${LAMBDA_TASK_ROOT}`

Variables

var BASIC_LAMBDA_POLICY_ARN = "arn:aws:iam::aws:policy/service-role/AWSLambdaBasicExecutionRole"

var CREATE_LAMBDA_REPOSITORY string = "create-lambda-repository"

var CheckAWSLogin func() (bool, error)

var ConfigPath = "."

var FaasRootCmd = &cobra.Command{
	Use:   "faas",
	Short: "Execute FaaS commands",
	Long:  "Configure, Create, and Execute Functions as a Service (AWS Lambdas)",
}

var LAMBDA_BASIC_EXECUTION_ROLE string = "arn:aws:iam::aws:policy/service-role/AWSLambdaBasicExecutionRole"

Basic execution policy for Lambda Functions.

var S3_BUCKET_NAME string = "example-lambda-apps"

Name of the S3 bucket which holds all example lambda zips

var TEMPLATE_REPO_OWNER string = "obscurelyme"

Owner of the template repos

var TRUST_POLICY_DOC string = `` /* 192-byte string literal not displayed */

Functions

func CreateFaasResource

func CreateFaasResource(input CreateFaaSResourceInput) error

Creates the Lambda Function, this function can take some time due to having to wait for the AWS Policies and Role to take effect so that the lambda may assume the role.

func CreateLambdaRole

func CreateLambdaRole(input *CreateFaaSResourceInput) (string, string, error)

func DeleteFaaSRepo

func DeleteFaaSRepo(cfg aws.Config, name string) error

func DeleteFaaSResource

func DeleteFaaSResource(cfg aws.Config) error

func DeleteFaaSResourceRole

func DeleteFaaSResourceRole(cfg aws.Config) error

func DetachFaaSPolicies

func DetachFaaSPolicies(cfg aws.Config) error

func ListLambdas

func ListLambdas() error

func ProvisionFaasRepo

func ProvisionFaasRepo(input CreateFaaSResourceInput) error

func ReadLambdaConfig

func ReadLambdaConfig() (*viper.Viper, error)

func TryMakeFaaSResource

func TryMakeFaaSResource(client *lambda.Client, functionCode types.FunctionCode, defaultTimeout int32, roleArn string, input *CreateFaaSResourceInput) (bool, error)

func ValidateFunctionName

func ValidateFunctionName(input string) error

Types

type CreateFaaSResourceInput

type CreateFaaSResourceInput struct {
	FunctionName string
	Runtime      *LambdaRuntime
}

type DeleteRepositoryPayload

type DeleteRepositoryPayload struct {
	RepositoryOwner string `json:"repositoryOwner"`
	RepositoryName  string `json:"repositoryName"`
}

Payload to send when deleting a repository after deleting an FaaS resource

type DockerImage

type DockerImage string

const (
	DockerImageNodeJS DockerImage = "amazon/aws-lambda-nodejs"
	DockerImageJava   DockerImage = "amazon/aws-lambda-java"
	DockerImagePython DockerImage = "amazon/aws-lambda-python"
	DockerImageGo     DockerImage = "amazon/aws-lambda-go"
)

type LambdaLanguage

type LambdaLanguage string

const Golang LambdaLanguage = "golang"

const Java LambdaLanguage = "java"

const NodeJs LambdaLanguage = "nodejs"

const Python LambdaLanguage = "python"

type LambdaRuntime

type LambdaRuntime struct {
	// Internal AWS runtime for the lambda function
	AWSRuntime lambdaTypes.Runtime
	Language   LambdaLanguage
	// Handler for the lambda function
	Handler string
	// Name of the S3 key (zip file) stored in in the examples S3 bucket
	Example string
	// Template repository from which a new repo will be provisioned from
	TemplateRepo string
}

type Payload

type Payload struct {
	TemplateRepo          string `json:"templateRepo"`
	TemplateOwner         string `json:"templateOwner"`
	Owner                 string `json:"owner"`
	RepositoryName        string `json:"repositoryName"`
	RepositoryDescription string `json:"repositoryDescription"`
	Visibility            string `json:"visibility"`
}

Payload to send when provisioning a new template repository for a new FaaS resource