Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/appvia/tako
Develop Kubernetes apps iteratively with Docker-Compose
https://github.com/appvia/tako
compose deployment development docker docker-compose kubernetes manifests
Last synced: 5 days ago
JSON representation
Develop Kubernetes apps iteratively with Docker-Compose
- Host: GitHub
- URL: https://github.com/appvia/tako
- Owner: appvia
- License: apache-2.0
- Created: 2020-03-18T08:12:37.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-10-18T18:19:07.000Z (about 1 year ago)
- Last Synced: 2024-06-22T08:36:21.304Z (6 months ago)
- Topics: compose, deployment, development, docker, docker-compose, kubernetes, manifests
- Language: Go
- Homepage:
- Size: 15.2 MB
- Stars: 60
- Watchers: 9
- Forks: 6
- Open Issues: 39
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Tako :octopus:
> Develop Kubernetes apps iteratively with Docker-Compose
Tako helps developers port and iterate Docker Compose apps onto Kubernetes. It understands the Docker Compose application topology and prepares it for deployment in (multiple) target environments, with minimal user input.
We leverage the [Docker Compose](https://docs.docker.com/compose/compose-file/) specification and allow for target-specific configurations to be applied to each component of the application stack, simply.
Tako is opinionated in its choice of Kubernetes elements you should be able to control. It automatically infers key config parameters by analysing and reconciling changes in the project source compose file(s). The configuration parameters can be manually overridden to allow for better control of a cloud application deployment on Kubernetes.
Tako reduces the need for Kubernetes expertise in the team. The generated Kubernetes deployment configuration follows best industry practices, with a thin layer of config options to enable further control. See [tako reference documentation](docs/reference/config-params.md) for a list of available options.
## Features
* **Simplicity** - Based on the familiar Docker Compose specification. There is no new framework to learn, no new specification to embrace, and vastness of Kubernetes reduced to a limited set of easy to follow configuration parameters. You focus on the app development. Tako will prepare it for deployment in Kubernetes.
* **Multi-environment support** - Parameterisation enabled with the same configuration primitives you're already familiar with. Each defined environment gets its own docker-compose override file, which is there to control the behaviour of your application in Kubernetes in a simple and consistent way.
* **Best practice out of the box** - Best practice is codified and embedded in the translation layer, so you don't have to think about what's required to run your project application on Kubernetes.
* **Secure** - Tako is opinionated about the secret management. At this stage of its relatively short life it delegates that responsibility to the user, to remove the risk of potential uncontrolled secrets leak. No secrets == No leaks!
* **No vendor lock-in** - Because you already use docker-compose, you can keep using it, even if Tako turns out to be not your cup of tea.
* **Easy integrations** - You may use generated Kubernetes manifests with any tool / framework of your choice. Check out our [Skaffold Integration](docs/tutorials/tako-dev-with-skaffold.md).
## Contents
- **[Installation](#installation)**
- **[Quickstart](docs/tutorials/quickstart-guide.md)**
* **[Initialise project](docs/tutorials/quickstart-guide.md#initialise-project)**
* **[Generate Kubernetes manifests](docs/tutorials/quickstart-guide.md#generate-kubernetes-manifests)**
- **[Tutorials & guides](#tutorials-and-guides)**
- **[Configuration](#configuration)**
- **[Similar tools](#similar-tools)**
- **[Contributing to Tako](#contributing-to-tako)**
- **[Roadmap](#roadmap)**
- **[License](#license)**
## Installation
All you need to get started quickly is the [tako](https://github.com/appvia/tako/releases) binary added to your PATH, and one or more docker compose files.
## Tutorials and guides
- [How does Tako differ from Kompose?](docs/tutorials/how-tako-differs-from-kompose.md)
- [Getting started with Tako](docs/tutorials/getting-started-with-tako.md)
- [Develop the app with Tako and Skaffold](docs/tutorials/tako-dev-with-skaffold.md)
- [Simple Node.js app development workflow example](docs/tutorials/simple-nodejs-app-workflow.md)
- [Simple Node.js app CI workflow example](docs/tutorials/simple-nodejs-app-ci-workflow.md)
## Configuration
As mentioned in the [Quickstart](docs/tutorials/quickstart-guide.md), the environment specific configuration lives in a set of docker-compose override files. Each environment override file holds simplified Kubernetes configuration parameters for each of the application components.
Project components (aka services) are configured via a set of labels attached to them, and optionally environment variables section which allows for localised adjustments - the same exact way you'd control those in a regular docker-compose file.
Volumes come with their own set of labels to control Kubernetes storage specific parameters.
See the [configuration reference](docs/reference/config-params.md) for details.
## Similar tools
Tako is inspired by the simple, easy to use and well adopted Docker Compose specification, as well as several other tools in the Kubernetes manifests generation and templating space such as Kompose, Ksonnet and Kustomize, to name a few.
See how [Tako differs from Kompose.](docs/tutorials/how-tako-differs-from-kompose.md)
Each of the solutions above, however, come with their own set of challenges and are lacking in various areas. Some have been discontinued, some see very few contributions or updates, others require a great deal of prior Kubernetes expertise to find them useful.
Tako bridges the gaps in the existing tooling, helping developers familiar with Docker & Compose to easily get up and running with Kubernetes.
## Contributing to Tako
We welcome any contributions from the community! Have a look at our [contribution](CONTRIBUTING.md) guide for more information on how to get started. If you use Tako, find it useful, or are generally interested in improving Developer Experience on Kubernetes then please let us know by **Starring** and **Watching** this repo. Thanks!
## Get Involved
Join discussion on our [Community channel](https://www.appvia.io/join-the-appvia-community).
Tako is a community project and we welcome your contributions. To report a bug, suggest an improvement, or request a new feature please open a Github issue. Refer to our [contributing](CONTRIBUTING.md) guide for more information on how you can help.
## Roadmap
See our [Roadmap][roadmap] for details about our plans for the project.
## License
Copyright (c) 2020-2021 [Appvia Ltd](https://appvia.io)
This project is distributed under the [Apache License, Version 2.0](./LICENSE).
[roadmap]: https://github.com/appvia/tako/issues