v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the opennms v1alpha1 API group

Index

• Variables
• type BaseServiceResources
  • func (in *BaseServiceResources) DeepCopy() *BaseServiceResources
  • func (in *BaseServiceResources) DeepCopyInto(out *BaseServiceResources)
• type ImageStatus
  • func (in *ImageStatus) DeepCopy() *ImageStatus
  • func (in *ImageStatus) DeepCopyInto(out *ImageStatus)
• type ImageUpdateConfig
  • func (in *ImageUpdateConfig) DeepCopy() *ImageUpdateConfig
  • func (in *ImageUpdateConfig) DeepCopyInto(out *ImageUpdateConfig)
• type OpenNMS
  • func (in *OpenNMS) DeepCopy() *OpenNMS
  • func (in *OpenNMS) DeepCopyInto(out *OpenNMS)
  • func (in *OpenNMS) DeepCopyObject() runtime.Object
• type OpenNMSList
  • func (in *OpenNMSList) DeepCopy() *OpenNMSList
  • func (in *OpenNMSList) DeepCopyInto(out *OpenNMSList)
  • func (in *OpenNMSList) DeepCopyObject() runtime.Object
• type OpenNMSSpec
  • func (in *OpenNMSSpec) DeepCopy() *OpenNMSSpec
  • func (in *OpenNMSSpec) DeepCopyInto(out *OpenNMSSpec)
• type OpenNMSStatus
  • func (in *OpenNMSStatus) DeepCopy() *OpenNMSStatus
  • func (in *OpenNMSStatus) DeepCopyInto(out *OpenNMSStatus)
• type ReadinessStatus
• type ServiceStatus
• type Timeseries
  • func (in *Timeseries) DeepCopy() *Timeseries
  • func (in *Timeseries) DeepCopyInto(out *Timeseries)

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "opennms.k8s.opennms.com", Version: "v1alpha1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

Types

type BaseServiceResources

type BaseServiceResources struct {
	MEM  string `json:"mem,omitempty"`
	Disk string `json:"disk,omitempty"`
	CPU  string `json:"cpu,omitempty"`
}

BaseServiceResources - defines basic resource needs of a service

func (*BaseServiceResources) DeepCopy

func (in *BaseServiceResources) DeepCopy() *BaseServiceResources

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

func (*BaseServiceResources) DeepCopyInto

func (in *BaseServiceResources) DeepCopyInto(out *BaseServiceResources)

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

type ImageStatus

type ImageStatus struct {
	// true if latest image used, false otherwise
	IsLatest bool `json:"isLatest"`
	// timestamp of a last image check in DockerHub
	CheckedAt string `json:"checkedAt,omitempty"`
	// list of services that have updates available
	ServicesToUpdate string `json:"servicesToUpdate,omitempty"`
}

ImageStatus - defines current status of used image for OpenNMS container

func (*ImageStatus) DeepCopy

func (in *ImageStatus) DeepCopy() *ImageStatus

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

func (*ImageStatus) DeepCopyInto

func (in *ImageStatus) DeepCopyInto(out *ImageStatus)

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

type ImageUpdateConfig

type ImageUpdateConfig struct {
	// can have values of now/none
	Update string `json:"update,omitempty"`
}

ImageUpdateConfig - defines current status of used image for OpenNMS container

func (*ImageUpdateConfig) DeepCopy

func (in *ImageUpdateConfig) DeepCopy() *ImageUpdateConfig

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

func (*ImageUpdateConfig) DeepCopyInto

func (in *ImageUpdateConfig) DeepCopyInto(out *ImageUpdateConfig)

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

type OpenNMS

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

	Spec   OpenNMSSpec   `json:"spec,omitempty"`
	Status OpenNMSStatus `json:"status,omitempty"`
}

OpenNMS - is the Schema for the opennms API

func (*OpenNMS) DeepCopy

func (in *OpenNMS) DeepCopy() *OpenNMS

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

func (*OpenNMS) DeepCopyInto

func (in *OpenNMS) DeepCopyInto(out *OpenNMS)

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

func (*OpenNMS) DeepCopyObject

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

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

type OpenNMSList

type OpenNMSList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []OpenNMS `json:"items"`
}

OpenNMSList - contains a list of OpenNMS

func (*OpenNMSList) DeepCopy

func (in *OpenNMSList) DeepCopy() *OpenNMSList

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

func (*OpenNMSList) DeepCopyInto

func (in *OpenNMSList) DeepCopyInto(out *OpenNMSList)

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

func (*OpenNMSList) DeepCopyObject

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

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

type OpenNMSSpec

type OpenNMSSpec struct {
	// Image tag version of OpenNMS.
	Version string `json:"version,omitempty"`

	// Domain name used in ingress rule
	Host string `json:"host,omitempty"`

	// K8s namespace to use
	Namespace string `json:"namespace"`

	// Users allowed login via tokens
	AllowedUsers []string `json:"allowedUsers,omitempty"`

	// Deploy an instance in a nonoperative testing mode
	TestDeploy bool `json:"testDeploy,omitempty"`

	// Defines what plugin for timeseries to use
	Timeseries Timeseries `json:"timeseries,omitempty"`

	// Defines cpu,mem and disk size for core
	Core BaseServiceResources `json:"core,omitempty"`

	// Defines cpu,mem and disk size for postgres
	Postgres BaseServiceResources `json:"postgres,omitempty"`

	// Defines the logic of ONMS image update
	ImageUpdateConfig ImageUpdateConfig `json:"imageUpdate,omitempty"`
}

OpenNMSSpec defines the desired state of OpenNMS

func (*OpenNMSSpec) DeepCopy

func (in *OpenNMSSpec) DeepCopy() *OpenNMSSpec

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

func (*OpenNMSSpec) DeepCopyInto

func (in *OpenNMSSpec) DeepCopyInto(out *OpenNMSSpec)

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

type OpenNMSStatus

type OpenNMSStatus struct {
	Image     ImageStatus     `json:"image,omitempty"`
	Readiness ReadinessStatus `json:"readiness,omitempty"`
	Nodes     []string        `json:"nodes,omitempty"`
}

OpenNMSStatus - defines the observed state of OpenNMS

func (*OpenNMSStatus) DeepCopy

func (in *OpenNMSStatus) DeepCopy() *OpenNMSStatus

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

func (*OpenNMSStatus) DeepCopyInto

func (in *OpenNMSStatus) DeepCopyInto(out *OpenNMSStatus)

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

type ReadinessStatus

type ReadinessStatus struct {
	// if the ONMS instance is ready
	Ready bool `json:"ready,omitempty"`
	// reason an ONMS instance isn't ready
	Reason string `json:"reason,omitempty"`
	// the time the `ready` flag was last updated
	Timestamp string `json:"timestamp,omitempty"`
	// list of readinesses of the constituent services
	Services []ServiceStatus `json:"services,omitempty"`
}

ReadinessStatus - the ready status of the ONMS instance

type ServiceStatus

type ServiceStatus struct {
	// if the service is ready
	Ready bool `json:"ready"`
	// reason a service isn't ready
	Reason string `json:"reason"`
	// the time the `ready` flag was last updated
	Timestamp string `json:"timestamp,omitempty"`
}

type Timeseries

type Timeseries struct {
	Mode   string `json:"mode,omitempty"`
	Host   string `json:"host,omitempty"`
	Port   string `json:"port,omitempty"`
	ApiKey string `json:"apiKey,omitempty"`
}

Timeseries - defines the timeseries DB backend to use

func (*Timeseries) DeepCopy

func (in *Timeseries) DeepCopy() *Timeseries

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

func (*Timeseries) DeepCopyInto

func (in *Timeseries) DeepCopyInto(out *Timeseries)

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