# Ryvn

> Deploy your SaaS to customer cloud environments with automated infrastructure, monitoring, and compliance controls

- [Introduction](https://ryvn.ai/docs/introduction.md): Ship SaaS and AI applications into customer clouds without the usual Kubernetes, Terraform, and compliance lift that slows enterprise sales.
- [Quickstart](https://ryvn.ai/docs/quickstart.md): Deploy your first application on Ryvn in minutes by connecting a GitHub repo, provisioning a cloud environment, and shipping a service.
- [CLI](https://ryvn.ai/docs/cli.md): Install and use the Ryvn CLI to manage your platform from the terminal
- [How Ryvn works](https://ryvn.ai/docs/how-ryvn-works.md): Understanding the core concepts and architecture of Ryvn
- [Why BYOC](https://ryvn.ai/docs/why-byoc.md): Understanding the benefits of Bring Your Own Cloud for SaaS deployments
- [Ryvn BYOC](https://ryvn.ai/docs/ryvn-byoc.md): Run a dedicated Ryvn control plane (hub) inside your own cloud account, provisioned and kept up to date by Ryvn.
- [Agent Skills](https://ryvn.ai/docs/agents/agent-skills.md): Give your AI coding assistant deep knowledge of the Ryvn platform
- [Docs MCP](https://ryvn.ai/docs/agents/docs-mcp.md): Connect your AI tools directly to the Ryvn knowledge base
- [How provisioning works](https://ryvn.ai/docs/provision/how-provisioning-works.md): Learn how Ryvn provisions and manages your infrastructure
- [AWS](https://ryvn.ai/docs/provision/aws.md): Provision and manage your AWS infrastructure with Ryvn
- [GCP](https://ryvn.ai/docs/provision/google-cloud.md): Provision and manage your Google Cloud infrastructure with Ryvn
- [Azure](https://ryvn.ai/docs/provision/azure.md): Provision and manage your Azure infrastructure with Ryvn
- [Existing clusters](https://ryvn.ai/docs/provision/existing-cluster.md): Connect a Kubernetes cluster you already run to Ryvn, and optionally let Ryvn manage cloud infrastructure in it
- [How deploying works](https://ryvn.ai/docs/deploy/how-deploying-works.md): Understand how Ryvn triggers deployments from Git pushes, supports auto-deploy and manual workflows, and lets you skip specific commits.
- [Which to Use?](https://ryvn.ai/docs/deploy/service-types/comparison.md): Compare Ryvn's server, job, Helm chart, and Terraform service types to pick the right fit for web apps, scheduled tasks, or infrastructure.
- [Server](https://ryvn.ai/docs/deploy/service-types/server.md): Deploy long-running HTTP services on Ryvn with auto-scaling, built-in load balancing, health checks, and zero-downtime rolling deployments.
- [Job](https://ryvn.ai/docs/deploy/service-types/job.md): Deploy and manage scheduled and manual jobs on Ryvn
- [Helm Chart](https://ryvn.ai/docs/deploy/service-types/chart.md): Deploy Helm charts on Ryvn with full Kubernetes resource support, including CRDs, plus integrated release channels and rollback workflows.
- [Terraform](https://ryvn.ai/docs/deploy/service-types/terraform.md): Deploy and manage infrastructure with Terraform on Ryvn
- [Deploy from GitHub](https://ryvn.ai/docs/deploy/deploy-from-github.md): Connect a GitHub repository and deploy with Buildpacks or your own Dockerfile, with images built and stored in the managed Ryvn Registry.
- [Deploy from Registry](https://ryvn.ai/docs/deploy/deploy-from-registry.md): Connect Docker Hub, GitHub Container Registry, Harbor, or Amazon ECR to deploy existing container images and Helm charts with Ryvn.
- [Environments](https://ryvn.ai/docs/guides/environments.md): How Ryvn environments isolate workloads at the cluster and network layer, and what that means when deploying one service to multiple targets.
- [Services](https://ryvn.ai/docs/guides/services.md): Services are runtime templates that define containers, resource needs, and networking for each of Ryvn's four supported workload types.
- [Installations](https://ryvn.ai/docs/guides/installations.md): How one service becomes many running deployments — one per environment — each with its own variables, resources, scaling, and rollout strategy.
- [Namespaces](https://ryvn.ai/docs/guides/namespaces.md): Where installations land in Kubernetes, how Ryvn creates and labels namespaces, and what your charts must not do.
- [Ryvn Agent](https://ryvn.ai/docs/guides/ryvn-agent.md): The Kubernetes operator that runs inside each Ryvn environment to execute deployments and reconcile state over a secure outbound connection.
- [Environment Variables](https://ryvn.ai/docs/configure/environment-variables.md): Configure environment variables for your installations
- [Variable Groups](https://ryvn.ai/docs/configure/variable-groups.md): Share configuration across installations and sync secrets from external providers
- [Scaling](https://ryvn.ai/docs/configure/scaling.md): Configure horizontal scaling for server installations
- [Rollbacks and Force Deploy](https://ryvn.ai/docs/configure/rollbacks.md): Manually control your installation's deployed version
- [Health Checks](https://ryvn.ai/docs/configure/health-checks.md): Configure liveness and readiness probes so Ryvn can verify new server replicas before routing traffic, enabling zero-downtime deployments.
- [Installation Dependencies](https://ryvn.ai/docs/configure/installation-dependencies.md): Control the order installations come up in an environment and which installation a release's version range applies to.
- [IaC / GitOps](https://ryvn.ai/docs/configure/infrastructure-as-code.md): Manage environments, services, blueprints, and installations as YAML resources synced from a connected Git repository.
- [Connections](https://ryvn.ai/docs/connections/overview.md): Configure the external services your Ryvn organization uses
- [GitHub](https://ryvn.ai/docs/connections/github.md): Install the Ryvn GitHub App and choose which repositories Ryvn can access
- [Infisical](https://ryvn.ai/docs/connections/infisical.md): Connect an Infisical machine identity to sync secrets into Ryvn variable groups
- [GCP Secret Manager](https://ryvn.ai/docs/connections/gcp-secret-manager.md): Grant Ryvn access to Google Cloud secrets without uploading a service-account key
- [Temporal](https://ryvn.ai/docs/connections/temporal.md): Configure Temporal Cloud credentials for queue-based autoscaling
- [Observability](https://ryvn.ai/docs/connections/observability.md): Inspect managed Grafana and configure environment routing for published observability stacks
- [Release Channels](https://ryvn.ai/docs/configure/release-channels.md): Configure and manage release channels for your deployments
- [Release Metadata](https://ryvn.ai/docs/configure/release-metadata.md): Define release artifacts, service dependencies, and migration schemas for automated deployment
- [Maintenance Windows](https://ryvn.ai/docs/configure/maintenance-windows.md): Schedule and manage maintenance windows for your installations
- [Blueprints](https://ryvn.ai/docs/configure/blueprints.md): Avoid configuration drift across staging, production, and preview by standardizing multi-service installations through one reusable template.
- [Marketplace Blueprints](https://ryvn.ai/docs/configure/marketplace-blueprints.md): Install production-ready infrastructure blueprints maintained by Ryvn — databases, caches, and more — without writing Terraform from scratch.
- [Previews](https://ryvn.ai/docs/configure/previews.md): Automatic deployments for pull requests and feature branches
- [Metrics](https://ryvn.ai/docs/observability/metrics.md): Visualize CPU, memory, disk, and network metrics for installations across replicas to monitor performance and catch bottlenecks early.
- [Database metrics](https://ryvn.ai/docs/observability/database-metrics.md): Collect Postgres engine metrics — connections, transactions, cache hit ratio, locks and database size — for Ryvn-provisioned Postgres databases on AWS, GCP, and Azure.
- [Logs](https://ryvn.ai/docs/observability/logs.md): Stream and search real-time installation logs for server and job services from the Ryvn dashboard, powered by Grafana Alloy and Loki.
- [Notifications](https://ryvn.ai/docs/observability/notifications.md): Get real-time notifications about your installations through Slack
- [Outbound IPs](https://ryvn.ai/docs/networking/outbound-ips.md): Find the outbound IP addresses used by your installations
- [TLS Certificates](https://ryvn.ai/docs/networking/tls-certificates.md): Free, fully managed SSL/TLS certificates for your public servers
- [Custom Domains](https://ryvn.ai/docs/networking/custom-domains.md): Configure custom domains for server and Helm chart installations, or set a custom root domain to replace ryvn.run across an entire environment.
- [Ingress NGINX Retirement](https://ryvn.ai/docs/networking/migration-guides/ingress-nginx-retirement.md): Ryvn is upgrading its networking stack as ingress-nginx reaches end-of-life. Here's what's changing and what you need to know.
- [Contact Us](https://ryvn.ai/docs/support/contact-us.md): Expert support and solutions for your infrastructure needs
- [FAQ](https://ryvn.ai/docs/support/faq.md): Answers to common questions about Ryvn's BYOC model, supported application types, security posture, pricing, and how the platform compares.
- [Overview](https://ryvn.ai/docs/iac/overview.md): Index of Ryvn's YAML resource kinds — Services, Environments, Installations, Blueprints, Previews, Release Channels — and how they fit together.
- [Server](https://ryvn.ai/docs/iac/services/server.md): Define a server service that builds long-running HTTP applications and APIs from a GitHub repo, Dockerfile, or public container image.
- [Job](https://ryvn.ai/docs/iac/services/job.md): Define a job service that runs one-off tasks, batch jobs, database migrations, or scheduled workloads to completion on a target environment.
- [Helm Chart](https://ryvn.ai/docs/iac/services/helm-chart.md): Define a Helm chart service built from a GitHub repository or sourced from a public chart repository for deployment across environments.
- [Terraform](https://ryvn.ai/docs/iac/services/terraform.md): YAML reference for Terraform services that provision cloud infrastructure from modules in GitHub repos or the Terraform public registry.
- [AWS](https://ryvn.ai/docs/iac/environments/aws.md): Define a Ryvn environment on AWS, provisioning VPCs, EKS clusters, networking, load balancers, and DNS in a target AWS account.
- [GCP](https://ryvn.ai/docs/iac/environments/gcp.md): Define a Ryvn environment on Google Cloud Platform, provisioning GKE clusters, networking, load balancers, and DNS in a target project.
- [Azure](https://ryvn.ai/docs/iac/environments/azure.md): Define a Ryvn environment on Azure, provisioning AKS clusters, networking, load balancers, and DNS in a target Azure subscription.
- [Server](https://ryvn.ai/docs/iac/installations/server.md): Install a server service on an environment with environment variables, resource limits, replicas, ingress, and other per-environment settings.
- [Job](https://ryvn.ai/docs/iac/installations/job.md): Install a job service on an environment with cron schedules, run-now triggers, environment variables, and resource limits for batch workloads.
- [Helm Chart](https://ryvn.ai/docs/iac/installations/helm-chart.md): Install a Helm chart service on an environment with Helm values, secrets, and resource settings tailored to each target cluster.
- [Terraform](https://ryvn.ai/docs/iac/installations/terraform.md): Install a Terraform service on an environment with input variables, secrets, and other per-environment settings to provision cloud resources.
- [Blueprint](https://ryvn.ai/docs/iac/installations/blueprint.md): Install a blueprint on an environment to deploy all of its services at once, using inputs to customize values for that environment.
- [Template Functions](https://ryvn.ai/docs/iac/installations/template-functions.md): Reference for template functions and the .ryvn context object used to inject environment, installation, and service data into YAML configs.
- [Blueprint](https://ryvn.ai/docs/iac/blueprint.md): YAML reference for the Blueprint resource — declare bundled service installations, input variables, and defaults for consistent rollouts.
- [Preview](https://ryvn.ai/docs/iac/preview.md): Automatically deploy a blueprint to an isolated preview environment for each pull request, and tear it down when the PR closes.
- [Release](https://ryvn.ai/docs/iac/release.md): Define release metadata including container artifacts, service dependencies, and migration versions in a release.ryvn.yaml file for the CLI.
- [Maintenance Window](https://ryvn.ai/docs/iac/maintenance-window.md): Define maintenance schedules for controlled deployments
- [Promotion Pipeline](https://ryvn.ai/docs/iac/promotion-pipeline.md): Define paths between release channels with manual, timed, or canary criteria to automate how releases move from staging to production.
- [Deployment Approvals](https://ryvn.ai/docs/guides/deployment-approvals.md): Control deployment execution with approval workflows for customer environments
- [Set up just-in-time kubectl access in BYOC](https://ryvn.ai/docs/guides/jit-kubectl-access.md): Get customer-approved, time-boxed kubectl access to troubleshoot your application in a customer's cloud.
- [Drift Protection](https://ryvn.ai/docs/guides/drift-protection.md): Prevent git sync from overwriting resources modified outside of git
- [Infrastructure auditing](https://ryvn.ai/docs/guides/infrastructure-auditing.md): Archive Kubernetes and cloud API audit logs from an AWS, GCP, or Azure environment to storage that the account owner controls.
- [Graceful Shutdown for Workers](https://ryvn.ai/docs/guides/graceful-shutdown.md): Prevent in-flight work from being killed during rolling deploys and autoscale-downs
- [Docker Build Secrets](https://ryvn.ai/docs/guides/docker-build-secrets.md): Use private credentials like NPM tokens and API keys in your Docker builds
- [Database Access via Tailscale](https://ryvn.ai/docs/guides/tailscale-database-access.md): Connect to your RDS or other managed databases from your local machine using Tailscale and Ryvn marketplace blueprints.
- [Service Dependency](https://ryvn.ai/docs/guides/examples/service-dependency-constraints.md): Managing service dependencies and deployment order
- [Schema Migration](https://ryvn.ai/docs/guides/examples/schema-migration-constraints.md): Safe database schema migrations with automated constraint enforcement
- [GPU Workloads](https://ryvn.ai/docs/guides/gpu-workloads.md): Provision on-demand GPU compute pools for ML training and inference
- [Kubernetes Basics](https://ryvn.ai/docs/guides/kubernetes-basics.md): Essential Kubernetes concepts for working with Ryvn
- [API Reference](https://ryvn.ai/docs/api-reference/introduction.md): Authenticate to the Ryvn REST API with OAuth client credentials and make requests against api.ryvn.app to automate your platform workflows.
- [List Organization Secrets](https://ryvn.ai/docs/api-reference/secrets/list.md): List the deprecated organization-level secrets in your Ryvn organization. Existing organization secrets keep resolving for the installations that already reference them; migrate them to environment variable groups from the Secrets page with Migrate to Variable Groups.
- [Create Organization Secrets](https://ryvn.ai/docs/api-reference/secrets/create.md): Organization secrets are deprecated and can no longer be created. This endpoint always returns 412 with error OrgSecretsDeprecated; store shared values in environment variable groups instead.
- [Update Organization Secret](https://ryvn.ai/docs/api-reference/secrets/update.md): Add new key-value pairs or remove keys from an existing organization-level secret. Organization secrets are deprecated; migrate them to environment variable groups.
- [Delete Organization Secret](https://ryvn.ai/docs/api-reference/secrets/delete.md): Permanently delete a deprecated organization-level secret from your Ryvn organization. Any installations still referencing it will fail to sync, so migrate them to environment variable groups first.

## OpenAPI Specs

- [api](/docs/api.json)