v1

Getting Started /

Build and deploy your code

This walkthrough will take you through the steps to build and deploy your code in one simple service.

Combined services are a self-contained continuous integration and continuous delivery system.

It's as easy as choosing a branch from a Git repository to automatically build and deploy from.

Combined services cannot be added to a pipeline as they act as a self-contained pipeline. If you want to create a more complex workflow, the set up a pipeline walkthrough will take you through all the steps.

Create a combined service

All aspects of a combined service can be configured after creation - except the name.

  1. Choose service from the create new menu in the top right corner of the dashboard
  2. Basic information: select combined service and enter a name
  3. Repository: select the repository from the drop-down list and choose the branch you want to build from
  4. Build options: choose Dockerfile if you have a Dockerfile in your registry, or buildpack to automatically build your application. If your Dockerfile and/or build context are not root, specify the relative paths.
  5. Environment variables (optional): you can set runtime variables and build arguments, or add secret files in advanced
  6. Networking (optional): Northflank will automatically detect and add ports exposed in your Dockerfile, or add a public port for buildpacks. You can create a service with no ports. Networking will be covered in more detail later in this walkthrough.
  7. Resources: leave the resources as the default values for now, this walkthough will cover scaling later
  8. Advanced (optional): you can configure health checks, a Docker CMD override, and add a persistent volume
  9. Click create service
Creating Combined Service

Service dashboard

You will be taken to your new service's overview after creating it, you can find your service again by clicking on the services icon in the project menu on the left.

Your combined service will immediately start to build the latest commit to your branch.

Your combined service has CI/CD enabled by default and will automatically build and deploy the latest commits to your linked repository branch.

Combined service controls

The service header displays some useful details of the service at a glance:

  • Public DNS
  • Service region
  • Git repository
  • Repository branch
  • Currently deployed commit hash
  • Active containers and their status

You can manage your service using the controls found at the top of the dashboard:

  • You can toggle CI (continuous integration) to enable or disable the automatic build of the latest commit to the repository, branch, or pull request.
  • You can toggle CD (continuous delivery) to enable or disable the automatic deployment of new builds to your service. All instances will be redeployed with the new build. If you also have CI enabled, your service will automatically build and deploy the latest commits from your tracked branch.
  • You can trigger a restart to automatically replace the running containers with new instances. An old container will not be halted until its replacement is confirmed running.
  • You can scale the amount of instances up or down by entering the desired amount and saving.
  • You can pause to disable CI/CD and scale the service to 0 instances or resume

Service overview

The service overview contains real-time information on:

  • Recent builds by the service
  • Latest commits to the linked repository branch
  • Active containers and their status
  • Any configured public and private ports
  • Local access, which includes commands to connect to the service on your machine via the Northflank CLI

Configure your service

This walkthrough will take you through two commons tasks to configure a deployment: exposing a public port and increasing the resources available to your service.

Add a public port

Northflank can automatically detect and configure ports exposed in your Dockerfile, however you may sometimes need to manually add or edit ports.

Your Dockerfile should expose the port(s) configured in your application/service. For example if you have an Express.js application configured to listen for requests on port 3000, your Dockerfile should include EXPOSE 3000.

  1. Go to the ports & DNS page in your service
  2. Click add port
  3. Enter the port to expose (between 1 and 65,535)
  4. Choose HTTP as the protocol (public ports only support HTTP/S)
  5. Select publicly expose this port to the internet
  6. Enter a name for the port (this will form part of the unique DNS generated by Northflank)
  7. Save changes to start using the newly configured port

Northflank will automatically generate TLS certificates for your public ports using Let's Encrypt .

If the website or service is inaccessible, check that the correct ports exposed by your application and Dockerfile.

Increase your service's resources

The resources dedicated to your services will determine how they perform under load.

To build your code faster or run intensive applications you may need to increase the compute plan (CPU and memory) of your service.

If you expect or experience a high volume of traffic to your deployment, you should scale up the number of instances. Northflank will automatically load-balance incoming traffic to your instances to ensure maximum availability.

You can quickly scale the number of containers your deployment is running from the service header controls, but you can scale your service and increase other resources from the resources page.

  1. Go the resources page in your service
  2. Select a new compute plan with a combination of a higher share of a vCPU, or a dedicated CPU, and higher memory
  3. Increase the number of instances
  4. Update & restart your service to deploy more instances with the selected resources

Your available resources are limited in a free project. To scale up further you will need to upgrade your project.

© 2022 Northflank Ltd. All rights reserved.