arc-deploy 0.1.4__tar.gz

arc_deploy-0.1.4/.gitignore

@@ -0,0 +1,48 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# Virtual environments
+venv/
+env/
+ENV/
+.venv
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+
+# uv
+.uv/
+uv.lock
+
+# Local config
+deploy.local.yaml
+*.secret.yaml

arc_deploy-0.1.4/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Arcsite Team
+
+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.

arc_deploy-0.1.4/MANIFEST.in

@@ -0,0 +1,14 @@
+# Include documentation
+# README.md is automatically included
+include LICENSE
+
+# Include example configurations
+recursive-include examples *.yaml *.md
+
+# Exclude development files
+exclude publish.sh
+exclude .gitignore
+global-exclude __pycache__
+global-exclude *.py[cod]
+global-exclude *.swp
+global-exclude .DS_Store

arc_deploy-0.1.4/PKG-INFO

@@ -0,0 +1,238 @@
+Metadata-Version: 2.4
+Name: arc-deploy
+Version: 0.1.4
+Summary: Unified deployment CLI tool for Docker Swarm with monorepo support
+Project-URL: Homepage, https://github.com/your-org/deploy-controller
+Project-URL: Documentation, https://github.com/your-org/deploy-controller/tree/main/cli
+Project-URL: Repository, https://github.com/your-org/deploy-controller
+Project-URL: Issues, https://github.com/your-org/deploy-controller/issues
+Author-email: Arcsite Team <noreply@example.com>
+License: MIT
+License-File: LICENSE
+Keywords: cicd,cli,deployment,devops,docker,monorepo,swarm
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Topic :: System :: Systems Administration
+Requires-Python: >=3.8
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: typer>=0.9.0
+Description-Content-Type: text/markdown
+
+# Arc Deploy CLI
+
+A unified CLI tool for building and deploying Docker services to the Deploy Controller. Supports both single-service and monorepo architectures with configuration-driven deployments.
+
+## Features
+
+- **Single Service & Monorepo Support**: Deploy one service or manage multiple services from a single configuration
+- **Configuration Inheritance**: Shared settings via `common` section in monorepo configs
+- **Unique Image Tagging**: Automatic tag generation using Git SHA and timestamp
+- **Flexible Deployment Options**: Build only, build+push, or full deployment workflow
+- **Real-time Monitoring**: Track deployment progress and status
+
+## 📚 Documentation
+
+Full documentation is available in the `docs/` directory or served via MkDocs:
+
+- [Overview](docs/cli/index.md) - Installation and basic usage
+- [Monorepo Guide](docs/cli/monorepo.md) - Configuring monorepo deployments
+- [Publishing Guide](docs/cli/publishing.md) - How to publish the CLI package
+- [Package Info](docs/cli/package.md) - Package structure and metadata
+
+## 🚀 Quick Start
+
+### Installation
+
+```bash
+# Install via pip
+pip install arc-deploy
+
+# Or using uv
+uv pip install arc-deploy
+```
+
+### Single Service Configuration
+
+Create `deploy.yaml` in your project root:
+
+```yaml
+service_name: my_service
+ecr_registry: 123.dkr.ecr.us-west-2.amazonaws.com
+deploy_controller_url: https://deploy.example.com
+aws_region: us-west-2
+
+build:
+  dockerfile: Dockerfile
+  context: .
+  build_args:
+    NODE_ENV: production
+```
+
+**Deploy**:
+
+```bash
+export WEBHOOK_TOKEN="your-token"
+arc-deploy build-and-deploy --env test
+```
+
+### Monorepo Configuration
+
+Create `deploy.yaml` at repository root:
+
+```yaml
+common:
+  ecr_registry: 123.dkr.ecr.us-west-2.amazonaws.com
+  deploy_controller_url: https://deploy.example.com
+  aws_region: us-west-2
+
+services:
+  # 简化版本：不指定 service_name，使用 key 作为默认值
+  api:
+    build: { context: services/api }
+  worker:
+    build: { context: services/worker }
+  
+  # 完整版本：指定不同的 service_name（用于不同的 Docker 服务名）
+  api-gateway:
+    service_name: arc_api_gateway  # 可选：如果未指定，使用 key (api-gateway)
+    build: { context: services/api-gateway }
+```
+
+**Deploy**:
+
+```bash
+# List available services
+arc-deploy list-services
+
+# Deploy specific service(s)
+arc-deploy build-and-deploy --env test --service api
+arc-deploy build-and-deploy --env prod --service api,worker
+
+# Deploy all services
+arc-deploy build-and-deploy --env test --all
+```
+
+## Commands
+
+### `build-and-deploy`
+
+Build Docker image, push to ECR, and deploy via Deploy Controller.
+
+**Options**:
+- `--env`, `-e`: Deployment environment (test/prod) - **Required**
+- `--config`, `-c`: Configuration file path (default: `deploy.yaml`)
+- `--service`, `-s`: Service name(s) for monorepo (comma-separated or multiple flags)
+- `--all`: Deploy all services (monorepo only)
+- `--skip-push`: Build only, skip push and deploy
+- `--skip-deploy`: Build and push only, skip deployment
+
+**Examples**:
+```bash
+# Single service
+arc-deploy build-and-deploy --env test
+
+# Monorepo - specific service
+arc-deploy build-and-deploy --env test --service api
+
+# Monorepo - multiple services
+arc-deploy build-and-deploy --env prod --service api,worker
+
+# Build only (no push/deploy)
+arc-deploy build-and-deploy --env test --skip-push
+```
+
+### `validate-config`
+
+Validate the deployment configuration file.
+
+**Options**:
+- `--config`, `-c`: Configuration file path (default: `deploy.yaml`)
+
+**Example**:
+```bash
+arc-deploy validate-config
+```
+
+### `build-only`
+
+Build Docker image only (no push or deploy).
+
+**Options**:
+- `--config`, `-c`: Configuration file path (default: `deploy.yaml`)
+- `--service`, `-s`: Service name for monorepo
+- `--tag`, `-t`: Custom image tag (optional, defaults to auto-generated tag)
+
+**Examples**:
+```bash
+# Single service
+arc-deploy build-only
+
+# Monorepo
+arc-deploy build-only --service api
+
+# With custom tag
+arc-deploy build-only --tag v1.0.0
+```
+
+### `list-services`
+
+List all services in a monorepo configuration.
+
+**Options**:
+- `--config`, `-c`: Configuration file path (default: `deploy.yaml`)
+
+**Example**:
+```bash
+arc-deploy list-services
+```
+
+## Environment Variables
+
+- `WEBHOOK_TOKEN`: Bearer token for Deploy Controller webhook authentication (required for deployments)
+- `AWS_PROFILE`: AWS profile name (or use standard AWS environment variables)
+- `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`: AWS credentials (if not using profile)
+
+## Configuration Reference
+
+| Field | Description | Required |
+|-------|-------------|----------|
+| `service_name` | Service name in Deploy Controller | Yes |
+| `ecr_registry` | ECR repository URL | Yes |
+| `deploy_controller_url` | Base URL of Deploy Controller | Yes |
+| `aws_region` | AWS region for ECR | Yes |
+| `image_name` | Docker image name (defaults to `service_name`) | No |
+| `build.dockerfile` | Path to Dockerfile (default: `Dockerfile`) | No |
+| `build.context` | Build context path (default: `.`) | No |
+| `build.build_args` | Dictionary of build arguments | No |
+
+For monorepo configurations, see the [Monorepo Guide](docs/cli/monorepo.md) for details on `common` and `services` sections.
+
+## Examples
+
+Example configurations are available in the `examples/` directory:
+- `arc-nodejs-service.yaml` - Single service example
+- `arc-agent-gateway.yaml` - Single service example
+- `monorepo/deploy.yaml` - Basic monorepo example
+- `monorepo/deploy-fullstack.yaml` - Fullstack app example
+
+## Development
+
+For local development, install in editable mode:
+
+```bash
+cd cli
+uv pip install -e .
+```
+
+## License
+
+MIT License - see [LICENSE](LICENSE) file for details.

arc_deploy-0.1.4/README.md

@@ -0,0 +1,209 @@
+# Arc Deploy CLI
+
+A unified CLI tool for building and deploying Docker services to the Deploy Controller. Supports both single-service and monorepo architectures with configuration-driven deployments.
+
+## Features
+
+- **Single Service & Monorepo Support**: Deploy one service or manage multiple services from a single configuration
+- **Configuration Inheritance**: Shared settings via `common` section in monorepo configs
+- **Unique Image Tagging**: Automatic tag generation using Git SHA and timestamp
+- **Flexible Deployment Options**: Build only, build+push, or full deployment workflow
+- **Real-time Monitoring**: Track deployment progress and status
+
+## 📚 Documentation
+
+Full documentation is available in the `docs/` directory or served via MkDocs:
+
+- [Overview](docs/cli/index.md) - Installation and basic usage
+- [Monorepo Guide](docs/cli/monorepo.md) - Configuring monorepo deployments
+- [Publishing Guide](docs/cli/publishing.md) - How to publish the CLI package
+- [Package Info](docs/cli/package.md) - Package structure and metadata
+
+## 🚀 Quick Start
+
+### Installation
+
+```bash
+# Install via pip
+pip install arc-deploy
+
+# Or using uv
+uv pip install arc-deploy
+```
+
+### Single Service Configuration
+
+Create `deploy.yaml` in your project root:
+
+```yaml
+service_name: my_service
+ecr_registry: 123.dkr.ecr.us-west-2.amazonaws.com
+deploy_controller_url: https://deploy.example.com
+aws_region: us-west-2
+
+build:
+  dockerfile: Dockerfile
+  context: .
+  build_args:
+    NODE_ENV: production
+```
+
+**Deploy**:
+
+```bash
+export WEBHOOK_TOKEN="your-token"
+arc-deploy build-and-deploy --env test
+```
+
+### Monorepo Configuration
+
+Create `deploy.yaml` at repository root:
+
+```yaml
+common:
+  ecr_registry: 123.dkr.ecr.us-west-2.amazonaws.com
+  deploy_controller_url: https://deploy.example.com
+  aws_region: us-west-2
+
+services:
+  # 简化版本：不指定 service_name，使用 key 作为默认值
+  api:
+    build: { context: services/api }
+  worker:
+    build: { context: services/worker }
+  
+  # 完整版本：指定不同的 service_name（用于不同的 Docker 服务名）
+  api-gateway:
+    service_name: arc_api_gateway  # 可选：如果未指定，使用 key (api-gateway)
+    build: { context: services/api-gateway }
+```
+
+**Deploy**:
+
+```bash
+# List available services
+arc-deploy list-services
+
+# Deploy specific service(s)
+arc-deploy build-and-deploy --env test --service api
+arc-deploy build-and-deploy --env prod --service api,worker
+
+# Deploy all services
+arc-deploy build-and-deploy --env test --all
+```
+
+## Commands
+
+### `build-and-deploy`
+
+Build Docker image, push to ECR, and deploy via Deploy Controller.
+
+**Options**:
+- `--env`, `-e`: Deployment environment (test/prod) - **Required**
+- `--config`, `-c`: Configuration file path (default: `deploy.yaml`)
+- `--service`, `-s`: Service name(s) for monorepo (comma-separated or multiple flags)
+- `--all`: Deploy all services (monorepo only)
+- `--skip-push`: Build only, skip push and deploy
+- `--skip-deploy`: Build and push only, skip deployment
+
+**Examples**:
+```bash
+# Single service
+arc-deploy build-and-deploy --env test
+
+# Monorepo - specific service
+arc-deploy build-and-deploy --env test --service api
+
+# Monorepo - multiple services
+arc-deploy build-and-deploy --env prod --service api,worker
+
+# Build only (no push/deploy)
+arc-deploy build-and-deploy --env test --skip-push
+```
+
+### `validate-config`
+
+Validate the deployment configuration file.
+
+**Options**:
+- `--config`, `-c`: Configuration file path (default: `deploy.yaml`)
+
+**Example**:
+```bash
+arc-deploy validate-config
+```
+
+### `build-only`
+
+Build Docker image only (no push or deploy).
+
+**Options**:
+- `--config`, `-c`: Configuration file path (default: `deploy.yaml`)
+- `--service`, `-s`: Service name for monorepo
+- `--tag`, `-t`: Custom image tag (optional, defaults to auto-generated tag)
+
+**Examples**:
+```bash
+# Single service
+arc-deploy build-only
+
+# Monorepo
+arc-deploy build-only --service api
+
+# With custom tag
+arc-deploy build-only --tag v1.0.0
+```
+
+### `list-services`
+
+List all services in a monorepo configuration.
+
+**Options**:
+- `--config`, `-c`: Configuration file path (default: `deploy.yaml`)
+
+**Example**:
+```bash
+arc-deploy list-services
+```
+
+## Environment Variables
+
+- `WEBHOOK_TOKEN`: Bearer token for Deploy Controller webhook authentication (required for deployments)
+- `AWS_PROFILE`: AWS profile name (or use standard AWS environment variables)
+- `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`: AWS credentials (if not using profile)
+
+## Configuration Reference
+
+| Field | Description | Required |
+|-------|-------------|----------|
+| `service_name` | Service name in Deploy Controller | Yes |
+| `ecr_registry` | ECR repository URL | Yes |
+| `deploy_controller_url` | Base URL of Deploy Controller | Yes |
+| `aws_region` | AWS region for ECR | Yes |
+| `image_name` | Docker image name (defaults to `service_name`) | No |
+| `build.dockerfile` | Path to Dockerfile (default: `Dockerfile`) | No |
+| `build.context` | Build context path (default: `.`) | No |
+| `build.build_args` | Dictionary of build arguments | No |
+
+For monorepo configurations, see the [Monorepo Guide](docs/cli/monorepo.md) for details on `common` and `services` sections.
+
+## Examples
+
+Example configurations are available in the `examples/` directory:
+- `arc-nodejs-service.yaml` - Single service example
+- `arc-agent-gateway.yaml` - Single service example
+- `monorepo/deploy.yaml` - Basic monorepo example
+- `monorepo/deploy-fullstack.yaml` - Fullstack app example
+
+## Development
+
+For local development, install in editable mode:
+
+```bash
+cd cli
+uv pip install -e .
+```
+
+## License
+
+MIT License - see [LICENSE](LICENSE) file for details.

arc_deploy-0.1.4/docs/cli/index.md

@@ -0,0 +1,86 @@
+# Deploy Controller CLI
+
+A unified CLI tool for building and deploying Docker services to the Deploy Controller. Supports both single-service and monorepo architectures.
+
+## Installation
+
+```bash
+# Install via pip
+pip install arc-deploy
+
+# Or using uv
+uv pip install arc-deploy
+```
+
+## Configuration
+
+### 1. Single Service
+Create `deploy.yaml` in your project root:
+
+```yaml
+service_name: arc_nodejs_service
+ecr_registry: 264778582408.dkr.ecr.us-west-2.amazonaws.com
+deploy_controller_url: https://deploy-controller.example.com
+aws_region: us-west-2
+
+build:
+  dockerfile: Dockerfile
+  context: .
+  build_args:
+    NODE_ENV: production
+```
+
+### 2. Monorepo
+Create `deploy.yaml` in your repository root. See [Monorepo Guide](monorepo.md) for details.
+
+```yaml
+common:
+  ecr_registry: 264778582408.dkr.ecr.us-west-2.amazonaws.com
+  deploy_controller_url: https://deploy-controller.example.com
+services:
+  api:
+    service_name: arc_api
+    build: { context: services/api }
+  worker:
+    service_name: arc_worker
+    build: { context: services/worker }
+```
+
+## Usage
+
+**Environment Variables:**
+```bash
+export WEBHOOK_TOKEN="your-token"
+export AWS_PROFILE="default" # or standard AWS env vars
+```
+
+**Commands:**
+
+```bash
+# Deploy (Single config or Monorepo root)
+arc-deploy build-and-deploy --env test
+
+# Monorepo: Deploy specific service(s)
+arc-deploy build-and-deploy --env test --service api
+arc-deploy build-and-deploy --env test --service api,worker
+
+# Monorepo: Deploy all services
+arc-deploy build-and-deploy --env test --all
+
+# Build only (skip push/deploy)
+arc-deploy build-only
+
+# Validate config
+arc-deploy validate-config
+```
+
+## Reference
+
+| Field | Description |
+|-------|-------------|
+| `service_name` | **Required**. Must match service name in Deploy Controller. |
+| `ecr_registry` | **Required**. ECR repository URL. |
+| `deploy_controller_url` | **Required**. Base URL of the controller. |
+| `build.dockerfile` | Path to Dockerfile (default: `Dockerfile`). |
+| `build.context` | Build context path (default: `.`). |
+| `build.build_args` | Dictionary of build arguments. |

arc_deploy-0.1.4/docs/cli/monorepo.md

@@ -0,0 +1,62 @@
+# Monorepo Configuration Guide
+
+## Directory Structure
+```
+repo/
+├── deploy.yaml          # Unified config at root
+└── services/
+    ├── service-a/
+    └── service-b/
+```
+
+## Configuration Logic
+
+1.  **Inheritance**:
+    *   `common`: Settings applied to *all* services (e.g., registry, URL).
+    *   `services`: Individual service configurations. Values here override `common`.
+
+2.  **Paths**:
+    *   All paths (`dockerfile`, `context`) are **relative** to the `deploy.yaml` file location.
+
+## Example Configuration
+
+```yaml
+common:
+  ecr_registry: 264778582408.dkr.ecr.us-west-2.amazonaws.com
+  deploy_controller_url: https://deploy-controller.example.com
+  aws_region: us-west-2
+
+services:
+  # Service ID: 'frontend' (used in CLI: --service frontend)
+  frontend:
+    service_name: arc_frontend      # Real service name in controller
+    build:
+      context: apps/frontend
+
+  # Service ID: 'backend'
+  backend:
+    service_name: arc_backend
+    build:
+      context: apps/backend
+      dockerfile: apps/backend/Dockerfile.prod
+```
+
+## CLI Usage
+
+```bash
+# List all available services
+arc-deploy list-services
+
+# Deploy specific services from root
+arc-deploy build-and-deploy --env test --service frontend
+arc-deploy build-and-deploy --env prod --service frontend,backend
+
+# Deploy all services
+arc-deploy build-and-deploy --env test --all
+
+# Build only (skip push and deploy)
+arc-deploy build-and-deploy --env test --service frontend --skip-push
+
+# Build and push only (skip deploy)
+arc-deploy build-and-deploy --env test --service frontend --skip-deploy
+```