Set up a preview environment | Release | Northflank Application docs

v1

Overview
Getting started
- Introduction to Northflank
- Link your Git account
- Create a project
- Build and deploy your code
- Set up a pipeline
- Add and verify a domain
Production workloads
- Get production-ready on Northflank
- Release for production
- Persistent storage in production
- Production operations
Deploy on Northflank
Migrate from Heroku
Pricing on Northflank
How-to guides
Build
- Build your code on Northflank
- Build code from a Git repository
- Build code from a self-hosted VCS
- Inject build arguments
- Build with a Dockerfile
- Build with buildpacks
- Pull images from Northflank
Run
- Run containers and micro-services on Northflank
- Run an image continuously
- Run an image once or on a schedule
- Run an image from a container registry
- Save registry credentials
- Change deployment source
- Inject runtime variables
- Deploy to a region
- Access running containers locally
- Override command or entrypoint
Release
- Continuous integration and delivery on Northflank
- Manage CI/CD
- Create a pipeline and release flow
- Configure a release flow
- Set up a preview environment
- Run and manage releases
- Run migrations
Infrastructure as code
- Infrastructure as code on Northflank
- Create a template
- Write a template
- Run a template
- Share a template
- GitOps on Northflank
- Use GitHub Actions with Northflank
Observe
- Observability on Northflank
- See builds
- Monitor containers
- View logs
- View metrics
- Configure health checks
- Configure notification integrations
- Set infrastructure alerts
- Configure log sinks
- Tag workloads and resources
Scale
- Scaling your services on Northflank
- Scale replicas/instances
- Increase CPU and memory resources
- Increase storage
- Autoscale deployments
Databases & persistence
- Stateful workloads on Northflank
- Deploy a database
- Connect database secrets to workloads
- Access a database
- Scale a database
- Configure addons for high availability
- Database observability and monitoring
- Backup, restore, and import data
- Upgrade a database
- Add a persistent volume
- Deploy databases and storage on Northflank
- Migrate your data to Northflank
Network
- Networking on Northflank
- Expose your application
- Configure ports
- Set IP policies
- Configure basic authentication
Secure
- Security on Northflank
- Inject secrets
- Upload secret files
- Manage secret groups
- Manage API tokens
- Enable single sign-on and multi-factor authentication
Domains
- Domains on Northflank
- Add a domain to your account
- Link a domain to a port
- Remove a domain
- Wildcard domains and certificates
- Domain registrar guides
Collaborate
- Teams on Northflank
- Create a team
- Manage Git integrations
- Using role-based access control
- Grant a team member API access
Cloud providers
- Using other cloud providers with Northflank
- Add your cloud account to Northflank
- Create a Kubernetes cluster with Northflank
- Manage and use your Kubernetes cluster with Northflank
- Deploy your workloads to specific node pools
Billing
- Pricing on Northflank
- Cloud provider billing
- Add a card
- Project types
- Monitor spending
- View invoices
- Pay an invoice
- Add your tax ID
API & CLI
Use the API
Use the CLI
Use the JavaScript client
Forwarding
Execute commands
Log tailing
Retrieve metrics

Application API & CLI

On this page

Preview environment templates
Configure a preview environment
Create and manage a preview environment
Delete a preview environment
Next steps

Release /

Set up a preview environment

Northflank's preview environment feature facilitates the automatic provisioning of resources and deployment of builds when you push commits to Git branches.

You can configure a preview environment template for each of your pipelines, and define Git triggers to create new preview environments when you push a commit to specific pull requests and branches.

A new preview environment will be created when you push a commit to a branch that matches your trigger rules, or, if the branch already has a preview environment, the existing preview environment will be updated.

Early access

Preview environments are in early access and subject to change. To request access for your account please contact support.

Click here to select a pipeline and create a preview environment in it.

Preview environment templates

Preview environments are defined with Northflank templates to provision resources such as deployment services, databases, and secret groups, and to build and deploy your commits. If you're not familiar with Northflank templates you can refer to the documentation for writing templates.

Editing a build source node for a preview environment template using the visual editor in the Northflank application.