top
(README.md)
English | [中文](README_zh-CN.md)

<h1 align="center">
	<br>
	<img width="400" src="docs/logo.jpeg" alt="cyclone">
	<br>
	<br>
</h1>

[![Go Report Card](https://goreportcard.com/badge/github.com/caicloud/cyclone?style=flat-square)](https://goreportcard.com/report/github.com/caicloud/cyclone)
[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg?style=flat-square)](https://godoc.org/github.com/caicloud/cyclone)
[![Gitter](https://img.shields.io/gitter/room/caicloud/cyclone.svg?style=flat-square)](https://gitter.im/caicloud/cyclone?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

[![StackShare](https://img.shields.io/badge/tech-stack-0690fa.svg?style=flat-square)](https://stackshare.io/gaocegege/cyclone)
[![GitHub contributors](https://img.shields.io/github/contributors/caicloud/cyclone.svg?style=flat-square)](https://github.com/caicloud/cyclone/graphs/contributors)
[![Issue Stats](https://img.shields.io/issuestats/i/github/caicloud/cyclone.svg?style=flat-square)](https://github.com/caicloud/cyclone/issues)
[![Issue Stats](https://img.shields.io/issuestats/p/github/caicloud/cyclone.svg?style=flat-square)](https://github.com/caicloud/cyclone/pulls)

Unit testing:
[![Build Status](https://travis-ci.org/caicloud/cyclone.svg?branch=master)](https://travis-ci.org/caicloud/cyclone)
End-to-end testing:
![Build Status](https://img.shields.io/badge/e2e--test-comming%20soon-brightgreen.svg)

Cyclone is a cloud native CI/CD platform built for container workflow.

The primary directive of cyclone is to ship code from local development all the way to container engine of choice, either running in test or production environment. Features of cyclone includes:

- **Container Native**: every build, integration and deployment runs in container, completely excludes inconsistency between runtime environment
- **Dependency Aware**: define dependency rules, or simply component relationship, cyclone takes care of execution order as well as rollout strategy
- **Version Control**: cyclone is built with version control in mind; retrieving image/pipeline history is as simple as querying its version management interface
- **Two-way Binding**: cyclone records every CI/CD operation and its effect to answer questions like "how various container images are deployed across the fleet?"
- **Security First**: security is an essential part of cyclone; barriers can be setup to prevent insecure images from launching into production

## Documentation

### Setup Guide

To set up a cyclone instance, check out the [setup guide](./docs/setup.md) in the documentation.

### Quick Start

You could read the [quick start to start a tour of cyclone.](./docs/quick-start.md)

### Caicloud.yml Introduction

When `caicloud.yml` is given, version creation would include what you defined in the configuration file. you could find the [introduction to caicloud.yml](./docs/caicloud-yml-introduction.md) in the documentation.

### Developer Guide

Feel free to hack on cyclone! We have [instructions to help you get started contributing.](./docs/developer-guide.md)

## Preview Feature

### Dependency Management

<div align="center">
	<img src="./docs/dependency.png" alt="Dependency Management" width="500">
</div>

### Security Scanning

<div align="center">
	<img src="./docs/security.png" alt="Security Scanning" width="500">
</div>

Please watch the [Fuctions Introduction](./docs/functions.md) for more features.

## Roadmap

Please watch the [Github milestones](https://github.com/caicloud/cyclone/milestones) for our future plans.

Imports 15 package(s)

  1. github.com/emicklei/go-restful/swagger
  2. github.com/caicloud/cyclone/kafka
  3. github.com/caicloud/cyclone/pkg/osutil
  4. github.com/caicloud/cyclone/pkg/log
  5. github.com/caicloud/cyclone/store
  6. github.com/caicloud/cyclone/api
  7. github.com/caicloud/cyclone/pkg/wait
  8. github.com/caicloud/cyclone/api/rest
  9. github.com/caicloud/cyclone/etcd
  10. gopkg.in/mgo.v2
  11. github.com/caicloud/cyclone/http
  12. github.com/caicloud/cyclone/event
  13. github.com/emicklei/go-restful
  14. github.com/caicloud/cyclone/websocket
  15. github.com/spf13/pflag