engine

command
v0.53.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 26, 2024 License: BSD-3-Clause Imports: 59 Imported by: 0

README

CDS Engine

This is the core component of CDS.

This component is responsible and is the entry point to several µServices such as:

  • API
  • VCS
  • Hooks
  • Repositories
  • ElasticSearch
  • Migrate
  • CDN
  • Hatcheries

The API component is the core component and is mandatory in every setups.

To start CDS API, the mandatory dependencies are a PostgreSQL database, a Redis Server and a path to the directory containing other CDS binaries, for serious usages you may need other third parties Read more

Configuration

There are two ways to set up CDS:

  • with toml configuration
  • with environment variables.

Read more

Startup

A docker-compose file is provided for light deployment and dev environments, follow this guide.

For larger deployments you have to go deeper and read this advanced startup page.

Database management

CDS provides all needed tools scripts to perform Schema creation and auto-migration. Those tools are embedded inside the engine binary.

The migration files are available to download on GitHub Releases and the archive is named sql.tar.gz. You have to download it and untar (tar xvzf sql.tar.gz).

Read more

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
api
cdn
services/mock_services
Package mock_services is a generated GoMock package.
Package mock_services is a generated GoMock package.
vcs
cdn
lru
mock_elasticsearch
Package mock_elasticsearch is a generated GoMock package.
Package mock_elasticsearch is a generated GoMock package.
vsphere/mock_vsphere
Package mock_vsphere is a generated GoMock package.
Package mock_vsphere is a generated GoMock package.
vcs
pkg/workerruntime/mock_workerruntime
Package mock_workerruntime is a generated GoMock package.
Package mock_workerruntime is a generated GoMock package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL