plan

Documentation

Index

• Constants
• func GetPlanStep(ctx context.Context) string
• type FlyPostgresPlan
  • func (p *FlyPostgresPlan) Guest() *fly.MachineGuest
• type GitHubActionsPlan
• type LaunchPlan
  • func (p *LaunchPlan) Guest() *fly.MachineGuest
• type ObjectStoragePlan
  • func DefaultObjectStorage(plan *LaunchPlan) ObjectStoragePlan
  • func (p *ObjectStoragePlan) Provider() any
• type PostgresPlan
  • func DefaultPostgres(plan *LaunchPlan) PostgresPlan
  • func (p *PostgresPlan) Provider() any
• type RedisPlan
  • func DefaultRedis(plan *LaunchPlan) RedisPlan
  • func (p *RedisPlan) Provider() any
• type RuntimeStruct
• type SupabasePostgresPlan
  • func (p *SupabasePostgresPlan) GetDbName(plan *LaunchPlan) string
  • func (p *SupabasePostgresPlan) GetRegion(plan *LaunchPlan) string
• type TigrisObjectStoragePlan
• type UpstashRedisPlan

Constants

const PlanStepKey contextKey = "planStep"

Functions

func GetPlanStep

func GetPlanStep(ctx context.Context) string

Types

type FlyPostgresPlan

type FlyPostgresPlan struct {
	AppName    string `json:"app_name"`
	VmSize     string `json:"vm_size"`
	VmRam      int    `json:"vm_ram"`
	Nodes      int    `json:"nodes"`
	DiskSizeGB int    `json:"disk_size_gb"`
	AutoStop   bool   `json:"auto_stop"`
}

func (*FlyPostgresPlan) Guest

func (p *FlyPostgresPlan) Guest() *fly.MachineGuest

type GitHubActionsPlan

type GitHubActionsPlan struct {
	Deploy bool `json:"deploy"`
	Review bool `json:"review"`
}

type LaunchPlan

type LaunchPlan struct {
	AppName string `json:"name"`
	OrgSlug string `json:"org"`

	RegionCode       string `json:"region"`
	HighAvailability bool   `json:"ha"`

	// Deprecated: The UI currently returns this instead of Compute, but new development should use Compute.
	CPUKind string `json:"vm_cpukind,omitempty"`
	// Deprecated: The UI currently returns this instead of Compute, but new development should use Compute.
	CPUs int `json:"vm_cpus,omitempty"`
	// Deprecated: The UI currently returns this instead of Compute, but new development should use Compute.
	MemoryMB int `json:"vm_memory,omitempty"`
	// Deprecated: The UI currently returns this instead of Compute, but new development should use Compute.
	VmSize string `json:"vm_size,omitempty"`

	// In the future, we'll use this over CPUKind, CPUs, MemoryMB, and VmSize.
	// As of writing this, however, the UI does not return this field.
	Compute []*appconfig.Compute `json:"compute"`

	HttpServicePort             int  `json:"http_service_port,omitempty"`
	HttpServicePortSetByScanner bool `json:"http_service_port_set_by_scanner,omitempty"`

	Postgres      PostgresPlan      `json:"postgres"`
	Redis         RedisPlan         `json:"redis"`
	GitHubActions GitHubActionsPlan `json:"github_actions"`
	Sentry        bool              `json:"sentry"`
	ObjectStorage ObjectStoragePlan `json:"object_storage"`

	ScannerFamily string          `json:"scanner_family"`
	FlyctlVersion version.Version `json:"flyctl_version"`

	Runtime RuntimeStruct `json:"runtime"`
}

func (*LaunchPlan) Guest

func (p *LaunchPlan) Guest() *fly.MachineGuest

Guest returns the guest described by the *raw* guest fields in a Plan. When the UI starts returning Compute, this will be deprecated.

type ObjectStoragePlan

type ObjectStoragePlan struct {
	TigrisObjectStorage *TigrisObjectStoragePlan `json:"tigris_object_storage"`
}

func DefaultObjectStorage

func DefaultObjectStorage(plan *LaunchPlan) ObjectStoragePlan

func (*ObjectStoragePlan) Provider

func (p *ObjectStoragePlan) Provider() any

type PostgresPlan

type PostgresPlan struct {
	FlyPostgres      *FlyPostgresPlan      `json:"fly_postgres"`
	SupabasePostgres *SupabasePostgresPlan `json:"supabase_postgres"`
}

func DefaultPostgres

func DefaultPostgres(plan *LaunchPlan) PostgresPlan

func (*PostgresPlan) Provider

func (p *PostgresPlan) Provider() any

type RedisPlan

type RedisPlan struct {
	UpstashRedis *UpstashRedisPlan `json:"upstash_redis"`
}

func DefaultRedis

func DefaultRedis(plan *LaunchPlan) RedisPlan

func (*RedisPlan) Provider

func (p *RedisPlan) Provider() any

type RuntimeStruct

type RuntimeStruct struct {
	Language string `json:"language"`
	Version  string `json:"version"`
}

type SupabasePostgresPlan

type SupabasePostgresPlan struct {
	DbName string `json:"db_name"`
	Region string `json:"region"`
}

func (*SupabasePostgresPlan) GetDbName

func (p *SupabasePostgresPlan) GetDbName(plan *LaunchPlan) string

func (*SupabasePostgresPlan) GetRegion

func (p *SupabasePostgresPlan) GetRegion(plan *LaunchPlan) string

type TigrisObjectStoragePlan

type TigrisObjectStoragePlan struct {
	Name              string `json:"name"`
	Public            bool   `json:"public"`
	Accelerate        bool   `json:"accelerate"`
	WebsiteDomainName string `json:"website_domain_name"`
}

type UpstashRedisPlan

type UpstashRedisPlan struct {
	Eviction     bool     `json:"eviction"`
	ReadReplicas []string `json:"read_replicas"`
}