Open topic with navigation

TIBCO® Control Plane 1.2.0

# Configuring TIBCO Control Plane Helm Chart Values

Before you install TIBCO Control Plane Helm charts, you must configure the different values specific to your environment such as service account, certificates, and storage. These values are used by TIBCO Control Plane during deployment.

## Configuring platform-bootstrap Helm Chart Values

Sample Platform Bootstrap Helm Chart Values YAML file is available in the GitHub Repository. Update the file with values specific to your environment. Refer the following table for more information about parameters in the values file.

Refer the following table to learn more about parameters used in the `values.yaml` file.

Parameter | Required? | Default | Description
--- | --- | --- | ---
`fluentbit:` `enabled: true` | Mandatory | true | Enable or disable Fluentbit sidecar deployment for log processing. By default, Fluentbit log processing is enabled. If you disable this option, the logs from Control Plane are not captured and forwarded to log processor configured in the observability resource. If your organization's current infrastructure already captures logs from all workloads then you can disable this feature to reduce resource consumption.
`serviceAccount` | Optional |  | Specify service account name used for deploying TIBCO Control Plane components in your cluster. If not set, the chart creates a new service account `control-plane-sa`. If you specify a service account, and set `rbac.infra=false`, it is your responsibility to apply necessary RBACs for the service account.
`rbac`: `infra: true` | Mandatory | true | Set this to true to create RBAC resources for the service account (ClusterRole and Rolebinding). Set to false if the service account already has the RBACs created. By default this is set to true.
Parameters for Container Registry for TIBCO Components
`containerRegistry:` `url` `username` `password` | Mandatory |  | These are values required to pull TIBCO Components images from the Jfrog repository. Account Owner must get these values by signing in to the TIBCO Control Plane SaaS environment.
Common Parameters
`createNetworkPolicy` | Optional | false | Flag to enable or disable the creation of default network policies for TIBCO Control Plane namespace. The default value is false.
`controlPlaneInstanceId` | Mandatory |  | This is to identify multiple TIBCO Control Plane installations in the same cluster. Maximum characters allowed are five. Example: prod, stag
`dnsTunnelDomain` | Mandatory |  | Domain to be used by the tunnel in the Data Plane to connect to TIBCO Control Plane.
`dnsDomain` | Mandatory |  | Domain to be used for accessing TIBCO Control Plane.
`clusterInfo:` `nodeCIDR:` `podCIDR:` | Mandatory |  | `NodeIPCIDR` is the IP range of Nodes VPC or the VNet address space (CIDR notation). Example: 10.180.0.0/16 `PodIPCIDR` is IP range of Pod IP CIDR (CIDR notation). Example: 192.168.0.0/16
Logserver Configuration Values
`endpoint` | Optional |  | The URL of the network proxy that provides access to the Elasticsearch endpoint URL.
`username` | Optional |  | User name to connect to the Elasticsearch server.
`index` | Optional |  | Specify the name of the index that matches the patterns of the Index template definition created on your Elasticsearch server.
`password`: | Optional |  | Password to connect to the Elasticsearch server.
Storage Configuration Values
`storageClassName` | Mandatory |  | To create or use volumeName, uncomment the storageClassName and set matching value as volume. To use default storageClass, keep storageClassName key commented. To use preconfigured storageClass, uncomment storageClassName and pass the value. Example: `efs-sc`
`volumeName` | Optional |  | Specify the volume name
`provider` | Mandatory | aws | Type of cloud provider. Example: `aws`
Values for Ingress
`ingress:` `ingressClassName` | Mandatory |  | Ingress Controller class name Example: `nginx`
`ingress:` `certificateArn` | Mandatory |  | The Amazon Resource Name (ARN) of the certificate for Ingress.
`ingress:` `annotations` | Optional |  | Annotations to customize Ingress Controller
Values specific for Load Balancer service of AWS
`aws:` `tunnelService:` `loadBalancerClass` | Mandatory | service.k8s.aws/nlb | Load balancer class name.
`aws:` `tunnelService:` `certificateArn` | Mandatory |  | Certificate ARN for tunnel domain
`aws:` `tunnelService:` `annotations` | Optional |  | Additional annotations for network load balancer service

## Configuring platform-base Helm Chart Values

The sample Platform Base Helm Chart Values YAML file is available in the GitHub Repository. Update the file with the values specific to your environment. Refer the following table for more information about parameters in the values file.

Before you begin

- You must have configured email server used for sending emails from TIBCO Control Plane. Currently, TIBCO Control Plane supports SES, SMTP, or SendGrid.
- If you are using Amazon SES, you must have configured from and reply to email address. For more information, see Amazon SES documentation.

Refer the following table to learn more about parameters used in the preceding `values.yaml` file.

Parameter | Required? | Description
--- | --- | ---
Database details
`db_host` | Mandatory | Database host address Example: `platform-postgres-fs6b8-4cphb.cdqjgaolpoo0.us-west-2.rds.amazonaws.com`
`db_name` | Mandatory | Master database name Example: `postgres`
`db_port` | Mandatory | Database port number Example: `5432`
`db_username` | Mandatory | User name to access the database
`db_password` | Mandatory | Password to access the database
`db_secret_name` | Mandatory | Database secret name which stores user credentials Example: `provider-cp-database-credentials`
`db_ssl_mode` | Optional | If you are connecting to a database instance over SSL, specify DB SSL mode value. Default: disabled Example: verify-full
`db_ssl_root_cert` | Optional | Use this parameter to reference the certificate for SSL connection to database. Example: `rds-ssl-ca-cert.pem` if `db_ssl_mode` is set to verify-full, you must set the `db_ssl_root_cert` to `/private/tsc/certificates/global-bundle.pem`
Email Service Configuration
`emailServerType` | Mandatory | Type of email service you have set up for email notifications. Supported values: smtp ses sendgrid
`emailServer:` `ses:` `arn: ""` | Mandatory if type of email service is ses | If emailServerType is ses, then you must specify this value. Amazon Resource Name (ARN) for Amazon SES. Example: `arn:aws:ses:us-east-1:123456789012:identity/user@example.com`
`emailServer:` `smtp:` `server: ""` `port: "25"` `username: ""` `password: ""` | Mandatory if type of email service is smtp | If emailServerType is smtp, then you must specify these values: SMTP server address. SMTP port SMTP username SMTP password
`emailServer:` `sendgrid:` `apiKey: ""` | Mandatory if type of email service is sendgrid | Key to authenticate access to SendGrid email services. You must specify this if you are using SendGrid email service.
`fromAndReplyToEmailAddress` | Mandatory | From and reply to email address to be used by email service.
`cronJobReportsEmailAlias` | Optional | Cron Job reports are sent to this email alias if configured.
`platformEmailNotificationCcAddresses` | Optional | Optional email address to mark as CC for subscription email notifications.
TIBCO Platform Console Administrator user details
`admin:` `email:` | Mandatory | Email address of the administrator user. Initial email is sent to this email address with the link to sign in to TIBCO Platform Console for provisioning subscription.
`admin:` `firstname:` | Mandatory | First name of the administrator user
`admin:` `lastname:` | Mandatory | Last name of the administrator user
`admin:` `customerID:` | Mandatory | The Account owner must get this id by signing in to TIBCO Control Plane SaaS environment. This id is available on the Settings > Account Details section.

Did you find this helpful?

Yes No
Great!
Thanks for taking the time to give us some feedback.
Sorry about that

Why wasn't this helpful? (check all that apply)

Could not find what I was looking for
Instructions confusing or unclear
Instructions did not work

Want to tell us more?

Please select at least one option or provide details about the issue!!

Error occurred while submitting feedback.

Error2 occurred while submitting feedback.

TIBCO® Control Plane

Copyright © 2023-2024. Cloud Software Group, Inc. All Rights Reserved.