AILERON Gateway

Overview

This page describes how to get started with developing the AILERON Gateway.

Required tools are:

• Go
• protoc - Protocol Buffer
• GNU make (Optional but recommended)

This image shows the overview of to build and run the AILERON Gateway.

stateDiagram-v2
  state run <<join>>
  state combine <<join>>
  state "Build binary" as build
  state "AILERON Gateway </br> binary" as binary
  state "*.go" as go
  state "*.proto" as proto
  state "*.pb.go" as pbgo
  state "Config files</br>(.yaml  /.json)" as config
  
  state build {
  proto --> pbgo : protoc
  pbgo --> combine
  go --> combine
  combine --> binary : go build
  }
build --> run
config --> run
run --> [*] : Run the gateway

Setup development environment

1. Install Go

Follow the instruction: Download and install.

Basicaly use the latest stable (1.(N).x) or previous stable (1.(N-1).x) version when developing from the main latest AILERON Gateway release. Minimum requirement of the Go version is declared in the go.mod.

Once installation is completed, make sure go command is available. You can check it by running go version.

$ go version
go version go1.24.0 linux/amd64

In addition to above, it is recommended to set $(go env GOPATH)/bin to the PATH variable at this time. $(go env GOPATH)/bin is the location where tools installed by go install .... are located.

If you are working on linux, this command sets the PATH.

PATH=$PATH:$(go env GOPATH)/bin

2. Install Protoc

Protoc is required when working with proto files. If you are not woking with proto files, you can skip this step.

Follow the instruction: Protocol Buffer Compiler Installation.

AILERON Gateway leverages protocol buffer to define config file interfaces. Go codes are generated from proto files using protoc command. See the proto directory for proto files.

Once installation is completed, make sure protoc command is available. You can check it by running protoc --version.

$ protoc --version
libprotoc 29.0

When installing the protoc, include/google/ directory which is bundled to the official protoc release must be located to the appropriate directory.

If you are working on a linux, typical directory structure should be like this.

/usr/
└── local/
    ├── bin/
    │   └── protoc
    └── include/
        └── google/

Where the /usr/local/include/ is one of the protoc default include path.

Other protoc default include paths are:

• <Current>/
• <Current>/include/
• <Parent>/include/

You can use one of them to locate the google/ directory.

 <Parent>
 ├── <Current>
 │   ├── protoc        <---- Current is the binary path
 │   ├── google/       <---- Included by default.
 │   └── include/
 │       └── google/   <---- Included by default.
 └── include/
     └── google/       <---- Included by default.

Read more at command_line_interface.cc.

3. Install protoc-gen-go

protoc-gen-go is required to generate Go codes from proto files.

Install it with the command.

go install "google.golang.org/protobuf/cmd/protoc-gen-go@latest"

And check the command was successfully installed.

$ protoc-gen-go --version
protoc-gen-go v1.36.6

Note that the command is installed in the path $(go env GOPATH)/bin when tools are installe by the go install ... command. So, the path must be exist in the PATH as describe in the 1. Install Go.

Build AILERON Gateway

The most simple way to build the AILERON Gateway is

# Working on the AILERON Gateway repository root.
go build cmd/aileron/

or with some recommended options

export CGO_ENABLED=0
go build -ldflags="-s -w" cmd/aileron/

You can use Makefile instead of running go command directory.

make build