Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cpg1111/maestro
Faster CI/CD for multi-artifact projects
https://github.com/cpg1111/maestro
build-automation build-pipelines builder continuous-delivery continuous-deployment continuous-integration maestro
Last synced: 3 days ago
JSON representation
Faster CI/CD for multi-artifact projects
- Host: GitHub
- URL: https://github.com/cpg1111/maestro
- Owner: cpg1111
- License: apache-2.0
- Created: 2016-04-18T02:58:47.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-05-21T21:38:33.000Z (over 7 years ago)
- Last Synced: 2024-06-20T16:50:18.783Z (5 months ago)
- Topics: build-automation, build-pipelines, builder, continuous-delivery, continuous-deployment, continuous-integration, maestro
- Language: Go
- Homepage:
- Size: 146 KB
- Stars: 13
- Watchers: 4
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# maestro
Deploy only what's changed for your multiple services in mono-repos
[](https://goreportcard.com/report/github.com/cpg1111/maestro) [](https://codeclimate.com/github/cpg1111/maestro)
## How it Works
Maestro pulls a given repository then builds a dependency graph based on a given config file.
Once the dependency graph is created, Maestro diffs against a given previous commit, with the pathspec being the root directory for each artifact.
Maestro then flags only the changed artifacts for the pipeline, which are then ran concurrently per teir of dependencies, therefore siblings in the graph will build, test and deploy concurrently, but parents and children dependencies will always be built in the correct order.
Used with [Maestrod](https://github.com/cpg1111/maestrod) you can have a build manager that integrates with Github webhooks and runs on Kubernetes or a single-host Docker setup.
For more details see this talk: https://www.youtube.com/watch?v=dGM8mYj8nz4&feature=youtu.be
## Install
```
git clone [email protected]:cpg1111/maestro
cd maestro
make docker
```
or
```
docker pull cpg1111/maestro:
```
## Test
```
go test ./...
```
## Run
```
Usage of maestro:
--branch string
Git branch to checkout for project (default "master")
--clone-path string
Local path to clone repo to defaults to PWD (default "./")
--config string
Path to the config for maestro to use (default "./conf.toml")
--deploy
Whether or not to deploy this build # defaults to false
--prev-commit string
Previous commit to compare to # required
```
```
maestro --branch --conf --prev-commit --deploy --clone-path
```
or
```
docker run -v : -v : maestro --branch --conf --prev-commit --deploy --clone-path
```
## Example Config
```
[Environment] # Environment will run before anything else, ExecSync will execute commands in the array synchronously, while exec will execute them concurrently
Env=["node_env:test", "docker_tls_verify:1"] # set environment variables all lowercase keys and keys are separated from values with ':'
ExecSync=["apt-get install -y docker node go"]
Exec=["docker pull someOrg/logger", "docker pull someOrg/models", "docker pull someOrg/auth", "docker pull someOrg/client"]
[Project]
RepoURL="[email protected]:someOrg/someRepo.git"
CloneCMD="git clone"
AuthType="SSH"
SSHPrivKeyPath="~/.ssh/id_rsa"
SSHPubKeyPath="~/.ssh/id_rsa.pub"
Username="git" # github's ssh user is git, but this can vary
Password=""
PromptForPWD=false # when requiring a password, you prompt for a password
[[Services]] # Services are either actual services or libraries / packages / separately compiled objects
Name="logger"
Tag="0.1.0"
TagType="git"
Path="./src/logger"
BuildCMD=["docker build -t logger ."] # '.' is relative to the given path field of the service
TestCMD=["go test ./..."]
CheckCMD=["bash -c 'docker images -a | grep logger'"]
CreateCMD=[
"docker tag logger /logger:{{.Curr}}",
"docker push /logger:{{.Curr}}"
]
UpdateCMD=[
"docker tag logger /logger:{{.Curr}}", # {{.Curr}} will template the current commit hash into the command
"docker push /logger:{{.Curr}}"
]
DependsOn=[]
[[Services]]
Name="models"
Tag="0.1.0"
TagType="git"
Path="./src/models"
BuildCMD=["docker build -t models ."]
TestCMD=["go test ./..."]
CheckCMD=["bash -c 'docker images -a | grep models'"]
CreateCMD=[
"docker tag models /models:{{.Curr}}",
"docker push /models:{{.Curr}}"
]
UpdateCMD=[
"docker tag models /models:{{.Curr}}",
"docker push /models:{{.Curr}}"
]
DependsOn=["logger"] # Assume Dockerfile contains FROM logger
[[Services]]
Name="auth"
Tag="0.1.0"
TagType="git"
Path="./src/auth"
BuildCMD=["docker build -t auth ."]
TestCMD=["go test ./..."]
CheckCMD=["bash -c 'docker ps -a | grep auth'"]
CreateCMD=[
"docker tag auth /auth:{{.Curr}}",
"docker tag auth /auth:{{.Curr}}",
"docker run --rm -d /auth:{{.Curr}}"
]
UpdateCMD=[
"docker tag auth /auth:{{.Curr}}",
"docker tag auth /auth:{{.Curr}}",
"docker run --rm -d /auth:{{.Curr}}"
]
DependsOn=["models"] # Assume Dockerfile contains FROM models
[[Services]]
Name="client"
Tag="0.1.0"
TagType="git"
Path="./src/client"
BuildCMD=["docker build -t client ."]
TestCMD=["npm test"]
CheckCMD=["bash -c 'docker ps -a | grep client'"]
CreateCMD=[
"docker tag client /client:{{.Curr}}",
"docker push /client:{{.Curr}}",
"docker run --rm -d /client:{{.Curr}}"
]
UpdateCMD=[
"docker tag client /client:{{.Curr}}",
"docker push /client:{{.Curr}}",
"docker run --rm -d /client:{{.Curr}}"
]
DependsOn=[]
[CleanUp]
AdditionalCMDs=["docker inspect auth", "docker export -o ./dist/auth.tgz auth"] # Will execute synchronously
InDaemon=false # COMING SOON for maestrod
[[CleanUp.Artifacts]] # Artifacts are saved concurrently
RuntimeFilePath="./dist/auth.tgz"
SaveFilePath="/opt/data/auth.tgz"
```
## Roadmap
- Allow larger log buffers
- More possible dependency structures
- Encrypted Environment variable values
- Log Versbosity control
- Debug with bash session
### Daemon
See [this](https://github.com/cpg1111/maestrod) (https://github.com/cpg1111/maestrod) for a manager daemon for handling git push hooks and multiple concurrent builds and repos.
### Warning
Some dependency structures are not supported yet. Best to refer to immediate dependencies only and avoid circlular references.