Prerequisites
- Basic understanding of Kubernetes concepts
- A Helm chart repository containing your charts
- A provisioned environment on AWS, Google Cloud, or Azure
Kubernetes Resource Support
Ryvn supports all Kubernetes resource types that can be defined in your Helm chart. This includes commonly used resources like ConfigMaps, Secrets, Persistent Volumes, and Service Accounts, as well as any Custom Resource Definitions (CRDs) your application requires.Create Your Service
Chart Requirements
Your Helm chart should follow these requirements:
- Use specific chart versions (avoid
latestor floating versions) - Define proper Kubernetes resources
- Include valid health check endpoints
- Use
values.yamlfor configuration
Create Service
Open the Ryvn Dashboard, go to the Services tab, and click Create Service in the
top-right corner. Choose Chart as your service type.
Configure Chart
Give your service a name and provide your chart details:
- Repository URL
- Chart name
- Registry credentials (if private)
Setup GitHub Actions (Optional)
After creating your service, you’ll have the option to set up GitHub Actions for automated deployments. Click Setup GitHub Actions to create a workflow that automatically builds and deploys your Helm chart when you push changes.See GitHub Actions Integration for detailed setup instructions.
We support pulling charts from public repositories, GitHub repositories, and private OCI registries. For other private
chart repositories, please contact us.
Private Registry Support
Ryvn supports deploying Helm charts from private OCI registries. To use a private registry:Add Registry Credentials
First, add your registry credentials through Settings in the Ryvn Dashboard:
- Navigate to Settings
- Select the Registries tab
- Click “Add Registry”
- Enter your registry name, URL, and authentication credentials
Public Charts
Public charts allow you to deploy community-maintained or vendor-provided Helm charts without hosting your own chart repository.Create Helm Chart Service
- Navigate to Services and click Create Service
- Select Helm Chart as the service type
- Select Deploy from Public Chart
-
Provide the required information:
Repository URL: The Helm repository URL (e.g.,
https://charts.bitnami.com/bitnami) Chart Name: The name of the chart in the repository (e.g.,postgresql)
Deploy to Environment
Navigate to Environment
Go to the Environments tab in the Ryvn Dashboard and select the environment where you want to deploy your Helm chart.
Configure Values
Configure your chart’s values for this installation
Values specified here will override the defaults in your chart’s
values.yaml.Custom Domains
To configure custom domains, ingress controllers, and TLS certificates for your Helm charts, see the Custom Domains documentation. This covers:- Configuring ingress for public and internal services
- Using Ryvn’s built-in NGINX controllers (
external-nginxandinternal-nginx) - Automatic TLS certificate management
- DNS configuration for custom domains
Versioning
Helm chart versions in Ryvn directly correspond to service release versions. When you create a release for your Helm Chart service, the release version must match an existing chart version in your repository. For GitHub-hosted charts:- Chart versions are defined in
Chart.yaml(versionfield) - Release versions should match the chart version you want to deploy
- Ryvn will look for the chart at the specified version in your repository
- Chart versions are managed by the chart maintainer
- You must use versions that actually exist in the public repository
- Check the chart repository’s available versions before creating releases
Automated Deployments with GitHub Actions
For Helm Chart services, you can set up automated deployments using GitHub Actions. This integration enables:- Automatic builds and deployments when you push changes to your chart
- Version management through Git tags
- Synchronized releases between GitHub and Ryvn
- Controlled deployments through release channels
- During service creation (recommended)
- Later through the service’s menu options
Release Management
Ryvn integrates with your existing release workflow:- Use release channels for staged deployments
- Configure maintenance windows for updates
- Enable automatic rollbacks for failed deployments
- Track release history across environments
Troubleshooting
Version Not Found Error
Version Not Found Error
- Verify the exact version exists in the chart repository
- Check for typos in version numbers
- Ensure the repository URL is correct and accessible
Chart Pull Failures
Chart Pull Failures
- Confirm the repository URL is publicly accessible
- Check if the chart name is spelled correctly
- Verify the repository supports the chart version you specified