Skip to content
This repository has been archived by the owner on May 3, 2024. It is now read-only.

Latest commit

 

History

History
32 lines (23 loc) · 3.02 KB

QUICK_START.md

File metadata and controls

32 lines (23 loc) · 3.02 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. Download a CORTX virtual machine image to get up and running in minutes

    1. On a single node on Kubernetes inside an OVA: LINK
    2. On an AWS EC2 instance: LINK
    3. Across a cluster: TODO

  2. Run CORTX on Kubernetes

    1. Manual steps: LINK
    2. Automated script: LINK
    3. On Amazon Web Services
      1. Using Cloudformation: LINK
        Click here for more details on Cloudformation.
      2. Using Terraform: LINK
        Click here for more details on Terraform.

  3. Build entire CORTX into binaries: LINK

  4. Build just the block storage layer (motr) from the source: LINK

    1. Run motr on a single node: LINK
    2. Run motr across a cluster: LINK

  5. Use a pre-built virtual machine to quickly test the block storage layer (motr)

    1. Run CORTX on a single node: LINK

Once you have your CORTX system running, you can use these code samples to show you how to connect to it and perform common S3 operations.

If you use any of these, please consider adding your name to the 'Tested By' section at the bottom of each respective page. 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.