Skip to main content

Getting Started with Kuberns


Kuberns is built to help you streamline your cloud management and Deploy Seamlessly. Whether you're a solo developer or part of a team, Kuberns provides the tools you need to efficiently set up, manage, and scale your services. This guide will walk you through the initial steps, from project creation to service deployment, ensuring you have a solid foundation to build and grow your applications confidently.

Step 1: Create a new Project​

All your services come under a project. So to deploy your first backend service let’s create a project to define different services that make up your application. New users are prompted with a new project screen by default but in case you missed it, you can create one by clicking on Add New button on the top right of your navbar.

  1. Start by giving your project an easy-to-remember and relatable name

  2. Pick the service you want to start your project with
    - Here, we’ll go with a backend Service.



Tip

You can create multiple services within a single project. For now, select one service to begin with.

Step 2: Connect with GitHub​

Following the selection of service, you will be redirected to the "Creating a Service" page where you can configure the version control source. If this is the first time to Kuberns, you will need to authenticate GitHub to allow access to your repositories. Once authorized, you can select an organization, repository, and branch from your GitHub account.

  • On choosing to connect to GitHub, you are redirected to authorize Kuberns to access your Repositories.

Consecutively you are redirected back to the Kuberns dashboard, which now displays a list of your GitHub repos to choose from including your choice of organization and branch thus successfully linking your GitHub account.

Select Organization, Repository, and Branch:​

  • Once authenticated, select the appropriate organization.
  • Choose the repository you want to use.
  • Select the branch you want to deploy


Step 3: Tailor your deployment:​

At Kuberns, we aim to simplify and enhance your deployment experience by tailoring it to your specific needs.

Start by giving the service a name, selecting the region where it will be hosted, and choosing a template. Additionally, you can select a plan for your services based on your requirements.

  • Service Name: Provide a name for your service.
  • Select Region: Choose the region where your service will be hosted.
  • Select Template: Pick the template (framework) of your project.
  • Select Plan: By default, a starter plan is provided, suitable for independent developers and small-scale businesses. You can choose a different plan as per your requirements.


Step 4: Attach a Database​

In this step, you can add a database to your service and set its plan. You can choose the type of database, such as PostgreSQL, and configure the necessary settings. Adding a database is not a compulsion, we’ll skip it in this guide but if you want to see how the Database works in kuberns check it out here.



Step 5: Add Environment Variables​

Here, you can manually enter the key and value of each environment variable or upload a .env file to automatically read the environment variable values. Once done, you can complete the setup.

  • Enter Environment Variables Manually: Manually input the key and value for each environment variable.
  • Upload .env File: Alternatively, upload a .env file to automatically populate the environment variable values.
  • Complete Setup: Once all variables are set, complete the setup process.


Initial Deployment​

The initial deployment will take some time. After the deployment is complete, you will be redirected to the service dashboard. Here, you can manage your service and view the deployed service.



Congratulations! Your service has been successfully deployed.

You can now manage your service and access the deployed version from the service dashboard. Thank you for choosing our platform for your development needs. Happy coding!