api

Documentation

Index

• Constants
• type Image
  • func (i *Image) IsEmpty() bool
  • func (i *Image) String() string
• type KogitoCloudEventInfoInterface
• type KogitoCloudEventsStatusInterface
• type KogitoProbeInterface
• type KogitoService
• type KogitoServiceConditionType
• type KogitoServiceList
• type KogitoServiceSpecInterface
• type KogitoServiceStatusInterface
• type KogitoSupportingServiceInterface
• type KogitoSupportingServiceListInterface
• type KogitoSupportingServiceSpecInterface
• type KogitoSupportingServiceStatusInterface
• type MonitoringInterface
• type RuntimeType
• type ServiceType
• type WebHookSecretInterface
• type WebHookType

Constants

const (

	// MonitoringDefaultPathQuarkus default path
	MonitoringDefaultPathQuarkus = "/q/metrics"

	// MonitoringDefaultPathSpringboot default path
	MonitoringDefaultPathSpringboot = "/actuator/prometheus"

	// MonitoringDefaultScheme default scheme
	MonitoringDefaultScheme = "http"
)

Types

type Image

type Image struct {
	Domain string `json:"domain,omitempty"`
	Name   string `json:"name,omitempty"`
	Tag    string `json:"tag,omitempty"`
}

Image is a definition of a Docker image.

func (*Image) IsEmpty

func (i *Image) IsEmpty() bool

IsEmpty verifies if this Image instance is empty.

func (*Image) String

func (i *Image) String() string

String representation of this Image.

type KogitoCloudEventInfoInterface

type KogitoCloudEventInfoInterface interface {
	GetType() string
	GetSource() string
}

KogitoCloudEventInfoInterface ...

type KogitoCloudEventsStatusInterface

type KogitoCloudEventsStatusInterface interface {
	GetConsumes() []KogitoCloudEventInfoInterface
	SetConsumes(consumes []KogitoCloudEventInfoInterface)
	GetProduces() []KogitoCloudEventInfoInterface
	SetProduces(produces []KogitoCloudEventInfoInterface)
}

KogitoCloudEventsStatusInterface ...

type KogitoProbeInterface

type KogitoProbeInterface interface {
	GetLivenessProbe() corev1.Probe
	SetLivenessProbe(livenessProbe corev1.Probe)
	GetReadinessProbe() corev1.Probe
	SetReadinessProbe(readinessProbe corev1.Probe)
	GetStartupProbe() corev1.Probe
	SetStartupProbe(startupProbe corev1.Probe)
}

KogitoProbeInterface ...

type KogitoService

type KogitoService interface {
	client.Object
	// GetSpec gets the Kogito Service specification structure.
	GetSpec() KogitoServiceSpecInterface
	// GetStatus gets the Kogito Service Status structure.
	GetStatus() KogitoServiceStatusInterface
}

KogitoService defines the interface for any Kogito service that the operator can handle, e.g. Data Index, Jobs Service, Runtimes, etc.

type KogitoServiceConditionType

type KogitoServiceConditionType string

KogitoServiceConditionType is the type of condition

const (
	// DeployedConditionType - The KogitoService is deployed
	DeployedConditionType KogitoServiceConditionType = "Deployed"
	// ProvisioningConditionType - The KogitoService is being provisioned
	ProvisioningConditionType KogitoServiceConditionType = "Provisioning"
	// FailedConditionType - The KogitoService is in a failed state
	FailedConditionType KogitoServiceConditionType = "Failed"
)

type KogitoServiceList

type KogitoServiceList interface {
	runtime.Object
	// GetItems get all items
	GetItems() []KogitoService
}

KogitoServiceList defines a base interface for Kogito Service list.

type KogitoServiceSpecInterface

type KogitoServiceSpecInterface interface {
	GetReplicas() *int32
	SetReplicas(replicas int32)
	GetEnvs() []corev1.EnvVar
	SetEnvs(envs []corev1.EnvVar)
	AddEnvironmentVariable(name, value string)
	AddEnvironmentVariableFromSecret(variableName, secretName, secretKey string)
	GetImage() string
	SetImage(image string)
	GetResources() corev1.ResourceRequirements
	SetResources(resources corev1.ResourceRequirements)
	AddResourceRequest(name, value string)
	AddResourceLimit(name, value string)
	GetDeploymentLabels() map[string]string
	SetDeploymentLabels(labels map[string]string)
	AddDeploymentLabel(name, value string)
	GetServiceLabels() map[string]string
	SetServiceLabels(labels map[string]string)
	AddServiceLabel(name, value string)
	GetRuntime() RuntimeType
	IsRouteDisabled() bool
	SetDisableRoute(disableRoute bool)
	IsInsecureImageRegistry() bool
	GetPropertiesConfigMap() string
	GetInfra() []string
	AddInfra(name string)
	GetMonitoring() MonitoringInterface
	SetMonitoring(monitoring MonitoringInterface)
	GetConfig() map[string]string
	GetProbes() KogitoProbeInterface
	SetProbes(probes KogitoProbeInterface)
	GetTrustStoreSecret() string
	SetTrustStoreSecret(trustStore string)
}

KogitoServiceSpecInterface defines the interface for the Kogito service specification, it's the basic structure for any Kogito service.

type KogitoServiceStatusInterface

type KogitoServiceStatusInterface interface {
	GetConditions() *[]metav1.Condition
	SetConditions(conditions *[]metav1.Condition)
	GetDeploymentConditions() []appsv1.DeploymentCondition
	SetDeploymentConditions(deploymentConditions []appsv1.DeploymentCondition)
	GetRouteConditions() *[]metav1.Condition
	SetRouteConditions(conditions *[]metav1.Condition)
	GetImage() string
	SetImage(image string)
	GetExternalURI() string
	SetExternalURI(uri string)
	GetCloudEvents() KogitoCloudEventsStatusInterface
	SetCloudEvents(cloudEvents KogitoCloudEventsStatusInterface)
}

KogitoServiceStatusInterface defines the basic interface for the Kogito Service status.

type KogitoSupportingServiceInterface

type KogitoSupportingServiceInterface interface {
	KogitoService
	// GetSpec gets the Kogito Service specification structure.
	GetSupportingServiceSpec() KogitoSupportingServiceSpecInterface
	// GetStatus gets the Kogito Service Status structure.
	GetSupportingServiceStatus() KogitoSupportingServiceStatusInterface
}

KogitoSupportingServiceInterface ...

type KogitoSupportingServiceListInterface

type KogitoSupportingServiceListInterface interface {
	runtime.Object
	// GetItems gets all items
	GetItems() []KogitoSupportingServiceInterface
}

KogitoSupportingServiceListInterface ...

type KogitoSupportingServiceSpecInterface

type KogitoSupportingServiceSpecInterface interface {
	KogitoServiceSpecInterface
	GetServiceType() ServiceType
	SetServiceType(serviceType ServiceType)
}

KogitoSupportingServiceSpecInterface ...

type KogitoSupportingServiceStatusInterface

type KogitoSupportingServiceStatusInterface interface {
	KogitoServiceStatusInterface
}

KogitoSupportingServiceStatusInterface ...

type MonitoringInterface

type MonitoringInterface interface {
	GetScheme() string
	SetScheme(scheme string)
	GetPath() string
	SetPath(path string)
}

MonitoringInterface ...

type RuntimeType

type RuntimeType string

RuntimeType - type of condition.

const (
	// QuarkusRuntimeType Runtime for quarkus application
	QuarkusRuntimeType RuntimeType = "quarkus"
	// SpringBootRuntimeType Runtime for springboot application
	SpringBootRuntimeType RuntimeType = "springboot"
)

type ServiceType

type ServiceType string

ServiceType define resource type of supporting service

const (
	// DataIndex supporting service resource type
	DataIndex ServiceType = "DataIndex"
	// Explainability supporting service resource type
	Explainability ServiceType = "Explainability"
	// JobsService supporting service resource type
	JobsService ServiceType = "JobsService"
	// MgmtConsole supporting service resource type
	MgmtConsole ServiceType = "MgmtConsole"
	// TaskConsole supporting service resource type
	TaskConsole ServiceType = "TaskConsole"
	// TrustyAI supporting service resource type
	TrustyAI ServiceType = "TrustyAI"
	// TrustyUI supporting service resource type
	TrustyUI ServiceType = "TrustyUI"
)

type WebHookSecretInterface

type WebHookSecretInterface interface {
	GetType() WebHookType
	GetSecret() string
}

WebHookSecretInterface ...

type WebHookType

type WebHookType string

WebHookType literal type to distinguish between different types of webHooks.

const (
	// GitHubWebHook GitHub webHook.
	GitHubWebHook WebHookType = "GitHub"
	// GenericWebHook Generic webHook.
	GenericWebHook WebHookType = "Generic"
)