api

Documentation

Index

• Constants
• type Cluster
• type ClusterGetter
• type ClusterGroup
  • func (g *ClusterGroup) IsMember(clusterName string) bool
• type CreateRequest
  • func (g *CreateRequest) Validate() error
• type CreateResponse
• type Feature
• type FeatureHandler
• type FeatureRequest
• type FeatureResponse
• type Member
• type UpdateRequest
  • func (g *UpdateRequest) Validate() error
• type UpdateResponse

Constants

const ReconcileFailed = "FAILED"

const ReconcileInProgress = "IN_PROGRESS"

const ReconcileSucceded = "SUCCESS"

Types

type Cluster

type Cluster interface {
	GetID() uint
	GetCloud() string
	GetDistribution() string
	GetName() string
	GetK8sConfig() ([]byte, error)
	GetStatus() (*cluster.GetClusterStatusResponse, error)
	IsReady() (bool, error)
}

Cluster

type ClusterGetter

type ClusterGetter interface {
	GetClusterByIDOnly(ctx context.Context, clusterID uint) (Cluster, error)
	GetClusterByID(ctx context.Context, organizationID uint, clusterID uint) (Cluster, error)
	GetClusterByName(ctx context.Context, organizationID uint, clusterName string) (Cluster, error)
}

ClusterGetter

type ClusterGroup

type ClusterGroup struct {
	Id              uint             `json:"id" yaml:"id" example:"10"`
	UID             string           `json:"uid" yaml:"uid"`
	Name            string           `json:"name" yaml:"name"`
	OrganizationID  uint             `json:"organizationId" yaml:"organizationId"`
	Members         []Member         `json:"members,omitempty" yaml:"members"`
	EnabledFeatures []string         `json:"enabledFeatures,omitempty" yaml:"enabledFeatures"`
	Clusters        map[uint]Cluster `json:"-" yaml:"-"`
}

ClusterGroup

func (*ClusterGroup) IsMember

func (g *ClusterGroup) IsMember(clusterName string) bool

type CreateRequest

type CreateRequest struct {
	Name    string `json:"name" yaml:"name" example:"cluster_group_name"`
	Members []uint `json:"members" yaml:"members"`
}

CreateRequest describes fields of a create cluster group request

func (*CreateRequest) Validate

func (g *CreateRequest) Validate() error

Validate validates CreateRequest

type CreateResponse

type CreateResponse struct {
	Name       string `json:"name" example:"cluster_group_name"`
	ResourceID uint   `json:"id"`
}

CreateResponse describes fields of a create cluster group response

type Feature

type Feature struct {
	Name               string       `json:"name"`
	ClusterGroup       ClusterGroup `json:"clusterGroup"`
	Enabled            bool         `json:"enabled"`
	Properties         interface{}  `json:"properties,omitempty"`
	ReconcileState     string       `json:"reconcileState,omitempty"`
	LastReconcileError string       `json:"lastReconcileError,omitempty"`
}

Feature

type FeatureHandler

type FeatureHandler interface {
	ReconcileState(featureState Feature) error
	ValidateState(featureState Feature) error
	ValidateProperties(clusterGroup ClusterGroup, currentProperties, properties interface{}) error
	GetMembersStatus(featureState Feature) (map[uint]string, error)
}

type FeatureRequest

type FeatureRequest interface{}

FeatureRequest

type FeatureResponse

type FeatureResponse struct {
	Name               string          `json:"name"`
	ClusterGroup       ClusterGroup    `json:"clusterGroup"`
	Enabled            bool            `json:"enabled"`
	Properties         FeatureRequest  `json:"properties,omitempty" yaml:"properties"`
	Status             map[uint]string `json:"status,omitempty" yaml:"status"`
	ReconcileState     string          `json:"reconcileState,omitempty" yaml:"reconcileState"`
	LastReconcileError string          `json:"lastReconcileError,omitempty" yaml:"lastReconcileError"`
}

FeatureResponse

type Member

type Member struct {
	ID           uint   `json:"id" yaml:"id" example:"1001"`
	Cloud        string `json:"cloud,omitempty" yaml:"cloud" example:"google"`
	Distribution string `json:"distribution,omitempty" yaml:"distribution" example:"gke"`
	Name         string `json:"name" yaml:"name" example:"clusterName"`
	Status       string `json:"status,omitempty" yaml:"status,omitempty"`
}

Member

type UpdateRequest

type UpdateRequest struct {
	Name    string `json:"name" yaml:"name" example:"cluster_group_name"`
	Members []uint `json:"members,omitempty" yaml:"members"`
}

UpdateRequest describes fields of a update cluster group request

func (*UpdateRequest) Validate

func (g *UpdateRequest) Validate() error

Validate validates UpdateRequest

type UpdateResponse

type UpdateResponse struct {
	Name       string `json:"name" example:"cluster_group_name"`
	ResourceID uint   `json:"id"`
}

UpdateResponse describes fields of a update cluster group response