Arvados Contributor Wiki¶

This wiki has information related to the open source project. It's a work in progress, so come back often for updates and feel free to become a contributor.

• Table of contents
• Arvados Contributor Wiki
  • Platform Overview
  • Key Components
  • Using Arvados
  • Contributing and hacking
  • Community
  • Legal

Platform Overview¶

• Introduction to Arvados
• Technical Architecture
• Cloud Operating Systems and Virtualization
• Provenance and Reproducibility
• Federation and Data Sharing
• Glossary of Arvados Terms
• External Resources

Key Components¶

• Keep, the content addressable distributed storage service
  • Keep-balance
  • Keep Proxy
• Crunch, container orchestration
• System and Metadata Database
  • REST API Server
• SDKs, including the Python library and the CLI "arv" tool
• Workbench, the web-based application for doing day-to-day work in Arvados
• Node Manager dynamically starts and stops cloud compute nodes based on demand in the job queue
  • Lifecycle of an Arvados compute node
• Common Workflow Language integration with Arvados

Using Arvados¶

• Curoverse Public Beta Program — Curoverse Public Beta Program.
• Developing with Arvados — Porting pipelines and writing crunch scripts.
• User Guide — How to manage data and do analysis with Arvados.
• API Reference — Details about the Arvados APIs.
• SDK Reference — Details about the Arvados SDKs.
• Install Guide — Instructions for installing Arvados.
• How to Report Issues in Arvados -- including some notes about safely reporting bugs in a public forum.
• Running Common Workflow Language (CWL) workflows on Arvados

Contributing and hacking¶

• How to Contribute
• Installing a Development Arvados Instance
• Hacking HQ: introductory material for new developers, and index of resources for all of us
• Source Tree Overview and implementation status
• Arvados Licenses FAQ
• Documentation Project
• Design Principles
• Proposals and work-in-progress design documents

Community¶

• Mission and Principles
• Governance
• IRC and Mailing Lists
• Design Process
• History
• Arvados Summit - Fall 2013

Legal¶

• Licensing Terms