v1

type APIType string

type AddFirewallRulesToInstanceArgs struct {
	InstanceID    CloudProviderInstanceID
	FirewallRules FirewallRules
}

type Architecture string

type ArchitectureFilter struct {
	// If IncludeArchitectures is provided, only the architectures in the list will be included
	IncludeArchitectures []Architecture

	// If ExcludeArchitectures is provided, the architectures in the list will be excluded
	ExcludeArchitectures []Architecture
}

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

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

type BytesValue int64

type Capabilities []Capability

type Capability string

type CloudAPI interface {
	GetAPIType() APIType
	GetCapabilities(ctx context.Context) (Capabilities, error)
	GetCloudProviderID() CloudProviderID
}

type CloudBase interface {
	CloudCreateTerminateInstance
}

type CloudChangeInstanceType interface {
	ChangeInstanceType(ctx context.Context, instanceID CloudProviderInstanceID, instanceType string) error
}

type CloudClient interface {
	CloudCredential
	CloudBase
	CloudQuota
	CloudRebootInstance
	CloudStopStartInstance
	CloudResizeInstanceVolume
	CloudMachineImage
	CloudChangeInstanceType
	CloudModifyFirewall
	CloudInstanceTags
	UpdateHandler
	CloudMaintainVPC
	CloudMaintainKubernetes
}

type CloudCreateTerminateInstance interface {
	// CreateInstance expects an instance object to exist if successful, and no instance to exist if there is ANY error
	//      CloudClient Implementers: ensure that the instance is terminated if there is an error
	// Public ip is not always returned from create, but will exist when instance is in running state
	CreateInstance(ctx context.Context, attrs CreateInstanceAttrs) (*Instance, error)
	TerminateInstance(ctx context.Context, instanceID CloudProviderInstanceID) error // may or may not be locationally scoped
	GetMaxCreateRequestsPerMinute() int
	CloudInstanceType
	CloudInstanceReader
}

type CloudCredential interface {
	MakeClient(ctx context.Context, location string) (CloudClient, error)
	GetTenantID() (string, error)
	GetReferenceID() string
	CloudAPI
}

type CloudFilter struct {
	// If IncludeClouds is provided, only the clouds in the list will be included
	IncludeClouds []string

	// If ExcludeClouds is provided, the clouds in the list will be excluded
	ExcludeClouds []string
}

type CloudInstanceReader interface {
	GetInstance(ctx context.Context, id CloudProviderInstanceID) (*Instance, error)
	ListInstances(ctx context.Context, args ListInstancesArgs) ([]Instance, error)
}

type CloudInstanceTags interface {
	UpdateInstanceTags(ctx context.Context, args UpdateInstanceTagsArgs) error
}

type CloudInstanceType interface {
	GetInstanceTypes(ctx context.Context, args GetInstanceTypeArgs) ([]InstanceType, error)
	GetInstanceTypePollTime() time.Duration
	CloudLocation
}

type CloudLocation interface {
	GetLocations(ctx context.Context, args GetLocationsArgs) ([]Location, error)
}

type CloudMachineImage interface {
	GetImages(ctx context.Context, args GetImageArgs) ([]Image, error)
}

type CloudMaintainKubernetes interface {
	// Create a new Kubernetes cluster.
	CreateCluster(ctx context.Context, args CreateClusterArgs) (*Cluster, error)

	// Get a Kubernetes cluster identified by the provided args.
	GetCluster(ctx context.Context, args GetClusterArgs) (*Cluster, error)

	// Idempotently set a user into a Kubernetes cluster.
	SetClusterUser(ctx context.Context, args SetClusterUserArgs) (*ClusterUser, error)

	// Create a new Kubernetes node group.
	CreateNodeGroup(ctx context.Context, args CreateNodeGroupArgs) (*NodeGroup, error)

	// Get a Kubernetes node group identified by the provided args.
	GetNodeGroup(ctx context.Context, args GetNodeGroupArgs) (*NodeGroup, error)

	// Modify a Kubernetes node group.
	ModifyNodeGroup(ctx context.Context, args ModifyNodeGroupArgs) error

	// Delete a Kubernetes node group identified by the provided args.
	DeleteNodeGroup(ctx context.Context, args DeleteNodeGroupArgs) error

	// Delete a Kubernetes cluster identified by the provided args.
	DeleteCluster(ctx context.Context, args DeleteClusterArgs) error
}

type CloudMaintainVPC interface {
	// Create a new VPC.
	CreateVPC(ctx context.Context, args CreateVPCArgs) (*VPC, error)

	// Get a VPC identified by the provided args.
	GetVPC(ctx context.Context, args GetVPCArgs) (*VPC, error)

	// Delete a VPC identified by the provided args.
	DeleteVPC(ctx context.Context, args DeleteVPCArgs) error
}

type CloudModifyFirewall interface {
	AddFirewallRulesToInstance(ctx context.Context, args AddFirewallRulesToInstanceArgs) error
	RevokeSecurityGroupRules(ctx context.Context, args RevokeSecurityGroupRuleArgs) error
}

type CloudProviderID string // aws, gcp, azure, etc.

type CloudProviderInstanceID string

type CloudProviderResourceID string

type CloudQuota interface {
	GetInstanceTypeQuotas(ctx context.Context, args GetInstanceTypeQuotasArgs) (Quota, error)
}

type CloudRebootInstance interface {
	RebootInstance(ctx context.Context, instanceID CloudProviderInstanceID) error
}

type CloudResizeInstanceVolume interface {
	ResizeInstanceVolume(ctx context.Context, args ResizeInstanceVolumeArgs) error
}

type CloudStopStartInstance interface {
	StopInstance(ctx context.Context, instanceID CloudProviderInstanceID) error
	StartInstance(ctx context.Context, instanceID CloudProviderInstanceID) error
}

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

type ClusterSettings struct {
	// The ID assigned by the cloud provider to the cluster.
	ID CloudProviderResourceID

	// The name of the cluster, displayed on clients.
	Name string

	// The unique ID used to associate with this cluster.
	RefID string

	// The cloud provider that manages the cluster.
	Provider string

	// The cloud that hosts the cluster.
	Cloud string

	// The location of the cluster.
	Location string

	// The ID of the VPC that the cluster is associated with.
	VPCID CloudProviderResourceID

	// The subnet IDs that the cluster's nodes are deployed into.
	SubnetIDs []CloudProviderResourceID

	// The version of Kubernetes that the cluster is running.
	KubernetesVersion string

	// The status of the cluster.
	Status ClusterStatus

	// The API endpoint of the cluster.
	APIEndpoint string

	// The CA certificate of the cluster, in base64.
	ClusterCACertificateBase64 string

	// The node groups associated with the cluster.
	NodeGroups []*NodeGroup

	// The tags associated with the cluster.
	Tags Tags
}

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

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

type ClusterUserSettings struct {
	// The name of the cluster that the user is associated with.
	ClusterName string

	// The CA certificate of the cluster, in base64.
	ClusterCertificateAuthorityDataBase64 string

	// The API endpoint of the cluster.
	ClusterServerURL string

	// The username of the user.
	Username string

	// The client certificate of the user, in base64.
	UserClientCertificateDataBase64 string

	// The client key of the user, in base64.
	UserClientKeyDataBase64 string

	// The kubeconfig of the user, in base64.
	KubeconfigBase64 string
}

type CreateClusterArgs struct {
	Name              string
	RefID             string
	VPCID             CloudProviderResourceID
	SubnetIDs         []CloudProviderResourceID
	KubernetesVersion string
	Tags              Tags
}

type CreateInstanceAttrs struct {
	Location             string
	SubLocation          string
	Name                 string
	RefID                string // required also can be used for idempotency
	VPCID                string
	SubnetID             string
	PublicKey            string // must be in openssh format
	KeyPairName          *string
	ImageID              string
	InstanceType         string
	UserDataBase64       string
	DiskSize             units.Base2Bytes // TODO: deprecate in favor of DiskSizeByteValue
	DiskSizeBytes        Bytes
	Tags                 Tags
	FirewallRules        FirewallRules
	UseSpot              bool
	UsePersistentIP      bool
	UseMultiAttachVolume bool
	RetireTimeout        *time.Duration
	// Additional Environment Variables.
	// Note: As of May 2024, the only cloud provider we have this implemented for
	// is the Akash provider.
	AdditionalEnvVars map[string]string
	AdditionalDisks   []Disk
}

type CreateNodeGroupArgs struct {
	ClusterID    CloudProviderResourceID
	Name         string
	RefID        string
	MinNodeCount int
	MaxNodeCount int
	InstanceType string
	DiskSize     Bytes
	Tags         Tags
}

type CreateSubnetArgs struct {
	// The unique ID used to associate with this subnet.
	RefID string

	// The IPv4 network range for the subnet, in CIDR notation. For example, "10.0.0.0/24".
	CidrBlock string

	// The type of the subnet.
	Type SubnetType

	// The tags to associate with the subnet.
	Tags Tags
}

type CreateVPCArgs struct {
	// The name of the VPC, displayed on clients.
	Name string

	// The unique ID used to associate with this VPC.
	RefID string

	// The IPv4 network range for the VPC, in CIDR notation. For example, "10.0.0.0/16".
	CidrBlock string

	// The subnets to create in the VPC.
	Subnets []CreateSubnetArgs

	// The tags to associate with the VPC.
	Tags Tags
}

type DeleteClusterArgs struct {
	ID CloudProviderResourceID
}

type DeleteNodeGroupArgs struct {
	ClusterID CloudProviderResourceID
	ID        CloudProviderResourceID
}

type DeleteVPCArgs struct {
	// The ID of the VPC to delete.
	ID CloudProviderResourceID
}

type Disk struct {
	Size      units.Base2Bytes // TODO: deprecate in favor of SizeByteValue
	SizeBytes Bytes
	Type      string
	MountPath string
}

type Field struct {
	Key   string
	Value any
}

type FirewallRule struct {
	ID       string // ignored when creating a new rule
	FromPort int32
	ToPort   int32
	IPRanges []string
}

type FirewallRules struct {
	IngressRules []FirewallRule
	EgressRules  []FirewallRule
}

type GPU struct {
	Count          int32
	Memory         units.Base2Bytes // TODO: deprecate in favor of MemoryByteValue
	MemoryBytes    Bytes
	MemoryDetails  string // "", "HBM", "GDDR", "DDR", etc.
	NetworkDetails string // "PCIe", "SXM4", "SXM5", etc.
	Manufacturer   Manufacturer
	Name           string
	Type           string
}

type GPUManufacturerFilter struct {
	// If IncludeGPUManufacturers is provided, only the GPU manufacturers in the list will be included
	IncludeGPUManufacturers []Manufacturer

	// If ExcludeGPUManufacturers is provided, the GPU manufacturers in the list will be excluded
	ExcludeGPUManufacturers []Manufacturer
}

type GetClusterArgs struct {
	ID CloudProviderResourceID
}

type GetImageArgs struct {
	Owners        []string // self, amazon, aws-marketplace, <account id>, project id for GCP
	Architectures []string // i386, x86_64, arm64
	NameFilters   []string // name of the image (wildcard permitted)
	ImageIDs      []string
}

type GetInstanceTypeArgs struct {
	Locations             LocationsFilter
	InstanceTypes         []string
	GPUManufactererFilter *GPUManufacturerFilter // nil means all GPU manufacturers are allowed
	CloudFilter           *CloudFilter           // nil means all clouds are allowed
	ArchitectureFilter    *ArchitectureFilter    // nil means all architectures are allowed
}

type GetInstanceTypeQuotasArgs struct {
	InstanceType string
}

type GetLocationsArgs struct {
	IncludeUnavailable bool
}

type GetNodeGroupArgs struct {
	ClusterID CloudProviderResourceID
	ID        CloudProviderResourceID
}

type GetVPCArgs struct {
	// The ID of the VPC to get.
	ID CloudProviderResourceID
}

type Image struct {
	ID           string
	Architecture string
	Description  string
	Name         string
	CreatedAt    time.Time
}

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

type Instance struct {
	Name                            string
	RefID                           string
	CloudCredRefID                  string // cloudCred used to create the Instance
	CreatedAt                       time.Time
	CloudID                         CloudProviderInstanceID
	IPAllocationID                  *string
	PublicIP                        string // Public ip is not always returned from create, but will exist when instance is in running state
	PublicDNS                       string
	PrivateIP                       string
	Hostname                        string
	ImageID                         string
	InstanceType                    string
	DiskSize                        units.Base2Bytes // TODO: deprecate in favor of DiskSizeByteValue
	DiskSizeBytes                   Bytes
	VolumeType                      string
	PubKeyFingerprint               string
	SSHUser                         string
	SSHPort                         int
	Status                          Status
	MetaEndpointEnabled             bool
	MetaTagsEnabled                 bool
	VPCID                           string
	SubnetID                        string
	Spot                            bool
	FirewallRules                   FirewallRules
	RetiredAt                       *time.Time
	RetireTimeout                   *time.Duration
	LastStopTransitionTime          *time.Time
	Location                        string
	SubLocation                     string
	Tags                            Tags
	Stoppable                       bool
	Rebootable                      bool
	IsContainer                     bool
	UserPrivilegeEscalationDisabled bool
	NotPrivileged                   bool
	InstanceTypeID                  InstanceTypeID
	AdditionalDisks                 []Disk

	// As of 08/26/2024 only used for Launchpad cloud.
	// Because there is port forwarding from a GPU node to Bastion node,
	// there is port mappings from the GPU node itself to the Bastion node.
	// i.e. Verb SSH port 2222 is mapped to 2022 on the Bastion node
	InternalPortMappings []PortMapping
}

type InstanceType struct {
	ID                              InstanceTypeID // this id should be unique across all regions and stable
	Location                        string
	AvailableAzs                    []string
	SubLocation                     string
	Type                            string
	SupportedGPUs                   []GPU
	SupportedStorage                []Storage
	ElasticRootVolume               bool
	SupportedUsageClasses           []string
	Memory                          units.Base2Bytes // TODO: deprecate in favor of MemoryByteValue
	MemoryBytes                     Bytes
	MaximumNetworkInterfaces        int32
	NetworkPerformance              string
	SupportedNumCores               []int32
	DefaultCores                    int32
	VCPU                            int32
	SupportedArchitectures          []Architecture
	ClockSpeedInGhz                 float64
	Quota                           InstanceTypeQuota
	Stoppable                       bool
	Rebootable                      bool
	VariablePrice                   bool
	Preemptible                     bool
	IsAvailable                     bool
	BasePrice                       *currency.Amount
	SubLocationTypeChangeable       bool
	IsContainer                     bool
	UserPrivilegeEscalationDisabled bool
	NotPrivileged                   bool
	EstimatedDeployTime             *time.Duration
	Provider                        string
	Cloud                           string
	CanModifyFirewallRules          bool
	ReservedInstancePoolID          string
}

type InstanceTypeID string

type InstanceTypeQuota struct {
	OnDemand Quota
	Spot     Quota
	Reserved Quota
}

type InstanceWaitNotFoundError struct {
	InstanceID CloudProviderInstanceID
	Err        error
}

type InstanceWaitTimeoutError struct {
	Instance *Instance
	Desired  LifecycleStatus
	Err      error
}

type LifecycleStatus string

type ListInstancesArgs struct {
	InstanceIDs []CloudProviderInstanceID
	TagFilters  map[string][]string
	Locations   LocationsFilter
}

type Location struct {
	Name        string // basically the id
	Description string
	Available   bool
	Endpoint    string
	Priority    int
	Country     string // ISO 3166-1 alpha-3 https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3
}

type LocationsFilter []string

type Logger interface {
	Debug(ctx context.Context, msg string, fields ...Field)
	Info(ctx context.Context, msg string, fields ...Field)
	Warn(ctx context.Context, msg string, args ...Field)
	Error(ctx context.Context, err error, fields ...Field)
}

type Manufacturer string

type ModifyNodeGroupArgs struct {
	ClusterID    CloudProviderResourceID
	ID           CloudProviderResourceID
	MinNodeCount int
	MaxNodeCount int
}

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

type NodeGroupSettings struct {
	// The name of the node group, displayed on clients.
	Name string

	// The unique ID used to associate with this node group.
	RefID string

	// The ID assigned by the cloud provider to the node group.
	ID CloudProviderResourceID

	// The minimum number of nodes in the node group.
	MinNodeCount int

	// The maximum number of nodes in the node group.
	MaxNodeCount int

	// The instance type of the nodes in the node group.
	InstanceType string

	// The disk size of the nodes in the node group.
	DiskSize Bytes

	// The status of the node group.
	Status NodeGroupStatus

	// The tags associated with the node group.
	Tags Tags
}

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

type NoopLogger struct{}

type NotImplCloudClient struct {
	InnerNotImplCloudClient
}

type PortMapping struct {
	FromPort int
	ToPort   int
}

type Quota struct {
	ID      string
	Name    string
	Maximum int    // maximum number of units
	Current int    // current number of units being used
	Unit    string // if gpu, will trigger https://github.com/brevdev/brev-deploy/blob/e8ad711e641794e0b2f7b582e301535826aca8b3/internal/routes/instance_types.go#L408
}

type ResizeInstanceVolumeArgs struct {
	InstanceID        CloudProviderInstanceID
	Size              units.Base2Bytes // TODO: deprecate in favor of SizeByteValue
	SizeBytes         Bytes
	WaitForOptimizing bool
}

type RevokeSecurityGroupRuleArgs struct {
	InstanceID           CloudProviderInstanceID
	SecurityGroupRuleIDs []string
}

type SetClusterUserArgs struct {
	ClusterID    CloudProviderResourceID
	Username     string
	RSAPEMBase64 string
	Role         string
}

type Status struct {
	LifecycleStatus LifecycleStatus
	Messages        []string
}

type Storage struct {
	Count                   int32
	Size                    units.Base2Bytes // TODO: deprecate in favor of SizeByteValue
	SizeBytes               Bytes
	Type                    string
	MinSize                 *units.Base2Bytes // TODO: deprecate in favor of MinSizeByteValue
	MinSizeBytes            *Bytes
	MaxSize                 *units.Base2Bytes // TODO: deprecate in favor of MaxSizeByteValue
	MaxSizeBytes            *Bytes
	PricePerGBHr            *currency.Amount
	IsEphemeral             bool
	IsAdditionalDisk        bool
	RequiresVolumeMountPath bool
	IsElastic               bool
}

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

type SubnetSettings struct {
	// The name of the subnet, displayed on clients.
	Name string

	// The unique ID used to associate with this subnet.
	RefID string

	// The ID of the VPC that the subnet is associated with.
	VPCID CloudProviderResourceID

	// The ID assigned by the cloud provider to the subnet.
	ID CloudProviderResourceID

	// The location of the subnet. For example, "us-east-1".
	Location string

	// The IPv4 network range for the subnet, in CIDR notation. For example, "10.0.0.0/24".
	CidrBlock string

	// The type of the subnet.
	Type SubnetType

	// The tags associated with the subnet.
	Tags Tags
}

type SubnetType string

type Tags map[string]string

type UpdateHandler interface {
	MergeInstanceForUpdate(currInst Instance, newInst Instance) Instance
	MergeInstanceTypeForUpdate(currIt InstanceType, newIt InstanceType) InstanceType
}

type UpdateInstanceTagsArgs struct {
	InstanceID CloudProviderInstanceID
	Tags       Tags
}

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

type VPCSettings struct {
	// The name of the VPC, displayed on clients.
	Name string

	// The unique ID used to associate with this VPC.
	RefID string

	// The cloud provider that manages the VPC. Unless the provider is a broker to other clouds, this will be the same as
	// the Cloud field. For example, "aws".
	Provider string

	// The cloud that hosts the VPC. For example, "aws".
	Cloud string

	// The ID assigned by the cloud provider to the VPC.
	ID CloudProviderResourceID

	// The location of the VPC. For example, "us-east-1".
	Location string

	// The IPv4 network range for the VPC, in CIDR notation. For example, "10.0.0.0/16".
	CidrBlock string

	// The status of the VPC.
	Status VPCStatus

	// The subnets associated with the VPC.
	Subnets []*Subnet

	// The tags associated with the VPC.
	Tags Tags
}

type VPCStatus string