preconfigs

Documentation

Overview

Copyright 2020 Eric Ace.

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.

This package contains the code that interprets the "preConfigs" resource in the Nuxeo CR. These CR stanzas are short-hands for known configurations so the configurer can quickly and easily integrate a Nuxeo cluster to one or more backing services. All these functions do is return fully built-out structures that implement a backing service binding.

Index

• func CrunchyBacking(preCfg v1alpha1.PreconfiguredBackingService, backingMountBase string) (v1alpha1.BackingService, error)
• func EckBacking(preCfg v1alpha1.PreconfiguredBackingService, backingMountBase string) (v1alpha1.BackingService, error)
• func MongoEntBacking(preCfg v1alpha1.PreconfiguredBackingService, _ string) (v1alpha1.BackingService, error)
• func ParsePreconfigOpts(preconfigured v1alpha1.PreconfiguredBackingService) (map[string]string, error)
• func StrimziBacking(preCfg v1alpha1.PreconfiguredBackingService, backingMountBase string) (v1alpha1.BackingService, error)

Functions

func CrunchyBacking

func CrunchyBacking(preCfg v1alpha1.PreconfiguredBackingService,
	backingMountBase string) (v1alpha1.BackingService, error)

Generates a backing service struct for integrating with Crunchy Postgres.

func EckBacking

func EckBacking(preCfg v1alpha1.PreconfiguredBackingService, backingMountBase string) (v1alpha1.BackingService, error)

returns a backing service configured to connect to ECK. The resource name in the passed pre-config is the name of an 'elasticsearch.k8s.elastic.co' resource in the namespace.

func MongoEntBacking

func MongoEntBacking(preCfg v1alpha1.PreconfiguredBackingService, _ string) (v1alpha1.BackingService, error)

This is just a very basic pre-config for mongo.com Enterprise supporting a single stand-alone Mongo DB with no client auth. A future version of the operator will support the various Mongo topologies, plus TLS encryption and SCRAM/TLS auth. This is just an initial version to get a stake in the sand.

func ParsePreconfigOpts

func ParsePreconfigOpts(preconfigured v1alpha1.PreconfiguredBackingService) (map[string]string, error)

ParsePreconfigOpts parses the options in the passed preconfigured backing service

func StrimziBacking

func StrimziBacking(preCfg v1alpha1.PreconfiguredBackingService,
	backingMountBase string) (v1alpha1.BackingService, error)

Returns a backing service struct configured to connect to Strimzi Kafka. The resource name in the passed pre-config is the name of a 'kafka.strimzi.io' resource in the namespace.