Documentation ¶
Index ¶
- Constants
- func K8SServicePortForward(ctx context.Context, svcName string, ns string, pPort string) (*portforward.PortForwarder, error)
- type App
- func NewCassandraInstance(name string) App
- func NewCockroachDB(name string) App
- func NewCouchbaseDB(name string) App
- func NewElasticsearchInstance(name string) App
- func NewFoundationDB(name string) App
- func NewKafkaCluster(name, pathToYaml string) App
- func NewMariaDB(name string) App
- func NewMongoDBDepConfig(name string, templateVersion DBTemplate, storageType storage) App
- func NewMssqlDB(name string) App
- func NewMysqlDepConfig(name string, templateVersion DBTemplate, storageType storage, tag string) App
- func NewPostgreSQLDepConfig(name string, templateVersion DBTemplate, storageType storage) App
- func NewPostgresDB(name string, subPath string) App
- func NewRDSAuroraMySQLDB(name, region string) App
- func NewRDSPostgresDB(name string, customRegion string) App
- func NewTimeLogCSI(name string) App
- type AppBlueprint
- type Blueprinter
- type CassandraInstance
- func (cas *CassandraInstance) Count(ctx context.Context) (int, error)
- func (cas *CassandraInstance) GetClusterScopedResources(ctx context.Context) []crv1alpha1.ObjectReference
- func (cas *CassandraInstance) Init(context.Context) error
- func (cas *CassandraInstance) Initialize(ctx context.Context) error
- func (cas *CassandraInstance) Insert(ctx context.Context) error
- func (cas *CassandraInstance) Install(ctx context.Context, namespace string) error
- func (cas *CassandraInstance) IsReady(ctx context.Context) (bool, error)
- func (cas *CassandraInstance) Object() crv1alpha1.ObjectReference
- func (cas *CassandraInstance) Ping(ctx context.Context) error
- func (cas *CassandraInstance) Reset(ctx context.Context) error
- func (cas *CassandraInstance) Uninstall(ctx context.Context) error
- type CockroachDB
- func (c *CockroachDB) ConfigMaps() map[string]crv1alpha1.ObjectReference
- func (c *CockroachDB) Count(ctx context.Context) (int, error)
- func (c *CockroachDB) GetClusterScopedResources(context.Context) []crv1alpha1.ObjectReference
- func (c *CockroachDB) Init(context.Context) error
- func (c *CockroachDB) Initialize(ctx context.Context) error
- func (c *CockroachDB) Insert(ctx context.Context) error
- func (c *CockroachDB) Install(ctx context.Context, namespace string) error
- func (c *CockroachDB) IsReady(ctx context.Context) (bool, error)
- func (c *CockroachDB) Object() crv1alpha1.ObjectReference
- func (c *CockroachDB) Ping(ctx context.Context) error
- func (c *CockroachDB) Reset(ctx context.Context) error
- func (c *CockroachDB) Secrets() map[string]crv1alpha1.ObjectReference
- func (c *CockroachDB) Uninstall(ctx context.Context) error
- type ConfigApp
- type CouchbaseDB
- func (cb CouchbaseDB) Count(ctx context.Context) (int, error)
- func (cb CouchbaseDB) GetClusterScopedResources(ctx context.Context) []crv1alpha1.ObjectReference
- func (cb *CouchbaseDB) Init(ctx context.Context) error
- func (cb CouchbaseDB) Initialize(ctx context.Context) error
- func (cb CouchbaseDB) Insert(ctx context.Context) error
- func (cb *CouchbaseDB) Install(ctx context.Context, ns string) error
- func (cb *CouchbaseDB) IsReady(ctx context.Context) (bool, error)
- func (cb *CouchbaseDB) Object() crv1alpha1.ObjectReference
- func (cb *CouchbaseDB) Ping(ctx context.Context) error
- func (cb CouchbaseDB) Reset(ctx context.Context) error
- func (cb CouchbaseDB) Uninstall(ctx context.Context) error
- type DBTemplate
- type DatabaseApp
- type ElasticsearchInstance
- func (esi *ElasticsearchInstance) Count(ctx context.Context) (int, error)
- func (esi *ElasticsearchInstance) GetClusterScopedResources(ctx context.Context) []crv1alpha1.ObjectReference
- func (esi *ElasticsearchInstance) Init(ctx context.Context) error
- func (esi *ElasticsearchInstance) Initialize(ctx context.Context) error
- func (esi *ElasticsearchInstance) Insert(ctx context.Context) error
- func (esi *ElasticsearchInstance) Install(ctx context.Context, namespace string) error
- func (esi *ElasticsearchInstance) IsReady(ctx context.Context) (bool, error)
- func (esi *ElasticsearchInstance) Object() crv1alpha1.ObjectReference
- func (esi *ElasticsearchInstance) Ping(ctx context.Context) error
- func (esi *ElasticsearchInstance) Reset(ctx context.Context) error
- func (esi *ElasticsearchInstance) Secrets() map[string]crv1alpha1.ObjectReference
- func (esi *ElasticsearchInstance) Uninstall(ctx context.Context) error
- type ElasticsearchPingOutput
- type FoundationDB
- func (fdb *FoundationDB) Count(ctx context.Context) (int, error)
- func (fdb *FoundationDB) GetClusterScopedResources(ctx context.Context) []crv1alpha1.ObjectReference
- func (fdb *FoundationDB) Init(ctx context.Context) error
- func (fdb *FoundationDB) Initialize(ctx context.Context) error
- func (fdb *FoundationDB) Insert(ctx context.Context) error
- func (fdb *FoundationDB) Install(ctx context.Context, namespace string) error
- func (fdb *FoundationDB) IsReady(ctx context.Context) (bool, error)
- func (fdb *FoundationDB) Object() crv1alpha1.ObjectReference
- func (fdb *FoundationDB) Ping(ctx context.Context) error
- func (fdb *FoundationDB) Reset(ctx context.Context) error
- func (fdb *FoundationDB) Uninstall(ctx context.Context) error
- type HelmApp
- type InsertPayload
- type IsMasterOutput
- type KafkaCluster
- func (kc *KafkaCluster) ConfigMaps() map[string]crv1alpha1.ObjectReference
- func (kc *KafkaCluster) Count(ctx context.Context) (int, error)
- func (kc *KafkaCluster) GetClusterScopedResources(ctx context.Context) []crv1alpha1.ObjectReference
- func (kc *KafkaCluster) Init(context.Context) error
- func (kc *KafkaCluster) Initialize(ctx context.Context) error
- func (kc *KafkaCluster) Insert(ctx context.Context) error
- func (kc *KafkaCluster) InsertRecord(ctx context.Context, namespace string) error
- func (kc *KafkaCluster) Install(ctx context.Context, namespace string) error
- func (kc *KafkaCluster) IsReady(ctx context.Context) (bool, error)
- func (kc *KafkaCluster) Object() crv1alpha1.ObjectReference
- func (kc *KafkaCluster) Ping(ctx context.Context) error
- func (kc *KafkaCluster) Reset(ctx context.Context) error
- func (kc *KafkaCluster) Secrets() map[string]crv1alpha1.ObjectReference
- func (kc *KafkaCluster) Uninstall(ctx context.Context) error
- type MariaDB
- func (m *MariaDB) Count(ctx context.Context) (int, error)
- func (m *MariaDB) GetClusterScopedResources(ctx context.Context) []crv1alpha1.ObjectReference
- func (m *MariaDB) Init(context.Context) error
- func (m *MariaDB) Initialize(ctx context.Context) error
- func (m *MariaDB) Insert(ctx context.Context) error
- func (m *MariaDB) Install(ctx context.Context, namespace string) error
- func (m *MariaDB) IsReady(ctx context.Context) (bool, error)
- func (m *MariaDB) Object() crv1alpha1.ObjectReference
- func (m *MariaDB) Ping(ctx context.Context) error
- func (m *MariaDB) Reset(ctx context.Context) error
- func (m *MariaDB) Uninstall(ctx context.Context) error
- type Message
- type MongoDB
- func (mongo *MongoDB) Chart() *helm.ChartInfo
- func (mongo *MongoDB) Count(ctx context.Context) (int, error)
- func (mongo *MongoDB) GetClusterScopedResources(ctx context.Context) []crv1alpha1.ObjectReference
- func (mongo *MongoDB) Init(ctx context.Context) error
- func (mongo *MongoDB) Initialize(ctx context.Context) error
- func (mongo *MongoDB) Insert(ctx context.Context) error
- func (mongo *MongoDB) Install(ctx context.Context, namespace string) error
- func (mongo *MongoDB) IsReady(ctx context.Context) (bool, error)
- func (mongo *MongoDB) Object() crv1alpha1.ObjectReference
- func (mongo *MongoDB) Ping(ctx context.Context) error
- func (mongo *MongoDB) Reset(ctx context.Context) error
- func (mongo *MongoDB) SetChart(chart helm.ChartInfo)
- func (mongo *MongoDB) Uninstall(ctx context.Context) error
- type MongoDBDepConfig
- func (mongo *MongoDBDepConfig) Count(ctx context.Context) (int, error)
- func (mongo *MongoDBDepConfig) GetClusterScopedResources(ctx context.Context) []crv1alpha1.ObjectReference
- func (mongo *MongoDBDepConfig) Init(context.Context) error
- func (mongo *MongoDBDepConfig) Initialize(ctx context.Context) error
- func (mongo *MongoDBDepConfig) Insert(ctx context.Context) error
- func (mongo *MongoDBDepConfig) Install(ctx context.Context, namespace string) error
- func (mongo *MongoDBDepConfig) IsReady(ctx context.Context) (bool, error)
- func (mongo *MongoDBDepConfig) Object() crv1alpha1.ObjectReference
- func (mongo *MongoDBDepConfig) Ping(ctx context.Context) error
- func (mongo *MongoDBDepConfig) Reset(ctx context.Context) error
- func (mongo *MongoDBDepConfig) Uninstall(ctx context.Context) error
- type MssqlDB
- func (m *MssqlDB) ConfigMaps() map[string]crv1alpha1.ObjectReference
- func (m *MssqlDB) Count(ctx context.Context) (int, error)
- func (m *MssqlDB) GetClusterScopedResources(ctx context.Context) []crv1alpha1.ObjectReference
- func (m *MssqlDB) Init(ctx context.Context) error
- func (m *MssqlDB) Initialize(ctx context.Context) error
- func (m *MssqlDB) Insert(ctx context.Context) error
- func (m *MssqlDB) Install(ctx context.Context, namespace string) error
- func (m *MssqlDB) IsReady(ctx context.Context) (bool, error)
- func (m *MssqlDB) Object() crv1alpha1.ObjectReference
- func (m *MssqlDB) Ping(ctx context.Context) error
- func (m *MssqlDB) Reset(ctx context.Context) error
- func (m *MssqlDB) Secrets() map[string]crv1alpha1.ObjectReference
- func (m *MssqlDB) Uninstall(ctx context.Context) error
- type MysqlDB
- func (mdb *MysqlDB) Chart() *helm.ChartInfo
- func (mdb *MysqlDB) ConfigMaps() map[string]crv1alpha1.ObjectReference
- func (mdb *MysqlDB) Count(ctx context.Context) (int, error)
- func (mdb *MysqlDB) GetClusterScopedResources(ctx context.Context) []crv1alpha1.ObjectReference
- func (mdb *MysqlDB) Init(ctx context.Context) error
- func (mdb *MysqlDB) Initialize(ctx context.Context) error
- func (mdb *MysqlDB) Insert(ctx context.Context) error
- func (mdb *MysqlDB) Install(ctx context.Context, namespace string) error
- func (mdb *MysqlDB) IsReady(ctx context.Context) (bool, error)
- func (mdb *MysqlDB) Object() crv1alpha1.ObjectReference
- func (mdb *MysqlDB) Ping(ctx context.Context) error
- func (mdb *MysqlDB) Reset(ctx context.Context) error
- func (mdb *MysqlDB) Secrets() map[string]crv1alpha1.ObjectReference
- func (mdb *MysqlDB) SetChart(chart helm.ChartInfo)
- func (mdb *MysqlDB) Uninstall(ctx context.Context) error
- type MysqlDepConfig
- func (mdep *MysqlDepConfig) Count(ctx context.Context) (int, error)
- func (mdep *MysqlDepConfig) GetClusterScopedResources(ctx context.Context) []crv1alpha1.ObjectReference
- func (mdep *MysqlDepConfig) Init(context.Context) error
- func (mdep *MysqlDepConfig) Initialize(ctx context.Context) error
- func (mdep *MysqlDepConfig) Insert(ctx context.Context) error
- func (mdep *MysqlDepConfig) Install(ctx context.Context, namespace string) error
- func (mdep *MysqlDepConfig) IsReady(ctx context.Context) (bool, error)
- func (mdep *MysqlDepConfig) Object() crv1alpha1.ObjectReference
- func (mdep *MysqlDepConfig) Ping(ctx context.Context) error
- func (mdep *MysqlDepConfig) Reset(ctx context.Context) error
- func (mdep *MysqlDepConfig) Uninstall(ctx context.Context) error
- type PITRBlueprint
- type PITRBlueprinter
- type Payload
- type PostgreSQLDepConfig
- func (pgres *PostgreSQLDepConfig) Count(ctx context.Context) (int, error)
- func (pgres *PostgreSQLDepConfig) GetClusterScopedResources(ctx context.Context) []crv1alpha1.ObjectReference
- func (pgres *PostgreSQLDepConfig) Init(ctx context.Context) error
- func (pgres *PostgreSQLDepConfig) Initialize(ctx context.Context) error
- func (pgres *PostgreSQLDepConfig) Insert(ctx context.Context) error
- func (pgres *PostgreSQLDepConfig) Install(ctx context.Context, namespace string) error
- func (pgres *PostgreSQLDepConfig) IsReady(ctx context.Context) (bool, error)
- func (pgres *PostgreSQLDepConfig) Object() crv1alpha1.ObjectReference
- func (pgres *PostgreSQLDepConfig) Ping(ctx context.Context) error
- func (pgres *PostgreSQLDepConfig) Reset(ctx context.Context) error
- func (pgres *PostgreSQLDepConfig) Uninstall(ctx context.Context) error
- type PostgresDB
- func (pdb PostgresDB) ConfigMaps() map[string]crv1alpha1.ObjectReference
- func (pdb PostgresDB) Count(ctx context.Context) (int, error)
- func (pdp *PostgresDB) GetClusterScopedResources(ctx context.Context) []crv1alpha1.ObjectReference
- func (pdb *PostgresDB) Init(ctx context.Context) error
- func (pdb PostgresDB) Initialize(ctx context.Context) error
- func (pdb PostgresDB) Insert(ctx context.Context) error
- func (pdb *PostgresDB) Install(ctx context.Context, ns string) error
- func (pdb *PostgresDB) IsReady(ctx context.Context) (bool, error)
- func (pdb *PostgresDB) Object() crv1alpha1.ObjectReference
- func (pdb *PostgresDB) Ping(ctx context.Context) error
- func (pdb PostgresDB) Reset(ctx context.Context) error
- func (pdb PostgresDB) Secrets() map[string]crv1alpha1.ObjectReference
- func (pdb PostgresDB) Uninstall(ctx context.Context) error
- type RDSAuroraMySQLDB
- func (a *RDSAuroraMySQLDB) Count(ctx context.Context) (int, error)
- func (a *RDSAuroraMySQLDB) GetClusterScopedResources(ctx context.Context) []crv1alpha1.ObjectReference
- func (a *RDSAuroraMySQLDB) Init(context.Context) error
- func (a *RDSAuroraMySQLDB) Initialize(ctx context.Context) error
- func (a *RDSAuroraMySQLDB) Insert(ctx context.Context) error
- func (a *RDSAuroraMySQLDB) Install(ctx context.Context, namespace string) error
- func (a *RDSAuroraMySQLDB) IsReady(context.Context) (bool, error)
- func (a *RDSAuroraMySQLDB) Object() crv1alpha1.ObjectReference
- func (a *RDSAuroraMySQLDB) Ping(ctx context.Context) error
- func (a *RDSAuroraMySQLDB) Reset(ctx context.Context) error
- func (a *RDSAuroraMySQLDB) Uninstall(ctx context.Context) error
- type RDSPostgresDB
- func (pdb RDSPostgresDB) ConfigMaps() map[string]crv1alpha1.ObjectReference
- func (pdb RDSPostgresDB) Count(ctx context.Context) (int, error)
- func (pdb RDSPostgresDB) GetClusterScopedResources(ctx context.Context) []crv1alpha1.ObjectReference
- func (pdb *RDSPostgresDB) Init(ctx context.Context) error
- func (pdb RDSPostgresDB) Initialize(ctx context.Context) error
- func (pdb RDSPostgresDB) Insert(ctx context.Context) error
- func (pdb *RDSPostgresDB) Install(ctx context.Context, ns string) error
- func (pdb *RDSPostgresDB) IsReady(ctx context.Context) (bool, error)
- func (pdb *RDSPostgresDB) Object() crv1alpha1.ObjectReference
- func (pdb *RDSPostgresDB) Ping(ctx context.Context) error
- func (pdb RDSPostgresDB) Reset(ctx context.Context) error
- func (pdb RDSPostgresDB) Secrets() map[string]crv1alpha1.ObjectReference
- func (pdb RDSPostgresDB) Uninstall(ctx context.Context) error
- type Records
- type SubscriptionPayload
- type TimeLogCSI
- func (tlc *TimeLogCSI) ConfigMaps() map[string]crv1alpha1.ObjectReference
- func (tlc *TimeLogCSI) Count(ctx context.Context) (int, error)
- func (tlc *TimeLogCSI) GetClusterScopedResources(ctx context.Context) []crv1alpha1.ObjectReference
- func (tlc *TimeLogCSI) Init(ctx context.Context) error
- func (tlc *TimeLogCSI) Initialize(ctx context.Context) error
- func (tlc *TimeLogCSI) Insert(ctx context.Context) error
- func (tlc *TimeLogCSI) Install(ctx context.Context, namespace string) error
- func (tlc *TimeLogCSI) IsReady(ctx context.Context) (bool, error)
- func (tlc *TimeLogCSI) Object() crv1alpha1.ObjectReference
- func (tlc *TimeLogCSI) Ping(ctx context.Context) error
- func (tlc *TimeLogCSI) Reset(ctx context.Context) error
- func (tlc *TimeLogCSI) Secrets() map[string]crv1alpha1.ObjectReference
- func (tlc *TimeLogCSI) Uninstall(ctx context.Context) error
Constants ¶
const ( AuroraDBInstanceClass = "db.r5.large" AuroraDBStorage = 20 DetailsCMName = "dbconfig" )
const ( // PersistentStorage can be used if we want to deploy database with Persistent Volumes PersistentStorage storage = "persistent" //nolint:varcheck // EphemeralStorage can be used if we don't want to deploy database with Persistent EphemeralStorage storage = "ephemeral" // TemplateVersionOCP3_11 stores version of db template 3.11 TemplateVersionOCP3_11 DBTemplate = "release-3.11" // TemplateVersionOCP4_4 stores version of db template 4.4 TemplateVersionOCP4_4 DBTemplate = "release-4.4" // TemplateVersionOCP4_5 stores version of db template 4.5 TemplateVersionOCP4_5 DBTemplate = "release-4.5" // TemplateVersionOCP4_10 stores version of db template 4.10 TemplateVersionOCP4_10 DBTemplate = "release-4.10" // TemplateVersionOCP4_11 stores version of db template 4.11 TemplateVersionOCP4_11 DBTemplate = "release-4.11" // TemplateVersionOCP4_12 stores version of db template 4.12 TemplateVersionOCP4_12 DBTemplate = "release-4.12" // TemplateVersionOCP4_13 stores version of db template 4.13 TemplateVersionOCP4_13 DBTemplate = "release-4.13" // TemplateVersionOCP4_14 stores version of db template 4.14 TemplateVersionOCP4_14 DBTemplate = "release-4.14" )
Variables ¶
This section is empty.
Functions ¶
func K8SServicePortForward ¶
func K8SServicePortForward(ctx context.Context, svcName string, ns string, pPort string) (*portforward.PortForwarder, error)
K8SServicePortForward creates a service port forwarding and returns the forwarder and error if any
Types ¶
type App ¶
type App interface { // Init instantiates the app based on the environment configuration, // including environement variables and state in the Kubernetes cluster. If // any required configuration is not discoverable, Init will return an // error. Init(context.Context) error // Install will install the app into a specified namespace. Install should // be called after Init. Install(ctx context.Context, namespace string) error // IsReady returns true once an app is running. If we detect a failure state // that will not recover from on it's own, then IsReady will return an // error. IsReady(context.Context) (bool, error) // Object returns a reference to this app to be used by ActionSets. Object() crv1alpha1.ObjectReference // Uninstall deletes an app and all it's components from a Namespace. Uninstall(context.Context) error // GetClusterScopedResources returns the list of cluster scoped k8s resources created during app Install GetClusterScopedResources(context.Context) []crv1alpha1.ObjectReference }
App represents an application we can install into a namespace.
func NewCassandraInstance ¶
NewCassandraInstance returns new cassandra application
func NewCockroachDB ¶
NewCockroachDB Last tested working version "22.1.5"
func NewCouchbaseDB ¶
NewCouchbaseDB initialises an instance of Couchbase DB Last tested woking version "2.3.0"
func NewElasticsearchInstance ¶
NewElasticsearchInstance initialises an instance of Elasticsearch Last tested on 8.5.1
func NewFoundationDB ¶
NewFoundationDB initializes and returns the foundation db instance
func NewKafkaCluster ¶
func NewMariaDB ¶
func NewMongoDBDepConfig ¶
func NewMongoDBDepConfig(name string, templateVersion DBTemplate, storageType storage) App
func NewMssqlDB ¶
func NewMysqlDepConfig ¶
func NewMysqlDepConfig(name string, templateVersion DBTemplate, storageType storage, tag string) App
func NewPostgreSQLDepConfig ¶
func NewPostgreSQLDepConfig(name string, templateVersion DBTemplate, storageType storage) App
func NewPostgresDB ¶
NewPostgresDB initialises an instance of Postgres DB Last tested chart version "15.5.38". Also, we are using postgres version 16
func NewRDSAuroraMySQLDB ¶
func NewRDSPostgresDB ¶
func NewTimeLogCSI ¶
NewTimeLogCSI instantiates the TimeLogCSI integration test app
type AppBlueprint ¶
AppBlueprint implements Blueprint() to return Blueprint specs for the app Blueprint() returns Blueprint placed at ./blueprints/{app-name}-blueprint.yaml
func (AppBlueprint) Blueprint ¶
func (b AppBlueprint) Blueprint() *crv1alpha1.Blueprint
type Blueprinter ¶
type Blueprinter interface { // Blueprint returns a new non-namespaced Blueprint. Blueprint() *crv1alpha1.Blueprint }
Blueprinter is the interface used to create a Blueprint.
func NewBlueprint ¶
func NewBlueprint(app string, bpReposPath string, useDevImages bool) Blueprinter
func NewPITRBlueprint ¶
func NewPITRBlueprint(app string, bpReposPath string, useDevImages bool) Blueprinter
NewPITRBlueprint returns blueprint placed at ./blueprints/{app-name}-blueprint.yaml
type CassandraInstance ¶
type CassandraInstance struct {
// contains filtered or unexported fields
}
CassandraInstance defines structure a cassandra databse application
func (*CassandraInstance) Count ¶
func (cas *CassandraInstance) Count(ctx context.Context) (int, error)
Count will return the number of records, there are inside the database's table
func (*CassandraInstance) GetClusterScopedResources ¶
func (cas *CassandraInstance) GetClusterScopedResources(ctx context.Context) []crv1alpha1.ObjectReference
func (*CassandraInstance) Init ¶
func (cas *CassandraInstance) Init(context.Context) error
Init initializes the database application
func (*CassandraInstance) Initialize ¶
func (cas *CassandraInstance) Initialize(ctx context.Context) error
Initialize is used to initialize the database or create schema
func (*CassandraInstance) Insert ¶
func (cas *CassandraInstance) Insert(ctx context.Context) error
Insert is used to insert the records into the database
func (*CassandraInstance) Install ¶
func (cas *CassandraInstance) Install(ctx context.Context, namespace string) error
Install is used to install the initialized application
func (*CassandraInstance) IsReady ¶
func (cas *CassandraInstance) IsReady(ctx context.Context) (bool, error)
IsReady waits for the application to be ready
func (*CassandraInstance) Object ¶
func (cas *CassandraInstance) Object() crv1alpha1.ObjectReference
Object returns the kubernetes resource that is being referred by db application installation
func (*CassandraInstance) Ping ¶
func (cas *CassandraInstance) Ping(ctx context.Context) error
Ping is used to ping the application to check the database connectivity
type CockroachDB ¶
type CockroachDB struct {
// contains filtered or unexported fields
}
func (*CockroachDB) ConfigMaps ¶
func (c *CockroachDB) ConfigMaps() map[string]crv1alpha1.ObjectReference
func (*CockroachDB) GetClusterScopedResources ¶
func (c *CockroachDB) GetClusterScopedResources(context.Context) []crv1alpha1.ObjectReference
func (*CockroachDB) Initialize ¶
func (c *CockroachDB) Initialize(ctx context.Context) error
Initialize is used to initialize the database or create schema
func (*CockroachDB) Install ¶
func (c *CockroachDB) Install(ctx context.Context, namespace string) error
func (*CockroachDB) Object ¶
func (c *CockroachDB) Object() crv1alpha1.ObjectReference
func (*CockroachDB) Secrets ¶
func (c *CockroachDB) Secrets() map[string]crv1alpha1.ObjectReference
type ConfigApp ¶
type ConfigApp interface { App // ConfigMaps returns named references to ConfigMaps when installing App. ConfigMaps() map[string]crv1alpha1.ObjectReference // Secrets returns named references to Secrets when installing App. Secrets() map[string]crv1alpha1.ObjectReference }
ConfigApp describes an App installs additional configuration that can be referenced from an ActionSet and used in a Blueprint. Not all apps will create this additional configuration.
type CouchbaseDB ¶
type CouchbaseDB struct {
// contains filtered or unexported fields
}
func (CouchbaseDB) GetClusterScopedResources ¶
func (cb CouchbaseDB) GetClusterScopedResources(ctx context.Context) []crv1alpha1.ObjectReference
func (CouchbaseDB) Initialize ¶
func (cb CouchbaseDB) Initialize(ctx context.Context) error
Initialize is used to initialize the database or create schema
func (*CouchbaseDB) Object ¶
func (cb *CouchbaseDB) Object() crv1alpha1.ObjectReference
type DatabaseApp ¶
type DatabaseApp interface { App // Ping will issue trivial request to the database to see if it is // accessible. Ping(context.Context) error // Insert adds n entries to the database. Insert(ctx context.Context) error // Count returns the number of entries in the database. Count(context.Context) (int, error) // Reset Removes all entries from the database. Reset(context.Context) error // Initialize Initializes the database Initialize(context.Context) error }
DatabaseApp inherits methods from App, but also includes method to add, read and remove entries stored byt the App.
type ElasticsearchInstance ¶
type ElasticsearchInstance struct {
// contains filtered or unexported fields
}
func (*ElasticsearchInstance) Count ¶
func (esi *ElasticsearchInstance) Count(ctx context.Context) (int, error)
func (*ElasticsearchInstance) GetClusterScopedResources ¶
func (esi *ElasticsearchInstance) GetClusterScopedResources(ctx context.Context) []crv1alpha1.ObjectReference
func (*ElasticsearchInstance) Init ¶
func (esi *ElasticsearchInstance) Init(ctx context.Context) error
func (*ElasticsearchInstance) Initialize ¶
func (esi *ElasticsearchInstance) Initialize(ctx context.Context) error
Initialize is used to initialize the database or create schema
func (*ElasticsearchInstance) Insert ¶
func (esi *ElasticsearchInstance) Insert(ctx context.Context) error
func (*ElasticsearchInstance) Install ¶
func (esi *ElasticsearchInstance) Install(ctx context.Context, namespace string) error
func (*ElasticsearchInstance) IsReady ¶
func (esi *ElasticsearchInstance) IsReady(ctx context.Context) (bool, error)
func (*ElasticsearchInstance) Object ¶
func (esi *ElasticsearchInstance) Object() crv1alpha1.ObjectReference
func (*ElasticsearchInstance) Ping ¶
func (esi *ElasticsearchInstance) Ping(ctx context.Context) error
func (*ElasticsearchInstance) Reset ¶
func (esi *ElasticsearchInstance) Reset(ctx context.Context) error
func (*ElasticsearchInstance) Secrets ¶
func (esi *ElasticsearchInstance) Secrets() map[string]crv1alpha1.ObjectReference
type ElasticsearchPingOutput ¶
type ElasticsearchPingOutput struct { Hits struct { Total struct { Value int `json:"value"` } `json:"total"` } `json:"hits"` }
ElasticsearchPingOutput struct gets mapped to the output of curl <es-host>:<es-port>/<index-name>/_search?pretty which actually returns details about all the documents of a specific ES index (index-name) if, due to any reason, there is change in how Elasticsearch responds to above query, below struct is subject to change.
type FoundationDB ¶
type FoundationDB struct {
// contains filtered or unexported fields
}
FoundationDB has fields of foundationdb instance
func (*FoundationDB) Count ¶
func (fdb *FoundationDB) Count(ctx context.Context) (int, error)
Count is used to count the number of records
func (*FoundationDB) GetClusterScopedResources ¶
func (fdb *FoundationDB) GetClusterScopedResources(ctx context.Context) []crv1alpha1.ObjectReference
func (*FoundationDB) Init ¶
func (fdb *FoundationDB) Init(ctx context.Context) error
Init initialises the kubernetes config details
func (*FoundationDB) Initialize ¶
func (fdb *FoundationDB) Initialize(ctx context.Context) error
Initialize is used to initialize the database or create schema
func (*FoundationDB) Insert ¶
func (fdb *FoundationDB) Insert(ctx context.Context) error
Insert is used to insert some records into the database
func (*FoundationDB) Install ¶
func (fdb *FoundationDB) Install(ctx context.Context, namespace string) error
Install is used to install the database
func (*FoundationDB) IsReady ¶
func (fdb *FoundationDB) IsReady(ctx context.Context) (bool, error)
IsReady is used to check the database that is installed is ready or not
func (*FoundationDB) Object ¶
func (fdb *FoundationDB) Object() crv1alpha1.ObjectReference
Object will return the controller reference that is installed to run the database
func (*FoundationDB) Ping ¶
func (fdb *FoundationDB) Ping(ctx context.Context) error
Ping is used to check if the database is able to accept the request
type HelmApp ¶
type HelmApp interface { App // Chart returns the chart of this Helm app. Chart() *helm.ChartInfo // SetChart sets the chart of this Helm app. SetChart(chart helm.ChartInfo) }
func NewMongoDB ¶
NewMongoDB initialises an instance of Mongo DB Last tested working version "9.0.0"
func NewMysqlDB ¶
NewMysqlDB was last tested with working version "6.14.11"
type InsertPayload ¶
type InsertPayload struct {
Records []Records `json:"records"`
}
InsertPayload is a list of Records passed to a topic
type IsMasterOutput ¶
type IsMasterOutput struct {
Ismaster bool `json:"ismaster"`
}
IsMasterOutput struct gets mapped to the output of the mongo command that checks if node is master or not.
type KafkaCluster ¶
type KafkaCluster struct {
// contains filtered or unexported fields
}
func (*KafkaCluster) ConfigMaps ¶
func (kc *KafkaCluster) ConfigMaps() map[string]crv1alpha1.ObjectReference
func (*KafkaCluster) GetClusterScopedResources ¶
func (kc *KafkaCluster) GetClusterScopedResources(ctx context.Context) []crv1alpha1.ObjectReference
func (*KafkaCluster) Initialize ¶
func (kc *KafkaCluster) Initialize(ctx context.Context) error
Initialize is used to initialize the database or create schema
func (*KafkaCluster) InsertRecord ¶
func (kc *KafkaCluster) InsertRecord(ctx context.Context, namespace string) error
InsertRecord creates a topic and insert a record
func (*KafkaCluster) Install ¶
func (kc *KafkaCluster) Install(ctx context.Context, namespace string) error
func (*KafkaCluster) Object ¶
func (kc *KafkaCluster) Object() crv1alpha1.ObjectReference
Object return the configmap referred in blueprint
func (*KafkaCluster) Secrets ¶
func (kc *KafkaCluster) Secrets() map[string]crv1alpha1.ObjectReference
type MariaDB ¶
type MariaDB struct {
// contains filtered or unexported fields
}
func (*MariaDB) GetClusterScopedResources ¶
func (m *MariaDB) GetClusterScopedResources(ctx context.Context) []crv1alpha1.ObjectReference
func (*MariaDB) Object ¶
func (m *MariaDB) Object() crv1alpha1.ObjectReference
type Message ¶
type Message struct { Topic string `json:"topic"` Key string `json:"key"` Value string `json:"value"` Partition int `json:"partition"` Offset int `json:"offset"` }
Message describes the response we get after consuming a topic
type MongoDB ¶
type MongoDB struct {
// contains filtered or unexported fields
}
func (*MongoDB) GetClusterScopedResources ¶
func (mongo *MongoDB) GetClusterScopedResources(ctx context.Context) []crv1alpha1.ObjectReference
func (*MongoDB) Initialize ¶
Initialize is used to initialize the database or create schema
func (*MongoDB) Object ¶
func (mongo *MongoDB) Object() crv1alpha1.ObjectReference
type MongoDBDepConfig ¶
type MongoDBDepConfig struct {
// contains filtered or unexported fields
}
func (*MongoDBDepConfig) Count ¶
func (mongo *MongoDBDepConfig) Count(ctx context.Context) (int, error)
func (*MongoDBDepConfig) GetClusterScopedResources ¶
func (mongo *MongoDBDepConfig) GetClusterScopedResources(ctx context.Context) []crv1alpha1.ObjectReference
func (*MongoDBDepConfig) Initialize ¶
func (mongo *MongoDBDepConfig) Initialize(ctx context.Context) error
Initialize is used to initialize the database or create schema
func (*MongoDBDepConfig) Install ¶
func (mongo *MongoDBDepConfig) Install(ctx context.Context, namespace string) error
func (*MongoDBDepConfig) IsReady ¶
func (mongo *MongoDBDepConfig) IsReady(ctx context.Context) (bool, error)
func (*MongoDBDepConfig) Object ¶
func (mongo *MongoDBDepConfig) Object() crv1alpha1.ObjectReference
type MssqlDB ¶
type MssqlDB struct {
// contains filtered or unexported fields
}
func (*MssqlDB) ConfigMaps ¶
func (m *MssqlDB) ConfigMaps() map[string]crv1alpha1.ObjectReference
func (*MssqlDB) GetClusterScopedResources ¶
func (m *MssqlDB) GetClusterScopedResources(ctx context.Context) []crv1alpha1.ObjectReference
func (*MssqlDB) Object ¶
func (m *MssqlDB) Object() crv1alpha1.ObjectReference
func (*MssqlDB) Secrets ¶
func (m *MssqlDB) Secrets() map[string]crv1alpha1.ObjectReference
type MysqlDB ¶
type MysqlDB struct {
// contains filtered or unexported fields
}
func (*MysqlDB) ConfigMaps ¶
func (mdb *MysqlDB) ConfigMaps() map[string]crv1alpha1.ObjectReference
func (*MysqlDB) GetClusterScopedResources ¶
func (mdb *MysqlDB) GetClusterScopedResources(ctx context.Context) []crv1alpha1.ObjectReference
func (*MysqlDB) Initialize ¶
Initialize is used to initialize the database or create schema
func (*MysqlDB) Object ¶
func (mdb *MysqlDB) Object() crv1alpha1.ObjectReference
func (*MysqlDB) Secrets ¶
func (mdb *MysqlDB) Secrets() map[string]crv1alpha1.ObjectReference
type MysqlDepConfig ¶
type MysqlDepConfig struct {
// contains filtered or unexported fields
}
func (*MysqlDepConfig) GetClusterScopedResources ¶
func (mdep *MysqlDepConfig) GetClusterScopedResources(ctx context.Context) []crv1alpha1.ObjectReference
func (*MysqlDepConfig) Initialize ¶
func (mdep *MysqlDepConfig) Initialize(ctx context.Context) error
Initialize is used to initialize the database or create schema
func (*MysqlDepConfig) Install ¶
func (mdep *MysqlDepConfig) Install(ctx context.Context, namespace string) error
func (*MysqlDepConfig) IsReady ¶
func (mdep *MysqlDepConfig) IsReady(ctx context.Context) (bool, error)
func (*MysqlDepConfig) Object ¶
func (mdep *MysqlDepConfig) Object() crv1alpha1.ObjectReference
type PITRBlueprint ¶
type PITRBlueprint struct {
AppBlueprint
}
PITRBlueprint implements Blueprint() to return Blueprint with PITR Blueprint() returns Blueprint placed at ./blueprints/{app-name}-blueprint.yaml
func (PITRBlueprint) FormatPITR ¶
func (b PITRBlueprint) FormatPITR(pitr time.Time) string
type PITRBlueprinter ¶
type PITRBlueprinter interface { Blueprinter // FormatPITR takes a time.Time struct and returns a string for use by a // Blueprint that supports PITR. FormatPITR(time.Time) string }
PITRBlueprinter is optionally implemented if a Blueprint supports point-in-time recovery.
type Payload ¶
type Payload struct { Name string `json:"name"` AutoOffsetReset string `json:"auto.offset.reset"` Format string `json:"format"` EnableAutoCommit bool `json:"enable.auto.commit"` FetchMinBytes int `json:"fetch.min.bytes"` ConsumerRequestTimeoutMs int `json:"consumer.request.timeout.ms"` }
Payload sets the consumer configuration
type PostgreSQLDepConfig ¶
type PostgreSQLDepConfig struct {
// contains filtered or unexported fields
}
func (*PostgreSQLDepConfig) Count ¶
func (pgres *PostgreSQLDepConfig) Count(ctx context.Context) (int, error)
func (*PostgreSQLDepConfig) GetClusterScopedResources ¶
func (pgres *PostgreSQLDepConfig) GetClusterScopedResources(ctx context.Context) []crv1alpha1.ObjectReference
func (*PostgreSQLDepConfig) Init ¶
func (pgres *PostgreSQLDepConfig) Init(ctx context.Context) error
func (*PostgreSQLDepConfig) Initialize ¶
func (pgres *PostgreSQLDepConfig) Initialize(ctx context.Context) error
Initialize is used to initialize the database or create schema
func (*PostgreSQLDepConfig) Insert ¶
func (pgres *PostgreSQLDepConfig) Insert(ctx context.Context) error
func (*PostgreSQLDepConfig) Install ¶
func (pgres *PostgreSQLDepConfig) Install(ctx context.Context, namespace string) error
func (*PostgreSQLDepConfig) IsReady ¶
func (pgres *PostgreSQLDepConfig) IsReady(ctx context.Context) (bool, error)
func (*PostgreSQLDepConfig) Object ¶
func (pgres *PostgreSQLDepConfig) Object() crv1alpha1.ObjectReference
func (*PostgreSQLDepConfig) Ping ¶
func (pgres *PostgreSQLDepConfig) Ping(ctx context.Context) error
type PostgresDB ¶
type PostgresDB struct {
// contains filtered or unexported fields
}
func (PostgresDB) ConfigMaps ¶
func (pdb PostgresDB) ConfigMaps() map[string]crv1alpha1.ObjectReference
func (*PostgresDB) GetClusterScopedResources ¶
func (pdp *PostgresDB) GetClusterScopedResources(ctx context.Context) []crv1alpha1.ObjectReference
func (PostgresDB) Initialize ¶
func (pdb PostgresDB) Initialize(ctx context.Context) error
Initialize is used to initialize the database or create schema
func (*PostgresDB) Object ¶
func (pdb *PostgresDB) Object() crv1alpha1.ObjectReference
func (*PostgresDB) Ping ¶
func (pdb *PostgresDB) Ping(ctx context.Context) error
Ping makes and tests DB connection
func (PostgresDB) Secrets ¶
func (pdb PostgresDB) Secrets() map[string]crv1alpha1.ObjectReference
type RDSAuroraMySQLDB ¶
type RDSAuroraMySQLDB struct {
// contains filtered or unexported fields
}
func (*RDSAuroraMySQLDB) GetClusterScopedResources ¶
func (a *RDSAuroraMySQLDB) GetClusterScopedResources(ctx context.Context) []crv1alpha1.ObjectReference
func (*RDSAuroraMySQLDB) Initialize ¶
func (a *RDSAuroraMySQLDB) Initialize(ctx context.Context) error
func (*RDSAuroraMySQLDB) Install ¶
func (a *RDSAuroraMySQLDB) Install(ctx context.Context, namespace string) error
func (*RDSAuroraMySQLDB) IsReady ¶
func (a *RDSAuroraMySQLDB) IsReady(context.Context) (bool, error)
func (*RDSAuroraMySQLDB) Object ¶
func (a *RDSAuroraMySQLDB) Object() crv1alpha1.ObjectReference
type RDSPostgresDB ¶
type RDSPostgresDB struct {
// contains filtered or unexported fields
}
func (RDSPostgresDB) ConfigMaps ¶
func (pdb RDSPostgresDB) ConfigMaps() map[string]crv1alpha1.ObjectReference
func (RDSPostgresDB) GetClusterScopedResources ¶
func (pdb RDSPostgresDB) GetClusterScopedResources(ctx context.Context) []crv1alpha1.ObjectReference
func (RDSPostgresDB) Initialize ¶
func (pdb RDSPostgresDB) Initialize(ctx context.Context) error
Initialize is used to initialize the database or create schema
func (*RDSPostgresDB) Install ¶
func (pdb *RDSPostgresDB) Install(ctx context.Context, ns string) error
func (*RDSPostgresDB) IsReady ¶
func (pdb *RDSPostgresDB) IsReady(ctx context.Context) (bool, error)
func (*RDSPostgresDB) Object ¶
func (pdb *RDSPostgresDB) Object() crv1alpha1.ObjectReference
func (*RDSPostgresDB) Ping ¶
func (pdb *RDSPostgresDB) Ping(ctx context.Context) error
Ping makes and tests DB connection
func (RDSPostgresDB) Secrets ¶
func (pdb RDSPostgresDB) Secrets() map[string]crv1alpha1.ObjectReference
type Records ¶
Records takes value and place that to a partition in a topic based on hash of the key
type SubscriptionPayload ¶
type SubscriptionPayload struct {
Topics []string `json:"topics"`
}
SubscriptionPayload takes the list of topic names to subscribe
type TimeLogCSI ¶
type TimeLogCSI struct {
// contains filtered or unexported fields
}
TimeLogCSI is integration test app for CSI Snapshot functions.
func (*TimeLogCSI) ConfigMaps ¶
func (tlc *TimeLogCSI) ConfigMaps() map[string]crv1alpha1.ObjectReference
func (*TimeLogCSI) GetClusterScopedResources ¶
func (tlc *TimeLogCSI) GetClusterScopedResources(ctx context.Context) []crv1alpha1.ObjectReference
func (*TimeLogCSI) Init ¶
func (tlc *TimeLogCSI) Init(ctx context.Context) error
Init initialises kubernetes CLI
func (*TimeLogCSI) Initialize ¶
func (tlc *TimeLogCSI) Initialize(ctx context.Context) error
func (*TimeLogCSI) Install ¶
func (tlc *TimeLogCSI) Install(ctx context.Context, namespace string) error
Install deploys the TimeLogCSI App Deployment and PVC
func (*TimeLogCSI) IsReady ¶
func (tlc *TimeLogCSI) IsReady(ctx context.Context) (bool, error)
IsReady waits for the App Deployment to be in 'Ready' state
func (*TimeLogCSI) Object ¶
func (tlc *TimeLogCSI) Object() crv1alpha1.ObjectReference
Object defines the objectReference that will be used to create actions in blueprint
func (*TimeLogCSI) Ping ¶
func (tlc *TimeLogCSI) Ping(ctx context.Context) error
Ping is used to check the connection with Deployment Pod
func (*TimeLogCSI) Reset ¶
func (tlc *TimeLogCSI) Reset(ctx context.Context) error
Reset deletes the log file present at the volume mount path
func (*TimeLogCSI) Secrets ¶
func (tlc *TimeLogCSI) Secrets() map[string]crv1alpha1.ObjectReference
Source Files ¶
- app.go
- bp.go
- cassandra.go
- cockroachdb.go
- couchbase.go
- csi-snapshot.go
- elasticsearch.go
- foundationdb.go
- helm_app.go
- kafka.go
- mariadb.go
- mongodb-deploymentconfig.go
- mongodb.go
- mssql.go
- mysql-deploymentconfig.go
- mysql.go
- postgresql-deploymentconfig.go
- postgresql.go
- rds_aurora_mysql.go
- rds_postgres.go
- utils.go