api

Documentation

Index

• Constants
• func CloudEventToJSONMap(evt *cloudevents.Event) (datatypes.JSONMap, error)
• func DecodeBundleStatus(status datatypes.JSONMap) (map[string]interface{}, error)
• func JSONMAPToCloudEvent(jsonmap datatypes.JSONMap) (*cloudevents.Event, error)
• func NewID() string
• func SendAPI(w http.ResponseWriter, r *http.Request)
• func SendAPIV1(w http.ResponseWriter, r *http.Request)
• func SendNotFound(w http.ResponseWriter, r *http.Request)
• func SendPanic(w http.ResponseWriter, r *http.Request)
• func SendUnauthorized(w http.ResponseWriter, r *http.Request, message string)
• type CollectionMetadata
• type Consumer
  • func (d *Consumer) BeforeCreate(tx *gorm.DB) error
• type ConsumerIndex
• type ConsumerList
  • func (l ConsumerList) Index() ConsumerIndex
• type ConsumerPatchRequest
• type Error
• type Event
  • func (d *Event) BeforeCreate(tx *gorm.DB) error
• type EventIndex
• type EventInstance
• type EventInstanceList
• type EventList
  • func (l EventList) Index() EventIndex
• type EventType
• type ManifestBundleWrapper
  • func DecodeManifestBundle(manifestBundle datatypes.JSONMap) (*ManifestBundleWrapper, error)
• type Meta
• type Metadata
• type PagingMeta
• type Resource
  • func (d *Resource) BeforeCreate(tx *gorm.DB) error
  • func (d *Resource) GetDeletionTimestamp() *metav1.Time
  • func (d *Resource) GetResourceVersion() string
  • func (d *Resource) GetUID() ktypes.UID
• type ResourceBundleStatus
• type ResourceIndex
• type ResourceList
  • func (l ResourceList) Index() ResourceIndex
• type ResourceType
• type ServerInstance
  • func (i *ServerInstance) String() string
• type ServerInstanceList
• type StatusEvent
  • func (e *StatusEvent) BeforeCreate(tx *gorm.DB) error
• type StatusEventIndex
• type StatusEventList
  • func (l StatusEventList) Index() StatusEventIndex
• type StatusEventType
• type VersionMetadata

Constants

const ErrorType = "Error"

ErrorType is the name of the type used to report errors.

Functions

func CloudEventToJSONMap

func CloudEventToJSONMap(evt *cloudevents.Event) (datatypes.JSONMap, error)

CloudEventToJSONMap converts a CloudEvent to a JSONMap (resource manifest or status)

func DecodeBundleStatus

func DecodeBundleStatus(status datatypes.JSONMap) (map[string]interface{}, error)

DecodeBundleStatus converts a CloudEvent JSONMap representation of a resource bundle status into resource bundle status (map[string]interface{}) in openapi output.

func JSONMAPToCloudEvent

func JSONMAPToCloudEvent(jsonmap datatypes.JSONMap) (*cloudevents.Event, error)

JSONMAPToCloudEvent converts a JSONMap (resource manifest or status) to a CloudEvent

func NewID

func NewID() string

func SendAPI

func SendAPI(w http.ResponseWriter, r *http.Request)

SendAPI sends API documentation response.

func SendAPIV1

func SendAPIV1(w http.ResponseWriter, r *http.Request)

SendAPIV1 sends API version v1 documentation response.

func SendNotFound

func SendNotFound(w http.ResponseWriter, r *http.Request)

SendNotFound sends a 404 response with some details about the non existing resource.

func SendPanic

func SendPanic(w http.ResponseWriter, r *http.Request)

SendPanic sends a panic error response to the client, but it doesn't end the process.

func SendUnauthorized

func SendUnauthorized(w http.ResponseWriter, r *http.Request, message string)

Types

type CollectionMetadata

type CollectionMetadata struct {
	ID   string `json:"id"`
	HREF string `json:"href"`
	Kind string `json:"kind"`
}

CollectionMetadata represents a collection.

type Consumer

type Consumer struct {
	Meta

	// Name must be unique and not null, it can be treated as the consumer external ID.
	// The format of the name should be follow the RFC 1123 (same as the k8s namespace).
	// When creating a consumer, if its name is not specified, the consumer id will be used as its name.
	//
	// Cannot be updated.
	Name   string
	Labels *db.StringMap
}

func (*Consumer) BeforeCreate

func (d *Consumer) BeforeCreate(tx *gorm.DB) error

type ConsumerIndex

type ConsumerIndex map[string]*Consumer

type ConsumerList

type ConsumerList []*Consumer

func (ConsumerList) Index

func (l ConsumerList) Index() ConsumerIndex

type ConsumerPatchRequest

type ConsumerPatchRequest struct {
}

type Error

type Error struct {
	Type   string `json:"type,omitempty"`
	ID     string `json:"id,omitempty"`
	HREF   string `json:"href,omitempty"`
	Code   string `json:"code,omitempty"`
	Reason string `json:"reason,omitempty"`
}

Error represents an error reported by the API.

type Event

type Event struct {
	Meta
	Source         string     // MyTable
	SourceID       string     // primary key of MyTable
	EventType      EventType  // Add|Update|Delete
	ReconciledDate *time.Time `json:"gorm:null"`
}

func (*Event) BeforeCreate

func (d *Event) BeforeCreate(tx *gorm.DB) error

type EventIndex

type EventIndex map[string]*Event

type EventInstance

type EventInstance struct {
	EventID    string
	InstanceID string
}

type EventInstanceList

type EventInstanceList []*EventInstance

type EventList

type EventList []*Event

func (EventList) Index

func (l EventList) Index() EventIndex

type EventType

type EventType string

const (
	CreateEventType EventType = "Create"
	UpdateEventType EventType = "Update"
	DeleteEventType EventType = "Delete"
)

type ManifestBundleWrapper

type ManifestBundleWrapper struct {
	Meta            map[string]interface{}
	Manifests       []map[string]interface{}
	ManifestConfigs []map[string]interface{}
	DeleteOption    map[string]interface{}
}

ManifestBundleWrapper is a wrapper used for openapi output that contains: * metadata - manifestwork metadata * manifests - resource manifests * manifest configs - manifest configs * delete option - delete option

func DecodeManifestBundle

func DecodeManifestBundle(manifestBundle datatypes.JSONMap) (*ManifestBundleWrapper, error)

DecodeManifestBundle converts a CloudEvent JSONMap representation of a list of resource manifests into manifests and manifestconfigs that will be used in openapi output.

type Meta

type Meta struct {
	ID        string
	CreatedAt time.Time
	UpdatedAt time.Time
	DeletedAt gorm.DeletedAt `gorm:"index"`
}

Meta is base model definition, embedded in all kinds

type Metadata

type Metadata struct {
	ID       string            `json:"id"`
	HREF     string            `json:"href"`
	Kind     string            `json:"kind"`
	Versions []VersionMetadata `json:"versions"`
}

Metadata api metadata.

type PagingMeta

type PagingMeta struct {
	Page  int
	Size  int64
	Total int64
}

List Paging metadata

type Resource

type Resource struct {
	Meta
	Version      int32
	Source       string
	ConsumerName string
	Type         ResourceType
	Payload      datatypes.JSONMap
	Status       datatypes.JSONMap
	// Name must be unique and not null, it can be treated as the resource external ID.
	// The format of the name should be follow the RFC 1123 (same as the k8s namespace).
	// When creating a resource, if its name is not specified, the resource id will be used as its name.
	// Cannot be updated.
	Name string
}

func (*Resource) BeforeCreate

func (d *Resource) BeforeCreate(tx *gorm.DB) error

func (*Resource) GetDeletionTimestamp

func (d *Resource) GetDeletionTimestamp() *metav1.Time

func (*Resource) GetResourceVersion

func (d *Resource) GetResourceVersion() string

func (*Resource) GetUID

func (d *Resource) GetUID() ktypes.UID

type ResourceBundleStatus

type ResourceBundleStatus struct {
	ObservedVersion int32
	SequenceID      string
	*workpayload.ManifestBundleStatus
}

ResourceBundleStatus defines resource bundle status

type ResourceIndex

type ResourceIndex map[string]*Resource

type ResourceList

type ResourceList []*Resource

func (ResourceList) Index

func (l ResourceList) Index() ResourceIndex

type ResourceType

type ResourceType string

type ServerInstance

type ServerInstance struct {
	Meta
	LastHeartbeat time.Time // LastHeartbeat indicates the last time the instance sent a heartbeat.
	Ready         bool      // Ready indicates whether the instance is ready to serve requests.
}

ServerInstance is employed by Maestro to discover active server instances. The updatedAt field determines the liveness of the instance; if the instance remains unchanged for three consecutive check intervals (30 seconds by default), it is marked as dead. However, it is not meant for direct exposure to end users through the API.

func (*ServerInstance) String

func (i *ServerInstance) String() string

String returns the identifier of the maestro instance.

type ServerInstanceList

type ServerInstanceList []*ServerInstance

type StatusEvent

type StatusEvent struct {
	Meta
	ResourceID      string
	ResourceSource  string
	ResourceType    ResourceType
	Payload         datatypes.JSONMap
	Status          datatypes.JSONMap
	StatusEventType StatusEventType // Update|Delete
	ReconciledDate  *time.Time      `json:"gorm:null"`
}

func (*StatusEvent) BeforeCreate

func (e *StatusEvent) BeforeCreate(tx *gorm.DB) error

type StatusEventIndex

type StatusEventIndex map[string]*StatusEvent

type StatusEventList

type StatusEventList []*StatusEvent

func (StatusEventList) Index

func (l StatusEventList) Index() StatusEventIndex

type StatusEventType

type StatusEventType string

const (
	StatusUpdateEventType StatusEventType = "StatusUpdate"
	StatusDeleteEventType StatusEventType = "StatusDelete"
)

type VersionMetadata

type VersionMetadata struct {
	ID          string               `json:"id"`
	HREF        string               `json:"href"`
	Kind        string               `json:"kind"`
	Collections []CollectionMetadata `json:"collections"`
}

VersionMetadata represents a version.