Repository files navigation

This projecthas ended, andall development/maintenance activities have halted.

As it is free software, people are free and welcome to fork and develop the codebase on their own.However, to avoid any confusion, the original repository is archived and we recommend any further fork/development to proceed with an explicit rename and rebranding first.

We encourage all interested parties to mirror any relevant bits as we can't actively guarantee their existence in the future.

rkt (pronounced like a"rocket") is a CLI for running application containers on Linux. rkt is designed to be secure, composable, and standards-based.

Some of rkt's key features and goals include:

• Pod-native: rkt's basic unit of execution is apod, linking together resources and user applications in a self-contained environment.
• Security: rkt is developed with a principle of "secure-by-default", and includes a number of important security features like support forSELinux,TPM measurement, and running app containers inhardware-isolated VMs.
• Composability: rkt is designed for first-class integration with init systems (likesystemd, upstart) and cluster orchestration tools (likeKubernetes andNomad), and supportsswappable execution engines.
• Open standards and compatibility: rkt implements theappc specification, supports theContainer Networking Interface specification, and can runDocker images andOCI images. Broader native support for OCI images and runtimes isin development.

The rkt v1.x series provides command line user interface and on-disk data structures stability for external development. Any major changes to those primary areas will be clearly communicated, and a formal deprecation process conducted for any retired features.

Check out theroadmap for more details on the future of rkt.

To get started quickly using rkt for the first time, start with the"trying out rkt" document.Also checkrkt support on your Linux distribution.For an end-to-end example of building an application from scratch and running it with rkt, check out thegetting started guide.

There are a number of different avenues for seeking help and communicating with the rkt community:

• For bugs and feature requests (including documentation!), file anissue
• For general discussion about both using and developing rkt, join therkt-dev mailing list
• For real-time discussion, join us on IRC: #rkt-dev on freenode.org
• For more details on rkt development plans, check out the GitHubmilestones

Most discussion about rkt development happens on GitHub via issues and pull requests.The rkt developers also host a semi-regular community sync meeting open to the public.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.For more details, including how to join and recordings of previous syncs, see thesync doc on Google Docs.

rkt is an open source project and contributions are gladly welcomed!See theHacking Guide for more information on how to build and work on rkt.SeeCONTRIBUTING for details on submitting patches and the contribution workflow.

Unless otherwise noted, all code in the rkt repository is licensed under theApache 2.0 license.Some portions of the codebase are derived from other projects under different licenses; the appropriate information can be found in the header of those source files, as applicable.

If you suspect you have found a security vulnerability in rkt, pleasedo not file a GitHub issue, but instead emailsecurity@coreos.com with the full details, including steps to reproduce the issue.CoreOS is currently the primary sponsor of rkt development, and all reports are thoroughly investigated by CoreOS engineers.For more information, see theCoreOS security disclosure page.

Check thetroubleshooting document.

• Projects integrating with rkt
• Production users