models

Documentation

Overview

Package models defines the different object models used in EdgeCluster

Package models defines the different object models used in EdgeCluster

Index

• Variables
• type ClusterType
• type EdgeCluster
  • func (val EdgeCluster) Validate() error
• type EdgeClusterNodeStatus
• type EdgeClusterPod
• type EdgeClusterWithCursor
• type ParsedToken
• type ProvisionDetails

Variables

var (
	// ContextKeyParsedToken var
	ContextKeyParsedToken = contextKey("ParsedToken")
)

Types

type ClusterType

type ClusterType int

ClusterType is the edge cluster type

const (
	// K3S is an edge cluster using K3S server and agent nodes
	K3S ClusterType = iota
)

type EdgeCluster

type EdgeCluster struct {
	ProjectID     string      `bson:"projectID" json:"projectID"`
	Name          string      `bson:"name" json:"name"`
	ClusterSecret string      `bson:"clusterSecret" json:"clusterSecret"`
	ClusterType   ClusterType `bson:"clusterType" json:"clusterType"`
}

EdgeCluster defines the Edge Cluster object

func (EdgeCluster) Validate

func (val EdgeCluster) Validate() error

Validate validates the EdgeCluster and return error if the validation failes Returns error if validation failes

type EdgeClusterNodeStatus

type EdgeClusterNodeStatus struct {
	// Node contains information about an existing edge cluster node
	Node v1.Node
}

EdgeClusterNodeStatus is information about the current status of a node.

type EdgeClusterPod

type EdgeClusterPod struct {
	// Pod contains information about a deployed edge cluster node pod
	Pod v1.Pod
}

EdgeClusterPod is information about the current status of a pod.

type EdgeClusterWithCursor

type EdgeClusterWithCursor struct {
	EdgeClusterID    string
	EdgeCluster      EdgeCluster
	Cursor           string
	ProvisionDetails ProvisionDetails
}

EdgeClusterWithCursor implements the pair of the edge cluster with a cursor that determines the location of the edge cluster in the repository.

type ParsedToken

type ParsedToken struct {
	Email string
}

ParsedToken contains details that are encoded in the received JWT token

type ProvisionDetails

type ProvisionDetails struct {
	Ingress           []v1.LoadBalancerIngress
	Ports             []v1.ServicePort
	KubeconfigContent string
}

ProvisionDetails represents the provision detail of an edge cluster