CyVerse Core Software Documentation¶
Welcome to the comprehensive technical documentation for deploying and maintaining the CyVerse cyberinfrastructure. This documentation is designed to support DevOps engineers, system administrators, and application developers working with CyVerse's open-source scientific cyberinfrastructure.
Documentation Overview¶
CyVerse is a Software as a Service (SaaS) platform built on modern cloud-native technologies, providing researchers with powerful computational infrastructure for data-intensive science. Our documentation covers the complete stack from infrastructure deployment to API integration.
Find Documentation by Your Role¶
DevOps Engineer¶
You're deploying and maintaining CyVerse infrastructure
Start here:
- Getting Started Guide - Prerequisites and deployment roadmap
- System Overview - Architecture and technology stack
- Deployment Guide - Complete deployment walkthrough
Common tasks:
- Deploy Kubernetes cluster - Core infrastructure setup
- Configure authentication - KeyCloak deployment and LDAP integration
- Set up storage - OpenEBS and iRODS CSI driver
- Deploy Discovery Environment - Main application platform
- Database management - PostgreSQL schemas and migrations
System Administrator¶
You're managing users, apps, and operational tasks
Start here:
- Administration Guide - Daily operational procedures
- Discovery Environment Admin - User management, app publishing, VICE access
- Data Store Admin - Data management and permissions
Common tasks:
- Grant VICE access - Enable interactive computing for users
- Process DOI/Permanent ID requests - Data publishing workflows
- Manage user groups - Grouper administration
- Publish apps to Discovery Environment - Tool integration
- FAQ - Frequently asked questions and troubleshooting
Application Developer¶
You're integrating with CyVerse APIs or contributing code
Start here:
- Developer Guide - Development environment and contribution workflow
- API Overview - Terrain API introduction
- API Endpoint Index - Complete API reference
Common tasks:
- Authentication - OAUTH 2.0 integration
- Filesystem operations - Data Store API
- Job submission - Analysis execution
- Tapis v2 to v3 migration - Upgrade guide
- Error handling - API error codes and responses
Documentation Sections¶
| Section | Description | Audience |
|---|---|---|
| Getting Started | Prerequisites, system overview, and deployment roadmap | DevOps, New users |
| Deployment Guide | Complete infrastructure deployment: Kubernetes, services, databases | DevOps Engineers |
| Administration Guide | Operational procedures, user management, app publishing | System Administrators |
| API Reference | Terrain API endpoints, authentication, error handling | Developers |
| Developer Guide | Development environment, contribution workflow, architecture | Developers |
| System Architecture | Platform components, services, and design decisions | All audiences |
| Database Reference | PostgreSQL schemas for all CyVerse services | DevOps, DBAs |
CyVerse Platform Components¶
Core Products¶
- Discovery Environment (DE) - Web-based analysis platform for computational workflows
- Data Store - 6+ PB iRODS-based data management system
- Data Commons - Data publishing platform with DOI/ARK support
- VICE - Visual Interactive Computing Environment (Jupyter, RStudio, etc.)
Specialized Tools¶
- BisQue - Bio-Image Semantic Query User Environment
- DNA Subway - Educational genomics platform
- Cloud Services (CACAO) - Cloud automation and multi-cloud orchestration
Infrastructure Services¶
- Authentication (KeyCloak) - OAUTH 2.0, LDAP, CILogon integration
- Terrain API - RESTful API aggregating all DE services
- Kubernetes - Container orchestration platform
- iRODS - Integrated Rule-Oriented Data System for data management
Quick Links¶
- FAQ - Frequently asked questions and troubleshooting
- GitHub Organization - Source code repositories
- Live Terrain API - Interactive API documentation
- Harbor Registry - Container image repository
- CyVerse Website - Public-facing information and user support
What is CyVerse?
CyVerse is a powerful computational infrastructure and the people who support its operations. It is fully open source, and dedicated to furthering open science.
CyVerse has been funded by the United States National Science Foundation (NSF) from 2008 until the present
SOFTWARE LICENSE
Copyright © 2010-2026, The Arizona Board of Regents on behalf of The University of Arizona
All rights reserved.
Developed by: CyVerse as a collaboration between participants at BIO5 at The University of Arizona (the primary hosting institution), Cold Spring Harbor Laboratory, The University of Texas at Austin, and individual contributors. Find out more at http://www.cyverse.org/.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
- Neither the name of CyVerse, BIO5, The University of Arizona, Cold Spring Harbor Laboratory, The University of Texas at Austin, nor the names of other contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.