LogoLogo
  • Welcome to Release
  • Getting started
    • Quickstart
    • Create an account
    • Prepare to use Release
    • Create an application
      • Create custom application
      • Create from template
      • Servers vs runnables
    • Create an environment
  • Guides and examples
    • Domains and DNS
      • Manage domains
      • DNS and nameservers
        • Configure GoDaddy
        • Configure Cloudflare
        • Configure Namecheap
        • Other DNS hosts
      • Routing traffic
    • Example applications
      • Full stack voting app
      • Flask and RDS counter app
      • Static site with Gatsby
      • Golang with Postgres and Nginx
      • WordPress with MySQL
      • Spring and PostgreSQL
      • Terraform and Flask
      • OpenTelemetry demo
      • Load balancer with hostname
      • Static JavaScript service
      • SSH bastion access to services
      • ngrok and OAuth for private tunnels
      • Using OAuth Proxy
      • Hybrid Docker and static site
      • App Imports: Connecting two applications
      • Example library
    • Running instances
      • Cron jobs
      • Jobs
      • Using Helm charts
      • Using terminal
      • Viewing logs
      • Troubleshooting
        • ImagePullBackoff error
        • CrashLoopBackoff error
        • Exit codes
        • OOM: out of memory
    • Advanced guides
      • Containers guide
      • Application guide
      • Kubernetes guide
      • Create a cluster
      • Upgrade a cluster
      • Managing node groups
      • Patch node groups
      • Hostnames and rules
      • Serve traffic on multiple ports
      • Configure access to your K8s cluster
      • Designing for multiple environments
      • Microservices architecture
      • Monitoring your clusters
      • Performance tuning
      • Visibility and monitoring
      • Working with data
        • Container-based data
        • Seeding and migration
        • Cloud-provided data
        • Golden images
        • Third party
      • Pausing Instant Datasets
        • Application pausing schedules
        • Pause/resume environments
      • Infrastructure as code
        • Terraform
  • Reference documentation
    • Account settings
      • Account info
      • Managing users
      • Build settings
        • Build arguments
        • Build SSH keys
      • Add integrations
      • View clusters and cloud integrations
      • Add datasets
      • Environment handles
    • Workflows in Release
      • Stages of workflows
      • Serial deployments
      • Parallel deployments
      • Rolling deployments
      • Rainbow deployments
    • Networking
      • Network architecture (AWS)
      • Network architecture (GCP)
      • Ingresses
      • IP addresses
      • Cloud-provided services
      • Third-party services
    • Release environment versioning
    • Application settings
      • Application Template
        • Schema definition
      • Default environment variables
      • GitHub
      • Pull requests
      • GitOps
      • Just-in-time file mounts
      • Primary App Link
      • Create application FAQ
      • App-level build arguments
      • Parameters
      • Workspaces
    • End-to-end testing
    • Environment settings
      • Environment configuration
      • Environment variables
        • Environment variable mappings
        • Secrets vaults
        • Using Secrets with GitOps
        • Kubernetes Secrets as environment variables
        • Managing legacy Release Secrets
    • Environment expiration
    • Environment presets
    • Instant datasets on AWS
    • Instant datasets on GCP
    • Instant dataset tasks
      • Tonic Cloud
      • Tonic On-Premise
    • Cloud resources
    • Static service deployment
    • Helm
      • Getting started
      • Version-controlled Helm charts
      • Open-source charts
      • Building Docker images
      • Ingress and networking
      • Configuration
    • GitOps
    • The .release.yaml file
    • Docker Compose conversion support
    • Reference examples
      • Adding and removing services
      • Managing service resources
      • Adding database containers to the Application Template
      • Stock Off-The-Shelf Examples
    • Release API
      • Account Authentication
      • Environments API
        • Create
        • Get
        • Setup
        • Patch
      • User Authentication
      • Environment Presets API
        • Get Environment Preset List
        • Get Environment Preset
        • Put Environment Preset
  • Background concepts
    • How Release works
  • Frequently asked questions
    • Release FAQ
    • AWS FAQ
    • Docker FAQ
    • JavaScript FAQ
  • Integrations
    • Integrations overview
      • Artifactory integration
      • Cloud integrations (AWS)
        • AWS guides
        • Grant access to AWS resources
        • AWS how to increase EIP quota
        • Control your EKS fleet with systems manager
        • Managing STS access
        • AWS Permissions Boundaries
        • Private ECR Repositories
        • Using an Existing AWS VPC
        • Using an Existing EKS Cluster
      • Docker Hub integration
      • LaunchDarkly integration
      • Private registries
      • Slack integration
      • Cloud integrations (GCP)
        • GCP Permissions Boundary
      • Datadog Agent
      • Doppler Secrets Manager
      • AWS Secrets Management
    • Source control integrations
      • GitHub
        • Pull request comments
        • Pull request labels
        • GitHub deployments
        • GitHub statuses
        • Remove GitHub integration
      • Bitbucket
      • GitLab
    • Monitoring and logging add-ons
      • Datadog
      • New Relic
      • ELK (Elasticsearch, Logstash, and Kibana)
  • Release Delivery
    • Create new customer integration
    • Delivery guide
    • Release to customer account access controls
    • Delivery FAQs
  • Release Instant Datasets
    • Introduction
    • Quickstart
    • Security
      • AWS Instant Dataset security
    • FAQ
    • API
  • CLI
    • Getting started
    • Installation
    • Configuration
    • CLI usage example
    • Remote development environments
    • Command reference
      • release accounts
        • release accounts list
        • release accounts select
      • release ai
        • release ai chat
        • release ai config-delete
        • release ai config-init
        • release ai config-select
        • release ai config-upsert
      • release apps
        • release apps list
        • release apps select
      • release auth
        • release auth login
        • release auth logout
      • release builds
        • release builds create
      • release clusters
        • release clusters exec
        • release clusters kubeconfig
        • release clusters shell
      • release datasets
        • release datasets list
        • release datasets refresh
      • release deploys
        • release deploys create
        • release deploys list
      • release development
        • release development logs
        • release development start
      • release environments
        • release environments config-get
        • release environments config-set
        • release environments create
        • release environments delete
        • release environments get
        • release environments list
        • release environments vars-get
      • release gitops
        • release gitops init
        • release gitops validate
      • release instances
        • release instances exec
        • release instances logs
        • release instances terminal
  • Release.ai
    • Release.ai Introduction
    • Getting Started
    • Release.ai Templates
    • Template Configuration Basics
    • Using GPU Resources
    • Custom Workflows
    • Fine Tuning LlamaX
    • Serving Inference
Powered by GitBook
On this page
  • Step 1: Create a Release account
  • Step 2: Upgrade to a paid plan
  • Step 3: Integrate your cloud provider
  • Step 4: Link your domain
  • Step 5: Create a cluster
  • Step 6: Connect your source control provider
  • Step 7: Create and deploy an application
  • Where to next

Was this helpful?

  1. Getting started

Quickstart

PreviousWelcome to ReleaseNextCreate an account

Last updated 11 months ago

Was this helpful?

Here's a step-by-step guide to adopting Release in your organization.

  1. Create a Release account.

  2. Upgrade to a paid plan.

  3. Integrate your cloud provider.

  4. Link a domain.

  5. Create a cluster.

  6. Connect your source control provider.

  7. Create your application.

Step 1: Create a Release account

Visit and sign up using your email address or a single sign-on provider such as GitHub, Bitbucket, GitLab, or Google.

Take a look at our documentation if you need more information about this step.

Step 2: Upgrade to a paid plan

If you're just getting started, this step is optional.

After signing up, you'll have access to a limited free account, which you can use to explore Release and see how it works.

For production hosting on your Amazon Web Services (AWS) or Google Cloud Platform (GCP) account, you'll need to sign up for a paid plan. Email us at or contact us using the chat button on our website to arrange this.

Step 3: Integrate your cloud provider

If you're on a paid plan, integrate Release with your cloud provider.

In Account Settings, navigate to Clusters, and press Create new cloud provider integration. Currently, we support AWS and GCP.

When prompted to log in to your cloud provider, you should use an account with enough privileges to create and destroy clusters, manage permissions, manage DNS settings, and other provider-specific functionality that Release will need to function.

Take a look at the following docs for more help with integrating your cloud provider:

Step 4: Link your domain

If you don't already have a domain, you should register one through your cloud provider (for example, Route53 if you're using AWS).

To link your domain to Release, go to Settings -> Domains -> Create new domain.

Enter your domain and take note of the nameservers that Release will display. If you're using a third-party domain provider, configure your domain to point to these name servers.

Finally, verify your domain by pressing the Verify button.

Step 5: Create a cluster

Once you have a linked and verified domain, you can create your first cluster. Navigate to Settings -> Clusters and choose Create new cluster under your cloud provider.

Step 6: Connect your source control provider

Release will pull code from your source control provider (such as GitHub, GitLab, or Bitbucket) to deploy your application.

To get started, click on your profile picture in Release, then on Manage Profile.

You can connect GitHub, Bitbucket, or GitLab.

If you're connecting GitHub, you'll be given the option to grant Release access to all of your repositories or only specific repositories.

Once you've created the connection, you'll be able to view your repositories when creating a new app from Release and select the one that you want to deploy using Release.

Step 7: Create and deploy an application

Select an example application and fork it to your integrated source control account. Then press Create new app from your Release dashboard and choose the repository you forked.

Where to next

Now you can configure and monitor your applications through your Release dashboard. If necessary, you can still access your AWS account and Kubernetes cluster directly, but for most use cases, you can enjoy our simplified controls and sensible defaults.

To get the most out of Release, you should:

You can also use a domain registered through a third-party provider such as GoDaddy (follow our guide), but it's easier if you use your cloud provider directly.

For more help with this, see .

You may have integrated a source provider account when you signed up for Release using SSO, but you can further to give Release access to the correct repositories and edit other settings, like whether Release automatically comments on your pull requests.

To test that everything works, you can deploy one of our .

Prepare your applications for use with Release. See .

Understand the that lets you configure most aspects of Release.

Read our to understand the details of how Release works.

app.releasehub.com
Create an Account
upgrade@releasehub.com
AWS Integration
GCP Integration
external DNS
Create a cluster
configure your source control provider
ready-to-go example applications
Prepare to use Release
Application Template file
Application guide
Create new cloud provider integration
Create new cluster
Source Control Settings
New Application
Create new app
Analyze Repository
Generate Template