core

Documentation

Index

• Constants
• func DeleteK8sWorkloads(ctx string)
• func ErrGetK8sComponents(err error) error
• func GetK8Components(config []byte, ctx string) (*manifests.Component, error)
• func RegisterMesheryOAMTraits() error
• func RegisterMesheryOAMWorkloads() error
• func RegisterScope(data []byte) (err error)
• func RegisterTrait(data []byte) (err error)
• func RegisterWorkload(data []byte) (err error)
• type Pattern
  • func NewPatternFile(yml []byte) (af Pattern, err error)
  • func NewPatternFileFromCytoscapeJSJSON(byt []byte) (Pattern, error)
  • func (p *Pattern) GenerateApplicationConfiguration() (v1alpha1.Configuration, error)
  • func (p *Pattern) GetApplicationComponent(name string) (v1alpha1.Component, error)
  • func (p *Pattern) GetServiceType(name string) string
  • func (p *Pattern) ToCytoscapeJS() (cytoscapejs.GraphElem, error)
  • func (p *Pattern) ToYAML() ([]byte, error)
• type ScopeCapability
  • func GetScope(name string) (s []ScopeCapability)
  • func GetScopeByID(name, id string) (w *ScopeCapability)
  • func GetScopes() (scopes []ScopeCapability)
  • func (cap *ScopeCapability) GetID() string
  • func (cap *ScopeCapability) SetID(id string)
• type Service
• type TraitCapability
  • func GetTrait(name string) (t []TraitCapability)
  • func GetTraitByID(name, id string) *TraitCapability
  • func GetTraits() (traits []TraitCapability)
  • func (cap *TraitCapability) GetID() string
  • func (cap *TraitCapability) SetID(id string)
• type WorkloadCapability
  • func GetWorkload(name string) (w []WorkloadCapability)
  • func GetWorkloadByID(name, id string) *WorkloadCapability
  • func GetWorkloads() (caps []WorkloadCapability)
  • func (cap *WorkloadCapability) GetID() string
  • func (cap *WorkloadCapability) SetID(id string)

Constants

const (
	ErrGetK8sComponentsCode = "2154"
)

Functions

func DeleteK8sWorkloads

func DeleteK8sWorkloads(ctx string)

DeleteK8sWorkloads deletes the registered in memory k8s workloads for a given k8s contextID.

func ErrGetK8sComponents

func ErrGetK8sComponents(err error) error

func GetK8Components

func GetK8Components(config []byte, ctx string) (*manifests.Component, error)

GetK8Components returns all the generated definitions and schemas for available api resources

func RegisterMesheryOAMTraits

func RegisterMesheryOAMTraits() error

RegisterMesheryOAMTraits will register local meshery traits with meshery server

func RegisterMesheryOAMWorkloads

func RegisterMesheryOAMWorkloads() error

RegisterMesheryOAMWorkloads will register local meshery workloads with meshery server

func RegisterScope

func RegisterScope(data []byte) (err error)

RegisterScope will register a Scope definition into the database

func RegisterTrait

func RegisterTrait(data []byte) (err error)

RegisterTrait will register a TraitDefinition into the database

func RegisterWorkload

func RegisterWorkload(data []byte) (err error)

RegisterWorkload will register a workload definition into the database

Types

type Pattern

type Pattern struct {
	// Name is the human-readable, display-friendly descriptor of the pattern
	Name string `yaml:"name,omitempty" json:"name,omitempty"`
	// PatternID is the moniker use to uniquely identify any given pattern
	// Convention: SMP-###-v#.#.#
	PatternID string              `yaml:"patternID,omitempty" json:"patternID,omitempty"`
	Services  map[string]*Service `yaml:"services,omitempty" json:"services,omitempty"`
}

Pattern is the golang representation of the Pattern config file model

func NewPatternFile

func NewPatternFile(yml []byte) (af Pattern, err error)

NewPatternFile takes in raw yaml and encodes it into a construct

func NewPatternFileFromCytoscapeJSJSON

func NewPatternFileFromCytoscapeJSJSON(byt []byte) (Pattern, error)

NewPatternFileFromCytoscapeJSJSON takes in CytoscapeJS JSON and creates a PatternFile from it

func (*Pattern) GenerateApplicationConfiguration

func (p *Pattern) GenerateApplicationConfiguration() (v1alpha1.Configuration, error)

GenerateApplicationConfiguration generates OAM Application Configuration from the the given Pattern file for a particular deploymnet

func (*Pattern) GetApplicationComponent

func (p *Pattern) GetApplicationComponent(name string) (v1alpha1.Component, error)

GetApplicationComponent generates OAM Application Components from the the given Pattern file

func (*Pattern) GetServiceType

func (p *Pattern) GetServiceType(name string) string

GetServiceType returns the type of the service

func (*Pattern) ToCytoscapeJS

func (p *Pattern) ToCytoscapeJS() (cytoscapejs.GraphElem, error)

ToCytoscapeJS converts pattern file into cytoscape object

func (*Pattern) ToYAML

func (p *Pattern) ToYAML() ([]byte, error)

ToYAML converts a patternfile to yaml

type ScopeCapability

type ScopeCapability struct {
	OAMDefinition v1alpha1.ScopeDefinition `json:"oam_definition,omitempty"`
	// contains filtered or unexported fields
}

ScopeCapability is the struct for capturing the ScopeDefinition of a particular type

func GetScope

func GetScope(name string) (s []ScopeCapability)

GetScope takes in a scope name and will return a SLICE of all of the scopes registered against the name

func GetScopeByID

func GetScopeByID(name, id string) (w *ScopeCapability)

GetScopeByID takes an id of a scope and returns the scope

func GetScopes

func GetScopes() (scopes []ScopeCapability)

GetScopes return all of the scopes

func (*ScopeCapability) GetID

func (cap *ScopeCapability) GetID() string

GetID returns the ID of the capability

func (*ScopeCapability) SetID

func (cap *ScopeCapability) SetID(id string)

SetID sets the ID of the capability

type Service

type Service struct {
	// ID is the id of the service and is completely internal to
	// Meshery Server and meshery providers
	ID *uuid.UUID `yaml:"id,omitempty" json:"id,omitempty"`
	// Name is the name of the service and is an optional parameter
	// If given then this supercedes the name of the service inherited
	// from the parent
	Name      string `yaml:"name,omitempty" json:"name,omitempty"`
	Type      string `yaml:"type,omitempty" json:"type,omitempty"`
	Namespace string `yaml:"namespace,omitempty" json:"namespace,omitempty"`
	// DependsOn correlates one or more objects as a required dependency of this service
	// DependsOn is used to determine sequence of operations
	DependsOn []string `yaml:"dependsOn,omitempty" json:"dependsOn,omitempty"`

	Settings map[string]interface{} `yaml:"settings,omitempty" json:"settings,omitempty"`
	Traits   map[string]interface{} `yaml:"traits,omitempty" json:"traits,omitempty"`
}

Service represents the services defined within the appfile

type TraitCapability

type TraitCapability struct {
	OAMDefinition v1alpha1.TraitDefinition `json:"oam_definition,omitempty"`
	// contains filtered or unexported fields
}

TraitCapability is the struct for capturing the workload definition of a particular type

func GetTrait

func GetTrait(name string) (t []TraitCapability)

GetTrait takes in a trait name and will return a SLICE of all of the traits registered against the name

func GetTraitByID

func GetTraitByID(name, id string) *TraitCapability

GetTraitByID takes an id of a trait and returns the trait

func GetTraits

func GetTraits() (traits []TraitCapability)

GetTraits return all of the traits

func (*TraitCapability) GetID

func (cap *TraitCapability) GetID() string

GetID returns the ID of the capability

func (*TraitCapability) SetID

func (cap *TraitCapability) SetID(id string)

SetID sets the ID of the capability

type WorkloadCapability

type WorkloadCapability struct {
	OAMDefinition v1alpha1.WorkloadDefinition `json:"oam_definition,omitempty"`
	// contains filtered or unexported fields
}

WorkloadCapability is the struct for capturing the workload definition of a particular type

func GetWorkload

func GetWorkload(name string) (w []WorkloadCapability)

GetWorkload takes in a workload name and will return a SLICE of all of the workloads registered against the name

func GetWorkloadByID

func GetWorkloadByID(name, id string) *WorkloadCapability

GetWorkloadByID takes an id of a workload and returns the workload

func GetWorkloads

func GetWorkloads() (caps []WorkloadCapability)

GetWorkloads return all of the workloads

func (*WorkloadCapability) GetID

func (cap *WorkloadCapability) GetID() string

GetID returns the ID of the capability

func (*WorkloadCapability) SetID

func (cap *WorkloadCapability) SetID(id string)

SetID sets the ID of the capability