Deployment¶

• Deploying CyVerse from scratch - end-to-end walkthrough of a two-node deployment, phase by phase

The phases below are ordered by dependency, not by preference. iRODS needs PostgreSQL and RabbitMQ; the Discovery Environment needs all three plus a cluster; VICE needs the DE. Verify each phase before starting the next.

Phase 0: planning¶

• planning/ - prerequisites, Ansible, and Docker setup
• Prerequisites - hardware, skills, tooling, and access
• Component inventory and sizing - what to provision
• Network requirements - ports to open before you begin

Phase 1: foundation¶

• 01-foundation/ - the host services everything else depends on
• HAProxy - the public entry point
• PostgreSQL - catalog and service databases
• RabbitMQ - the AMQP message bus

Phase 2: databases¶

• 02-databases/ - one schema per service
• Database migrations - the shared migration procedure

Phase 3: Data Store¶

• 03-data-store/ - the iRODS zone
• iRODS catalog provider - install, policy, and zone initialization
• iRODS integration for the DE - specific queries and service account

Phase 4: Kubernetes¶

• 04-kubernetes/ - the cluster and its add-ons
• Cluster - control plane and workers
• Cluster resources - configuration, secrets, and manifests
• cert-manager - TLS issuance
• Ingress - Traefik and the legacy ingress-nginx path
• Storage - persistent volumes
• Harbor - container registry
• Argo Workflows - batch analysis execution

Phase 5: core services¶

• 05-core-services/ - directory, authentication, search, messaging, storage plumbing
• OpenLDAP - accounts and groups
• Keycloak - realm, federation, and OAuth clients
• Grouper - group management
• OpenSearch - data search index
• NATS - internal messaging
• Redis HA - caching and sessions
• Unleash - feature flags
• iRODS CSI driver - Data Store mounts for pods
• Mail - outbound mail
• Jaeger - distributed tracing

Phase 6: applications¶

• 06-applications/ - the user-facing platform
• Discovery Environment - the DE service set
• VICE - interactive analyses
• User Portal - account management

Phase 7: post-install¶

• 07-post-install/ - making the deployment usable and confirming it works
• Bootstrap - first administrator, VICE operator, starting apps
• Verification - end-to-end checks
• Troubleshooting - fixes for first-deployment problems

After deployment¶

• operations/ - day-to-day administration
• FAQ - common questions and recipes