Create Grid on your Kubernetes Cluster
Automate TurboScale provides Helm chart to create a browser automation grid on your existing Kubernetes cluster on your choice of Cloud provider. The TurboScale Grid is compatible with EKS on AWS, GKE on GCP, AKS on Azure. With this setup, you get a self-hosted grid that scales with on-demand resource consumption along with 360-degree insights into grid utilization and cost saving opportunities.
- The prerequisite is to have an BrowserStack account that allows you to authenticate your Grid on AWS, GCP and Azure and a running Kubernetes Cluster.
- With this approach, you need to manually configure the required IAM roles/service account and storage for Test Artifacts, More details below.
- The recommended approach to create a Grid from scratch is to use BrowserStack CLI with the required dependencies.
Deploy Helm Chart
Helm chart is the recommended installation way if you want to use your existing Kubernetes setup for setting up TurboScale Grid.
Deployment steps with Helm
1. Add BrowserStack’s Helm chart repository:
helm repo add automate https://grid.browserstack.com/packages/helm
2. Update Helm Chart
helm repo update
3. Install Helm Chart in new Namespace
helm install high-scale-grid automate/selenium-grid --set bstack-username="YOUR_USERNAME" --set bstack-accesskey="YOUR_ACCESS_KEY" --set cluster-name="<ClusterName>" --set region="<ClusterRegion>" --set cloud-provider="<CloudProvider>"
Please update the above command with relevant Cloud provider details. The cluster-name and region parameter should be in smallcase without spaces. The accepted value for cloud provider parameter is from aws, gcp and azure. Use our setup guide to access the appropriate command as per your requirement.
Enable storage of Test Artifacts
By default, TurboScale Grid will start recording the test artifacts as per your Grid settings from our Automation Console. You can enable artifact storage by following relevant steps on cloud provider and accessing them using our Builds Dashboard.
Enable Test Artifacts on EKS Cluster
Follow below steps to enable storage of test artefacts on AWS EKS Cluster.
1. Grant s3 Access to Cluster’s IAM Role
You need to add AWS Managed policy AmazonS3FullAccess to IAM role attached to your Kubernetes Cluster. You can find the role by navigating to your Cluster’s overview page on AWS Console. You can follow below steps to add this policy to your role.
Enable Test Artifacts on GKE Cluster
Follow below steps to enable storage of test artefacts on Google Cloud’s GKE Cluster.
1. Enable Scoped Access to Cluster’s Node Pool
There are Access scopes associated with the node group on GKE Cluster that needs access to your Cloud APIs. This allows individual pods and containers access Cloud APIs to upload test artifact generated during browser automation test.
- These steps need to be performed while creating a node pool for your Kubernetes Cluster
- If your Cluster already has a node pool setup, you must migrate to a new node pool and scale down or delete the older one. The migration steps are documented here.
The recommendation is to enable Allow full access to all Cloud APIs Access scope for your node pool as seen in below image. This step is not required if the access scope is already configured to Allow full access to all Cloud APIs.
2. Attach Storage Roles with Service Account
You need to attach storage related roles with the service account attached on your cluster’s node pool. By default, Google Cloud provides a Compute Engine default service account service account which is linked to your Kubernetes Cluster. The access to storage services can be given by adding below two predefined roles.
- Service Account Token Creator
- Storage Admin
This can be achieved by editing the cluster’s service account and adding new roles from available dropdown as seen below
Enable Test Artifacts on AKS Cluster
Automate TurboScale uses Azure Blob storage service for the storage of test artifacts to help you with debugging. There are two tasks necessary to achieve this.
- Download the Azure Resource Manager deployment template from here for setting up the Azure Blob service.
- Download and execute the script to execute the above template file and set up the required services on your Azure account.
The script makes the following changes to your account.
- Deploy the ARM template on your Azure account to create a storage account.
- Creates managed identity for your storage account and resource group.
- Enables workload identity and OIDC issuer in your cluster.
- Restart TurboScale Grid to apply these identity changes.
Ensure you have the necessary access to deploy a template and scripts required for enabling storage services on your Azure account.
Execute the script using the below command.
bash azure-storage-access.sh --cluster-name [cluster_name] --resource-group [resource_group_name] --grid-name [grid_name] --template-file </full/path/to/template.json>
md5sum package should be installed in your machine before running the bash script
Troubleshooting
Visibility on Resources
BrowserStack adds tags on AWS, GCP and Azure whenever a new resource(Compute or Non-Compute) is being created as part of Automate TurboScale in your Cloud account.
Tags are key-value pairs that you can use to view your Cloud resources and identify, organize, or search for resources. Here is a list of tags added by BrowserStack on all the resources.
| Tag Key | Tag value |
|---|---|
browserstack:managedBy |
BrowserStack |
browserstack:service |
BrowserStack-Automate-TurboScale |
browserstack:grid |
<grid name> used while creating a browser Automation Grid |
browserstack:creationDate |
Epoch Timestamp of resource creation |
Contact Us
Need help? Reach out to us here.
We're sorry to hear that. Please share your feedback so we can do better
Contact our Support team for immediate help while we work on improving our docs.
We're continuously improving our docs. We'd love to know what you liked
Is this page helping you?
Yes
No
We're sorry to hear that. Please share your feedback so we can do better
Contact our Support team for immediate help while we work on improving our docs.
We're continuously improving our docs. We'd love to know what you liked
Thank you for your valuable feedback!
