helmgen 0.1.0__tar.gz

helmgen-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 marcelodevops
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

helmgen-0.1.0/MANIFEST.in

@@ -0,0 +1 @@
+recursive-include helmgen/helm_templates *.yaml

helmgen-0.1.0/PKG-INFO

@@ -0,0 +1,273 @@
+Metadata-Version: 2.4
+Name: helmgen
+Version: 0.1.0
+Summary: Auto-generate Helm charts from Docker Compose files
+Author-email: Marcelo Garcia <marcelo.garcia@linux.com>
+License: MIT
+Project-URL: homepage, https://github.com/marcelodevops/helmgen
+Project-URL: repository, https://github.com/marcelodevops/helmgen
+Project-URL: issues, https://github.com/marcelodevops/helmgen/issues
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: PyYAML>=6.0.2
+Requires-Dist: ruamel.yaml>=0.18.6
+Requires-Dist: jinja2>=3.1.4
+Requires-Dist: click>=8.1.7
+Requires-Dist: rich>=13.7.1
+Dynamic: license-file
+
+## Helmgen
+Auto-generate Helm charts from Docker Compose files.
+
+**HelmGen** is a Python CLI tool that automatically converts your `docker-compose.yml` into a fully structured Helm chart — including Deployments, Services, PVCs, Ingress, and Secrets (internal or ExternalSecrets).
+##### Features:
+- Convert **Docker Compose** files directly into **Helm charts**
+- Auto-detect **databases** → generate StatefulSets + PVCs
+- Auto-generate **Kubernetes Secrets** or **ExternalSecrets**
+- Support for **Vault**, **AWS Secrets Manager**, or **ExternalSecrets Operator**
+- Generate **SecretStore** or **ClusterSecretStore** automatically
+- Auto-generate **Ingress** resources for web services
+- Replace hardcoded secrets with safe placeholders in `values.yaml`
+- Detect whether secrets should be env vars or mounted files
+- CLI support for flexible options and overrides
+
+### Installation
+
+##### From source (recommended for development)
+```bash
+git clone https://github.com/yourusername/helmgen.git
+cd helmgen
+pip install -e . 
+```
+- Then you can run it as a command:
+```bash
+helmgen --help
+```
+
+### Usage
+```bash
+helmgen docker-compose.yml [options]
+```
+### Example
+```bash
+helmgen docker-compose.yml \
+  --output ./charts/myapp \
+  --secret-provider externalsecret \
+  --store-scope cluster \
+  --reuse-store global-vault-store
+```
+
+
+- This generates
+```bash
+charts/myapp/
+├── Chart.yaml
+├── values.yaml
+└── templates/
+    ├── deployment.yaml
+    ├── service.yaml
+    ├── pvc.yaml
+    ├── ingress.yaml
+    ├── secrets.yaml
+    ├── externalsecret.yaml
+    └── secretstore.yaml
+
+```
+- Then you can deploy
+```bash
+helm install myapp ./charts/myapp
+```
+### CLI options
+
+| Option                  | Description                                     | Default             |
+| ----------------------- | ----------------------------------------------- | ------------------- |
+| `--output, -o`          | Directory for generated Helm chart              | `./generated-chart` |
+| `--secret-provider, -s` | `internal` (Helm Secret) or `externalsecret`    | `internal`          |
+| `--store-scope`         | `namespace` or `cluster` SecretStore            | `namespace`         |
+| `--reuse-store`         | Name of existing SecretStore/ClusterSecretStore | *None*              |
+
+### Example
+
+```yaml
+version: "3.8"
+services:
+  web:
+    image: nginx:alpine
+    ports:
+      - "8080:80"
+    environment:
+      APP_ENV: production
+      SECRET_KEY: supersecret
+
+  db:
+    image: postgres:14
+    environment:
+      POSTGRES_USER: user
+      POSTGRES_PASSWORD: pass123
+    volumes:
+      - db-data:/var/lib/postgresql/data
+    ports:
+      - "5432:5432"
+
+volumes:
+  db-data:
+
+```
+
+- This will generate a Helm Chart with
+
+    - StatefulSet for Postgres
+    - Deployment for web
+    - Secrets/ExternalSecrets for passwords
+    - PVC for db-data
+    - Ingress if ports are exposed
+
+
+- In this example the sensitive data is hard coded in the compose file with is a very bad practice but it's being used only for purpose of the example demonstration
+
+
+##### Secret management
+- There are 2 options
+    1. Internal (default helm secret)
+    2. External
+
+##### if you want to run it as a python script (not recommended)
+
+```bash
+python3 generator.py docker-compose.yml \
+  --output ./charts/myapp \
+  --secret-provider externalsecret \
+  --store-scope cluster \
+  --reuse-store global-vault-store
+  ```
+
+##### This will create a complete Helm chart with:
+
+```bash
+charts/myapp/
+├── Chart.yaml
+├── values.yaml
+└── templates/
+    ├── deployment.yaml
+    ├── service.yaml
+    ├── pvc.yaml
+    ├── ingress.yaml
+    ├── secrets.yaml
+    ├── externalsecret.yaml
+    └── secretstore.yaml
+
+```
+
+##### Templates 
+
+```bash
+helm_templates/
+├── deployment.yaml
+├── service.yaml
+├── pvc.yaml
+├── ingress.yaml
+├── secrets.yaml
+├── externalsecret.yaml
+└── secretstore.yaml
+
+```
+
+##### Summary
+
+Files and templates directory:
+- generator.py → generates chart structure and populates values.yaml.
+- helm_templates/ → reusable Jinja-style templates compatible with Helm.
+- Seamless handling of:
+
+    - Secrets and ExternalSecrets
+    - Databases as StatefulSets (via PVC)
+    - Ingress auto-detection
+    - ClusterSecretStore / SecretStore support
+
+##### Run this version
+- Generate files and templates from compose file:
+
+```bash
+python3 generator.py docker-compose.yml --output ./charts/myapp --secret-provider externalsecret
+```
+
+- Then install chart:
+```bash
+helm install myapp ./charts/myapp
+
+```
+
+##### Dependencies
+
+| Package         | Purpose                                                                                               |
+| --------------- | ----------------------------------------------------------------------------------------------------- |
+| **PyYAML**      | Primary YAML parser for reading `docker-compose.yml`.                                                 |
+| **ruamel.yaml** | More advanced YAML manipulation (preserves comments, ordering).                                       |
+| **jinja2**      | Template rendering for Helm YAML files (used when writing `templates/`).                              |
+| **click**       | Optional CLI framework (if you upgrade from `argparse` later for nicer commands).                     |
+| **rich**        | Optional but recommended — adds colored console output, status spinners, and better error formatting. |
+
+
+##### Install dependencies
+```bash
+pip install -r requirements.txt
+```
+
+##### Update to run it as a CLI tool
+- Usage
+
+```bash
+helmgen docker-compose.yml --output ./charts/myapp
+
+```
+
+##### How it works
+
+- project.scripts exposes a command called helmgen
+- That command runs the main() function inside your generator.py
+- Everything else is metadata (version, author, URLs, etc.)
+- Dependencies match the ones from your requirements.txt
+
+
+##### Project layout
+
+```bash
+
+helmgen/
+├── generator.py
+├── pyproject.toml
+├── README.md
+├── requirements.txt
+└── helm_templates/
+    ├── deployment.yaml
+    ├── service.yaml
+    ├── pvc.yaml
+    ├── ingress.yaml
+    ├── secrets.yaml
+    ├── externalsecret.yaml
+    └── secretstore.yaml
+```
+##### Install locally for development
+- From the folder containing pyproject.toml:
+```bash
+pip install -e .
+```
+##### Then you can run it directly:
+```bash
+helmgen docker-compose.yml --output ./charts/myapp
+```
+
+
+##### Build a distributable package
+- to share it or publish it to PyPI (optional):
+```bash
+python -m build
+```
+- and it generates
+```bash
+dist/
+├── helmgen-0.1.0-py3-none-any.whl
+└── helmgen-0.1.0.tar.gz
+
+```

helmgen-0.1.0/README.md

@@ -0,0 +1,254 @@
+## Helmgen
+Auto-generate Helm charts from Docker Compose files.
+
+**HelmGen** is a Python CLI tool that automatically converts your `docker-compose.yml` into a fully structured Helm chart — including Deployments, Services, PVCs, Ingress, and Secrets (internal or ExternalSecrets).
+##### Features:
+- Convert **Docker Compose** files directly into **Helm charts**
+- Auto-detect **databases** → generate StatefulSets + PVCs
+- Auto-generate **Kubernetes Secrets** or **ExternalSecrets**
+- Support for **Vault**, **AWS Secrets Manager**, or **ExternalSecrets Operator**
+- Generate **SecretStore** or **ClusterSecretStore** automatically
+- Auto-generate **Ingress** resources for web services
+- Replace hardcoded secrets with safe placeholders in `values.yaml`
+- Detect whether secrets should be env vars or mounted files
+- CLI support for flexible options and overrides
+
+### Installation
+
+##### From source (recommended for development)
+```bash
+git clone https://github.com/yourusername/helmgen.git
+cd helmgen
+pip install -e . 
+```
+- Then you can run it as a command:
+```bash
+helmgen --help
+```
+
+### Usage
+```bash
+helmgen docker-compose.yml [options]
+```
+### Example
+```bash
+helmgen docker-compose.yml \
+  --output ./charts/myapp \
+  --secret-provider externalsecret \
+  --store-scope cluster \
+  --reuse-store global-vault-store
+```
+
+
+- This generates
+```bash
+charts/myapp/
+├── Chart.yaml
+├── values.yaml
+└── templates/
+    ├── deployment.yaml
+    ├── service.yaml
+    ├── pvc.yaml
+    ├── ingress.yaml
+    ├── secrets.yaml
+    ├── externalsecret.yaml
+    └── secretstore.yaml
+
+```
+- Then you can deploy
+```bash
+helm install myapp ./charts/myapp
+```
+### CLI options
+
+| Option                  | Description                                     | Default             |
+| ----------------------- | ----------------------------------------------- | ------------------- |
+| `--output, -o`          | Directory for generated Helm chart              | `./generated-chart` |
+| `--secret-provider, -s` | `internal` (Helm Secret) or `externalsecret`    | `internal`          |
+| `--store-scope`         | `namespace` or `cluster` SecretStore            | `namespace`         |
+| `--reuse-store`         | Name of existing SecretStore/ClusterSecretStore | *None*              |
+
+### Example
+
+```yaml
+version: "3.8"
+services:
+  web:
+    image: nginx:alpine
+    ports:
+      - "8080:80"
+    environment:
+      APP_ENV: production
+      SECRET_KEY: supersecret
+
+  db:
+    image: postgres:14
+    environment:
+      POSTGRES_USER: user
+      POSTGRES_PASSWORD: pass123
+    volumes:
+      - db-data:/var/lib/postgresql/data
+    ports:
+      - "5432:5432"
+
+volumes:
+  db-data:
+
+```
+
+- This will generate a Helm Chart with
+
+    - StatefulSet for Postgres
+    - Deployment for web
+    - Secrets/ExternalSecrets for passwords
+    - PVC for db-data
+    - Ingress if ports are exposed
+
+
+- In this example the sensitive data is hard coded in the compose file with is a very bad practice but it's being used only for purpose of the example demonstration
+
+
+##### Secret management
+- There are 2 options
+    1. Internal (default helm secret)
+    2. External
+
+##### if you want to run it as a python script (not recommended)
+
+```bash
+python3 generator.py docker-compose.yml \
+  --output ./charts/myapp \
+  --secret-provider externalsecret \
+  --store-scope cluster \
+  --reuse-store global-vault-store
+  ```
+
+##### This will create a complete Helm chart with:
+
+```bash
+charts/myapp/
+├── Chart.yaml
+├── values.yaml
+└── templates/
+    ├── deployment.yaml
+    ├── service.yaml
+    ├── pvc.yaml
+    ├── ingress.yaml
+    ├── secrets.yaml
+    ├── externalsecret.yaml
+    └── secretstore.yaml
+
+```
+
+##### Templates 
+
+```bash
+helm_templates/
+├── deployment.yaml
+├── service.yaml
+├── pvc.yaml
+├── ingress.yaml
+├── secrets.yaml
+├── externalsecret.yaml
+└── secretstore.yaml
+
+```
+
+##### Summary
+
+Files and templates directory:
+- generator.py → generates chart structure and populates values.yaml.
+- helm_templates/ → reusable Jinja-style templates compatible with Helm.
+- Seamless handling of:
+
+    - Secrets and ExternalSecrets
+    - Databases as StatefulSets (via PVC)
+    - Ingress auto-detection
+    - ClusterSecretStore / SecretStore support
+
+##### Run this version
+- Generate files and templates from compose file:
+
+```bash
+python3 generator.py docker-compose.yml --output ./charts/myapp --secret-provider externalsecret
+```
+
+- Then install chart:
+```bash
+helm install myapp ./charts/myapp
+
+```
+
+##### Dependencies
+
+| Package         | Purpose                                                                                               |
+| --------------- | ----------------------------------------------------------------------------------------------------- |
+| **PyYAML**      | Primary YAML parser for reading `docker-compose.yml`.                                                 |
+| **ruamel.yaml** | More advanced YAML manipulation (preserves comments, ordering).                                       |
+| **jinja2**      | Template rendering for Helm YAML files (used when writing `templates/`).                              |
+| **click**       | Optional CLI framework (if you upgrade from `argparse` later for nicer commands).                     |
+| **rich**        | Optional but recommended — adds colored console output, status spinners, and better error formatting. |
+
+
+##### Install dependencies
+```bash
+pip install -r requirements.txt
+```
+
+##### Update to run it as a CLI tool
+- Usage
+
+```bash
+helmgen docker-compose.yml --output ./charts/myapp
+
+```
+
+##### How it works
+
+- project.scripts exposes a command called helmgen
+- That command runs the main() function inside your generator.py
+- Everything else is metadata (version, author, URLs, etc.)
+- Dependencies match the ones from your requirements.txt
+
+
+##### Project layout
+
+```bash
+
+helmgen/
+├── generator.py
+├── pyproject.toml
+├── README.md
+├── requirements.txt
+└── helm_templates/
+    ├── deployment.yaml
+    ├── service.yaml
+    ├── pvc.yaml
+    ├── ingress.yaml
+    ├── secrets.yaml
+    ├── externalsecret.yaml
+    └── secretstore.yaml
+```
+##### Install locally for development
+- From the folder containing pyproject.toml:
+```bash
+pip install -e .
+```
+##### Then you can run it directly:
+```bash
+helmgen docker-compose.yml --output ./charts/myapp
+```
+
+
+##### Build a distributable package
+- to share it or publish it to PyPI (optional):
+```bash
+python -m build
+```
+- and it generates
+```bash
+dist/
+├── helmgen-0.1.0-py3-none-any.whl
+└── helmgen-0.1.0.tar.gz
+
+```

helmgen-0.1.0/helmgen/__init__.py

@@ -0,0 +1,18 @@
+"""
+HelmGen — Auto-generate Helm charts from Docker Compose files.
+
+This package provides:
+  - A CLI entry point (helmgen)
+  - A generator that parses docker-compose.yml
+  - Template rendering for Helm charts
+
+Author: Marcelo Garcia
+License: MIT
+"""
+
+__version__ = "0.1.0"
+
+from .generator import main
+
+if __name__ == "__main__":
+    main()

helmgen-0.1.0/helmgen/__main__.py

@@ -0,0 +1,8 @@
+"""
+Entry point for running `python -m helmgen`
+"""
+
+from .generator import main
+
+if __name__ == "__main__":
+    main()