Skip to content

Commit 0b8c372

Browse files
SCALE-122: Document Bitbucket property translation (#970)
1 parent d45a295 commit 0b8c372

File tree

3 files changed

+45
-3
lines changed

3 files changed

+45
-3
lines changed

docs/docs/containers/BITBUCKET-MESH.md

+6
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,12 @@ can also be provided via Docker environment variables. For a full explanation of
103103
variables see
104104
[the relevant Spring Boot documentation](https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-external-config.html#boot-features-external-config-relaxed-binding).
105105

106+
To translate a property name into an environment variable:
107+
108+
* dot `.` becomes underscore `_`
109+
* dash `-` becomes underscore `_`
110+
* Example: `this.new-property` becomes `THIS_NEW_PROPERTY`
111+
106112
## Container Configuration
107113

108114
* `SET_PERMISSIONS` (default: true)

docs/docs/containers/BITBUCKET.md

+6
Original file line numberDiff line numberDiff line change
@@ -194,6 +194,12 @@ can also be provided via Docker environment variables. For a full explanation of
194194
variables see
195195
[the relevant Spring Boot documentation](https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-external-config.html#boot-features-external-config-relaxed-binding).
196196

197+
To translate a property name into an environment variable:
198+
199+
* dot `.` becomes underscore `_`
200+
* dash `-` becomes underscore `_`
201+
* Example: `this.new-property` becomes `THIS_NEW_PROPERTY`
202+
197203
For example, a full command-line for a Bitbucket node with a PostgreSQL
198204
database, and an external OpenSearch instance might look like:
199205

docs/docs/userguide/CONFIGURATION.md

+33-3
Original file line numberDiff line numberDiff line change
@@ -326,9 +326,9 @@ this behaviour may be undesirable; this flag forces an update of all
326326
generated files.
327327

328328
The affected files are:
329-
* Jira: `dbconfig.xml`
330-
* Confluence: `confluence.cfg.xml`
331-
* Bamboo: `bamboo.cfg.xml`
329+
- Jira: `dbconfig.xml`
330+
- Confluence: `confluence.cfg.xml`
331+
- Bamboo: `bamboo.cfg.xml`
332332

333333
To force update of the configuration files when pods restart, set `<product_name.forceConfigUpdate>` to true.
334334
You can do it by passing an argument to helm install/update command:
@@ -342,6 +342,36 @@ jira:
342342
forceConfigUpdate: true
343343
```
344344

345+
!!!info "Bitbucket and Bitbucket Mesh configuration file"
346+
It's not possible to generate the Bitbucket and Bitbucket Mesh configuration files.
347+
Bitbucket uses `${BITBUCKET_HOME}/shared/bitbucket.properties`. The properties are from
348+
[bitbucket.properties file](https://confluence.atlassian.com/bitbucketserver/bitbucket-server-config-properties-776640155.html)
349+
and can be provided as environment variables. For example:
350+
```yaml
351+
bitbucket:
352+
additionalEnvironmentVariables:
353+
- name: SEACRH_ENABLED
354+
value: false
355+
- name: PLUGIN_SEARCH_CONFIG_BASEURL
356+
value: http://my.opensearch.host
357+
```
358+
Bitbucket Mesh uses `${BITBUCKET_HOME}/mesh.properties`. The properties are from
359+
[mesh.properties file](https://confluence.atlassian.com/bitbucketserver/mesh-configuration-properties-1128304362.html)
360+
and can be provided as environment variables. For example:
361+
```yaml
362+
bitbucket:
363+
mesh:
364+
additionalEnvironmentVariables:
365+
- name: GIT_PATH_EXECUTABLE
366+
value: /usr/bin/git
367+
```
368+
369+
To translate property into an environment variable:
370+
371+
* dot `.` becomes underscore `_`
372+
* dash `-` becomes underscore `_`
373+
* Example: `this.new-property` becomes `THIS_NEW_PROPERTY`
374+
345375
## :material-book-cog: Additional libraries & plugins
346376

347377
The products' Docker images contain the default set of bundled libraries and plugins.

0 commit comments

Comments
 (0)