| title | Create a Go service in Zerops |
|---|---|
| description | Learn how you can create a go service in Zerops. |
import Image from '/src/components/Image'; import data from '@site/static/data.json'; import UnorderedList from '@site/src/components/UnorderedList'; import Video from '@site/src/components/Video'; import ResourceTable from '/src/components/ResourceTable';
Zerops provides a Go runtime service with extensive build support. Go runtime is highly scalable and customisable to suit both development and production.
First, set up a project in Zerops GUI. Then go to the project dashboard page and choose Add new service in the left menu in the Services block. Then add a new Go service:
Following Go versions are currently supported:
:::info You can change the major version at any time later. :::
Enter a unique service identifier like "app","cache", "gui" etc. Duplicate services with the same name in the same project are forbidden.
- maximum 25 characters
- must contain only lowercase ASCII letters (a-z) or numbers (0-9)
:::caution The hostname is fixed after the service is created. It can't be changed later. :::
Add environment variables with sensitive data, such as password, tokens, salts, certificates etc. These will be securely saved inside Zerops and added to your runtime service upon start.
Setting the secret environment variables is optional. You can set them later in Zerops GUI.
Read more about different types of env variables in Zerops.
import { SetVar } from '/src/components/content/var'; import AutoScalingSection from '/src/components/content/create-scaling.mdx';
zCLI is the Zerops command-line tool. To create a new Go service via the command-line, follow these steps:
- Install & setup zCLI
- Create a project description file
- Create a project with a Go and PostgreSQL service
Zerops uses a yaml format to describe the project infrastructure.
Create a directory my-project. Create an description.yaml file inside the my-project directory with following content:
# basic project data
project:
# project name
name: my-project
# array of project services
services:
- # service name
hostname: app
# service type and version number in go@{version} format
type: go@latest
# defines the minimum number of containers for horizontal autoscaling
minContainers: 1
# defines the maximum number of containers for horizontal autoscaling. Max value = 6.
maxContainers: 6
# optional: create env variables
envSecrets:
S3_ACCESS_KEY_ID: 'P8cX1vVVb'
S3_ACCESS_SECRET: 'ogFthuiLYki8XoL73opSCQ'The yaml file describes your future project infrastructure. The project will contain one Go version 1 service with default auto scaling configuration. Hostname will be set to "app", the internal port(s) the service listens on will be defined later in the zerops.yaml. Following secret env variables will be configured:
S3_ACCESS_KEY_ID="P8cX1vVVb"
S3_ACCESS_SECRET="ogFthuiLYki8XoL73opSCQ"Create a directory my-project. Create an description.yaml file inside the my-project directory with following content:
# basic project data
project:
# project name
name: my-project
# optional: project description
description: A project with a Go and PostgreSQL database
# optional: project tags
tags:
- DEMO
- ZEROPS
# array of project services
services:
- # service name
hostname: app
# service type and version number in go@{version} format
type: go@latest
# optional: vertical auto scaling customization
verticalAutoscaling:
cpuMode: DEDICATED
minCpu: 2
maxCpu: 5
minRam: 2
maxRam: 24
minDisk: 6
maxDisk: 50
startCpuCoreCount: 3
minFreeRamGB: 0.5
minFreeRamPercent: 20
# defines the minimum number of containers for horizontal autoscaling. Max value = 6.
minContainers: 2
# defines the maximum number of containers for horizontal autoscaling. Max value = 6.
maxContainers: 4
# optional: create secret env variables
envSecrets:
S3_ACCESS_KEY_ID: 'P8cX1vVVb'
S3_ACCESS_SECRET: 'ogFthuiLYki8XoL73opSCQ'
- # second service hostname
hostname: db
# service type and version number in postgresql@{version} format
type: postgresql@12
# mode of operation "HA"/"non_HA"
mode: NON_HAThe yaml file describes your future project infrastructure. The project will contain a Go service and a PostgreSQL service.
Go service with "app" hostname, the internal port(s) the service listens on will be defined later in the zerops.yaml. Go service will run on version 1 with a custom vertical and horizontal scaling. Following secret env variables will be configured:
S3_ACCESS_KEY_ID="P8cX1vVVb"
S3_ACCESS_SECRET="ogFthuiLYki8XoL73opSCQ"The hostname of the PostgreSQL service will be set to "db". The single container(/features/scaling#deployment-modes-databases-and-shared-storage) mode will be chosen and the default auto scaling configuration will be set.
The project: section is required. Only one project can be defined.
| Parameter | Description |
|---|---|
| hostname |
The unique service identifier.
|
When you have your description.yaml ready, use the zcli project project-import command to create a new project and the service infrastructure.
Usage:
zcli project project-import importYamlPath [flags]
Flags:
-h, --help Help for the project import command.
--org-id string If you have access to more than one organization, you must specify the org ID for which the
project is to be created.
--working-dir string Sets a custom working directory. Default working directory is the current directory. (default "./")Zerops will create a project and one or more services based on the description.yaml content.
Maximum size of the description.yaml file is 100 kB.
You don't specify the project name in the zcli project project-import command, because the project name is defined in the description.yaml.
If you have access to more than one client, you must specify the client ID for which the project is to be created. The clientID is located in the Zerops GUI under the client name on the project dashboard page.
Create a directory my-project if it doesn't exist. Create an import.yaml file inside the my-project directory with following content:
# basic project data
project:
# project name
name: my-project
# array of project services
services:
- # service name
hostname: app
# service type and version number in go@{version} format
type: go@latest
# defines the minimum number of containers for horizontal autoscaling
minContainers: 1
# defines the maximum number of containers for horizontal autoscaling. Max value = 6.
maxContainers: 6
# optional: create env variables
envSecrets:
S3_ACCESS_KEY_ID: 'P8cX1vVVb'
S3_ACCESS_SECRET: 'ogFthuiLYki8XoL73opSCQ'The yaml file describes the list of one or more services that you want to add to your existing project. In the example above, one Go service version 1 with default auto scaling configuration will be added to your project. Hostname of the new service will be set to app. Following secret env variables will be configured:
S3_ACCESS_KEY_ID="P8cX1vVVb"
S3_ACCESS_SECRET="ogFthuiLYki8XoL73opSCQ"The content of the services: section of import.yaml is identical to the project description file. The import.yaml never contains the project: section because the project already exists.
When you have your import.yaml ready, use the zcli project service-import command to add one or more services to your existing Zerops project.
Usage:
zcli project service-import importYamlPath [flags]
Flags:
-h, --help Help for the project service import command.
-P, --project-id string If you have access to more than one project, you must specify the project ID for which the
command is to be executed.zCLI commands are interactive, when you press enter after zcli project service-import importYamlPath, you will be given a list of your projects to choose from.
Maximum size of the import.yaml file is 100 kB.