Welcome to OpenSDS’s documentation!

OpenSDS is a software defined storage controller that provides unified block, file, object storage services. Mainly includes two projects of OpenSDS and NBP.

Community

• EUAC
  • Mission
  • Members
• TSC
  • Mission
  • Members
  • Weekly Meetings
  • Meeting Minutes
  • Past Arch WG Meeting Minutes
  • Kubernetes Storage SIG

Introduction

• OpenSDS
  • Introduction
  • Community
  • Collaborative Testing
  • Contact
  • REST API
    • OpenAPI
• OpenSDS Northbound Plugin Project
  • Introduction
  • Community
  • Contact
• Design Specs
  • OpenSDS Architecture
  • OpenSDS Roadmap
  • Design Proposal Links
  • Contact

Installation

• How-to-Run-Containerized-OpenSDS-for-Testing-Work
  • Pre-configuration
  • OpenSDS Service Installation
  • Test
    • Download cli tool.
    • Create a default profile firstly.
    • Create a volume.
    • List all volumes.
    • Delete the volume.
• Local-Cluster-Installation-through-Ansible
  • 1. How to install an opensds local cluster
    • Pre-config (Ubuntu 16.04)
    • Install docker
    • Install ansible tool
    • Download opensds-ansible release file
    • Configure opensds cluster variables:
    • Check if the hosts can be reached
    • Run opensds-ansible playbook to start deploy
  • 2. How to test opensds cluster
    • Configure opensds CLI tool
    • Create a default profile first.
    • Create a volume.
    • List all volumes.
    • Delete the volume.
  • 3. How to purge and clean opensds cluster
    • Run opensds-ansible playbook to clean the environment
    • Run ceph-ansible playbook to clean ceph cluster if ceph is deployed
    • Remove ceph-ansible source code (optional)
• Local-Cluster-Installation-with-Ceph
  • Pre-configuration
    • Bootstrap
    • Run etcd daemon in background.
    • Install the ceph driver dependent packet.
    • Config the configuration file, you can refer to the following configuration.
  • Run OpenSDS Service
    • Start up the osdslet and osdsdock daemon.
    • Test the OpenSDS if it is work well by getting the api versions and the ceph storage pools.
  • OpenSDS Usage Tutorial
    • Create a default profile firstly.
    • Create a volume.
    • List all volumes.
    • Delete the volume.
• Local-Cluster-Installation-with-Cinder-Standalone
  • Prepare
  • Step by Step Installation
    • Install and start cinder standalone service
    • Install etcd
    • Install opensds
    • Set the opensds configuration file.
    • Start opensds services.
  • Testing
    • Config osdsctl tool.
    • Create a default profile firstly.
    • Create a volume.
    • List all volumes.
    • Delete the volume.
• Local-Cluster-Installation-with-LVM
  • Prepare
  • Step by Step Installation
    • Bootstrap
    • Run all services in one command!
  • Testing
    • Config osdsctl tool.
    • Create default profile.
    • Create a volume.
    • List all volumes.
    • Delete the volume.
  • Uninstall the local cluster
• OpenSDS-Integration-with-Kubernetes-CSI
  • Prerequisite
    • ubuntu
    • docker
    • golang
    • Etcd
    • kubernetes local cluster
    • opensds local cluster
  • Testing steps
  • Clean up steps
• OpenSDS-Integration-with-Kubernetes-Flexvolume
  • Prerequisite
    • ubuntu
    • docker
    • golang
    • kubernetes local cluster
    • opensds local cluster
  • Testing steps
  • Clean up steps
• OpenSDS-Integration-with-Kubernetes-Service-Catalog
  • Pre-configuration
    • Check it out about your os (very important)
    • Install some package dependencies
    • Local Kubernetes Cluster Setup
    • Install helm (from scipt)
  • Service Catalog Setup
    • Tiller permissions
    • Helm repository setup
  • OpenSDS Service Broker Configuration
  • Start to work
  • Clean it up
  • Ending

Contributing

• Tutorials-for-Beginners
  • Step 1: Fork opensds repository
  • Step 2: Clone the remote repository
  • Step 3: Configure upstream repository
  • Step 4: Develop code locally
  • Step 5: Push the code to the remote repository
  • Step 6: Pull a request to opensds repository
• Community-Contributing
  • OpenSDS
  • How to contribute
  • Email and chat
  • Getting started
  • Contribution Workflow
    • Code style
    • Report issues
    • Propose PRs