Drycc workflow

Drycc Workflow is an open source Container as a Service (CaaS) that adds a developer-friendly layer to any Kubernetes cluster, making it easy to deploy and manage applications.

To get started with Drycc Workflow please read the Quick Start Guide.

Visit https://www.drycc.cc for more information on why you should use Drycc Workflow or learn about its features.

This repository contains the source code for Drycc Workflow documentation. If you're looking for individual components, they live in their own repositories.

Please see below for links and descriptions of each component:

• passport - Workflow single sign on system
• controller - Workflow API server
• builder - Git server and source-to-image component
• imagebuilder - The builder for Docker and CNCF Buildpacks based applications
• fluentd - Backend log shipping mechanism for drycc logs
• postgres - The central database
• registry - The Docker registry
• logger - The (in-memory) log buffer for drycc logs
• monitor - The platform monitoring components
• influxdb - The monitor database
• rabbitmq - RabbitMQ is a message broker used with controller celery
• storage - The in-cluster, kubernetes storage, s3 api compatible, hybrid storage system.
• workflow-cli - Workflow CLI drycc

We welcome your input! If you have feedback, please submit an issue. If you'd like to participate in development, please read the "Working on Documentation" section below and submit a pull request.

This project has been forked from Deis since 2018.08 but changed a lot, not compatible with each other.

Working on Documentation

The Drycc project welcomes contributions from all developers. The high level process for development matches many other open source projects. See below for an outline.

• Fork this repository.
• Make your changes.
• Submit a pull request (PR) to this repository with your changes, and unit tests whenever possible.
  • If your PR fixes any issues, make sure you write Fixes #1234 in your PR description (where #1234 is the number of the issue you're closing).
• The Drycc core contributors will review your code. After each of them sign off on your code, they'll label your PR with LGTM1 and LGTM2 (respectively). Once that happens, a contributor will merge it.

Requirements

The documentation site requires either a local installation of MkDocs or access to Docker.

Local Installation

Install MkDocs and required dependencies:

make deps

Building Documentation

To build the documentation run: make build or make docker-build.

Serve Documentation Locally

To serve documenation run: make serve or make docker-serve.

Then view the documentation on http://localhost:8000 or http://DOCKER_IP:8000.