Initialisation depot
This commit is contained in:
67
arti-api/auth-service/pipeline/PIPELINE-README.md
Normal file
67
arti-api/auth-service/pipeline/PIPELINE-README.md
Normal file
@@ -0,0 +1,67 @@
|
||||
# Pipeline Configuration Files
|
||||
|
||||
This folder contains all Drone CI pipeline-related configuration files and scripts.
|
||||
|
||||
## 📁 **File Organization**
|
||||
|
||||
### **🔧 Jsonnet Configuration**
|
||||
- `common.libsonnet` - Shared pipeline components (steps, environment, triggers)
|
||||
- `build-steps.libsonnet` - Build-specific logic (external Buildah integration)
|
||||
|
||||
### **🚀 Management Scripts**
|
||||
- `manage-external-buildah.sh` - External Buildah service management
|
||||
- `update-buildah-pod.sh` - Auto-update pod references in configurations
|
||||
- `deploy-external-buildah.sh` - Complete deployment automation
|
||||
- `convert-to-jsonnet.sh` - Migration helper from YAML to Jsonnet
|
||||
|
||||
### **⚙️ Kubernetes Resources**
|
||||
- `buildah-external-deployment.yaml` - External Buildah service deployment
|
||||
- `buildah-rbac.yaml` - RBAC for Buildah operations
|
||||
- `drone-build-rbac.yaml` - RBAC for Drone build steps
|
||||
- `default-sa-binding.yaml` - Service account permissions
|
||||
- `drone-configmap-updated.yaml` - Drone server configuration with Jsonnet support
|
||||
|
||||
### **📋 Alternative Configurations**
|
||||
- Various `.drone.yml.*` files - Alternative pipeline configurations for reference
|
||||
- `.drone.star.example` - Starlark configuration example (not used)
|
||||
|
||||
### **📚 Documentation**
|
||||
- `EXTERNAL-BUILDAH-SYSTEM.md` - External build system documentation
|
||||
- `JSONNET-GUIDE.md` - Jsonnet usage guide
|
||||
- Other analysis and guide files
|
||||
|
||||
## 🔄 **Usage Workflow**
|
||||
|
||||
1. **Edit Configuration**: Modify `common.libsonnet` or `build-steps.libsonnet`
|
||||
2. **Test Locally**: `cd .. && jsonnet .drone.jsonnet`
|
||||
3. **Deploy**: Commit and push changes
|
||||
4. **Manage**: Use scripts in this folder for maintenance
|
||||
|
||||
## 🎯 **Key Benefits**
|
||||
|
||||
- **🧩 Organized Structure**: All pipeline files in one place
|
||||
- **🔄 Modular Design**: Separate concerns and reusable components
|
||||
- **📝 Easy Maintenance**: Clear file organization and documentation
|
||||
- **🛠️ Management Tools**: Complete set of automation scripts
|
||||
|
||||
## 📖 **Quick Start**
|
||||
|
||||
```bash
|
||||
# Test current configuration
|
||||
cd .. && jsonnet .drone.jsonnet
|
||||
|
||||
# Check external Buildah status
|
||||
./manage-external-buildah.sh status
|
||||
|
||||
# Deploy complete system
|
||||
./deploy-external-buildah.sh
|
||||
|
||||
# Update pod references after restarts
|
||||
./update-buildah-pod.sh
|
||||
```
|
||||
|
||||
## 🔗 **Related Files**
|
||||
|
||||
- `../.drone.jsonnet` - Root-level entry point (imports from this folder)
|
||||
- `../Dockerfile` - Application container definition
|
||||
- `../requirements.txt` - Application dependencies
|
||||
Reference in New Issue
Block a user