Troubleshooting steps for Bitbucket Server Code Search
目的
This page contains the troubleshooting steps that can be performed to understand the reasons leading to the Bitbucket Server Code Search functionality not being available.
The steps below apply for the Embedded search server. If you have "Bitbucket Data Center" it means that you do not have Embedded search server but your own self-managed search server instance and therefore some of the troubleshooting steps below might not apply to your environment.
For Bitbucket 7.20 and below, Elasticsearch was bundled. Starting with 7.21, OpenSearch is the bundled search server
Troubleshooting steps
Check if you're hitting this: Test button in Search server for Bitbucket server results in the access denied
For Elasticsearch
Make sure that you did not update the Elasticsearch username and password in the Bitbucket Server user interface, if this is the case you'll need to reset them by following these steps:
- locate the
$BITBUCKET_HOME/shared/search/buckler/buckler.ymlfile - Retrieve the username (auth.basic.username attribute) and the password (auth.basic.password attribute) and update the ones available to Bitbucket Server in the user interface
If you did not update them, then there is no need to change anything.
For Opensearch
Use the steps detailed in this document: Test button in Search server for Bitbucket server results in the access denied to change the Opensearch username/password.
Configure details of your Search server instance within Bitbucket Server
To configure the details of your search server instance within the Bitbucket Server UI, go to the Administration settings page, then click Server Settings. At the bottom of the page is where you can configure the details of your search server instance.
Important:
Another way to configure connection settings is via bitbucket.properties file (resides in $BITBUCKET_HOME/shared).
If a parameter is set in the properties file, it cannot be edited later from the admin UI. Any changes that need to be made to the search server configuration must be made within the bitbucket.properties file (which requires an application restart to take effect).
- In the
$BITBUCKET_HOMEdirectory, create a new directory calledshared. - In the
$BITBUCKET_HOME/shareddirectory, create a text file namedbitbucket.properties.
Add these Elasticsearch properties to the file.
| プロパティ | Parameter name for properties file |
|---|---|
| URL | plugin.search.config.baseurl |
| ユーザ名 | plugin.search.config.username |
| パスワード | plugin.search.config.password |
This is applicable to both Elasticsearch and Opensearch. For more details refer to Install and configure a remote Elasticsearch server and Install and configure a remote OpenSearch server
The user/password required by Search server can be obtained by following the steps on the expand box above "Check the username/password for Search server".
The steps below should be run from the server where your Bitbucket Server/Search server instance are running. The reason why we reinforce it has to be a local connection is due to the configuration that we ship for Elasticsearch on $BITBUCKET_HOME/shared/search/elasticsearch.yml or for Opensearch on $BITBUCKET_HOME/shared/search/opensearch.yml.
You won't be able to browse Search server from a remote machine based on the search server configuration we ship. If you're installing your own remote Elasticsearch, you should configure the network.host: 0.0.0.0 on $Bitbucket-installation-dir/elasticsearch/<Elasticsearch_Config_dir>/elasticsearch.yml or for Opensearch on $Bitbucket-installation-dir/opensearch/<Opensearch_Config_dir>/opensearch.yml.
Please refer to Elasticsearch documentation to understand why: Special values for network.host
Please refer to Opensearch documentation to understand why: Step 3: Bind a cluster to specific IP addresses
Access the Search server user interface at the Search server bundled URL. From a browser window running locally on the server where Bitbucket is hosted, hit the following URL: http://localhost:7992
If the following login dialog is displayed, Search server is up and running:
If you don't have a local browser on the server that is running Bitbucket Server, you should also be able to run the following command successfully:
$ curl -u username:password http://localhost:7992
{
"name" : "bitbucket_bundled",
"cluster_name" : "bitbucket_search",
"cluster_uuid" : "s8DTMsNGRzSEaMrgo9x23Q",
"version" : {
"distribution" : "opensearch",
"number" : "1.2.4",
"build_type" : "tar",
"build_hash" : "e505b10357c03ae8d26d675172402f2f2144ef0f",
"build_date" : "2022-01-14T03:38:06.881862Z",
"build_snapshot" : false,
"lucene_version" : "8.10.1",
"minimum_wire_compatibility_version" : "6.8.0",
"minimum_index_compatibility_version" : "6.0.0-beta1"
},
"tagline" : "The OpenSearch Project: https://opensearch.org/"
}または
$ telnet localhost 7992
Connected to localhost.
Escape character is '^]'.
$ netstat -an | grep 7992メモ:
- As a result on your browser, you should expect to see something similar to that on your browser:
{
"name" : "bitbucket_bundled",
"cluster_name" : "bitbucket_search",
"cluster_uuid" : "s8DTMsNGRzSEaMrgo9x23Q",
"version" : {
"distribution" : "opensearch",
"number" : "1.2.4",
"build_type" : "tar",
"build_hash" : "e505b10357c03ae8d26d675172402f2f2144ef0f",
"build_date" : "2022-01-14T03:38:06.881862Z",
"build_snapshot" : false,
"lucene_version" : "8.10.1",
"minimum_wire_compatibility_version" : "6.8.0",
"minimum_index_compatibility_version" : "6.0.0-beta1"
},
"tagline" : "The OpenSearch Project: https://opensearch.org/"
}