api

package
v0.0.168 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 16, 2023 License: Apache-2.0 Imports: 26 Imported by: 0

Documentation

Index

Constants

View Source 
const AdminScope = "admin"

Variables

This section is empty.

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 DialPortWithToken added in v0.0.165 

func DialPortWithToken(ctx context.Context, token *auth.Token, cluster *KubernetesCluster, targetPort int) (net.Conn, error)

func FetchTenantToken added in v0.0.165 

func FetchTenantToken(ctx context.Context) (*auth.Token, error)

func Register added in v0.0.164 

func Register()

func RegistryCreds added in v0.0.166 

func RegistryCreds(ctx context.Context) (*authn.Basic, error)

func SetupFlags added in v0.0.164 

func SetupFlags(flags *pflag.FlagSet, hide bool)

func TailClusterLogs added in v0.0.168 

func TailClusterLogs(ctx context.Context, api API, opts *LogsOpts, w io.Writer) error

func UserSSHKeys 

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

Types

type API added in v0.0.103 

type API struct {
	StartCreateKubernetesCluster fnapi.Call[CreateKubernetesClusterRequest]
	GetKubernetesCluster         fnapi.Call[GetKubernetesClusterRequest]
	WaitKubernetesCluster        fnapi.Call[WaitKubernetesClusterRequest]
	ListKubernetesClusters       fnapi.Call[ListKubernetesClustersRequest]
	DestroyKubernetesCluster     fnapi.Call[DestroyKubernetesClusterRequest]
	TailClusterLogs              fnapi.Call[TailLogsRequest]
	GetClusterLogs               fnapi.Call[GetLogsRequest]
}
var Endpoint API

func MakeAPI added in v0.0.103 

func MakeAPI(endpoint string) API

type Attachment added in v0.0.167 

type Attachment struct {
	TypeURL string `json:"type_url,omitempty"`
	Content []byte `json:"content,omitempty"`
}

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 CreateClusterOpts added in v0.0.135 

type CreateClusterOpts struct {
	MachineType string
	Ephemeral   bool

	// Whether to keep the cluster alive, regardless of it being ephemeral.
	// This is typically needed if you want to execute multiple ns commands on an ephemeral cluster.
	KeepAlive bool

	Purpose           string
	Features          []string
	AuthorizedSshKeys []string
}

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, opts CreateClusterOpts) (*CreateClusterResult, error)

func EnsureBuildCluster added in v0.0.166 

func EnsureBuildCluster(ctx context.Context, api API) (*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"`
	Attachment        []Attachment `json:"attachment,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 GetLogsRequest added in v0.0.168 

type GetLogsRequest struct {
	ClusterID string        `json:"cluster_id,omitempty"`
	StartTs   *time.Time    `json:"start_ts,omitempty"`
	EndTs     *time.Time    `json:"end_ts,omitempty"`
	Selector  *LogsSelector `json:"selector,omitempty"`
}

type GetLogsResponse added in v0.0.168 

type GetLogsResponse struct {
	LogBlock []LogBlock `json:"log_block,omitempty"`
}

func GetClusterLogs added in v0.0.168 

func GetClusterLogs(ctx context.Context, api API, opts *LogsOpts) (*GetLogsResponse, error)

type ImageRegistry 

type ImageRegistry struct {
	EndpointAddress string `json:"endpoint_address,omitempty"`
	Username        string `json:"username,omitempty"`
	Password        string `json:"password,omitempty"`
}

type KubernetesCluster 

type KubernetesCluster struct {
	ClusterId         string        `json:"cluster_id,omitempty"`
	Created           string        `json:"created,omitempty"`
	DestroyedAt       string        `json:"destroyed_at,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, previousRuns bool) (*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"`
	IncludePreviousRuns bool   `json:"include_previous_runs,omitempty"`
	PaginationCursor    []byte `json:"pagination_cursor,omitempty"`
	MaxEntries          int64  `json:"max_entries,omitempty"`
}

type LogBlock added in v0.0.168 

type LogBlock struct {
	Namespace string    `json:"namespace,omitempty"`
	Pod       string    `json:"pod,omitempty"`
	Container string    `json:"container,omitempty"`
	Line      []LogLine `json:"line,omitempty"`
}

type LogLine added in v0.0.168 

type LogLine struct {
	Timestamp time.Time `json:"timestamp,omitempty"`
	Content   string    `json:"content,omitempty"`
	Stream    string    `json:"stream,omitempty"`
}

func (LogLine) String added in v0.0.168 

func (l LogLine) String() string

type LogsOpts added in v0.0.168 

type LogsOpts struct {
	ClusterID string
	StartTs   *time.Time
	EndTs     *time.Time
	Namespace string
	Pod       string
	Container string
}

type LogsSelector added in v0.0.168 

type LogsSelector struct {
	Namespace string `json:"namespace,omitempty"`
	Pod       string `json:"pod,omitempty"`
	Container string `json:"container,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, opts CreateClusterOpts) (*StartCreateKubernetesClusterResponse, error)

type TailLogsRequest added in v0.0.168 

type TailLogsRequest struct {
	ClusterID string        `json:"cluster_id,omitempty"`
	Selector  *LogsSelector `json:"selector,omitempty"`
}

type WaitKubernetesClusterRequest 

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.