API Reference

^{↩ Parent}

BusinessTeamsServiceSpec defines the desired state of BusinessTeamsService

spec:
    databaseConfig:
    serverName: postgres1.mycompany.com
    portNumber: 5432
    databaseName: btsdb
    userSecretName: postgresql-user
    ssl: "true"
    sslMode: verify-ca
    sslSecretName: postgres-ssl
    customProperties:
    - name: connectTimeout
      value: "5"
 

spec:
    databaseConfig:
    userSecretName: postgresql-user
    customProperties:
    - name: URL
      value: jdbc:postgresql://unwon1.fyre.ibm.com:5432/umsdb02
 

spec:
    enableHugepages: "true"
    hugepagesType: hugepages-2Mi
    hugepagesSize: 100Mi
 

spec:
    enableHugepages: "true"
    hugepagesType: hugepages-2Mi
    hugepagesSize: 100Mi
 

spec:
    enableHugepages: "true"
    hugepagesType: hugepages-2Mi
    hugepagesSize: 100Mi
 

spec:
    livenessProbe:
    initialDelaySeconds: 30
    timeoutSeconds: 1
    periodSeconds: 30
    successThreshold: 1
    failureThreshold: 3
    terminationGracePeriodSeconds: 30
 

spec:
    readinessProbe:
    initialDelaySeconds: 30
    timeoutSeconds: 1
    periodSeconds: 30
    successThreshold: 1
    failureThreshold: 3
    terminationGracePeriodSeconds: 30
 

spec:
    resources:
    requests:
      cpu: 200m
      memory: 256Mi
      ephemeral-storage: 100Mi
    limits:
      cpu: 500m
      memory: 512Mi
 

spec:
    resourcesPostgres:
    requests:
      cpu: 50m
      memory: 768Mi
    limits:
      cpu: 200m
      memory: 1Gi
 

spec:
    startupProbe:
    initialDelaySeconds: 120
    timeoutSeconds: 1
    periodSeconds: 5
    successThreshold: 1
    failureThreshold: 180
    terminationGracePeriodSeconds: 30
 

spec:
    trustedTLSCertificates:
    - secretName: platform-identity-provider
      key: ca.crt
 

^{↩ Parent}

Audit logging configuration for BTS

^{↩ Parent}

The backup configuration of the PostgreSQL database. This configuration relies on the EDB PostgreSQL operator's backup configuration. See https://cloudnative-pg.io/documentation/1.18/api_reference/#BackupConfiguration for reference.

^{↩ Parent}

BarmanObjectStoreConfiguration contains the backup configuration by using Barman against an S3-compatible object storage. For reference see https://cloudnative-pg.io/documentation/1.18/api_reference/#BarmanObjectStoreConfiguration

^{↩ Parent}

The credentials to use to upload data to Azure Blob storage

^{↩ Parent}

The connection string to be used

^{↩ Parent}

The storage account where to upload data

^{↩ Parent}

The storage account key to be used in conjunction with the storage account name

^{↩ Parent}

A shared-access-signature to be used in conjunction with the storage account name

^{↩ Parent}

The configuration to be used to backup the data files When not defined, base backups files will be stored uncompressed and may be unencrypted in the object store, according to the bucket default policy.

^{↩ Parent}

EndpointCA store the CA bundle of the barman endpoint. Useful when using self-signed certificates to avoid errors with certificate issuer and barman-cloud-wal-archive

^{↩ Parent}

The credentials to use to upload data to Google Cloud Storage

^{↩ Parent}

The secret containing the Google Cloud Storage JSON file with the credentials

^{↩ Parent}

The credentials to use to upload data to S3

^{↩ Parent}

The reference to the access key id

^{↩ Parent}

The reference to the secret access key

^{↩ Parent}

The references to the session key

^{↩ Parent}

The configuration for the backup of the WAL stream. When not defined, WAL files will be stored uncompressed and may be unencrypted in the object store, according to the bucket default policy.

^{↩ Parent}

Use the spec.databaseConfig to specify a custom PostgreSQL database configuration for BTS.

The basic connection properties include serverName, portNumber, and databaseName. These properties define the database endpoint and the database name to use. BTS automatically creates the necessary tables in this database if they do not exist.

The userSecretName property points to a secret that contains username and password for authentication against the database server.

Use the ssl, sslMode, and sslSecretName properties to configure SSL encryption for the database connection.

It is also possible to specify custom JDBC properties by using the customProperties section.

Example 1: Specify a database connection by using SSL

spec:
    databaseConfig:
    serverName: postgres1.mycompany.com
    portNumber: 5432
    databaseName: btsdb
    userSecretName: postgresql-user
    ssl: "true"
    sslMode: verify-ca
    sslSecretName: postgres-ssl
    customProperties:
    - name: connectTimeout
      value: "5"
 

Example 2: Specify a JDBC connection URL by using customProperties

spec:
    databaseConfig:
    userSecretName: postgresql-user
    customProperties:
    - name: URL
      value: jdbc:postgresql://unwon1.fyre.ibm.com:5432/umsdb02
 

apiVersion: v1
kind: Secret
metadata:
    name: postgres-cp4ba-custom-secret
type: Opaque
stringData:
    user: "postgres"
    pass: "Passw0rd"
    cert: |-
    -----BEGIN CERTIFICATE-----
    [PEM encoded CA certificate]
    -----END CERTIFICATE-----
 

spec:
    databaseConfig:
    autoDetectEDBSecretConfig:
      appSecretName: postgres-cp4ba-custom-secret
      appSecretUsernameKey: user
      appSecretPasswordKey: pass
      caSecretName: postgres-cp4ba-custom-secret
      caSecretCertificateKey: cert
 

^{↩ Parent}

Configure the names and keys of secrets to be used with the auto-detected EDB cluster

for a specific user and certificate secret with following structure:

apiVersion: v1
kind: Secret
metadata:
    name: postgres-cp4ba-custom-secret
type: Opaque
stringData:
    user: "postgres"
    pass: "Passw0rd"
    cert: |-
    -----BEGIN CERTIFICATE-----
    [PEM encoded CA certificate]
    -----END CERTIFICATE-----
 

the matching autoDetectEDBSecretConfig would look like this:

spec:
    databaseConfig:
    autoDetectEDBSecretConfig:
      appSecretName: postgres-cp4ba-custom-secret
      appSecretUsernameKey: user
      appSecretPasswordKey: pass
      caSecretName: postgres-cp4ba-custom-secret
      caSecretCertificateKey: cert
 

^{↩ Parent}

A list of name/value pairs to set custom JDBC driver configuration properties. Each name/value is set as property on the JDBC connection.

A list of supported properties can be found in the section properties.postgresql: https://www.ibm.com/docs/en/was-liberty/base?topic=SSEQTP_liberty/com.ibm.websphere.liberty.autogen.nd.doc/ae/rwlp_config_dataSource.htm

^{↩ Parent}

Explicitly assign a size limit for emptyDir volumes. Includes a limit for large and small sized emptyDirs.

^{↩ Parent}

Environment variable

^{↩ Parent}

Horizontal pod autoscaler settings. Only active if deploymentProfile is set to "hpa".

^{↩ Parent}

Configuration regarding IP Families for Kubernetes Services.

^{↩ Parent}

License parameter

^{↩ Parent}

Timeout and delay values for liveness probe according to https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/

Example:

spec:
    livenessProbe:
    initialDelaySeconds: 30
    timeoutSeconds: 1
    periodSeconds: 30
    successThreshold: 1
    failureThreshold: 3
    terminationGracePeriodSeconds: 30
 

^{↩ Parent}

Create a BTS PodDisruptionBudget (PDB) and decide how disruption thresholds are applied.

spec:
    pdb:
    enabled: "true"

spec:
    pdb:
    enabled: "true"
    minAvailable: 2

spec:
    pdb:
    enabled: "true"
    maxUnavailable: 1

^{↩ Parent}

Template for PVC creation, this is directly take over to EDB Cluster type storage.pvcTemplate property: https://cloudnative-pg.io/documentation/1.18/api_reference/#StorageConfiguration

^{↩ Parent}

dataSource field can be used to specify either:

• An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
• An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.

^{↩ Parent}

dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef:

• While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects.
• While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified.
• While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.

^{↩ Parent}

resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

^{↩ Parent}

selector is a label query over volumes to consider for binding.

^{↩ Parent}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

^{↩ Parent}

Timeout and delay values for readiness probe according to https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/

Example:

spec:
    readinessProbe:
    initialDelaySeconds: 30
    timeoutSeconds: 1
    periodSeconds: 30
    successThreshold: 1
    failureThreshold: 3
    terminationGracePeriodSeconds: 30
 

^{↩ Parent}

The recovery configuration of the PostgreSQL database. This configuration relies on the EDB PostgreSQL operators recovery configuration. See https://cloudnative-pg.io/documentation/1.18/api_reference/#BarmanObjectStoreConfiguration for reference.

^{↩ Parent}

BarmanObjectStoreConfiguration contains the backup configuration by using Barman against an S3-compatible object storage. For reference see https://cloudnative-pg.io/documentation/1.18/api_reference/#BarmanObjectStoreConfiguration

^{↩ Parent}

The credentials to use to upload data to Azure Blob storage

^{↩ Parent}

The connection string to be used

^{↩ Parent}

The storage account where to upload data

^{↩ Parent}

The storage account key to be used in conjunction with the storage account name

^{↩ Parent}

A shared-access-signature to be used in conjunction with the storage account name

^{↩ Parent}

The configuration to be used to backup the data files When not defined, base backups files will be stored uncompressed and may be unencrypted in the object store, according to the bucket default policy.

^{↩ Parent}

EndpointCA store the CA bundle of the barman endpoint. Useful when using self-signed certificates to avoid errors with certificate issuer and barman-cloud-wal-archive

^{↩ Parent}

The credentials to use to upload data to Google Cloud Storage

^{↩ Parent}

The secret containing the Google Cloud Storage JSON file with the credentials

^{↩ Parent}

The credentials to use to upload data to S3

^{↩ Parent}

The reference to the access key id

^{↩ Parent}

The reference to the secret access key

^{↩ Parent}

The references to the session key

^{↩ Parent}

The configuration for the backup of the WAL stream. When not defined, WAL files will be stored uncompressed and may be unencrypted in the object store, according to the bucket default policy.

^{↩ Parent}

Allows to set custom BTS pod resources, including CPU, memory, and ephemeral storage requests and limits.

Example:

spec:
    resources:
    requests:
      cpu: 200m
      memory: 256Mi
      ephemeral-storage: 100Mi
    limits:
      cpu: 500m
      memory: 512Mi
 

^{↩ Parent}

ResourceClaim references one entry in PodSpec.ResourceClaims.

^{↩ Parent}

Set custom EDB PostgreSQL resources, including CPU and memory request and limits.

Example:

spec:
    resourcesPostgres:
    requests:
      cpu: 50m
      memory: 768Mi
    limits:
      cpu: 200m
      memory: 1Gi
 

^{↩ Parent}

ResourceClaim references one entry in PodSpec.ResourceClaims.

^{↩ Parent}

Timeout and delay values for startup probe according to https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/

Example:

spec:
    startupProbe:
    initialDelaySeconds: 120
    timeoutSeconds: 1
    periodSeconds: 5
    successThreshold: 1
    failureThreshold: 180
    terminationGracePeriodSeconds: 30
 

^{↩ Parent}

^{↩ Parent}

BusinessTeamsServiceStatus defines the observed state of BusinessTeamsService.

^{↩ Parent}

Conditions indicate the status of the BTS service. Conditions can either have status True or False, depending on the status of BTS. Also, a reason and message set explains the status.

^{↩ Parent}

Indicates the BTS external service endpoints.

^{↩ Parent}

Reports the deployed version of BusinessTeamsService. The name field can be one of operator or operand.