2017-08-02 17:27:17 +00:00
# Heptio Ark
**Maintainers:** [Heptio][0]
2018-07-23 20:18:32 +00:00
[![Build Status][1]][2] < a href = "https://zenhub.com" > < img src = "https://raw.githubusercontent.com/ZenHubIO/support/master/zenhub-badge.png" > < / a >
2017-08-02 17:27:17 +00:00
## Overview
2018-02-14 18:02:35 +00:00
Ark gives you tools to back up and restore your Kubernetes cluster resources and persistent volumes. Ark lets you:
2017-08-02 17:27:17 +00:00
2018-02-14 18:02:35 +00:00
* Take backups of your cluster and restore in case of loss.
* Copy cluster resources across cloud providers. NOTE: Cloud volume migrations are not yet supported.
* Replicate your production environment for development and testing environments.
2017-08-02 17:27:17 +00:00
2018-02-14 18:02:35 +00:00
Ark consists of:
2017-08-02 17:27:17 +00:00
2018-02-14 18:02:35 +00:00
* A server that runs on your cluster
* A command-line client that runs locally
2017-08-02 17:27:17 +00:00
2018-02-21 18:18:34 +00:00
## More information
2018-07-05 15:33:22 +00:00
[The documentation][29] provides a getting started guide, plus information about building from source, architecture, extending Ark, and more.
2017-08-02 17:27:17 +00:00
## Troubleshooting
2018-04-26 19:00:14 +00:00
If you encounter issues, review the [troubleshooting docs][30], [file an issue][4], or talk to us on the [#ark-dr channel][25] on the Kubernetes Slack server.
2017-08-02 17:27:17 +00:00
## Contributing
Thanks for taking the time to join our community and start contributing!
2017-08-04 18:12:24 +00:00
Feedback and discussion is available on [the mailing list][24].
2018-07-05 15:33:22 +00:00
### Before you start
2017-08-02 17:27:17 +00:00
* Please familiarize yourself with the [Code of Conduct][8] before contributing.
* See [CONTRIBUTING.md][5] for instructions on the developer certificate of origin that we require.
2018-07-25 03:28:24 +00:00
* Read how [we're using ZenHub][26] for project and roadmap planning
2017-08-02 17:27:17 +00:00
2018-07-05 15:33:22 +00:00
### Pull requests
2017-08-02 17:27:17 +00:00
* We welcome pull requests. Feel free to dig through the [issues][4] and jump in.
## Changelog
See [the list of releases][6] to find out about feature changes.
[0]: https://github.com/heptio
2017-10-30 19:49:03 +00:00
[1]: https://travis-ci.org/heptio/ark.svg?branch=master
[2]: https://travis-ci.org/heptio/ark
2018-07-05 15:33:22 +00:00
2017-08-02 17:27:17 +00:00
[4]: https://github.com/heptio/ark/issues
2018-02-14 18:02:35 +00:00
[5]: https://github.com/heptio/ark/blob/master/CONTRIBUTING.md
[6]: https://github.com/heptio/ark/releases
2018-07-05 15:33:22 +00:00
2018-02-14 18:02:35 +00:00
[8]: https://github.com/heptio/ark/blob/master/CODE_OF_CONDUCT.md
2017-08-02 17:27:17 +00:00
[9]: https://kubernetes.io/docs/setup/
[10]: https://kubernetes.io/docs/tasks/tools/install-kubectl/#install-with-homebrew-on-macos
[11]: https://kubernetes.io/docs/tasks/tools/install-kubectl/#tabset-1
[12]: https://github.com/kubernetes/kubernetes/blob/master/cluster/addons/dns/README.md
[14]: https://github.com/kubernetes/kubernetes
2018-07-05 15:33:22 +00:00
2017-08-04 18:12:24 +00:00
[24]: http://j.hept.io/ark-list
2018-04-26 19:00:14 +00:00
[25]: https://kubernetes.slack.com/messages/ark-dr
2018-07-23 20:18:32 +00:00
[26]: https://github.com/heptio/ark/blob/master/docs/zenhub.md
2018-07-05 15:33:22 +00:00
2018-02-14 18:02:35 +00:00
[29]: https://heptio.github.io/ark/
2018-02-21 15:46:08 +00:00
[30]: /docs/troubleshooting.md