TL;DR: DevStream (CLI tool named dtm) is an open-source DevOps toolchain manager.
Imagine you are in a new project. Before writing the first line of code, you would have to figure out the tools needed in the whole Software Development Life Cycle (SDLC). You would probably need the following pieces:
- some kind of project management software or issue tracking tools (e.g., Jira);
- someplace for source code management (GitHub and alike);
- some tools for continuous integration (e.g., Jenkins, GitHub Actions, CircleCI, Travis CI);
- some tools for continuous delivery or continuous deployment (e.g., fluxcd/flux2, ArgoCD, etc.);
- someplace serving as the single source of truth for secrets and credentials (secrets manager, e.g., Vault by HashiCorp);
- some tools for centralized logging and monitoring (for example, ELK, Prometheus/Grafana);
And maybe more. The list could go on for quite a bit.
And, there are multiple challenges in creating YOUR ideal SDLC workflow:
- There are too many choices. Even for a particular field, there are too many. Which is best? There is no "one-size-fits-all" answer because it totally depends.
- Integration between different pieces.
- The software world (and the DevOps world) changes and it changes fast. What's best for today might not be the best tomorrow. You want to switch some parts out and get some new state-of-the-art pieces in so that you always keep your efficiency high.
To be fair, there are a few integrated products out there that may contain everything you might need, but they might not suit your specific requirements perfectly. So, the chance is, you will still want to go out and do your research, find the best pieces for you, and integrate them. And, it would be a lot of operational overhead if all you had to do all day was install and uninstall and integrate things.
You probably have already seen where we are going with this, and you are right: DevStream, an open-source DevOps toolchain manager, aims to be the solution here.
Think of the Linux kernel V.S. different distributions. Different distros offer different packages so that you can always choose the best for your need.
Or, Think of yum, apt, or apk. You can easily set it up with your favorite packages for any new environment using these package managers.
DevStream aims to be the package manager for DevOps tools. To be more ambitious, DevStream wants to be the Linux kernel, around which different distros can be created with various components so that you can always have the best components for each part of your SDLC workflow.
No more manual curl/wget download, apt install, helm install; no more local experiments and playing around just to get a piece of tool installed correctly.
Define your wanted DevOps tools in a single human-readable YAML config file, and at the press of a button (one single command), you will have your whole DevOps toolchain and SDLC workflow set up.
Want to install another different tool for a try? No problem. Want to remove or reinstall a specific piece in the whole workflow? Got your back.
| Type | Plugin | Note |
|---|---|---|
| Issue Tracking | trello-github-integ | Trello/GitHub integratoin |
| Source Code Management | github-repo-scaffolding-golang | Go WebApp scaffolding |
| CI | jenkins | Jenkins installation |
| CI | githubactions-golang | GitHub Actions CI for Golang |
| CI | githubactions-python | GitHub Actions CI for Python |
| CI | githubactions-nodejs | GitHub Actions CI for Nodejs |
| CI | gitlabci-golang | GitLab CI for Golang |
| CD/GitOps | argocd | ArgoCD installation |
| CD/GitOps | argocdapp | ArgoCD Application creation |
| Monitoring | kube-prometheus | Prometheus/Grafana K8s install |
| DevLake | devlake | DevLake installation |
Download the appropriate dtm version for your platform from DevStream Releases.
Once downloaded, you can run the binary from anywhere. You don’t need to install it into a global location.
Ideally, you should install it somewhere in your PATH(eg: /usr/local/bin) for easy use.
Remember to rename the binary file to dtm(eg: mv dtm-$(go env GOOS)-$(go env GOARCH) dtm).
- Git
- Go (1.17+)
mkdir -p ~/gocode
cd ~/gocode
git clone https://github.com/merico-dev/stream.gitcd ~/gocode/stream
make build
mv dtm-$(go env GOOS)-$(go env GOARCH) dtmSee the Makefile for more info.
$ make help
Usage:
make <target>
help Display this help.
build Build dtm & plugins locally.
build-core Build dtm core only, without plugins, locally.
build-linux-amd64 Cross-platform build for linux/amd64
fmt Run 'go fmt' & goimports against code.
vet Run go vet against code.
e2e Run e2e tests.
e2e-up Start kind cluster for e2e tests
e2e-down Stop kind cluster for e2e testsRun unit tests:
go test ./...Run e2e tests:
make e2eSee examples/config.yaml.
To apply the config, run:
./dtm apply -f examples/config.yamldtm will compare the config, the state, and the resources to decide whether a "create", "update", or "delete" is needed.
The command above will ask you for confirmation before actually executing the changes. To apply without confirmation (like apt-get -y update), run:
./dtm -y apply -f examples/config.yamlTo delete everything defined in the config, run:
./dtm delete -f examples/config.yamlNote that this deletes everything defined in the config. If some config is deleted after apply (state has it but config not), dtm delete won't delete it. It differs from dtm destroy which will be implemented soon.
Similarly, to delete without confirmation:
./dtm -y delete -f examples/config.yamlTo verify, run:
./dtm verify -f examples/config.yamlSee docs/architecture.md.
Q: The CLI tool is named dtm, while the tool itself is called DevStream. What the heck?! Where is the consistency?
A: Inspired by git, the name is (depending on your mood):
- a symmetric, scientific acronym of devstream.
- "devops toolchain manager": you're in a good mood, and it actually works for you.
- "dead to me": when it breaks.
See CONTRIBUTING.md.