Tribefire v1alpha1 API group

Packages:

tribefire.cloud

tribefire.cloud

Package v1alpha1 contains API Schema definitions for the tribefire v1alpha1 API group

Resource Types:

BackendConfiguration

This element is used to set the Tribefire backend as well as the configuration parameters for the chosen Tribefire backend. Currently, etcd and activemq are supported

Field	Description
`type` MessagingBackend	The backend for Tribefire Possible values: `activemq`, `etcd` (note: ActiveMQ is supported for compatibility only)
`parameters` []BackendParam	Configuration properties for the chosen Tribefire backend, e.g. the `etcd` URL Defaults (for etcd): `name='url'` `value='http://tf-etcd-cluster-client:2379'`

BackendParam

(Appears on: BackendConfiguration)

This element is used to set specific properties for the chosen Tribefire backend, e.g. URLs and credentials

Field	Description
`name` string	name of the backend property Examples: `username`, `password`, `url`
`value` string	the value of the backend configuration property Examples: `https://tf-etcd.etcd.svc.cluster.local`, `etcd-user`, `etcd-password`

ComponentStatus (`string` alias)

(Appears on: TribefireComponentStatus)

Description

The overall status of the related component, can be used as an indicator on health/availability of the component. degraded means “partially available”, i.e. when not all replicas of a component are available.

Possible Values

available, degraded, unavailable

ComponentStatusChangeReason (`string` alias)

ComponentType (`string` alias)

(Appears on: TribefireComponent)

Description

This identified the type of the component, that could be for instance control-center or modeler

Possible Values

services, control-center, modeler, explorer, web-reader, cartridge

CustomEnvironment (`map[string]string` alias)

Description

Every TribefireRuntimeComponent can have a custom environment that is structured the same as the standard env section on a container. Use it to control the environment variables that a TribefireRuntimeComponent container sees.

Example

- name: "PRODUCTION_MODE"
value: "true"

DatabaseSpec

(Appears on: TribefireSpec)

this spec is used to attach external/custom databases the DatabaseDescriptor is used to refer to the existing database, e.g. braintribe-databases:europe-west3:general-purpose=tcp:5555

Field	Description
`name` string	a symbolic name to refer to this database. Example: `tribecell-production`
`type` DatabaseType	The type of this database. If type is `cloudsql`, the operator will provision a Google CloudSQL database. If type is `local`, the operator will deploy a local PostgreSQL container Possible Values: `cloudsql`, `local` Example: `cloudsql`
`instanceDescriptor` string	The descriptor/connection string that identifies this database. This can either be a CloudSQL instance descriptor or a JDBC url. Example: `jdbc:postgresql://1.2.3.4:5432/documents-demo`
`envPrefixes` []string	For every database described by a `DatabaseSpec` there will be a set of environment variables exposed in the `tribefire-services` pods. This set of env vars contains the following variables: `${PREFIX}_DB_URL` `${PREFIX}_DB_USER` `${PREFIX}_DB_PASS` the values for this variables is taken from the `credentialsSecretRef` as well as the `instanceDescriptor` Example: `DOCUMENTS`
`databaseName` string	The name of the database Example: `documents`
`serviceAccountSecretRef` Kubernetes core/v1.SecretReference	This `secretRef` points to the secret that contains the service account manifest for CloudSQL. Only needed in case you want to connect to a CloudSQL database via the cloud-sql-proxy Example: `documents-cloudsql-secret`
`serviceAccountSecretKey` string	This points to the key of the `serviceAccountSecretRef` where to take the service account JSON from Example: `service-account.json`
`credentialsSecretRef` Kubernetes core/v1.SecretReference	This `secretRef` points to the secret that contains the database credentials, i.e. username and password to connect to the database. The secret itself should have a `username` and a `password` key that have the related values. Example: `database-credentials-secret`

DatabaseType (`string` alias)

(Appears on: DatabaseSpec, TribefireSpec)

Description

The type of the referenced database. If type is cloudsql, a Google CloudSQL database will be provisioned for this TribefireRuntime. If type is local, a local postgresql container will be bootstrapped.

Possible Values

cloudsql, local

Example

cloudsql

DcsaConfig

(Appears on: TribefireSpec)

The configuration element for DCSA support

Field	Description
`databaseUrl` string	The connection string that identifies this database. Currently only JDBC URLs are supported Example: `jdbc:postgresql://1.2.3.4:5432/documents-demo`
`credentialsSecretRef` Kubernetes core/v1.SecretReference	This `secretRef` points to the secret that contains the database credentials, i.e. username and password to connect to the database. The secret itself should have a `username` and a `password` key that have the related values. Example: `database-credentials-secret`

DeploymentPhase (`string` alias)

(Appears on: TribefireStatus)

Description

The current phase of the TribefireRuntime deployment. This can be used to determine how far the deployment has progressed, and can also be used to understand what went wrong. For instance, if a TribefireRuntime deployment does not progress any more and is in phase DatabaseBootstrap, it might indicate that something went wrong during the provisioning of the database.

Possible Values

TribefireValidation, DatabaseBootstrap, SecretBootstrap, BackendBootstrap, ComponentDeployment TribefireRunning

MessagingBackend (`string` alias)

(Appears on: BackendConfiguration)

Description

The backend that should be used for messaging, locking and leadership. Please note that in case of etcd, you must take care of the provisioning of the etcd cluster yourself. ActiveMQ will be deployed by the operator, every TribefireRuntime gets its own ActiveMQ instance.

Possible Values

activemq, etcd

Default

etcd

TribefireComponent

(Appears on: TribefireSpec)

Field	Description
`name` string	the name of this component
`type` ComponentType	type of this component, e.g.`services` or `control-center`
`image` string	Docker image to be used for this component. Example: `docker.artifactory.server/cloud/tribefire-master`
`imageTag` string	The image tag for the referenced Docker image Example: `2.0-latest`
`logLevel` string	The loglevel for this component. Possible values: `SEVERE`,`WARNING`,`INFO`,`CONFIG`,`FINE`,`FINER`,`FINEST`
`apiPath` string	absolute path (starting with `/`) for this component Example: `/tribefire-control-center`
`replicas` int32	number of replicas for this component Possible values: `1-10`
`publicUrl` string	The publicly accessible URL for this component Example: `https://demo-documents.tribefire.cloud/services`
`env` []Kubernetes core/v1.EnvVar	The environment for this component. Just a standard `env` section as in `ContainerSpec`
`logJson` string	Use JSON logging for this component Possible values: `true`, `false`
`resources` Kubernetes core/v1.ResourceRequirements	The resource requirements for this component. Standard `ResourceRequirements` as per `PodSpec`
`labels` map[string]string	Set of labels that should be attached to this component
`protocol` string	The protocol that should be used for the public URL Possible values: `http`, `https`
`persistentVolumes` []TribefireVolume	list of volumes that should be attached to this component. Should be used together with `persistentVolumeClaims`
`enableJpda` string	enables remote debugging capabilities via JPDA Possible values: `true`, `false`
`customHealthCheckPath` string	can be used to specify a custom health check endpoint URI. The default is `/healthz` for non-cartridge components and `/` for cartridges

TribefireComponentStatus

(Appears on: TribefireStatus)

status information about a specific component

Field	Description
`name` string	name of this component Examples: `services`, `control-center`
`status` ComponentStatus	status of this component Examples: `available`, `unavailable`, `degraded`
`urls` []string	the URL(s) under which this component is reachable from the outside (via the ingress) Examples: `https://demo-documents.tribefire.cloud/services`,`https://demo-documents.tribefire.cloud/control-center`,

TribefireRuntime

Field Description

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
TribefireSpec

`domain` string	the domain name under which this TribefireRuntime will be reachable (via the Ingress). For instance, if the domain is set to `tribefire.cloud` , the name of the runtime is `demo`, and the namespace of the runtime is `documents`, then the TribefireRuntime will be available via `https:/demo-documents.tribefire.cloud/` Possible values: any valid DNS name
`databaseType` DatabaseType	The type of the database for this TribefireRuntime
`databases` []DatabaseSpec	Any additional (external) database that the runtime might need, e.g. Documents database
`backend` BackendConfiguration	The backend configuration for this TribefireRuntime, e.g. configuration for `etcd` backend
`dcsaConfig` DcsaConfig	config element for DCSA support
`components` []TribefireComponent	The list of components for this TribefireRuntime, i.e. `services`, ‘control-center` and others

status
TribefireStatus

TribefireRuntimeCondition

(Appears on: TribefireStatus)

DeploymentCondition describes the state of a deployment at a certain point.

Field	Description
`type` TribefireRuntimeConditionType	Type of deployment condition.
`status` Kubernetes core/v1.ConditionStatus	Status of the condition, one of True, False, Unknown.
`lastUpdateTime` Kubernetes meta/v1.Time	The last time this condition was updated.
`lastTransitionTime` Kubernetes meta/v1.Time	Last time the condition transitioned from one status to another.
`reason` string	The reason for the condition’s last transition.
`message` string	A human readable message indicating details about the transition.

TribefireRuntimeConditionType (`string` alias)

(Appears on: TribefireRuntimeCondition)

Description

These are valid conditions of a deployment. A condition is a standard Kubernetes concept that can be used to track lifecycle changes, e.g. when a component gets available or unavailable. For instance, you can kubectl wait --for=condition=Available to block until the TribefireRuntime is fully available.

Possible Values

Available, EtcdAvailable, Progressing

TribefireSpec

(Appears on: TribefireRuntime)

The top level description of a TribefireRuntime. Describes the list of desired components, which backend to use and more.

Field	Description
`domain` string	the domain name under which this TribefireRuntime will be reachable (via the Ingress). For instance, if the domain is set to `tribefire.cloud` , the name of the runtime is `demo`, and the namespace of the runtime is `documents`, then the TribefireRuntime will be available via `https:/demo-documents.tribefire.cloud/` Possible values: any valid DNS name
`databaseType` DatabaseType	The type of the database for this TribefireRuntime
`databases` []DatabaseSpec	Any additional (external) database that the runtime might need, e.g. Documents database
`backend` BackendConfiguration	The backend configuration for this TribefireRuntime, e.g. configuration for `etcd` backend
`dcsaConfig` DcsaConfig	config element for DCSA support
`components` []TribefireComponent	The list of components for this TribefireRuntime, i.e. `services`, ‘control-center` and others

TribefireStatus

(Appears on: TribefireRuntime)

High level status information for this TribefireRuntime

Field	Description
`error` bool	error status indicator. If set to `true`, somethings wrong with this TribefireRuntime. Possible values: `true`, `false`
`status` string	a descriptive status message, such as `available` Example: `available`
`phase` DeploymentPhase	the `DeploymentPhase` this TribefireRuntime is in. For details see the docs on the `DeploymentPhase` Example: `DatabaseBootstrap`
`conditions` []TribefireRuntimeCondition	the status conditions for this TribefireRuntime. For details see the docs on the `TribefireRuntimeCondition`
`components` []TribefireComponentStatus	The list of `TribefireComponentStatus` information. For details, see the docs on `TribefireComponentStatus`
`observedGeneration` int64	This field is used to track changes to the `TribefireRuntimeSpec`
`created` string	Timestamp (ISO8601) when this TribefireRuntime was created. Example: `2019-03-20T17:41:09Z`
`updated` string	Timestamp (ISO8601) when this TribefireRuntime was updated. Example: `2019-03-20T19:36:39ZZ`

TribefireVolume

(Appears on: TribefireComponent)

a TribefireVolume is used to attach persistent storage to a component

Field	Description
`name` string	symbolic name of the volume Example: `nfs-documents`
`volumeClaimName` string	The name of the underlying `PersistentVolumeClaim`. Please note that you need to setup the PVC before referencing it here. Example: `nfs-documents-claim`
`volumeMountPath` string	The mount path where the PVC should be available inside the Tribefire pods. Example: `/nfs/documents`

Generated with gen-crd-api-reference-docs on git commit a3a05848.

Tribefire v1alpha1 API group

tribefire.cloud

BackendConfiguration

BackendParam

ComponentStatus (string alias)

Description

Possible Values

ComponentStatusChangeReason (string alias)

ComponentType (string alias)

Description

Possible Values

CustomEnvironment (map[string]string alias)

Description

Example

DatabaseSpec

DatabaseType (string alias)

Description

Possible Values

Example

DcsaConfig

DeploymentPhase (string alias)

Description

Possible Values

MessagingBackend (string alias)

Description

Possible Values

Default

TribefireComponent

TribefireComponentStatus

TribefireRuntime

TribefireRuntimeCondition

TribefireRuntimeConditionType (string alias)

Description

Possible Values

TribefireSpec

TribefireStatus

TribefireVolume

ComponentStatus (`string` alias)

ComponentStatusChangeReason (`string` alias)

ComponentType (`string` alias)

CustomEnvironment (`map[string]string` alias)

DatabaseType (`string` alias)

DeploymentPhase (`string` alias)

MessagingBackend (`string` alias)

TribefireRuntimeConditionType (`string` alias)