Skip to content

Latest commit

 

History

History
242 lines (198 loc) · 8.21 KB

README.md

File metadata and controls

242 lines (198 loc) · 8.21 KB

Deploy Bold BI and Bold Reports using Helm

This chart installs both Bold BI and Bold Reports on Kubernetes. You can create Kubernetes cluster on cloud infrastructure. Please follow the below documentation for Bold BI and Bold Reports deployment in a specific cloud environments.

Deployment prerequisites

Note: Note the Ingress IP address to use it while crafting values.yaml when installing Bold BI with helm chart.

Get Repo Info

  1. Add the Bold BI helm repository
helm repo add boldbi https://boldbi.github.io/boldbi-kubernetes
helm repo update
  1. View charts in repo
helm search repo boldbi

NAME            CHART VERSION   APP VERSION     DESCRIPTION
boldbi/bold-common   9.1.73           9.1.73          Embed powerful analytics inside your apps and t...

See helm repo for command documentation.

Install Chart

For Helm chart, you'll need to craft a values.yaml.

  • For GKE please download the values.yaml file here.
  • For EKS please download the values.yaml file here.
  • For AKS please download the values.yaml file here.
  • For ACK please download the values.yaml file here.
  • For OKE please download the values.yaml file here.

Name Description
namespace The namespace in which the Bold BI resources will be dpleoyed in the kubernetes cluster.
The default namespace is bold-services
appBaseUrl * Domain or Ingress IP address with http/https protocol. Follow the SSL Configuration to configure SSL certificate for https protocol after deploying Bold BI in your cluster.
optionalLibs These are the client libraries used in Bold BI by default.
'mongodb,mysql,influxdb,snowflake,oracle,npgsql'
Please refer to Optional Client Libraries section to know more.
clusterProvider The type of kubernetes cluster provider you are using.
The recommended values are 'gke,eks,aks and onpremise'
persistentVolume* Please refer to this section to know more on how to set Persistant Volumes for Bold BI.
image * By default latest image tag is used in the Helm chart. Please refer to this section for configure a image tag for Bold BI, Bold Reports and ID.
versions * By default latest version is used in the Helm chart. Please refer to this section for configure a version for Bold BI, Bold Reports and IDP version
loadBalancer Currently, we have provided support for Nginx and Istio as Load Balancers in Bold BI. Please refer to this section for configuring Load balancer for Bold BI.
autoscaling By default autoscaling is enabled in Bold BI. Please refer to this section to configure autoscaling in Bold BI.
bingMapWidget Please refer to this section to configure Bing Map Widget in Bold BI.
customSizePdfExport To utilize a customized page size for A4 PDF export, set this feature to true. By default, this feature is set to false.
browserTimeZone If you need to use Browser time zone feature , enable this to true. By default this feature will be set to false.

Note: Items marked with * are mandatory fields in values.yaml

Run the following command to delpoy Bold BI in your cluster.

helm install [RELEASE_NAME] boldbi/bold-common -f [Crafted values.yaml file]

Ex: helm install boldbi boldbi/bold-common -f my-values.yaml

Refer here for advanced configuration including SSL configuration, optional client libraries, etc.

See helm install for command documentation.

Upgrade

Run the following command to get the latest version of Bold BI helm chart.

helm repo update

Run the below command to apply changes in your Bold BI release or upgrading Bold BI to latest version.

helm upgrade [RELEASE_NAME] boldbi/bold-common -f [Crafted values.yaml file]

Ex: helm upgrade boldbi boldbi/bold-common -f my-values.yaml

Uninstall Chart

helm uninstall [RELEASE_NAME]

Ex: helm uninstall boldbi

This removes all the Kubernetes components associated with the chart and deletes the release.

See helm uninstall for command documentation.

Application Startup

  1. Configure the Bold BI application startup to use the application. Please refer to the following link for more details on configuring the application startup.

    https://help.boldbi.com/embedded-bi/application-startup

  2. Navigate to administration configuration file.

    <DNS>/ums/administration/config-editor

    Configuration-editor

  3. In product.json file, append the Internal URL for Bold reportes services as shown below :

    product-url-editor

  4. In product.json file, append the lines below for Bold Reports:

    {
"Name": "BoldReports",
"SetupName": "BoldReports_EnterpriseReporting",
"Version": "4.2.52",
"IDPVersion": "3.1.21",
"IsCommonLogin": true
}

    Note: The IDP version of Bold BI or Bold Reports should be same.

  5. Set IsCommonLogin property to be true for Bold BI and Bold Reports. Product Json

  6. Restart the deployment using the following command to apply the changes:

    kubectl rollout restart deployment -n [namespace]

  7. Refer to the document below to activate the License either by using your login credentials or by an offline unlock key for Bold Reports. https://help.boldreports.com/enterprise-reporting/administrator-guide/application-startup/#activate-bold-reports-license

Documentation Links: