api

Documentation

Index

• func DestroyCluster(ctx context.Context, api API, clusterId string) error
• func DialPort(ctx context.Context, cluster *KubernetesCluster, targetPort int) (net.Conn, error)
• func UserSSHKeys() (compute.Computable[[]string], error)
• type API
  • func MakeAPI(endpoint string) API
• type BuildCluster
• type BuildCluster_ColocatedPort
• type ClusterShape
• type CreateClusterResult
  • func CreateAndWaitCluster(ctx context.Context, api API, machineType string, ephemeral bool, ...) (*CreateClusterResult, error)
  • func WaitCluster(ctx context.Context, api API, clusterId string) (*CreateClusterResult, error)
• type CreateKubernetesClusterRequest
• type CreateKubernetesClusterResponse
• type DestroyKubernetesClusterRequest
• type GetKubernetesClusterRequest
• type GetKubernetesClusterResponse
  • func GetCluster(ctx context.Context, api API, clusterId string) (*GetKubernetesClusterResponse, error)
• type ImageRegistry
• type KubernetesCluster
• type KubernetesClusterList
  • func ListClusters(ctx context.Context, api API) (*KubernetesClusterList, error)
• type LabelEntry
• type ListKubernetesClustersRequest
• type StartCreateKubernetesClusterResponse
  • func CreateCluster(ctx context.Context, api API, machineType string, ephemeral bool, ...) (*StartCreateKubernetesClusterResponse, error)
• type WaitKubernetesClusterRequest

Functions

func DestroyCluster

func DestroyCluster(ctx context.Context, api API, clusterId string) error

func DialPort

func DialPort(ctx context.Context, cluster *KubernetesCluster, targetPort int) (net.Conn, error)

func UserSSHKeys

func UserSSHKeys() (compute.Computable[[]string], error)

Types

type API

type API struct {
	StartCreateKubernetesCluster fnapi.Call[CreateKubernetesClusterRequest]
	GetKubernetesCluster         fnapi.Call[GetKubernetesClusterRequest]
	WaitKubernetesCluster        fnapi.Call[WaitKubernetesClusterRequest]
	ListKubernetesClusters       fnapi.Call[ListKubernetesClustersRequest]
	DestroyKubernetesCluster     fnapi.Call[DestroyKubernetesClusterRequest]
}

var Endpoint API

func MakeAPI

func MakeAPI(endpoint string) API

type BuildCluster

type BuildCluster struct {
	Colocated *BuildCluster_ColocatedPort `json:"colocated,omitempty"`
}

type BuildCluster_ColocatedPort

type BuildCluster_ColocatedPort struct {
	TargetPort int32  `json:"target_port,omitempty"`
	ClusterId  string `json:"cluster_id,omitempty"`
}

type ClusterShape

type ClusterShape struct {
	VirtualCpu      int32 `json:"virtual_cpu,omitempty"`
	MemoryMegabytes int32 `json:"memory_megabytes,omitempty"`
}

type CreateClusterResult

type CreateClusterResult struct {
	ClusterId    string
	Cluster      *KubernetesCluster
	Registry     *ImageRegistry
	BuildCluster *BuildCluster
	Deadline     *time.Time
}

func CreateAndWaitCluster

func CreateAndWaitCluster(ctx context.Context, api API, machineType string, ephemeral bool, purpose string, features []string) (*CreateClusterResult, error)

func WaitCluster

func WaitCluster(ctx context.Context, api API, clusterId string) (*CreateClusterResult, error)

type CreateKubernetesClusterRequest

type CreateKubernetesClusterRequest struct {
	OpaqueUserAuth    []byte   `json:"opaque_user_auth,omitempty"`
	Ephemeral         bool     `json:"ephemeral,omitempty"`
	DocumentedPurpose string   `json:"documented_purpose,omitempty"`
	AuthorizedSshKeys []string `json:"authorized_ssh_keys,omitempty"`
	MachineType       string   `json:"machine_type,omitempty"`
	Feature           []string `json:"feature,omitempty"`
}

type CreateKubernetesClusterResponse

type CreateKubernetesClusterResponse struct {
	Status       string             `json:"status,omitempty"`
	ClusterId    string             `json:"cluster_id,omitempty"`
	Cluster      *KubernetesCluster `json:"cluster,omitempty"`
	Registry     *ImageRegistry     `json:"registry,omitempty"`
	BuildCluster *BuildCluster      `json:"build_cluster,omitempty"`
	Deadline     string             `json:"deadline,omitempty"`
}

type DestroyKubernetesClusterRequest

type DestroyKubernetesClusterRequest struct {
	OpaqueUserAuth []byte `json:"opaque_user_auth,omitempty"`
	ClusterId      string `json:"cluster_id,omitempty"`
}

type GetKubernetesClusterRequest

type GetKubernetesClusterRequest struct {
	OpaqueUserAuth []byte `json:"opaque_user_auth,omitempty"`
	ClusterId      string `json:"cluster_id,omitempty"`
}

type GetKubernetesClusterResponse

type GetKubernetesClusterResponse struct {
	Cluster      *KubernetesCluster `json:"cluster,omitempty"`
	Registry     *ImageRegistry     `json:"registry,omitempty"`
	BuildCluster *BuildCluster      `json:"build_cluster,omitempty"`
	Deadline     string             `json:"deadline,omitempty"`
}

func GetCluster

func GetCluster(ctx context.Context, api API, clusterId string) (*GetKubernetesClusterResponse, error)

type ImageRegistry

type ImageRegistry struct {
	EndpointAddress string `json:"endpoint_address,omitempty"`
}

type KubernetesCluster

type KubernetesCluster struct {
	ClusterId         string        `json:"cluster_id,omitempty"`
	Created           string        `json:"created,omitempty"`
	Deadline          string        `json:"deadline,omitempty"`
	SSHProxyEndpoint  string        `json:"ssh_proxy_endpoint,omitempty"`
	SshPrivateKey     []byte        `json:"ssh_private_key,omitempty"`
	DocumentedPurpose string        `json:"documented_purpose,omitempty"`
	Shape             *ClusterShape `json:"shape,omitempty"`

	EndpointAddress          string `json:"endpoint_address,omitempty"`
	CertificateAuthorityData []byte `json:"certificate_authority_data,omitempty"`
	ClientCertificateData    []byte `json:"client_certificate_data,omitempty"`
	ClientKeyData            []byte `json:"client_key_data,omitempty"`

	KubernetesDistribution string   `json:"kubernetes_distribution,omitempty"`
	Platform               []string `json:"platform,omitempty"`

	IngressDomain string `json:"ingress_domain,omitempty"`

	Label []*LabelEntry `json:"label,omitempty"`
}

type KubernetesClusterList

type KubernetesClusterList struct {
	Clusters []KubernetesCluster `json:"cluster"`
}

func ListClusters

func ListClusters(ctx context.Context, api API) (*KubernetesClusterList, error)

type LabelEntry

type LabelEntry struct {
	Name  string `json:"name,omitempty"`
	Value string `json:"value,omitempty"`
}

type ListKubernetesClustersRequest

type ListKubernetesClustersRequest struct {
	OpaqueUserAuth []byte `json:"opaque_user_auth,omitempty"`
}

type StartCreateKubernetesClusterResponse

type StartCreateKubernetesClusterResponse struct {
	ClusterId       string             `json:"cluster_id,omitempty"`
	ClusterFragment *KubernetesCluster `json:"cluster_fragment,omitempty"`
	Registry        *ImageRegistry     `json:"registry,omitempty"`
	Deadline        string             `json:"deadline,omitempty"`
}

func CreateCluster

func CreateCluster(ctx context.Context, api API, machineType string, ephemeral bool, purpose string, features []string) (*StartCreateKubernetesClusterResponse, error)

type WaitKubernetesClusterRequest

type WaitKubernetesClusterRequest struct {
	OpaqueUserAuth []byte `json:"opaque_user_auth,omitempty"`
	ClusterId      string `json:"cluster_id,omitempty"`
}