-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor: update docker-compose docs and structure (#15)
also: - set up renovatebot for Docker Compose. - remove Docker Compose for unsupported Camunda versions (8.2).
- Loading branch information
Showing
17 changed files
with
195 additions
and
1,030 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,86 @@ | ||
{ | ||
description: "Keeps Docker Compose up to date", | ||
packageRules: [ | ||
// Disable Minor and Major updates by default. | ||
{ | ||
enabled: false, | ||
matchFileNames: ["docker-compose/versions/camunda-8*/**"], | ||
matchUpdateTypes: ["minor", "major"], | ||
}, | ||
// Disable unsupported Camunda versions. | ||
{ | ||
enabled: false, | ||
matchFileNames: [ | ||
"docker-compose/versions/camunda-8.0/**", | ||
"docker-compose/versions/camunda-8.1/**", | ||
"docker-compose/versions/camunda-8.2/**", | ||
], | ||
}, | ||
// | ||
// Main groups. | ||
// This section should be updated with the Camunda supported versions. | ||
// Start of minor cycle chores. | ||
{ | ||
groupName: "camunda-docker-compose-8.3", | ||
addLabels: ["version/8.3", "deps/docker-compose"], | ||
matchFileNames: ["docker-compose/versions/camunda-8.3/**"], | ||
matchUpdateTypes: ["patch"], | ||
}, | ||
{ | ||
groupName: "camunda-docker-compose-8.4", | ||
addLabels: ["version/8.4", "deps/docker-compose"], | ||
matchFileNames: ["docker-compose/versions/camunda-8.4/**"], | ||
matchUpdateTypes: ["patch"], | ||
}, | ||
{ | ||
groupName: "camunda-docker-compose-8.5", | ||
addLabels: ["version/8.5", "deps/docker-compose"], | ||
matchFileNames: ["docker-compose/versions/camunda-8.5/**"], | ||
matchUpdateTypes: ["patch"], | ||
}, | ||
{ | ||
groupName: "camunda-docker-compose-8.6", | ||
addLabels: ["version/8.6", "deps/docker-compose"], | ||
matchFileNames: ["docker-compose/versions/camunda-8.6/**"], | ||
matchUpdateTypes: ["patch"], | ||
}, | ||
{ | ||
groupName: "camunda-docker-compose-alpha", | ||
addLabels: ["version/8.7", "deps/docker-compose"], | ||
matchFileNames: ["docker-compose/versions/camunda-alpha/**"], | ||
matchUpdateTypes: ["patch", "minor"], | ||
}, | ||
// End of minor cycle chores. | ||
|
||
// Disable auto-merge for alpha release candidates. | ||
{ | ||
matchNewValue: "/.*alpha[0-9]*-rc[0-9]*/", | ||
automerge: false, | ||
}, | ||
], | ||
|
||
regexManagers: [ | ||
{ | ||
// This is mainly used to update Web-Modeler image tag. | ||
// section is copied from camunda/camunda-platform-helm | ||
fileMatch: [".env"], | ||
datasourceTemplate: "docker", | ||
matchStrings: [ | ||
"# renovate: datasource=docker depName=(?<depName>[^\\s]+?)(?: (lookupName|packageName)=(?<packageName>[^\\s]+?))?(?: versioning=(?<versioning>[^\\s]+?))?(?: registryUrl=(?<registryUrl>[^\\s]+?))?\\s*?(\\S+)=(?<currentValue>\\S+)", | ||
], | ||
versioningTemplate: "{{#if versioning}}{{{versioning}}}{{else}}semver{{/if}}", | ||
}, | ||
{ | ||
fileMatch: [ | ||
".env", | ||
".keycloak/Dockerfile" | ||
], | ||
matchStrings: [ | ||
"KEYCLOAK_SERVER_VERSION\\s*=\\s*(?<currentValue>\\S+)", | ||
"KEYCLOAK_VERSION\\s*=\\s*(?<currentValue>\\S+)", | ||
], | ||
depNameTemplate: "bitnami/keycloak", | ||
datasourceTemplate: "docker", | ||
}, | ||
], | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
{ | ||
$schema: "https://docs.renovatebot.com/renovate-schema.json", | ||
extends: [ | ||
"config:recommended", | ||
":automergeDisabled", | ||
":dependencyDashboard", | ||
"github>camunda/camunda-self-managed//.github/config/renovatebot/renovate-docker-compose.json5" | ||
], | ||
"dependencyDashboard": true, | ||
"separateMinorPatch": true, | ||
"labels": [ | ||
"dependencies" | ||
], | ||
"patch": { | ||
"enabled": true | ||
}, | ||
"hostRules": [ | ||
{ | ||
"hostType": "docker", | ||
"matchHost": "https://registry.camunda.cloud", | ||
"username": "{{ secrets.DISTRO_CAMUNDA_DOCKER_REGISTRY_USERNAME }}", | ||
"password": "{{ secrets.DISTRO_CAMUNDA_DOCKER_REGISTRY_PASSWORD }}" | ||
} | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,36 @@ | ||
# Camunda 8 Self-Managed Distribution | ||
# Camunda 8 Self-Managed | ||
|
||
> [!CAUTION] | ||
> | ||
> This GitHub repository is mainly for development, don't use it directly to deploy Camunda. End users should use the [official documentation](https://docs.camunda.io/docs/self-managed/about-self-managed/). | ||
A mono repo for Camunda 8 Self-Managed Distributions. | ||
|
||
# Distributions | ||
## Distributions | ||
|
||
## Docker Compose | ||
### Docker Compose | ||
|
||
For more details, check the directory of [Camunda Docker Compose](./docker-compose/). | ||
|
||
## Documentation | ||
|
||
- Official docs: [Camunda 8 Self-Managed](https://docs.camunda.io/docs/self-managed/about-self-managed/). | ||
|
||
## Issues | ||
|
||
If you find any problem with the Camunda 8 Self-Managed distributions, create a [new issue](https://github.com/camunda/camunda-self-managed/issues). | ||
|
||
## Contributing | ||
|
||
We value all feedback and contributions. To start contributing to this project, please: | ||
|
||
- **Don't create a PR without opening [an issue](https://github.com/camunda/camunda-self-managed/issues/new/choose) | ||
and discussing it first.** | ||
|
||
## License | ||
|
||
Camunda 8 Self-Managed Distributions are licensed under the open-source Apache License 2.0. | ||
Please see [LICENSE](LICENSE) for details. | ||
|
||
For Camunda 8 components, please visit the | ||
[licensing information page](https://docs.camunda.io/docs/reference/licenses). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# Camunda 8 Self-Managed - Docker Compose | ||
|
||
A Docker Compose configuration to run Camunda Platform (e.g., Zeebe, Operate, Tasklist, Optimize, Identity, and Connectors Bundle). | ||
|
||
> [!CAUTION] | ||
> | ||
> Docker Compose is only recommended for local development. | ||
> For production setups we recommend using [Camunda 8 SaaS](https://camunda.com/platform/), or [Camunda 8 Helm charts](https://docs.camunda.io/docs/self-managed/setup/install/). | ||
## Supported Versions | ||
|
||
Released Camunda versions: | ||
|
||
- [Camunda 8.3](./versions/camunda-8.3) | ||
- [Camunda 8.4](./versions/camunda-8.4) | ||
- [Camunda 8.5](./versions/camunda-8.5) | ||
- [Camunda 8.6](./versions/camunda-8.6) | ||
|
||
## Next Version | ||
|
||
Unreleased Camunda version: | ||
|
||
- [Camunda Alpha](./versions/camunda-alpha) | ||
|
||
## Continuous Integration | ||
|
||
The basic functionality of Docker Compose is continually tested using GitHub Actions and Playwright. | ||
|
||
## Continuous Delivery | ||
|
||
TBA. |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
5 changes: 0 additions & 5 deletions
5
docker-compose/versions/camunda-8.2/.optimize/environment-config.yaml
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
9 changes: 0 additions & 9 deletions
9
docker-compose/versions/camunda-8.2/connectors.self-signed-certificates.yaml
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.