An open API service indexing awesome lists of open source software.

https://github.com/syntho-ai/deployment-tools

Syntho Application application deployment specification for Docker Compose, Kubernetes and Helm and our own cli.
https://github.com/syntho-ai/deployment-tools

docker docker-compose helm-charts kubernetes kubernetes-deployment

Last synced: 3 months ago
JSON representation

Syntho Application application deployment specification for Docker Compose, Kubernetes and Helm and our own cli.

Awesome Lists containing this project

README

          





Logo

Syntho Deployment Tools


Monorepo containing all deployment related tools: Deployment CLI, Helm Charts, Docker Compose files


Explore the docs »



Table of Contents


  1. Usage


  2. Getting Started



  3. Getting Started


  4. Releasing



  5. Contact

## Usage

### Docker Compose

_The Docker Compose documentation can be found in the Syntho [Documentation](https://docs.syntho.ai/deploy-syntho/deploy-syntho-using-docker)_

(back to top)

### Helm charts

_The Helm chart documentation can be found in the Syntho [Documentation](https://docs.syntho.ai/deploy-syntho/deploy-syntho-using-kubernetes)_

(back to top)

## Getting Started

A few things have been implemented for this project:

- Pre-commit hooks in order to check your files
- A VScode workspace file to correctly create VSCode workspaces
- The Docker Compose file and Helm charts to deploy the Syntho Application with
- The source code of the Syntho CLI (The deployment CLI for the Syntho Application)

### Project overview

```
deployment-tools
│ README.md
|
└───cli
|
└───docker-compose
│ └───config
│ └───postgres
|
└───helm
│ └───config
│ └───ray
│ └───syntho-ui

```
## Syntho CLI

### Prerequisites

* Install `Python 11.*` or higher and make sure it is the default one

### Installation

1. Clone the repo
```sh
git clone https://github.com/syntho-ai/deployment-tools.git
```
2. Install [Poetry](https://python-poetry.org/docs/#installing-with-the-official-installer)
```sh
curl -sSL https://install.python-poetry.org | python3 -
```
3. Install Python packages in root
```sh
poetry install --no-root
```
4. Run pre-commit install:
```sh
pre-commit install
```

(back to top)

## Releasing

This project uses [commitizen](https://commitizen-tools.github.io/commitizen/) to bump the version and create a new release. For every commit on main, we check whether a release can be created by seeing in any commits were made that either increase the patch, minor or major version. If that's the case, a Github release will be created with the new version and the changelog. After that, the Syntho CLI wheel will be uploaded to PyPI.

(back to top)

## Contact

Syntho B.V. - info@syntho.ai

(back to top)

[contributors-shield]: https://img.shields.io/github/contributors/syntho-ai/deployment-tools.svg?style=for-the-badge
[contributors-url]: https://github.com/syntho-ai/deployment-tools/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/syntho-ai/deployment-tools.svg?style=for-the-badge
[forks-url]: https://github.com/syntho-ai/deployment-tools/network/members
[stars-shield]: https://img.shields.io/github/stars/syntho-ai/deployment-tools.svg?style=for-the-badge
[stars-url]: https://github.com/syntho-ai/deployment-tools/stargazers
[issues-shield]: https://img.shields.io/github/issues/syntho-ai/deployment-tools.svg?style=for-the-badge
[issues-url]: https://github.com/syntho-ai/deployment-tools/issues
[license-shield]: https://img.shields.io/github/license/syntho-ai/deployment-tools.svg?style=for-the-badge
[license-url]: https://github.com/syntho-ai/deployment-tools/blob/master/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/linkedin_username
[product-screenshot]: images/demo_screenshot.png
[Next.js]: https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white
[Next-url]: https://nextjs.org/
[React.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB
[React-url]: https://reactjs.org/
[Vue.js]: https://img.shields.io/badge/Vue.js-35495E?style=for-the-badge&logo=vuedotjs&logoColor=4FC08D
[Vue-url]: https://vuejs.org/
[Angular.io]: https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular&logoColor=white
[Angular-url]: https://angular.io/
[Svelte.dev]: https://img.shields.io/badge/Svelte-4A4A55?style=for-the-badge&logo=svelte&logoColor=FF3E00
[Svelte-url]: https://svelte.dev/
[Laravel.com]: https://img.shields.io/badge/Laravel-FF2D20?style=for-the-badge&logo=laravel&logoColor=white
[Laravel-url]: https://laravel.com
[Bootstrap.com]: https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white
[Bootstrap-url]: https://getbootstrap.com
[JQuery.com]: https://img.shields.io/badge/jQuery-0769AD?style=for-the-badge&logo=jquery&logoColor=white
[JQuery-url]: https://jquery.com
[Python.org]: https://img.shields.io/badge/Python-14354C?style=for-the-badge&logo=python&logoColor=white
[Python-url]: [https://www.python.org/]
[Django]: https://img.shields.io/badge/Django-092E20?style=for-the-badge&logo=django&logoColor=white
[Django-url]: https://www.djangoproject.com/
[Fastapi]: https://img.shields.io/badge/FastAPI-009688?style=for-the-badge&logo=FastAPI&logoColor=white
[Fastapi-url]: https://fastapi.tiangolo.com/