Skip to content

Latest commit

 

History

History
186 lines (148 loc) · 7 KB

README.md

File metadata and controls

186 lines (148 loc) · 7 KB
Raw


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
  6. Contact

Usage

Docker Compose

The Docker Compose documentation can be found in the Syntho Documentation

(back to top)

Helm charts

The Helm chart documentation can be found in the Syntho Documentation

(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 
    git clone https://github.com/syntho-ai/deployment-tools.git
  2. Install Poetry 
    curl -sSL https://install.python-poetry.org | python3 -
  3. Install Python packages in root 
    poetry install --no-root
  4. Run pre-commit install: 
    pre-commit install

(back to top)

Releasing

This project uses 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)