Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
210 changes: 207 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,11 +1,215 @@
# Created by https://www.toptal.com/developers/gitignore/api/python,visualstudiocode,virtualenv
# Edit at https://www.toptal.com/developers/gitignore?templates=python,visualstudiocode,virtualenv

### Python ###
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/
cover/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
.pybuilder/
target/

# Jupyter Notebook
.ipynb_checkpoints

# IPython
profile_default/
ipython_config.py

# pyenv
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
# .python-version

# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock

# poetry
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
#poetry.lock

# pdm
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
#pdm.lock
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
# in version control.
# https://pdm.fming.dev/#use-with-ide
.pdm.toml

# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
__pypackages__/

# Celery stuff
celerybeat-schedule
celerybeat.pid

# SageMath parsed files
*.sage.py

# Environments
.env
.env.bak*
.venv
env/
venv/
ENV/
env.bak/
venv.bak/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/
.dmypy.json
dmypy.json

# Pyre type checker
.pyre/

# pytype static type analyzer
.pytype/

# Cython debug symbols
cython_debug/

# PyCharm
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
#.idea/

### Python Patch ###
# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
poetry.toml

# ruff
.ruff_cache/

# LSP config files
pyrightconfig.json

### VirtualEnv ###
# Virtualenv
# http://iamzed.com/2009/05/07/a-primer-on-virtualenv/
[Bb]in
[Ii]nclude
[Ll]ib
[Ll]ib64
[Ll]ocal
[Ss]cripts
pyvenv.cfg
pip-selfcheck.json

### VisualStudioCode ###
.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json
!.vscode/*.code-snippets

# Local History for Visual Studio Code
.history/

# Built Visual Studio Code Extensions
*.vsix

### VisualStudioCode Patch ###
# Ignore all local history of files
.history
.ionide

# End of https://www.toptal.com/developers/gitignore/api/python,visualstudiocode,virtualenv

data
htpasswd
*.log
*.pem
.rendered/
# Rendered stack files (generated by stackctl/tools)
*.rendered.yml
.venv/
__pycache__/
7 changes: 0 additions & 7 deletions .sops.yaml

This file was deleted.

12 changes: 12 additions & 0 deletions .sops.yaml.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Example SOPS configuration
# Copy to .sops.yaml and adjust keys/providers for your environment.
# Docs: https://github.com/getsops/sops

creation_rules:
# Example: age key (recommended for simplicity)
- path_regex:
- ".*\\.enc\\.yaml$"
- ".*secret.*\\.yaml$"
age: ["age1exampleexampleexampleexampleexampleexampleexampleexamplex"]
encrypted_regex: ".*"
# or use kms/gcp_kms/pgp depending on your setup
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,22 @@ See `stacks/README.md` for the full runbook or use `stackctl.sh` helpers:
./stackctl.sh up
```

### Bootstrap (developer setup)

To quickly prepare a development machine for working with this repository, there's a helper built into the main wrapper script.

```bash
./stackctl.sh --bootstrap
```

What this does:
- Copies missing `.env` files from `.env.example` where present.
- Installs Python requirements from `tools/requirements.txt` when a Python virtualenv is active.
- Checks that Docker is installed and whether Docker Swarm is active (prints next steps if not).

This is a safe convenience for local setup; it does not commit or overwrite existing `.env` files. See `tools/README.md` for more details about renderers and SOPS usage.


### 3. Set up core infrastructure (Compose - legacy local-only)

```bash
Expand Down
5 changes: 5 additions & 0 deletions apisix/api-gateway/.env.example.enc.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Example SOPS-encrypted file (placeholder values). Use 'sops' to encrypt/decrypt.
# This is a sample and contains no real secrets.
DATABASE_URL: ENC[AES256_GCM,data:PLACEHOLDER,iv:PLACEHOLDER,key:PLACEHOLDER,tags:PLACEHOLDER]
ADMIN_KEY: ENC[AES256_GCM,data:PLACEHOLDER,iv:PLACEHOLDER,key:PLACEHOLDER,tags:PLACEHOLDER]
VIEWER_KEY: ENC[AES256_GCM,data:PLACEHOLDER,iv:PLACEHOLDER,key:PLACEHOLDER,tags:PLACEHOLDER]
34 changes: 34 additions & 0 deletions docs/SOPS-usage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# SOPS Usage Guide (local development)

This repository supports using SOPS to keep secrets encrypted in the repository while allowing local
developers to decrypt them during setup.

High level
- Keep only encrypted files in the repository (e.g. `.env.enc.yaml`).
- Use `.sops.yaml` (copy from `.sops.yaml.example`) to configure encryption backends (age/KMS/PGP).
- Locally, decrypt with the `sops` CLI and write to `.env` when needed.

Examples

1) Decrypt for local use

```bash
# requires sops installed and the proper keys available in your keystore
./stackctl.sh secrets decrypt --in apisix/api-gateway/.env.example.enc.yaml --out apisix/api-gateway/.env --force
```

2) Encrypt a plaintext .env into an encrypted file

```bash
# Use sops to encrypt; this will respect .sops.yaml
./stackctl.sh secrets encrypt --in apisix/api-gateway/.env --out apisix/api-gateway/.env.enc.yaml
```

3) Best practices
- Never commit plaintext `.env` files. Add `.env` to your global or repo `.gitignore`.
- Add `.sops.yaml` to your local environment (do not commit a production `.sops.yaml` with real keys).
- Rotate keys and update `.sops.yaml` as needed.

Security notes
- The `stackctl_cli` helpers never print secret values; decrypt writes to a file.
- For CI, configure a decrypt step using appropriate secret storage (KMS/PGP) and avoid storing keys in the repo.
Loading
Loading