mirror of
https://github.com/ghndrx/k8s-game-2048.git
synced 2026-02-10 06:45:07 +00:00
Initial commit: 2048 game with Knative and Kourier deployment
- Complete 2048 game implementation with responsive design - Knative Serving manifests for dev/staging/prod environments - Scale-to-zero configuration with environment-specific settings - Custom domain mapping for wa.darknex.us subdomains - GitHub Actions workflows for CI/CD - Docker container with nginx and health checks - Setup scripts for Knative and Kourier installation - GHCR integration for container registry
This commit is contained in:
121
README.md
Normal file
121
README.md
Normal file
@@ -0,0 +1,121 @@
|
||||
# K8s Game 2048
|
||||
|
||||
A Kubernetes deployment of the classic 2048 game using Knative Serving with Kourier ingress controller.
|
||||
|
||||
## Features
|
||||
|
||||
- **Knative Serving**: Serverless deployment with scale-to-zero capability
|
||||
- **Kourier Gateway**: Lightweight ingress controller for Knative
|
||||
- **Multi-environment**: Development, Staging, and Production deployments
|
||||
- **Custom Domains**: Environment-specific domain configuration
|
||||
- **GitOps Workflow**: Complete CI/CD pipeline with GitHub Actions
|
||||
|
||||
## Environments
|
||||
|
||||
- **Development**: `2048-dev.wa.darknex.us`
|
||||
- **Staging**: `2048-staging.wa.darknex.us`
|
||||
- **Production**: `2048.wa.darknex.us`
|
||||
|
||||
## Architecture
|
||||
|
||||
```
|
||||
┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐
|
||||
│ Kourier │ │ Knative │ │ 2048 Game │
|
||||
│ Gateway │───▶│ Service │───▶│ Container │
|
||||
│ │ │ │ │ │
|
||||
└─────────────────┘ └─────────────────┘ └─────────────────┘
|
||||
```
|
||||
|
||||
## Quick Start
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- Kubernetes cluster (1.21+)
|
||||
- Knative Serving installed
|
||||
- Kourier as the networking layer
|
||||
- kubectl configured
|
||||
- Domain DNS configured to point to Kourier LoadBalancer
|
||||
|
||||
### Installation
|
||||
|
||||
1. Clone the repository:
|
||||
```bash
|
||||
git clone https://github.com/ghndrx/k8s-game-2048.git
|
||||
cd k8s-game-2048
|
||||
```
|
||||
|
||||
2. Deploy to development:
|
||||
```bash
|
||||
kubectl apply -f manifests/dev/
|
||||
```
|
||||
|
||||
3. Deploy to staging:
|
||||
```bash
|
||||
kubectl apply -f manifests/staging/
|
||||
```
|
||||
|
||||
4. Deploy to production:
|
||||
```bash
|
||||
kubectl apply -f manifests/prod/
|
||||
```
|
||||
|
||||
## Project Structure
|
||||
|
||||
```
|
||||
k8s-game-2048/
|
||||
├── README.md
|
||||
├── Dockerfile
|
||||
├── .github/
|
||||
│ └── workflows/
|
||||
│ ├── deploy-dev.yml
|
||||
│ ├── deploy-staging.yml
|
||||
│ └── deploy-prod.yml
|
||||
├── manifests/
|
||||
│ ├── dev/
|
||||
│ │ ├── namespace.yml
|
||||
│ │ ├── service.yml
|
||||
│ │ └── domain-mapping.yml
|
||||
│ ├── staging/
|
||||
│ │ ├── namespace.yml
|
||||
│ │ ├── service.yml
|
||||
│ │ └── domain-mapping.yml
|
||||
│ └── prod/
|
||||
│ ├── namespace.yml
|
||||
│ ├── service.yml
|
||||
│ └── domain-mapping.yml
|
||||
├── scripts/
|
||||
│ ├── setup-knative.sh
|
||||
│ ├── setup-kourier.sh
|
||||
│ └── deploy.sh
|
||||
└── src/
|
||||
└── (2048 game files)
|
||||
```
|
||||
|
||||
## Deployment
|
||||
|
||||
The application uses Knative Serving with the following features:
|
||||
|
||||
- **Scale to Zero**: Automatically scales down to 0 when not in use
|
||||
- **Auto-scaling**: Scales up based on incoming requests
|
||||
- **Blue-Green Deployments**: Safe deployment strategy with traffic splitting
|
||||
- **Custom Domains**: Environment-specific domain mapping
|
||||
|
||||
## Monitoring
|
||||
|
||||
Each environment includes:
|
||||
|
||||
- Knative Service status monitoring
|
||||
- Request metrics via Knative
|
||||
- Custom domain health checks
|
||||
|
||||
## Contributing
|
||||
|
||||
1. Fork the repository
|
||||
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
|
||||
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
|
||||
4. Push to the branch (`git push origin feature/amazing-feature`)
|
||||
5. Open a Pull Request
|
||||
|
||||
## License
|
||||
|
||||
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
||||
Reference in New Issue
Block a user