Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sevilayerkan/docker-file-generator
Generate Docker compose yml files from json files
https://github.com/sevilayerkan/docker-file-generator
docker docker-compose python yml-files
Last synced: 11 days ago
JSON representation
Generate Docker compose yml files from json files
- Host: GitHub
- URL: https://github.com/sevilayerkan/docker-file-generator
- Owner: sevilayerkan
- License: mit
- Created: 2023-06-04T03:02:00.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-24T16:16:52.000Z (12 months ago)
- Last Synced: 2024-10-11T00:20:02.290Z (28 days ago)
- Topics: docker, docker-compose, python, yml-files
- Language: Python
- Homepage:
- Size: 26.4 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Docker Compose YAML Generator
This script generates a Docker Compose YAML file based on JSON configuration files. It simplifies the process of creating a Docker Compose file for managing multi-container applications.
> ❗ **Disclaimer:**
YAML files generated with this app might not be suitable for your production environment. Please use them after making proper adjustments.
## Requirements
- Python 3.x
## Usage for cli app
1. Ensure you have Python 3.x installed on your system.
2. Download the `dockerJson.py` script from /apps/fromJson directory.
3. Run the script with the desired command-line options:
```bash
dockerJson.py -j config1.json config2.json -o /path/to/output -f docker-compose.yml
```
The script accepts the following command-line options:
- `-j` or `--json`: Path to one or more JSON configuration files. Separate multiple file paths with spaces.
- `-o` or `--output`: Output directory for the Docker Compose file. (Default: current directory)
- `-f` or `--filename`: Output filename for the Docker Compose file. (Default: docker-compose.yml)
- `-d` or `--json-dir`: Directory path for JSON configuration files. Use this option if the JSON files are located in a different directory.
4. The script will generate the Docker Compose YAML file based on the provided JSON configuration files and save it in the specified output directory with the specified filename.
5. The generated Docker Compose file can be used to deploy and manage your multi-container application using Docker Compose.
### Example Usage
```bash
python dockerJson.py -j flask-psql.json flask-redis.json
```
```bash
python dockerJson.py -j templates/flask-psql.json templates/flask-redis.json -o ./result -f compose.yml
```
## JSON Configuration File Format
The JSON configuration files should follow a specific format to define the services and their attributes in the Docker Compose file.
Here's an example of a valid JSON configuration file:
```json
{
"web":
{
"image": "nginx:latest",
"ports": ["80:80"]
},
"db":
{
"image": "mysql:latest",
"ports": ["3306:3306"],
"command": "--default-authentication-plugin=mysql_native_password"
}
}
```
## Usage for Flask Web App
This is a Flask application that generates a Docker Compose YAML file based on JSON configuration files.
### Requirements
- Python 3.6 or higher
### Installation
0. Clone repo in your device
1. Navigate to the project directory:
```shell
cd docker-file-generator
```
2. Create a virtual environment (optional but recommended):
```shell
python3 -m venv venv
```
3. Install the required dependencies:
```shell
pip install -r requirements.txt
```
### Usage
1. Place your JSON configuration files in the `json_templates` directory. Each JSON file should contain the configuration for a Docker service like shown before. Or choose from OS file system in the browser.
2. Run the Flask application:
```shell
flask run
```
3. Open your web browser and go to `http://localhost:5000`.
4. Select the JSON configuration files you want to include in the Docker Compose file.
5. Specify the output directory and filename for the generated Docker Compose YAML file.
6. Click the "Generate" button.
7. The Docker Compose YAML file will be generated and saved in the specified output directory.
8. After the file is generated, you will be redirected to a success page with a link to return to the generate page and generate another Docker Compose file.
## Notes
Each service in the Docker Compose file is defined as a key-value pair in the JSON object.
The key represents the service name, and the value is an object containing the service attributes.
Supported service attributes include:
`image` (string): The Docker image to use for the service.
`ports` (list of strings): The port mappings for the service.
`command` (string): The command to run when starting the service.
You can define multiple services in a single JSON configuration file.
Note that duplicate service names are not allowed. If a duplicate service name is detected, the script will skip the duplicate entry.
## Screenshots
## Contributing and Feedback
Contributions are always welcome! If you have any feedback, please feel free to open issue or contact me in [@sevilayerkan](https://www.github.com/sevilayerkan)