common

Documentation

Overview

Copyright 2021.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2021.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Constants
• func CompareRequiredResources(res1 *corev1.ResourceRequirements, res2 *corev1.ResourceRequirements) bool
• func FromJson(jsonStr *string, obj interface{}) error
• func GetJaasConfigSyntaxMatchRegEx() string
• func GetManager() manager.Manager
• func GetReconcileResyncPeriod() time.Duration
• func Int32ToPtr(v int32) *int32
• func IsConditionPresentAndEqual(conditions []metav1.Condition, condition metav1.Condition) bool
• func NewTrue() *bool
• func ResolveBrokerVersion(existingVersions map[string]*semver.Version, expected *semver.Version) *semver.Version
• func ResolveWatchNamespaceForManager(oprNamespace string, watchNamespace string) (bool, []string)
• func ResourceExists(dc discovery.DiscoveryInterface, apiGroupVersion, kind string) (bool, error)
• func SetManager(mgr manager.Manager)
• func SetReadyCondition(conditions *[]metav1.Condition)
• func ToJson(obj interface{}) (string, error)
• type ActiveMQArtemisConfigHandler
• type AutoDetector
  • func NewAutoDetect(mgr manager.Manager) (*AutoDetector, error)
  • func (b *AutoDetector) DetectOpenshift() error
• type BrokerVersion
  • func NewBrokerVersion(ver *semver.Version) *BrokerVersion
  • func (bver *BrokerVersion) IsMatch(ver *semver.Version) bool
  • func (bver *BrokerVersion) MajorOnly() bool
  • func (bver *BrokerVersion) MinorOnly() bool
• type StateManager
  • func GetStateManager() *StateManager
  • func (sm *StateManager) Clear()
  • func (sm *StateManager) GetState(key string) interface{}
  • func (sm *StateManager) SetState(key string, value interface{})

Constants

const (
	RouteKind              = "Route"
	OpenShiftAPIServerKind = "OpenShiftAPIServer"
	DEFAULT_RESYNC_PERIOD  = 30 * time.Second
	// comments push this over the edge a little when dealing with white space
	// as en env var it can be disabled by setting to "" or can be improved!
	JaasConfigSyntaxMatchRegExDefault = `` /* 187-byte string literal not displayed */
)

extra kinds

const (
	ReadyConditionType          = "Ready"
	ReadyConditionReason        = "ResourceReady"
	NotReadyConditionReason     = "WaitingForAllConditions"
	NotReadyConditionMessage    = "Some conditions are not met"
	ImageVersionConflictMessage = "Version and Images cannot be specified at the same time"
	PDBNonNilSelectorMessage    = "PodDisruptionBudget's selector should not be specified"

	ValidConditionType                       = "Validation"
	ValidConditionSuccessReason              = "ValidationSucceded"
	ValidConditionMissingResourcesReason     = "MissingDependentResources"
	ValidConditionImageVersionConflictReason = "VersionAndImagesConflict"
	ValidConditionPDBNonNilSelectorReason    = "PDBNonNilSelector"
	ValidConditionFailedReservedLabelReason  = "ReservedLabelReference"
	ValidConditionFailedExtraMountReason     = "InvalidExtraMount"
)

Functions

func CompareRequiredResources

func CompareRequiredResources(res1 *corev1.ResourceRequirements, res2 *corev1.ResourceRequirements) bool

func FromJson

func FromJson(jsonStr *string, obj interface{}) error

func GetJaasConfigSyntaxMatchRegEx

func GetJaasConfigSyntaxMatchRegEx() string

func GetManager

func GetManager() manager.Manager

func GetReconcileResyncPeriod

func GetReconcileResyncPeriod() time.Duration

func Int32ToPtr

func Int32ToPtr(v int32) *int32

func IsConditionPresentAndEqual

func IsConditionPresentAndEqual(conditions []metav1.Condition, condition metav1.Condition) bool

func NewTrue

func NewTrue() *bool

func ResolveBrokerVersion

func ResolveBrokerVersion(existingVersions map[string]*semver.Version, expected *semver.Version) *semver.Version

func ResolveWatchNamespaceForManager

func ResolveWatchNamespaceForManager(oprNamespace string, watchNamespace string) (bool, []string)

Given the operator's namespace and a string representation of it's WATCH_NAMESPACE value, this method returns whether the operator is watching its own(single) namespace, or watching multiple namespaces, or all namespace For watching single: it returns (true, nil) For watching multiple: it returns (false, [n]string) where n > 0 For watching all: it returns (false, nil)

func ResourceExists

func ResourceExists(dc discovery.DiscoveryInterface, apiGroupVersion, kind string) (bool, error)

func SetManager

func SetManager(mgr manager.Manager)

func SetReadyCondition

func SetReadyCondition(conditions *[]metav1.Condition)

func ToJson

func ToJson(obj interface{}) (string, error)

Types

type ActiveMQArtemisConfigHandler

type ActiveMQArtemisConfigHandler interface {
	IsApplicableFor(brokerNamespacedName types.NamespacedName) bool
	Config(initContainers []corev1.Container, outputDirRoot string, yacfgProfileVersion string, yacfgProfileName string) (value []string)
}

type AutoDetector

type AutoDetector struct {
	// contains filtered or unexported fields
}

func NewAutoDetect

func NewAutoDetect(mgr manager.Manager) (*AutoDetector, error)

New creates a new auto-detect runner

func (*AutoDetector) DetectOpenshift

func (b *AutoDetector) DetectOpenshift() error

type BrokerVersion

type BrokerVersion struct {
	Version *semver.Version
}

func NewBrokerVersion

func NewBrokerVersion(ver *semver.Version) *BrokerVersion

func (*BrokerVersion) IsMatch

func (bver *BrokerVersion) IsMatch(ver *semver.Version) bool

func (*BrokerVersion) MajorOnly

func (bver *BrokerVersion) MajorOnly() bool

func (*BrokerVersion) MinorOnly

func (bver *BrokerVersion) MinorOnly() bool

type StateManager

type StateManager struct {
	*sync.Mutex
	// contains filtered or unexported fields
}

func GetStateManager

func GetStateManager() *StateManager

func (*StateManager) Clear

func (sm *StateManager) Clear()

func (*StateManager) GetState

func (sm *StateManager) GetState(key string) interface{}

func (*StateManager) SetState

func (sm *StateManager) SetState(key string, value interface{})