deploy

Documentation

Index

• Constants
• func Deploy() error
• func PreCheck() error
• func PushWebImg(imageRegistry, tag string) (string, error)
• type Company
• type FirstUser
• type Infra
• type LogSubscriptions
• type Monitoring
• type PantherConfig
  • func Settings() (*PantherConfig, error)
• type Setup
• type Web

Constants

const ConfigFilepath = "deployments/panther_config.yml"

Functions

func Deploy

func Deploy() error

Deploy Panther to your AWS account

func PreCheck

func PreCheck() error

Fail the deploy early if there is a known issue with the user's environment.

func PushWebImg

func PushWebImg(imageRegistry, tag string) (string, error)

Build a personalized docker image from source and push it to the private image repo of the user

Types

type Company

type Company struct {
	DisplayName string `yaml:"DisplayName"`
	Email       string `yaml:"Email"`
}

type FirstUser

type FirstUser struct {
	GivenName  string `yaml:"GivenName"`
	FamilyName string `yaml:"FamilyName"`
	Email      string `yaml:"Email"`
}

type Infra

type Infra struct {
	BaseLayerVersionArns          string   `yaml:"BaseLayerVersionArns"`
	LoadBalancerSecurityGroupCidr string   `yaml:"LoadBalancerSecurityGroupCidr"`
	LogProcessorLambdaMemorySize  int      `yaml:"LogProcessorLambdaMemorySize"`
	PipLayer                      []string `yaml:"PipLayer"`
	PythonLayerVersionArn         string   `yaml:"PythonLayerVersionArn"`
	SecurityGroupID               string   `yaml:"SecurityGroupID"`
	SubnetOneIPRange              string   `yaml:"SubnetOneIPRange"`
	SubnetTwoIPRange              string   `yaml:"SubnetTwoIPRange"`
	VpcID                         string   `yaml:"VpcID"`
}

type LogSubscriptions

type LogSubscriptions struct {
	PrincipalARNs []string `yaml:"PrincipalARNs"`
}

type Monitoring

type Monitoring struct {
	AlarmSnsTopicArn           string `yaml:"AlarmSnsTopicArn"`
	CloudWatchLogRetentionDays int    `yaml:"CloudWatchLogRetentionDays"`
	Debug                      bool   `yaml:"Debug"`
	TracingMode                string `yaml:"TracingMode"`
}

type PantherConfig

type PantherConfig struct {
	Infra      Infra      `yaml:"Infra"`
	Monitoring Monitoring `yaml:"Monitoring"`
	Setup      Setup      `yaml:"Setup"`
	Web        Web        `yaml:"Web"`
}

func Settings

func Settings() (*PantherConfig, error)

Read settings from the config file

type Setup

type Setup struct {
	Company               Company          `yaml:"Company"`
	FirstUser             FirstUser        `yaml:"FirstUser"`
	OnboardSelf           bool             `yaml:"OnboardSelf"`
	EnableS3AccessLogs    bool             `yaml:"EnableS3AccessLogs"`
	EnableCloudTrail      bool             `yaml:"EnableCloudTrail"`
	EnableGuardDuty       bool             `yaml:"EnableGuardDuty"`
	S3AccessLogsBucket    string           `yaml:"S3AccessLogsBucket"`
	DataReplicationBucket string           `yaml:"DataReplicationBucket"`
	InitialAnalysisSets   []string         `yaml:"InitialAnalysisSets"`
	LogSubscriptions      LogSubscriptions `yaml:"LogSubscriptions"`
}

type Web

type Web struct {
	CertificateArn string `yaml:"CertificateArn"`
	CustomDomain   string `yaml:"CustomDomain"`
}