v1alpha1

package
v0.4.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 17, 2018 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Overview

Package v1alpha1 represents the v1alpha1 version of extenisons for the Cluster Bundle API. These are APIs that are not core to the Cluster Bundle, but provide value-add functionality.

These types here are quite experimental and indicate how we think the ClusterBundle and components might be used to create clusters.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type EnvVar 

type EnvVar struct {
	// Name of this environment variable. E.g., FOO_VAR. The name of the
	// environment variable should be unique within a node bootstrap
	// configuration.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The value to set for this environment variable.
	Value                string   `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

An environment variable specified for node startup.

func (*EnvVar) Descriptor 

func (*EnvVar) Descriptor() ([]byte, []int)

func (*EnvVar) GetName 

func (m *EnvVar) GetName() string

func (*EnvVar) GetValue 

func (m *EnvVar) GetValue() string

func (*EnvVar) ProtoMessage 

func (*EnvVar) ProtoMessage()

func (*EnvVar) Reset 

func (m *EnvVar) Reset()

func (*EnvVar) String 

func (m *EnvVar) String() string

func (*EnvVar) XXX_DiscardUnknown 

func (m *EnvVar) XXX_DiscardUnknown()

func (*EnvVar) XXX_Marshal 

func (m *EnvVar) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*EnvVar) XXX_Merge 

func (m *EnvVar) XXX_Merge(src proto.Message)

func (*EnvVar) XXX_Size 

func (m *EnvVar) XXX_Size() int

func (*EnvVar) XXX_Unmarshal 

func (m *EnvVar) XXX_Unmarshal(b []byte) error

type NodeConfig 

type NodeConfig struct {
	// Required. Kubernetes API Version for the NodeConfig type.
	// Should be 'gke.io/k8s-cluster-bundle-extensions/v1alpha1'
	ApiVersion string `protobuf:"bytes,1,opt,name=apiVersion,proto3" json:"apiVersion,omitempty"`
	// Required. The Kubernetes `kind` for this object. Must always be
	// 'NodeConfig'.
	Kind string `protobuf:"bytes,2,opt,name=kind,proto3" json:"kind,omitempty"`
	// Kubernetes Metadata for the node config. The Metadata.name field must be
	// filled out and each node config in a bundle must have a unique name. For
	// example you might have a 'master-node-config' component or perhaps even a
	// 'gpu-config' config.
	Metadata *v1alpha1.ObjectMeta `protobuf:"bytes,3,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// Initialization file to run on VM startup. The contents of this init file
	// will depend a great deal on the specific environment and operation system.
	//
	// Types that are valid to be assigned to InitData:
	//	*NodeConfig_InitFile
	//	*NodeConfig_ExternalInitFile
	InitData isNodeConfig_InitData `protobuf_oneof:"init_data"`
	// Envirnoment variables to set before startup to configure the init script.
	EnvVars []*EnvVar `protobuf:"bytes,6,rep,name=env_vars,json=envVars,proto3" json:"env_vars,omitempty"`
	// The OS image to use for VM creation.
	OsImage              *v1alpha1.File `protobuf:"bytes,7,opt,name=os_image,json=osImage,proto3" json:"os_image,omitempty"`
	XXX_NoUnkeyedLiteral struct{}       `json:"-"`
	XXX_unrecognized     []byte         `json:"-"`
	XXX_sizecache        int32          `json:"-"`
}

Configuration for node images. This is a resource that provides information about which images are available for node creation and how to initialize the node images.

func (*NodeConfig) Descriptor 

func (*NodeConfig) Descriptor() ([]byte, []int)

func (*NodeConfig) GetApiVersion 

func (m *NodeConfig) GetApiVersion() string

func (*NodeConfig) GetEnvVars 

func (m *NodeConfig) GetEnvVars() []*EnvVar

func (*NodeConfig) GetExternalInitFile 

func (m *NodeConfig) GetExternalInitFile() *v1alpha1.File

func (*NodeConfig) GetInitData 

func (m *NodeConfig) GetInitData() isNodeConfig_InitData

func (*NodeConfig) GetInitFile 

func (m *NodeConfig) GetInitFile() string

func (*NodeConfig) GetKind 

func (m *NodeConfig) GetKind() string

func (*NodeConfig) GetMetadata 

func (m *NodeConfig) GetMetadata() *v1alpha1.ObjectMeta

func (*NodeConfig) GetOsImage 

func (m *NodeConfig) GetOsImage() *v1alpha1.File

func (*NodeConfig) ProtoMessage 

func (*NodeConfig) ProtoMessage()

func (*NodeConfig) Reset 

func (m *NodeConfig) Reset()

func (*NodeConfig) String 

func (m *NodeConfig) String() string

func (*NodeConfig) XXX_DiscardUnknown 

func (m *NodeConfig) XXX_DiscardUnknown()

func (*NodeConfig) XXX_Marshal 

func (m *NodeConfig) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*NodeConfig) XXX_Merge 

func (m *NodeConfig) XXX_Merge(src proto.Message)

func (*NodeConfig) XXX_OneofFuncs 

func (*NodeConfig) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})

XXX_OneofFuncs is for the internal use of the proto package.

func (*NodeConfig) XXX_Size 

func (m *NodeConfig) XXX_Size() int

func (*NodeConfig) XXX_Unmarshal 

func (m *NodeConfig) XXX_Unmarshal(b []byte) error

type NodeConfig_ExternalInitFile 

type NodeConfig_ExternalInitFile struct {
	ExternalInitFile *v1alpha1.File `protobuf:"bytes,5,opt,name=external_init_file,json=externalInitFile,proto3,oneof"`
}

type NodeConfig_InitFile 

type NodeConfig_InitFile struct {
	InitFile string `protobuf:"bytes,4,opt,name=init_file,json=initFile,proto3,oneof"`
}

type ObjectReference 

type ObjectReference struct {
	ApiVersion           string   `protobuf:"bytes,1,opt,name=api_version,json=apiVersion,proto3" json:"api_version,omitempty"`
	Kind                 string   `protobuf:"bytes,2,opt,name=kind,proto3" json:"kind,omitempty"`
	Name                 string   `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Object reference for Kubernetes types. For example, if a Kubernetes object begins with: 

apiVersion: apps/v1
kind: StatefulSet
metadata: ...
  name: foo
spec: ...

The corresponding ObjectReferenc (or ObjectRef) would be: 

{apiVersion: 'apps/v1', kind: 'StatefulSet', name: 'foo'}

func (*ObjectReference) Descriptor 

func (*ObjectReference) Descriptor() ([]byte, []int)

func (*ObjectReference) GetApiVersion 

func (m *ObjectReference) GetApiVersion() string

func (*ObjectReference) GetKind 

func (m *ObjectReference) GetKind() string

func (*ObjectReference) GetName 

func (m *ObjectReference) GetName() string

func (*ObjectReference) ProtoMessage 

func (*ObjectReference) ProtoMessage()

func (*ObjectReference) Reset 

func (m *ObjectReference) Reset()

func (*ObjectReference) String 

func (m *ObjectReference) String() string

func (*ObjectReference) XXX_DiscardUnknown 

func (m *ObjectReference) XXX_DiscardUnknown()

func (*ObjectReference) XXX_Marshal 

func (m *ObjectReference) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ObjectReference) XXX_Merge 

func (m *ObjectReference) XXX_Merge(src proto.Message)

func (*ObjectReference) XXX_Size 

func (m *ObjectReference) XXX_Size() int

func (*ObjectReference) XXX_Unmarshal 

func (m *ObjectReference) XXX_Unmarshal(b []byte) error

type PatchCollection 

type PatchCollection struct {
	Patches              []*PatchTemplate `protobuf:"bytes,1,rep,name=patches,proto3" json:"patches,omitempty"`
	XXX_NoUnkeyedLiteral struct{}         `json:"-"`
	XXX_unrecognized     []byte           `json:"-"`
	XXX_sizecache        int32            `json:"-"`
}

A collection of PatcheTemplates that apply to a specific object.

func (*PatchCollection) Descriptor 

func (*PatchCollection) Descriptor() ([]byte, []int)

func (*PatchCollection) GetPatches 

func (m *PatchCollection) GetPatches() []*PatchTemplate

func (*PatchCollection) ProtoMessage 

func (*PatchCollection) ProtoMessage()

func (*PatchCollection) Reset 

func (m *PatchCollection) Reset()

func (*PatchCollection) String 

func (m *PatchCollection) String() string

func (*PatchCollection) XXX_DiscardUnknown 

func (m *PatchCollection) XXX_DiscardUnknown()

func (*PatchCollection) XXX_Marshal 

func (m *PatchCollection) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*PatchCollection) XXX_Merge 

func (m *PatchCollection) XXX_Merge(src proto.Message)

func (*PatchCollection) XXX_Size 

func (m *PatchCollection) XXX_Size() int

func (*PatchCollection) XXX_Unmarshal 

func (m *PatchCollection) XXX_Unmarshal(b []byte) error

type PatchTemplate 

type PatchTemplate struct {
	// Required. Name provides an identifier for this patch.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The Kubernetes object reference for a custom resource that provides the
	// options (parameters) for this Patch.
	ObjectRef *ObjectReference `protobuf:"bytes,2,opt,name=object_ref,json=objectRef,proto3" json:"object_ref,omitempty"`
	// Required. The patch itself. A templated YAML that's meant to be applied
	// viastrategic-merge-patch.  The patch itself must be specified as a
	// Go-Templatized YAML.
	TemplateString string `protobuf:"bytes,3,opt,name=template_string,json=templateString,proto3" json:"template_string,omitempty"`
	// Whether this patch is required (or optional) to be applied.
	IsRequired           bool     `protobuf:"varint,4,opt,name=is_required,json=isRequired,proto3" json:"is_required,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Patch provides functionality for patching Kubernetes objects. This relies on the strategic merge patch functionality from kubernetes.

func (*PatchTemplate) Descriptor 

func (*PatchTemplate) Descriptor() ([]byte, []int)

func (*PatchTemplate) GetIsRequired 

func (m *PatchTemplate) GetIsRequired() bool

func (*PatchTemplate) GetName 

func (m *PatchTemplate) GetName() string

func (*PatchTemplate) GetObjectRef 

func (m *PatchTemplate) GetObjectRef() *ObjectReference

func (*PatchTemplate) GetTemplateString 

func (m *PatchTemplate) GetTemplateString() string

func (*PatchTemplate) ProtoMessage 

func (*PatchTemplate) ProtoMessage()

func (*PatchTemplate) Reset 

func (m *PatchTemplate) Reset()

func (*PatchTemplate) String 

func (m *PatchTemplate) String() string

func (*PatchTemplate) XXX_DiscardUnknown 

func (m *PatchTemplate) XXX_DiscardUnknown()

func (*PatchTemplate) XXX_Marshal 

func (m *PatchTemplate) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*PatchTemplate) XXX_Merge 

func (m *PatchTemplate) XXX_Merge(src proto.Message)

func (*PatchTemplate) XXX_Size 

func (m *PatchTemplate) XXX_Size() int

func (*PatchTemplate) XXX_Unmarshal 

func (m *PatchTemplate) XXX_Unmarshal(b []byte) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.