Bitbucket Elasticsearch recommendations ¶

While Bitbucket has its own internal Elasticsearch instance, we highly recommend you use an external Elasticsearch installation, either within the Kubernetes cluster or, if available, an instance managed by your hosting provider.

Installing and configuring Elasticsearch in your Kubernetes cluster ¶

Installing Elasticsearch into your Kubernetes cluster ¶

Choose a version of Elasticsearch that is supported by the version of Bitbucket you are installing. For Bitbucket 7.14 the latest supported Elasticsearch version is 7.9.3, so we will target that.

There are official Helm charts for Elasticsearch 7.9.3. Following the documentation there add the Elasticsearch Helm charts repository:

helm repo add elastic https://helm.elastic.co

helm install elasticsearch --namespace <namespace> --set imageTag="7.9.3" elastic/elasticsearch

Configuring your Bitbucket deployment ¶

To enable the installed Elasticsearch service you need to configure the service URL under bitbucket: stanza in the values.yaml file. Check the Kubernetes official documentation on how to get DNS record for a service.

bitbucket:
  elasticSearch:
    baseUrl: http://elasticsearch-master.<namespace>.svc.cluster.local:9200

bitbucket:
  elasticSearch:    
     credentials:
        secretName: <my-elasticsearch-secret>
        usernameSecretKey: username
        passwordSecretKey: password

Configuring Amazon Elasticsearch Service with Bitbucket on Kubernetes ¶

Creating an Amazon Elasticsearch Service domain with a master user ¶

The Elasticsearch instance (“domain”) can be created via the AWS CLI or the web console; for this example we will use the web console and a master user:

1. In the EKS console navigate to Your Cluster → Networking and note the VPC ID.
2. In the Elasticsearch console create a new domain:
3. Select a production deployment.
4. Select Elasticsearch version 7.9.
5. In the next screen configure the AZs and nodes as appropriate for your expected workload.
6. On the Access and security page:
7. Select the same VPC as the EKS cluster, as noted in step 1.
8. Select appropriate subnets for each AZ; private subnets are fine.
9. Select appropriate security groups that will grant node/pod access.
10. Tick Fine–grained access control:
    • Select Create master user and add a username and a strong password.
11. Configure tags, etc. as appropriate for your organisation.

Once the Elasticsearch domain has finished creating, make a note of the VPC Endpoint, which will be an HTTPS URL.

Configuring your Bitbucket deployment ¶

To use the managed Elasticsearch service, first create a Kubernetes secret using the username and password from step 4 above. Then configure the service URL under bitbucket: in the values.yaml file, substituting the values below from the above steps where appropriate:

bitbucket:
  elasticSearch:
    baseUrl: <VPC Endpoint>
    credentials:
      secretName: <my-elasticsearch-secret>
      usernameSecretKey: username
      passwordSecretKey: password

Testing your Elasticsearch connection ¶

To test if Elasticsearch is properly set up, go to Administration > System - Server settings. The Elasticsearch URL should be pre-populated already in the search section. Click the Test button to see if it connects successfully.