Technical documentation for deploying and operating CyVerse — the open-source cyberinfrastructure for data-intensive science. This bundle follows the Open Knowledge Format v0.2: every document carries frontmatter, and every directory has an index like this one.

Start here¶

• About this documentation - what CyVerse is, and where each audience should start
• Deploying CyVerse from scratch - end-to-end walkthrough of a two-node deployment
• Update log - what changed in this bundle, newest first

Architecture¶

• architecture/ - how the pieces fit together, what they need, and what talks to what
• platform/ - the products and services CyVerse offers its users

Deployment¶

Ordered by dependency: nothing in a later phase can start before the phases above it.

• deployment/ - the full deployment path, phase by phase
• deployment/planning/ - prerequisites and deployment tooling
• deployment/01-foundation/ - HAProxy, PostgreSQL, RabbitMQ
• deployment/02-databases/ - per-service schemas and migrations
• deployment/03-data-store/ - the iRODS zone and its DE integration
• deployment/04-kubernetes/ - cluster, certificates, storage, ingress, registry
• deployment/05-core-services/ - directory, authentication, search, messaging
• deployment/06-applications/ - Discovery Environment, VICE, User Portal
• deployment/07-post-install/ - bootstrap, verification, troubleshooting

Operating and integrating¶

• operations/ - running a deployment day to day
• api/ - the Terrain API and its endpoints
• development/ - contributing to CyVerse code
• references/ - provenance notes for material this bundle derives from