primitives

Documentation

Overview

Package primitives contains data types for interacting with Manifold.

Index

• Constants
• func GetGeneratedDeepCopyFuncs() []conversion.GeneratedDeepCopyFunc
• type CredentialSpec
  • func (in *CredentialSpec) DeepCopy() *CredentialSpec
  • func (in *CredentialSpec) DeepCopyInto(out *CredentialSpec)
  • func (c *CredentialSpec) Valid() bool
• type CredentialValue
  • func (in *CredentialValue) DeepCopy() *CredentialValue
  • func (in *CredentialValue) DeepCopyInto(out *CredentialValue)
• type Project
  • func (in *Project) DeepCopy() *Project
  • func (in *Project) DeepCopyInto(out *Project)
  • func (in *Project) DeepCopyObject() runtime.Object
  • func (p *Project) Valid() bool
• type ProjectList
  • func (in *ProjectList) DeepCopy() *ProjectList
  • func (in *ProjectList) DeepCopyInto(out *ProjectList)
  • func (in *ProjectList) DeepCopyObject() runtime.Object
• type ProjectSpec
  • func (in *ProjectSpec) DeepCopy() *ProjectSpec
  • func (in *ProjectSpec) DeepCopyInto(out *ProjectSpec)
  • func (p *ProjectSpec) Valid() bool
• type Resource
  • func (in *Resource) DeepCopy() *Resource
  • func (in *Resource) DeepCopyInto(out *Resource)
  • func (in *Resource) DeepCopyObject() runtime.Object
  • func (r *Resource) Valid() bool
• type ResourceList
  • func (in *ResourceList) DeepCopy() *ResourceList
  • func (in *ResourceList) DeepCopyInto(out *ResourceList)
  • func (in *ResourceList) DeepCopyObject() runtime.Object
• type ResourceSpec
  • func (in *ResourceSpec) DeepCopy() *ResourceSpec
  • func (in *ResourceSpec) DeepCopyInto(out *ResourceSpec)
  • func (r *ResourceSpec) Valid() bool

Constants

const (
	CRDGroup   = "manifold.co"
	CRDVersion = "v1"

	CRDProjectsPlural = "projects"
	CRDProjectsName   = "Project"

	CRDResourcesPlural = "resources"
	CRDResourcesName   = "Resource"
)

Constants for CRD

Functions

func GetGeneratedDeepCopyFuncs

func GetGeneratedDeepCopyFuncs() []conversion.GeneratedDeepCopyFunc

GetGeneratedDeepCopyFuncs returns the generated funcs, since we aren't registering them.

Deprecated: deepcopy registration will go away when static deepcopy is fully implemented.

Types

type CredentialSpec

type CredentialSpec struct {
	Key     string `json:"key"`
	Name    string `json:"name,omitempty"`
	Default string `json:"default,omitempty"`
}

CredentialSpec represents the specification that is required to filter out specific credentials in the Resource spec.

func (*CredentialSpec) DeepCopy

func (in *CredentialSpec) DeepCopy() *CredentialSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CredentialSpec.

func (*CredentialSpec) DeepCopyInto

func (in *CredentialSpec) DeepCopyInto(out *CredentialSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*CredentialSpec) Valid

func (c *CredentialSpec) Valid() bool

Valid will validate the CredentialSpec.

type CredentialValue

type CredentialValue struct {
	CredentialSpec `json:",inline"`
	Value          string `json:"value"`
}

CredentialValue is a simple representation of the actual key/value of a Credential.

func (*CredentialValue) DeepCopy

func (in *CredentialValue) DeepCopy() *CredentialValue

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CredentialValue.

func (*CredentialValue) DeepCopyInto

func (in *CredentialValue) DeepCopyInto(out *CredentialValue)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Project

type Project struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata"`
	Spec              *ProjectSpec `json:"spec"`
}

Project is the manifest representation of a manifold.co Project CRD. +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func (*Project) DeepCopy

func (in *Project) DeepCopy() *Project

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Project.

func (*Project) DeepCopyInto

func (in *Project) DeepCopyInto(out *Project)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Project) DeepCopyObject

func (in *Project) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*Project) Valid

func (p *Project) Valid() bool

Valid will validate the Project.

type ProjectList

type ProjectList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`
	Items           []*Project `json:"items"`
}

ProjectList represents a list of available ProjectConfigurations in the cluster. +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func (*ProjectList) DeepCopy

func (in *ProjectList) DeepCopy() *ProjectList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProjectList.

func (*ProjectList) DeepCopyInto

func (in *ProjectList) DeepCopyInto(out *ProjectList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ProjectList) DeepCopyObject

func (in *ProjectList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type ProjectSpec

type ProjectSpec struct {
	Name      string          `json:"project,name"`
	Team      string          `json:"team,omitempty"`
	Resources []*ResourceSpec `json:"resources,omitempty"`
}

ProjectSpec is the specification that is required to build a valid Project manifest.

func (*ProjectSpec) DeepCopy

func (in *ProjectSpec) DeepCopy() *ProjectSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProjectSpec.

func (*ProjectSpec) DeepCopyInto

func (in *ProjectSpec) DeepCopyInto(out *ProjectSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ProjectSpec) Valid

func (p *ProjectSpec) Valid() bool

Valid will validate the ProjectSpec.

type Resource

type Resource struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata"`
	Spec              *ResourceSpec `json:"spec"`
}

Resource is the manifest representation of a manifold.co Resource CRD. +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func (*Resource) DeepCopy

func (in *Resource) DeepCopy() *Resource

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Resource.

func (*Resource) DeepCopyInto

func (in *Resource) DeepCopyInto(out *Resource)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Resource) DeepCopyObject

func (in *Resource) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*Resource) Valid

func (r *Resource) Valid() bool

Valid will validate the resource.

type ResourceList

type ResourceList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`
	Items           []*Resource `json:"items"`
}

ResourceList represents a list of available ResourceConfigurations in the cluster. +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func (*ResourceList) DeepCopy

func (in *ResourceList) DeepCopy() *ResourceList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceList.

func (*ResourceList) DeepCopyInto

func (in *ResourceList) DeepCopyInto(out *ResourceList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ResourceList) DeepCopyObject

func (in *ResourceList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type ResourceSpec

type ResourceSpec struct {
	Name        string            `json:"resource,name"`
	Team        string            `json:"team,omitempty"`
	Credentials []*CredentialSpec `json:"credentials,omitempty"`
}

ResourceSpec is the specification that is required to build a valid Resource manifest.

func (*ResourceSpec) DeepCopy

func (in *ResourceSpec) DeepCopy() *ResourceSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceSpec.

func (*ResourceSpec) DeepCopyInto

func (in *ResourceSpec) DeepCopyInto(out *ResourceSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ResourceSpec) Valid

func (r *ResourceSpec) Valid() bool

Valid will validate the ResourceSpec.