v1alpha1

Documentation

Index

• type Component
• type ComponentParameter
• type ComponentSpec
• type Configuration
• type ConfigurationSpec
• type ConfigurationSpecComponent
• type ConfigurationSpecComponentScope
• type ConfigurationSpecComponentScopeRef
• type ConfigurationSpecComponentTrait
• type DefinitionRef
• type ScopeDefinition
• type ScopeDefinitionSpec
• type TraitDefinition
• type TraitDefinitionSpec
• type WorkloadDefinition
• type WorkloadDefinitionSpec

Types

type Component

type Component struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec ComponentSpec `json:"spec,omitempty"`
}

Component is the structure for the core OAM Application Component

type ComponentParameter

type ComponentParameter struct {
	Name        string   `json:"name"`
	FieldPaths  []string `json:"fieldPaths"`
	Required    *bool    `json:"required,omitempty"`
	Description *string  `json:"description,omitempty"`
}

ComponentParameter is the structure for the core OAM Application Component Paramater

type ComponentSpec

type ComponentSpec struct {
	Type       string                 `json:"type"`
	Settings   map[string]interface{} `json:"settings"`
	Parameters []ComponentParameter   `json:"parameters"`
}

ComponentSpec is the structure for the core OAM Application Component Spec

type Configuration

type Configuration struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec ConfigurationSpec `json:"spec,omitempty"`
}

Configuration is the structure for OAM Application Configuration

type ConfigurationSpec

type ConfigurationSpec struct {
	Components []ConfigurationSpecComponent
}

ConfigurationSpec is the structure for the OAM Application Configuration Spec

type ConfigurationSpecComponent

type ConfigurationSpecComponent struct {
	ComponentName string
	Traits        []ConfigurationSpecComponentTrait
	Scopes        []ConfigurationSpecComponentScope
}

ConfigurationSpecComponent is the struct for OAM Appl

type ConfigurationSpecComponentScope

type ConfigurationSpecComponentScope struct {
	ScopeRef ConfigurationSpecComponentScopeRef
}

type ConfigurationSpecComponentScopeRef

type ConfigurationSpecComponentScopeRef struct {
	metav1.TypeMeta `json:",inline"`
	Name            string
}

type ConfigurationSpecComponentTrait

type ConfigurationSpecComponentTrait struct {
	Name       string
	Properties map[string]interface{}
}

ConfigurationSpecComponentTrait is the struct

type DefinitionRef

type DefinitionRef struct {
	Name string `json:"name,omitempty"`
}

type ScopeDefinition

type ScopeDefinition struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec ScopeDefinitionSpec
}

type ScopeDefinitionSpec

type ScopeDefinitionSpec struct {
	AllowComponentOverlap bool          `json:"allowComponentOverlap,omitempty"`
	DefinitionRef         DefinitionRef `json:"definitionRef,omitempty"`
}

type TraitDefinition

type TraitDefinition struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec TraitDefinitionSpec `json:"spec,omitempty"`
}

type TraitDefinitionSpec

type TraitDefinitionSpec struct {
	AppliesToWorkloads []string      `json:"appliesToWorkloads,omitempty"`
	DefinitionRef      DefinitionRef `json:"definitionRef,omitempty"`
	RevisionEnabled    bool          `json:"revisionEnabled,omitempty"`
}

type WorkloadDefinition

type WorkloadDefinition struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec WorkloadDefinitionSpec `json:"spec,omitempty"`
}

type WorkloadDefinitionSpec

type WorkloadDefinitionSpec struct {
	DefinitionRef DefinitionRef `json:"definitionRef,omitempty"`
}