Skip to content

pre-requisites.md

Latest commit

 

History

History
225 lines (172 loc) · 6.59 KB

pre-requisites.md

File metadata and controls

225 lines (172 loc) · 6.59 KB

Deployment Prerequisites

File Storage

GKE File Storage

  1. Create a Google filestore instance to store the shared folders for application usage.

    https://console.cloud.google.com/filestore

  2. Note the File share name and IP address after creating filestore instance.

File Share details

EKS File Storage

  1. Deploy the EFS CSI Driver to your cluster and create an Amazon Elastic File System (EFS) volume to store the shared folders for application usage by following the below link.

    https://docs.aws.amazon.com/eks/latest/userguide/efs-csi.html

  2. Note the File system ID after creating EFS file system.

AWS EFS

AKS File Storage

  1. Create a File share instance in your storage account and note the File share name to store the shared folders for application usage.

  2. Encode the storage account name and storage key in base64 format.

For encoding the values to base64 please run the following command in powershell

[System.Convert]::ToBase64String([System.Text.Encoding]::UTF8.GetBytes("<plain-text>"))

File Share details

ACK File System

Follow the documentation provided at this link to create a file system in Alibaba Cloud.

  1. Once the file system is created, locate and click on the cube icon. This will allow you to view the mount target hostname. Take note of the mount target hostname, as you will need it for mounting the file system with our application.

NAS-Mount-Target

Create and connect a cluster

GKE Cluster

  1. Create a Kubernetes cluster in Google Cloud Platform (GCP) to deploy Bold Reports.

    https://console.cloud.google.com/kubernetes

  2. Connect with your GKE cluster.

    https://cloud.google.com/kubernetes-engine/docs/quickstart

EKS Cluster

  1. Create an Amazon EKS cluster and node group to deploy Bold Reports.

    https://docs.aws.amazon.com/eks/latest/userguide/getting-started.html

  2. Connect to your Amazon EKS cluster. https://aws.amazon.com/premiumsupport/knowledge-center/eks-cluster-connection/

AKS Cluster

  1. Create a Kubernetes cluster in Microsoft Azure Kubernetes Service (AKS) to deploy Bold Reports. https://docs.microsoft.com/en-us/azure/aks/kubernetes-walkthrough-portal

  2. Connect with your Microsoft AKS cluster. https://docs.microsoft.com/en-us/azure/aks/kubernetes-walkthrough-portal#connect-to-the-cluster

ACK Cluster

  1. Follow the documentation provided at the below link to create a Kubernetes cluster in Alibaba Cloud for deploying Bold Reports. https://www.alibabacloud.com/help/en/container-service-for-kubernetes/latest/create-an-ack-managed-cluster

  2. Refer to the instructions provided at the below link to connect to your Alibaba ACK cluster using kubectl. https://www.alibabacloud.com/help/en/container-service-for-kubernetes/latest/connect-to-ack-clusters-by-using-kubectl

Load Balancing

Currently we have provided support for Nginx and Istio as Load Balancers in Bold Reports. By default Nginx is used as reverse proxy for Bold Reports.

Ingress-Nginx

If you need to configure Bold Reports with Ingress, Install Nginx ingress controller in your cluster please refer below and run the command accordingly.


Name Description
GKE Cluster kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/controller-v1.2.0/deploy/static/provider/cloud/deploy.yaml
EKS Cluster kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/controller-v1.2.0/deploy/static/provider/aws/deploy.yaml
AKS Cluster kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/controller-v1.2.0/deploy/static/provider/cloud/deploy.yaml
ACK Cluster kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/controller-v1.2.0/deploy/static/provider/cloud/deploy.yaml
OnPremise kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/controller-v1.2.0/deploy/static/provider/cloud/deploy.yaml

Istio Ingress Gateway

If you need to configure Bold Reports with Istio, Install Istio ingress gateway in your cluster please refer to the corresponing reference links


Name Description
GKE Cluster https://cloud.google.com/istio/docs/istio-on-gke/installing
EKS Cluster https://aws.amazon.com/blogs/opensource/getting-started-istio-eks/
AKS Cluster https://docs.microsoft.com/en-us/azure/aks/servicemesh-istio-install
ACK Cluster https://istio.io/v1.1/docs/setup/kubernetes/install/platform/alicloud/
OnPremise https://istio.io/latest/docs/setup/platform-setup/docker/

Get Ingress IP

Run the following command to get the ingress IP address.

# Nginx
kubectl get service/ingress-nginx-controller -n ingress-nginx

# Istio
kubectl get service/istio-ingressgateway -n istio-system

Note the ingress EXTERNAL-IP address and map it with your DNS. If you do not have the DNS and want to use the application, then you can use the ingress IP address.