https://github.com/mwarkentin/gatekeeper
Gatekeeper is a service that lets you temporarily mark an environment as locked for deployment.
https://github.com/mwarkentin/gatekeeper
Last synced: about 1 year ago
JSON representation
Gatekeeper is a service that lets you temporarily mark an environment as locked for deployment.
- Host: GitHub
- URL: https://github.com/mwarkentin/gatekeeper
- Owner: mwarkentin
- Created: 2012-09-01T02:17:28.000Z (almost 14 years ago)
- Default Branch: master
- Last Pushed: 2019-01-10T20:23:18.000Z (over 7 years ago)
- Last Synced: 2025-02-05T23:57:16.739Z (over 1 year ago)
- Language: Python
- Homepage: http://mwarkentin.github.io/gatekeeper/
- Size: 29.3 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
gatekeeper
==========
Gatekeeper is a service that lets you temporarily mark an environment as locked for deployment.
Usage
-----
### List all environment locks
```
GET /locks/
```
#### Response
Status **200 OK**
```
{
"locks": [
{
"environment": "acct-dev",
"owner": "mwarkentin",
"message": "Testing CDN",
"since": "2012-09-03 16:10:29.165004"
},
{
"environment": "acct-stage",
"owner": "dlanger",
"message": "Testing weekly email fix branch",
"since": "2012-09-03 15:53:46.717481"
},
{
"environment": "acct-prod",
"owner": "dlanger",
"message": "Testing weekly email fix branch",
"since": "2012-09-03 15:52:52.008120"
}
]
}
```
### Get the status of a single environment lock
```
GET /locks/:environment/
```
#### Response
Status **200 OK**
```
{
"environment": "acct-stage",
"owner": "dlanger",
"message": "Testing weekly email fix branch",
"since": "2012-09-03 15:53:46.717481"
}
```
#### No such environment response
Status **404 Not Found**
### Lock an environment
```
POST /locks/:environment/
```
#### Parameters
**user**
*Required* **string** - User who locked the environment.
**message**
*Optional* **string** - Description of why the environment has been locked.
```
{
"user": "mwarkentin",
"message": "Testing CDN"
}
```
#### Successful response
Status **200 OK**
```
{
'environment': 'acct-dev',
'owner': 'mwarkentin',
'message': 'Testing CDN',
'since': '2012-09-03 16:10:29.165004'
}
```
#### Already locked response
Status **409 Conflict**
### Unlock an environment
```
DELETE /locks/:environment/
```
#### Successful response
Status **200 OK**
#### Already unlocked response
Status **404 Not Found**