# Atlassian Operator
*Brought to you by [TMAN Consulting](https://en.tman.ltd)*
```text
___ ________ ___ _______________ _ __ ____ __
/ _ /_ __/ / / _ | / __/ __/ _/ _ | / |/ / / __ \___ ___ _______ _/ /____ ____
/ __ |/ / / /__/ __ |_\ \_\ \_/ // __ |/ / / /_/ / _ \/ -_) __/ _ `/ __/ _ \/ __/
/_/ |_/_/ /____/_/ |_/___/___/___/_/ |_/_/|_/ \____/ .__/\__/_/ \_,_/\__/\___/_/
/_/
```
> A Python-powered tool to simplify deployment and management of Atlassian products (Jira, Confluence, Bitbucket, Bamboo) using Docker containers.
[](https://blog.willshi.space)
[](https://devguide.python.org/versions/)
[](https://pypi.org/project/atlassian-operator)
----
## 🚀 Key Features
- Automated Provisioning: One-click deploy Jira, Confluence, or Bitbucket with pre-configured settings.
- Docker Orchestration: Abstracts complex Docker commands into simple Python operations.
- Persistent Storage: Auto-configure volumes for data persistence across restarts.
- Cluster Support: Deploy high-availability setups with load balancing.
- Configuration Management: Generate `server.xml`, `setenv.sh`, and database connectors automatically.
----
## ⚡️ Quick Start
### 1️⃣ Check preconditions
- [Python](https://www.python.org/downloads/) >= 3
- [pip](https://pip.pypa.io/en/stable/installation/)
- [Docker](https://docs.docker.com/get-started/get-docker/) >= 20
### 2️⃣ Install `atlassian-operator` tool
```bash
pip install atlassian-operator
```
### 3️⃣ Init and modify configuration
```bash
atlas-operator init --product postgres --product jira
```
### 4️⃣ Up products containers
```bash
atlas-operator up
```
It will be spent more time to pull images if this is the first time to run this command.
----
## 📦 Installation
```bash
pip install atlassian-operator
atlas-operator show --version
```
----
## 🍺 Basic Usage
```text
usage: atlas-operator [-h] {show,init,cleanup,pull,up,down,list} ...
positional arguments:
{show,init,cleanup,pull,up,down,list}
show Show some basic information
init Init the workspace and config of ATLAS OPERATOR.
cleanup Remove ATLAS OPERATOR config, if you want to remove all files under ATLAS OPERATOR workspace, please add --data
pull Pull all images of ATLAS OPERATOR.
up Up all containers of ATLAS OPERATOR services.
down Stop all services and down all containers
list List all service containers
optional arguments:
-h, --help show this help message and exit
```
### show
```text
usage: atlas-operator show [-h] [--version] [--config]
optional arguments:
-h, --help show this help message and exit
--version Show all versions of tools
--config Show base configuration path
```
### init
```text
usage: atlas-operator init [-h] --product {nginx,postgres,jira,jsm,conf,bitbucket}
optional arguments:
-h, --help show this help message and exit
--product {nginx,postgres,jira,jsm,conf,bitbucket,bamboo}
e.g. --product jira
e.g. --product jira --product conf
```
### up
Need to check and modify the products configuration before run `atlas-operator up` to start services.
All configuration files can be found when you run `atlas-operator show --config`
----
## 🌍 License
[Apache License 2.0](https://github.com/TMAN-Lab/tman-atlassian-operator?tab=Apache-2.0-1-ov-file)
----
## 📚 Resources
### Atlassian Docker Images
- [Jira Software `atlassian/jira-software:<tag>`](https://hub.docker.com/r/atlassian/jira-software)
- [Jira Service Management `atlassian/jira-servicemanagement:<tag>`](https://hub.docker.com/r/atlassian/jira-servicemanagement)
- [Confluence `atlassian/confluence:<tag>`](https://hub.docker.com/r/atlassian/confluence)
### Atlassian Official Docs
- [Jira Data Center Container](https://atlassian.github.io/data-center-helm-charts/containers/JIRA/)
- [Confluence Data Center Container](https://atlassian.github.io/data-center-helm-charts/containers/CONFLUENCE/)
- [Bitbucket Data Center Container](https://atlassian.github.io/data-center-helm-charts/containers/BITBUCKET/)
- [Bamboo Container](https://atlassian.github.io/data-center-helm-charts/containers/BAMBOO/)
- [Bamboo Agent Container](https://atlassian.github.io/data-center-helm-charts/containers/BAMBOO-AGENT/)
- [Crowd Data Center Container](https://atlassian.github.io/data-center-helm-charts/containers/CROWD/)
Raw data
{
"_id": null,
"home_page": null,
"name": "atlassian-operator",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "Will <will.shi@tman.ltd>",
"keywords": "atlassian, jira, confluence, docker, deploy, setup, cli",
"author": null,
"author_email": "Will <will.shi@tman.ltd>",
"download_url": "https://files.pythonhosted.org/packages/16/32/b35427c68f0a08b90781efca7a7ad0ee2753395de1e7674f142fc2c6782f/atlassian_operator-0.5.tar.gz",
"platform": null,
"description": "# Atlassian Operator\n\n*Brought to you by [TMAN Consulting](https://en.tman.ltd)*\n\n```text\n ___ ________ ___ _______________ _ __ ____ __ \n / _ /_ __/ / / _ | / __/ __/ _/ _ | / |/ / / __ \\___ ___ _______ _/ /____ ____\n / __ |/ / / /__/ __ |_\\ \\_\\ \\_/ // __ |/ / / /_/ / _ \\/ -_) __/ _ `/ __/ _ \\/ __/\n/_/ |_/_/ /____/_/ |_/___/___/___/_/ |_/_/|_/ \\____/ .__/\\__/_/ \\_,_/\\__/\\___/_/ \n /_/ \n```\n\n> A Python-powered tool to simplify deployment and management of Atlassian products (Jira, Confluence, Bitbucket, Bamboo) using Docker containers.\n\n[](https://blog.willshi.space)\n\n\n[](https://devguide.python.org/versions/)\n[](https://pypi.org/project/atlassian-operator)\n\n----\n\n## \ud83d\ude80 Key Features\n\n- Automated Provisioning: One-click deploy Jira, Confluence, or Bitbucket with pre-configured settings.\n- Docker Orchestration: Abstracts complex Docker commands into simple Python operations.\n- Persistent Storage: Auto-configure volumes for data persistence across restarts.\n- Cluster Support: Deploy high-availability setups with load balancing.\n- Configuration Management: Generate `server.xml`, `setenv.sh`, and database connectors automatically.\n\n----\n\n## \u26a1\ufe0f Quick Start\n\n### 1\ufe0f\u20e3 Check preconditions\n\n- [Python](https://www.python.org/downloads/) >= 3\n- [pip](https://pip.pypa.io/en/stable/installation/)\n- [Docker](https://docs.docker.com/get-started/get-docker/) >= 20\n\n### 2\ufe0f\u20e3 Install `atlassian-operator` tool\n\n```bash\npip install atlassian-operator\n```\n\n### 3\ufe0f\u20e3 Init and modify configuration\n\n```bash\natlas-operator init --product postgres --product jira\n```\n\n### 4\ufe0f\u20e3 Up products containers\n\n```bash\natlas-operator up \n```\n\nIt will be spent more time to pull images if this is the first time to run this command. \n\n----\n\n## \ud83d\udce6 Installation\n\n```bash\npip install atlassian-operator\natlas-operator show --version\n```\n\n----\n\n## \ud83c\udf7a Basic Usage\n\n```text\nusage: atlas-operator [-h] {show,init,cleanup,pull,up,down,list} ...\n\npositional arguments:\n {show,init,cleanup,pull,up,down,list}\n show Show some basic information\n init Init the workspace and config of ATLAS OPERATOR.\n cleanup Remove ATLAS OPERATOR config, if you want to remove all files under ATLAS OPERATOR workspace, please add --data\n pull Pull all images of ATLAS OPERATOR.\n up Up all containers of ATLAS OPERATOR services.\n down Stop all services and down all containers\n list List all service containers\n\noptional arguments:\n -h, --help show this help message and exit\n```\n\n### show\n\n```text\nusage: atlas-operator show [-h] [--version] [--config]\n\noptional arguments:\n -h, --help show this help message and exit\n --version Show all versions of tools\n --config Show base configuration path\n```\n\n### init\n\n```text\nusage: atlas-operator init [-h] --product {nginx,postgres,jira,jsm,conf,bitbucket}\n\noptional arguments:\n -h, --help show this help message and exit\n --product {nginx,postgres,jira,jsm,conf,bitbucket,bamboo}\n e.g. --product jira \n e.g. --product jira --product conf\n```\n\n### up\n\nNeed to check and modify the products configuration before run `atlas-operator up` to start services.\n\nAll configuration files can be found when you run `atlas-operator show --config` \n\n----\n\n## \ud83c\udf0d License\n\n[Apache License 2.0](https://github.com/TMAN-Lab/tman-atlassian-operator?tab=Apache-2.0-1-ov-file)\n\n----\n\n## \ud83d\udcda Resources\n\n### Atlassian Docker Images\n\n- [Jira Software `atlassian/jira-software:<tag>`](https://hub.docker.com/r/atlassian/jira-software)\n- [Jira Service Management `atlassian/jira-servicemanagement:<tag>`](https://hub.docker.com/r/atlassian/jira-servicemanagement)\n- [Confluence `atlassian/confluence:<tag>`](https://hub.docker.com/r/atlassian/confluence)\n\n### Atlassian Official Docs\n\n- [Jira Data Center Container](https://atlassian.github.io/data-center-helm-charts/containers/JIRA/)\n- [Confluence Data Center Container](https://atlassian.github.io/data-center-helm-charts/containers/CONFLUENCE/)\n- [Bitbucket Data Center Container](https://atlassian.github.io/data-center-helm-charts/containers/BITBUCKET/)\n- [Bamboo Container](https://atlassian.github.io/data-center-helm-charts/containers/BAMBOO/)\n- [Bamboo Agent Container](https://atlassian.github.io/data-center-helm-charts/containers/BAMBOO-AGENT/)\n- [Crowd Data Center Container](https://atlassian.github.io/data-center-helm-charts/containers/CROWD/)\n",
"bugtrack_url": null,
"license": null,
"summary": "Deploying Atlassian Products with Docker",
"version": "0.5",
"project_urls": {
"Homepage": "https://github.com/TMAN-Lab/tman-atlassian-operator"
},
"split_keywords": [
"atlassian",
" jira",
" confluence",
" docker",
" deploy",
" setup",
" cli"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "c8c6b42e108acae829679f9811fd69b99d8c8286b072bc1d624d3ca01f11f143",
"md5": "0cfab734bc0e7149058ebc126f9e32ae",
"sha256": "97911bb16ee13b73598d9ebdf7694dfae7eca6abf911d695ee882db1bb35e810"
},
"downloads": -1,
"filename": "atlassian_operator-0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0cfab734bc0e7149058ebc126f9e32ae",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 26397,
"upload_time": "2025-08-29T17:35:18",
"upload_time_iso_8601": "2025-08-29T17:35:18.791333Z",
"url": "https://files.pythonhosted.org/packages/c8/c6/b42e108acae829679f9811fd69b99d8c8286b072bc1d624d3ca01f11f143/atlassian_operator-0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "1632b35427c68f0a08b90781efca7a7ad0ee2753395de1e7674f142fc2c6782f",
"md5": "b105567715f315f816d6379bc3a7aa37",
"sha256": "e796eee6f17b6b084e2cab190a4c7749ea27ab04b050581d53c0984a515b8301"
},
"downloads": -1,
"filename": "atlassian_operator-0.5.tar.gz",
"has_sig": false,
"md5_digest": "b105567715f315f816d6379bc3a7aa37",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 20184,
"upload_time": "2025-08-29T17:35:19",
"upload_time_iso_8601": "2025-08-29T17:35:19.945342Z",
"url": "https://files.pythonhosted.org/packages/16/32/b35427c68f0a08b90781efca7a7ad0ee2753395de1e7674f142fc2c6782f/atlassian_operator-0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-29 17:35:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "TMAN-Lab",
"github_project": "tman-atlassian-operator",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "atlassian-operator"
}
JSON
