kogitoservice

package
v1.28.0 Latest Latest
Warning

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

 Go to latest Published: Oct 3, 2022 License: Apache-2.0 Imports: 36 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	EnvVarKogitoServiceURL = "LOCAL_KOGITO_SERVICE_URL"
)

Constants ...

Variables

This section is empty.

Functions

func IsKafkaResource 

func IsKafkaResource(instance api.KogitoInfraInterface) bool

IsKafkaResource checks if provided KogitoInfra instance is for kafka resource

Types

type ConfigMapReferenceReconciler added in v1.12.0 

type ConfigMapReferenceReconciler interface {
	Reconcile() error
}

ConfigMapReferenceReconciler ...

type ConfigReconciler added in v1.12.0 

type ConfigReconciler interface {
	Reconcile() error
}

ConfigReconciler ...

type DeploymentReconciler added in v1.12.0 

type DeploymentReconciler interface {
	Reconcile() error
}

DeploymentReconciler ...

type GrafanaDashboard 

type GrafanaDashboard struct {
	Name             string
	RawJSONDashboard string
}

GrafanaDashboard is a structure that contains the fetched dashboards

type GrafanaDashboardManager 

type GrafanaDashboardManager interface {
	ConfigureGrafanaDashboards(kogitoService api.KogitoService) error
}

GrafanaDashboardManager ...

func NewGrafanaDashboardManager 

func NewGrafanaDashboardManager(context operator.Context) GrafanaDashboardManager

NewGrafanaDashboardManager ...

type KogitoDeploymentHandler added in v1.12.0 

type KogitoDeploymentHandler interface {
	CreateDeployment(service api.KogitoService, resolvedImage string, definition ServiceDefinition) *appsv1.Deployment
}

KogitoDeploymentHandler ...

func NewKogitoDeploymentHandler added in v1.12.0 

func NewKogitoDeploymentHandler(context operator.Context) KogitoDeploymentHandler

NewKogitoDeploymentHandler ...

type KogitoInfraReconciler added in v1.12.0 

type KogitoInfraReconciler interface {
	Reconcile() error
}

KogitoInfraReconciler ...

type MessagingDeployer 

type MessagingDeployer interface {
	CreateRequiredResources(service api.KogitoService) error
}

MessagingDeployer ...

func NewKafkaMessagingDeployer 

func NewKafkaMessagingDeployer(context operator.Context, definition ServiceDefinition, infraHandler manager.KogitoInfraHandler) MessagingDeployer

NewKafkaMessagingDeployer handles messaging resources creation. These resources can be required by the deployed service through a bound KogitoInfra.

func NewKnativeMessagingDeployer 

func NewKnativeMessagingDeployer(context operator.Context, definition ServiceDefinition, infraHandler manager.KogitoInfraHandler) MessagingDeployer

NewKnativeMessagingDeployer ...

type ProbeType added in v1.7.0 

type ProbeType string

ProbeType defines the types of probes supported by K8s

type PrometheusManager 

type PrometheusManager interface {
	ConfigurePrometheus(kogitoService api.KogitoService) error
}

PrometheusManager ...

func NewPrometheusManager 

func NewPrometheusManager(context operator.Context) PrometheusManager

NewPrometheusManager ...

type RouteReconciler added in v1.12.0 

type RouteReconciler interface {
	Reconcile() error
}

RouteReconciler ...

type ServiceDefinition 

type ServiceDefinition struct {
	// DefaultImageName is the name of the default image distributed for Kogito, e.g. kogito-jobs-service, kogito-data-index and so on
	// can be empty, in this case Request.Name will be used as image name
	DefaultImageName string
	// DefaultImageTag is the default image tag to use for this service. If left empty, will use the minor version of the operator, e.g. 0.11
	DefaultImageTag string
	// Request made for the service
	Request controller.Request
	// OnDeploymentCreate applies custom deployment configuration in the required Deployment resource
	OnDeploymentCreate func(deployment *appsv1.Deployment) error
	// SingleReplica if set to true, avoids that the service has more than one pod replica
	SingleReplica bool
	// KafkaTopics is a collection of Kafka Topics to be created within the service
	KafkaTopics []string
	// CustomService indicates that the service can be built within the cluster
	// A custom service means that could be built by a third party, not being provided by the Kogito Team Services catalog (such as Data Index, Management Console and etc.).
	CustomService bool

	ConfigMapEnvFromReferences []string
	ConfigMapVolumeReferences  []api.VolumeReferenceInterface
	SecretEnvFromReferences    []string
	SecretVolumeReferences     []api.VolumeReferenceInterface
	Envs                       []v1.EnvVar
}

ServiceDefinition defines the structure for a Kogito Service

type ServiceDeployer 

type ServiceDeployer interface {
	// Deploy deploys the Kogito Service in the Kubernetes cluster according to a given ServiceDefinition
	Deploy() error
}

ServiceDeployer is the API to handle a Kogito Service deployment by Operator SDK controllers

func NewServiceDeployer 

func NewServiceDeployer(context operator.Context, definition ServiceDefinition, serviceType api.KogitoService, infraHandler manager.KogitoInfraHandler) ServiceDeployer

NewServiceDeployer creates a new ServiceDeployer to handle a custom Kogito Service instance to be handled by Operator SDK controller.

type ServiceEndpoints added in v1.19.0 

type ServiceEndpoints struct {
	// HTTPRouteURI ...
	HTTPRouteURI string
	// HTTPRouteEnv name of the environment variable that will hold the HTTP URI
	HTTPRouteEnv string
	// WSRouteURI ...
	WSRouteURI string
	// WSRouteEnv name of the environment variable that will hold the HTTP URI
	WSRouteEnv string
}

ServiceEndpoints represents the endpoints for a deployed Kogito Data Index service

func (*ServiceEndpoints) IsEmpty added in v1.19.0 

func (s *ServiceEndpoints) IsEmpty() bool

IsEmpty returns true if route URIs are empty

func (*ServiceEndpoints) String added in v1.19.0 

func (s *ServiceEndpoints) String() string

type ServiceHandler 

type ServiceHandler interface {
	GetKogitoServiceURL(kogitoService api.KogitoService) string
	GetKogitoServiceEndpoints(instance api.KogitoService, serviceHTTPRouteEnv string, serviceWSRouteEnv string) (endpoints *ServiceEndpoints, err error)
}

ServiceHandler ...

func NewKogitoServiceHandler 

func NewKogitoServiceHandler(context operator.Context) ServiceHandler

NewKogitoServiceHandler ...

type ServiceReconciler added in v1.12.0 

type ServiceReconciler interface {
	Reconcile() error
}

ServiceReconciler ...

type StatusHandler 

type StatusHandler interface {
	HandleStatusUpdate(instance api.KogitoService, err *error)
}

StatusHandler ...

func NewStatusHandler 

func NewStatusHandler(context operator.Context) StatusHandler

NewStatusHandler ...

type TrustStoreReconciler added in v1.12.0 

type TrustStoreReconciler interface {
	Reconcile() error
}

TrustStoreReconciler takes care of mounting the custom TrustStoreSecret in a given Deployment based on api.KogitoService spec

type VolumeReference added in v1.12.0 

type VolumeReference struct {
	// This must match the Name of a ConfigMap.
	Name string
	// Path within the container at which the volume should be mounted.
	MountPath string
	// FileMode ...
	FileMode *int32
	// Specify whether the Secret or its keys must be defined
	Optional *bool
}

VolumeReference ...

func (*VolumeReference) GetFileMode added in v1.12.0 

func (c *VolumeReference) GetFileMode() *int32

GetFileMode ...

func (*VolumeReference) GetMountPath added in v1.12.0 

func (c *VolumeReference) GetMountPath() string

GetMountPath ...

func (*VolumeReference) GetName added in v1.12.0 

func (c *VolumeReference) GetName() string

GetName ...

func (*VolumeReference) IsOptional added in v1.12.0 

func (c *VolumeReference) IsOptional() *bool

IsOptional ...

func (*VolumeReference) SetFileMode added in v1.12.0 

func (c *VolumeReference) SetFileMode(fileMode *int32)

SetFileMode ...

func (*VolumeReference) SetMountPath added in v1.12.0 

func (c *VolumeReference) SetMountPath(mountPath string)

SetMountPath ...

func (*VolumeReference) SetName added in v1.12.0 

func (c *VolumeReference) SetName(name string)

SetName ...

func (*VolumeReference) SetOptional added in v1.12.0 

func (c *VolumeReference) SetOptional(optional *bool)

SetOptional ....

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.