Skip to content

Latest commit

 

History

History
29 lines (23 loc) · 2.89 KB

QUICK_START.md

File metadata and controls

29 lines (23 loc) · 2.89 KB
Raw

CORTX Quick Start Guide

This document provides quick access to several different ways to set up CORTX for installation, testing, running, or deployment. CORTX is available in multiple formats, including as a pre-built virtual machine image - the easiest and fastest way to get CORTX up and running. Alternatively, CORTX can be built into a binary format from source code. Finally, for those interested in running different configurations of CORTX, there are a variety of different options available. These include everything from the full installation to more slimmed down installations, such as configuring and running motr, the core object storage layer, on its own. We have attempted to create easy-to-follow instructions for all of these installation/test methods which are organized below in order of difficulty.

  1. Run a pre-built CORTX OVA (virtual machine image)
    1. On a single node: LINK
    2. On an AWS EC2 instance: done, requires verification
    3. Across a cluster: TODO
  2. Build motr from the source: LINK
    1. Run it on a single node: LINK
    2. Run it across a cluster: LINK
  3. Build motr + S3 from the source: LINK
    1. Run it on a single node LINK
    2. Run it across a cluster [TODO]
  4. Run a prepackaged CORTX software releases
    1. On a single node: TODO
    2. Across a cluster: done, requires verification
  5. Build entire CORTX into binaries: done, requires verification
    1. Run it on a single node: TODO
    2. Run it on a cluster: TODO
  6. Build entire CORTX into OVA (virtual machine image): TODO
    1. Run it on a single node: TODO
    2. Run it on a cluster: TODO

Note that some of the links above are tagged 'requires verification' and some are tagged 'LINK'. We apply the 'LINK' tag only after instructions have been verified by at least two people. The 'required verification' instructions are instructions which are still awaiting a second verification. If you verify them, please add your name to the 'Tested By' section at the bottom of the page and change the tag on this page as well. If you have any questions, please visit our resources page or join us on Slack.

Once you're ready to make more contributions, please check out our Contribution Guide.