Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gtroshin/pipeline-api
https://github.com/gtroshin/pipeline-api
Last synced: 1 day ago
JSON representation
- Host: GitHub
- URL: https://github.com/gtroshin/pipeline-api
- Owner: gtroshin
- Created: 2024-10-01T08:45:00.000Z (4 months ago)
- Default Branch: master
- Last Pushed: 2024-10-08T16:29:06.000Z (4 months ago)
- Last Synced: 2024-11-22T14:26:36.033Z (2 months ago)
- Language: Python
- Size: 30.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CI/CD Pipeline API
[](https://github.com/gtroshin/pipeline-api/actions/workflows/ci.yml)
This is a simple CI/CD pipeline app built using Flask. It allows users to create, retrieve, update, delete, and trigger pipelines. This project also includes a CLI for interacting with the API.
## Prerequisites
- Python 3.8+
## Dependencies
You can install the dependencies using pip (it is highly recommended to use a virtual environment):
```bash
python -m venv venv
source venv/bin/activate
pip install -r requirements.txt
```
To deactivate the virtual environment, run:
```bash
deactivate
```
## Environment Variables
Create a `.env` file in root directory of project and add necessary environment variables (example):
```plaintext
API_KEY=api_key
API_URL=http://127.0.0.1:5000
```
## Running Tests
To run the unit tests, use the following command:
```bash
python -m unittest discover -s tests
```
## Running the API
To run the app locally, use the following command:
```bash
python run.py
```
The app will run on `http://127.0.0.1:5000`.
## App Example Usage
### Create a New Pipeline
```bash
curl -X POST http://127.0.0.1:5000/pipelines -H "Content-Type: application/json" -H "Authorization: Bearer api_key" -d '{
"stages": [
{
"type": "run",
"command": "echo \"Running tests\""
},
{
"type": "build",
"dockerfile": "Dockerfile"
},
{
"type": "deploy",
"manifest": "k8s/deployment.yaml"
}
]
}'
```
### Update an Existing Pipeline
```bash
curl -X PUT http://127.0.0.1:5000/pipelines/1 -H "Content-Type: application/json" -H "Authorization: Bearer api_key" -d '{
"stages": [
{
"type": "run",
"command": "echo \"Running updated tests\""
},
{
"type": "build",
"dockerfile": "UpdatedDockerfile"
},
{
"type": "deploy",
"manifest": "k8s/updated_deployment.yaml"
}
]
}'
```
### Retrieve an Existing Pipeline by ID
```bash
curl -X GET http://127.0.0.1:5000/pipelines/1 -H "Authorization: Bearer api_key"
```
### Trigger the Execution of a Pipeline
```bash
curl -X POST http://127.0.0.1:5000/pipelines/1/trigger -H "Authorization: Bearer api_key"
```
### Delete a Pipeline
```bash
curl -X DELETE http://127.0.0.1:5000/pipelines/1 -H "Authorization: Bearer api_key"
```
## Install `cicd-cli` CLI locally
Run the following command while at the project root to install the CLI:
```bash
pip install -e .
```
To uninstall the CLI, run:
```bash
pip uninstall cicd-cli
```
## CLI Example Usage
### Show help
```bash
cicd-cli help
```
### Create a New Pipeline
```bash
cicd-cli create-pipeline '{"stages": [{"type": "run", "command": "echo \"Running tests\""}, {"type": "build", "dockerfile": "Dockerfile"}, {"type": "deploy", "manifest": "k8s/deployment.yaml"}]}'
```
### Retrieve an Existing Pipeline by ID
```bash
cicd-cli get-pipeline 1
```
### Update an Existing Pipeline
```bash
cicd-cli update-pipeline 1 '{"stages": [{"type": "run", "command": "echo \"Running updated tests\""}, {"type": "build", "dockerfile": "UpdatedDockerfile"}, {"type": "deploy", "manifest": "k8s/updated_deployment.yaml"}]}'
```
### Trigger the Execution of a Pipeline
```bash
cicd-cli trigger-pipeline 1
```
### Delete a Pipeline
```bash
cicd-cli delete-pipeline 1
```