controllers

Documentation

Index

• Variables
• func AllComponents(c client.Client, logger logr.Logger, imageRegistry string) []components.Component
• func TryCreateInstallationResource(log logr.Logger, client client.Client)
• type AddonReconciler
  • func (r *AddonReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)
  • func (r *AddonReconciler) SetupWithManager(mgr ctrl.Manager) error
• type BlueprintReconciler
  • func (r *BlueprintReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)
  • func (r *BlueprintReconciler) SetupWithManager(mgr ctrl.Manager) error
• type InstallationReconciler
  • func (r *InstallationReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)
  • func (r *InstallationReconciler) SetupWithManager(mgr ctrl.Manager) error
• type ItemsLister
• type ManifestReconciler
  • func (r *ManifestReconciler) CreateManifestObjects(ctx context.Context, manifestNamespacedName types.NamespacedName, ...) error
  • func (r *ManifestReconciler) DeleteManifestObjects(ctx context.Context, objectList []v1alpha1.ManifestObject) error
  • func (r *ManifestReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)
  • func (r *ManifestReconciler) SetupWithManager(mgr ctrl.Manager) error
  • func (r *ManifestReconciler) UpdateManifestObjects(req ctrl.Request, ctx context.Context, existing *v1alpha1.Manifest) error

Variables

var (
	// installationHistVec is a histogram vector metric to observe various installations by Blueprint Operator.
	InstallationHistVec = promauto.NewHistogramVec(prometheus.HistogramOpts{
		Name: "blueprint_installation_histogram",
		Help: "Histogram vector for Blueprint Installations.",

		Buckets: []float64{1, 2, 3, 4, 5, 7, 10, 12, 15, 18, 20, 25, 30, 60, 120, 180, 300},
	},

		[]string{"name", "operation", "status"})
	// addOnHistVec is a histogram vector metric to observe various add ons installed by Blueprint Operator.
	AddOnHistVec = promauto.NewHistogramVec(prometheus.HistogramOpts{
		Name: "blueprint_add_on_histogram",
		Help: "Histogram vector for Blueprint Add Ons.",

		Buckets: []float64{1, 2, 3, 4, 5, 7, 10, 12, 15, 18, 20, 25, 30, 60, 120, 180, 300},
	},

		[]string{"name", "status"})
	// manifestHistVec is a histogram vector metric to observe various manifests reconciled by Blueprint Operator.
	ManifestHistVec = promauto.NewHistogramVec(prometheus.HistogramOpts{
		Name: "blueprint_manifest_histogram",
		Help: "Histogram vector for Blueprint Manifests.",

		Buckets: []float64{1, 2, 3, 4, 5, 7, 10, 12, 15, 18, 20, 25, 30, 60, 120, 180, 300},
	},

		[]string{"name", "status"})
)

var (
	DefaultInstanceKey = client.ObjectKey{Name: "default", Namespace: "default"}
)

var (
	// DefaultRequeueDuration is the default requeue duration
	DefaultRequeueDuration = time.Second * 10
)

Functions

func AllComponents

func AllComponents(c client.Client, logger logr.Logger, imageRegistry string) []components.Component

AllComponents returns a list of components installed by the blueprint operator

func TryCreateInstallationResource

func TryCreateInstallationResource(log logr.Logger, client client.Client)

TryCreateInstallationResource creates the Installation resource if it does not exist If the resource already exists, or if an error occurs, it logs the error and returns without taking any action.

Types

type AddonReconciler

type AddonReconciler struct {
	client.Client
	Scheme   *runtime.Scheme
	Recorder record.EventRecorder

	SetupLogger logr.Logger
	// contains filtered or unexported fields
}

AddonReconciler reconciles a Addon object

func (*AddonReconciler) Reconcile

func (r *AddonReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)

Reconcile is part of the main kubernetes reconciliation loop which aims to move the current state of the cluster closer to the desired state. Modify the Reconcile function to compare the state specified by the Addon object against the actual cluster state, and then perform operations to make the cluster state reflect the state specified by the user.

For more details, check Reconcile and its Result here: - https://pkg.go.dev/sigs.k8s.io/controller-runtime@v0.14.1/pkg/reconcile

func (*AddonReconciler) SetupWithManager

func (r *AddonReconciler) SetupWithManager(mgr ctrl.Manager) error

SetupWithManager sets up the controller with the Manager.

type BlueprintReconciler

type BlueprintReconciler struct {
	client.Client
	Scheme *runtime.Scheme
}

BlueprintReconciler reconciles a Blueprint object

func (*BlueprintReconciler) Reconcile

func (r *BlueprintReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)

Reconcile is part of the main kubernetes reconciliation loop which aims to move the current state of the cluster closer to the desired state. TODO(user): Modify the Reconcile function to compare the state specified by the Blueprint object against the actual cluster state, and then perform operations to make the cluster state reflect the state specified by the user.

For more details, check Reconcile and its Result here: - https://pkg.go.dev/sigs.k8s.io/controller-runtime@v0.14.1/pkg/reconcile

func (*BlueprintReconciler) SetupWithManager

func (r *BlueprintReconciler) SetupWithManager(mgr ctrl.Manager) error

SetupWithManager sets up the controller with the Manager.

type InstallationReconciler

type InstallationReconciler struct {
	client.Client
	Scheme        *runtime.Scheme
	SetupLogger   logr.Logger
	ImageRegistry string
}

InstallationReconciler reconciles a Installation object

func (*InstallationReconciler) Reconcile

func (r *InstallationReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)

Reconcile reconciles the Installation resource and installs the necessary components such as helm controller and cert manager.

func (*InstallationReconciler) SetupWithManager

func (r *InstallationReconciler) SetupWithManager(mgr ctrl.Manager) error

SetupWithManager sets up the controller with the Manager.

type ItemsLister

type ItemsLister func(ctx context.Context, apiClient client.Client) ([]client.Object, error)

type ManifestReconciler

type ManifestReconciler struct {
	client.Client
	Scheme   *runtime.Scheme
	Recorder record.EventRecorder
}

ManifestReconciler reconciles a Manifest object

func (*ManifestReconciler) CreateManifestObjects

func (r *ManifestReconciler) CreateManifestObjects(ctx context.Context, manifestNamespacedName types.NamespacedName, logger logr.Logger, data []byte) error

CreateManifestObjects reads manifest from a url and then create all objects in the cluster

func (*ManifestReconciler) DeleteManifestObjects

func (r *ManifestReconciler) DeleteManifestObjects(ctx context.Context, objectList []v1alpha1.ManifestObject) error

func (*ManifestReconciler) Reconcile

func (r *ManifestReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)

Reconcile is part of the main kubernetes reconciliation loop which aims to move the current state of the cluster closer to the desired state. TODO(user): Modify the Reconcile function to compare the state specified by the Manifest object against the actual cluster state, and then perform operations to make the cluster state reflect the state specified by the user.

For more details, check Reconcile and its Result here: - https://pkg.go.dev/sigs.k8s.io/controller-runtime@v0.14.1/pkg/reconcile

func (*ManifestReconciler) SetupWithManager

func (r *ManifestReconciler) SetupWithManager(mgr ctrl.Manager) error

SetupWithManager sets up the controller with the Manager.

func (*ManifestReconciler) UpdateManifestObjects

func (r *ManifestReconciler) UpdateManifestObjects(req ctrl.Request, ctx context.Context, existing *v1alpha1.Manifest) error

UpdateManifestObjects reads the manifest from a url and then create or update the new/existing objects in the cluster