github.com/blixtra/rkt@v0.8.1-0.20160204105720-ab0d1add1a43/README.md (about)

     1  # rkt - App Container runtime
     2  
     3  [![godoc](https://godoc.org/github.com/coreos/rkt?status.svg)](http://godoc.org/github.com/coreos/rkt)
     4  [![Build Status (Travis)](https://travis-ci.org/coreos/rkt.svg?branch=master)](https://travis-ci.org/coreos/rkt)
     5  [![Build Status (SemaphoreCI)](https://semaphoreci.com/api/v1/projects/28468e19-4fd0-483e-9c29-6c8368661333/395211/badge.svg)](https://semaphoreci.com/coreos/rkt)
     6  
     7  ![rkt Logo](logos/rkt-horizontal-color.png)
     8  
     9  rkt (pronounced _"rock-it"_) is a CLI for running app containers on Linux. rkt is designed to be composable, secure, and fast.
    10  
    11  Some of rkt's key features and goals include:
    12  
    13  - First-class integration with init systems ([systemd][systemd], upstart) and cluster orchestration tools (fleet, [Kubernetes][kubernetes], [Nomad][nomad])
    14  - Compatibility with other container software (e.g. rkt can run [Docker images][docker])
    15  - Modular and extensible architecture ([network configuration plugins][networking], swappable execution engines based on systemd or [KVM][lkvm])
    16  
    17  For more on the background and motivation behind rkt, read the original [launch announcement][blog-post].
    18  
    19  [systemd]: Documentation/using-rkt-with-systemd.md
    20  [kubernetes]: Documentation/using-rkt-with-kubernetes.md
    21  [nomad]: Documentation/using-rkt-with-nomad.md
    22  [docker]: Documentation/running-docker-images.md
    23  [networking]: Documentation/networking.md
    24  [lkvm]: Documentation/running-lkvm-stage1.md
    25  [blog-post]: https://coreos.com/blog/rocket
    26  
    27  ## Project status
    28  
    29  rkt is maturing rapidly while under active development, and its interfaces are not yet considered stable.
    30  We do not recommend its use in production, but we encourage you to try out rkt and provide feedback via issues and pull requests.
    31  
    32  Check out the [roadmap](ROADMAP.md) for more details on the future of rkt.
    33  
    34  ## rkt and App Container (appc)
    35  
    36  rkt is an implementation of the [App Container (appc) spec](Documentation/app-container.md).
    37  rkt's native image format ([ACI](Documentation/app-container.md#ACI)) and runtime/execution environment ([pods](Documentation/app-container.md#pods)) are defined in the specification.
    38  
    39  ## Trying out rkt
    40  
    41  To get started quickly using rkt for the first time, start with the ["trying out rkt" document](Documentation/trying-out-rkt.md).
    42  For an end-to-end example of building an application from scratch and running it with rkt, check out the [getting started guide](Documentation/getting-started-guide.md).
    43  
    44  ## Getting help with rkt
    45  
    46  There are a number of different avenues for seeking help and communicating with the rkt community:
    47  - For bugs and feature requests (including documentation!), file an [issue][new-issue]
    48  - For general discussion about both using and developing rkt, join the [rkt-dev][rkt-dev] mailing list
    49  - For real-time discussion, join us on IRC: #[rkt-dev][irc] on freenode.org
    50  - For more details on rkt development plans, check out the GitHub [milestones][milestones]
    51  
    52  Most discussion about rkt development happens on GitHub via issues and pull requests.
    53  The rkt developers also host a semi-regular community sync meeting open to the public.
    54  This sync usually features demos, updates on the roadmap, and time for anyone from the community to ask questions of the developers or share users stories with others.
    55  For more details, including how to join and recordings of previous syncs, see the [sync doc on Google Docs][sync-doc].
    56  
    57  [new-issue]: https://github.com/coreos/rkt/issues/new
    58  [rkt-dev]: https://groups.google.com/forum/?hl=en#!forum/rkt-dev
    59  [irc]: irc://irc.freenode.org:6667/#rkt-dev
    60  [milestones]: https://github.com/coreos/rkt/milestones
    61  [sync-doc]: https://docs.google.com/document/d/1NT_J5X2QErtKgd8Y3TFXNknWhJx_yOCMJnq3Iy2jPgE/edit#
    62  
    63  ## Contributing to rkt
    64  
    65  rkt is an open source project under the Apache 2.0 [license](LICENSE), and contributions are gladly welcomed!
    66  See the [Hacking Guide](Documentation/hacking.md) for more information on how to build and work on rkt.
    67  See [CONTRIBUTING](CONTRIBUTING.md) for details on submitting patches and the contribution workflow.
    68  
    69  ## Known issues
    70  
    71  Due to a bug in the Linux kernel, using rkt's overlay support on top of an overlay filesystem requires Linux 4.3+.
    72