https://github.com/terrapi-solution/protocol

TerrAPI protocol. Protobuf definitions for TerrAPI's signaling protocol
https://github.com/terrapi-solution/protocol

cloudnative golang opentofu protocol terraform terrapi

Last synced: about 2 months ago
JSON representation

TerrAPI protocol. Protobuf definitions for TerrAPI's signaling protocol

• Host: GitHub
• URL: https://github.com/terrapi-solution/protocol
• Owner: terrapi-solution
• License: apache-2.0
• Created: 2024-10-13T15:04:55.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-12-04T19:44:16.000Z (about 2 months ago)
• Last Synced: 2024-12-04T20:33:10.837Z (about 2 months ago)
• Topics: cloudnative, golang, opentofu, protocol, terraform, terrapi
• Language: Batchfile
• Homepage:
• Size: 83 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# TerrAPI Protocol

[![Current Tag](https://img.shields.io/github/v/tag/terrapi-solution/protocol?sort=semver)](https://github.com/terrapi-solution/protocol)

[![Lint Status](https://github.com/terrapi-solution/protocol/actions/workflows/protolint.yaml/badge.svg)](https://github.com/terrapi-solution/protocol/actions/workflows/protolint.yaml)

[![Go Reference](https://pkg.go.dev/badge/github.com/terrapi-solution/protocol.svg)](https://pkg.go.dev/github.com/terrapi-solution/protocol)

## Overview

This project shares a protobuf models with all TerrAPI projects.

## Prerequisites

- Go 1.16 or later

- Protocol Buffers compiler (`protoc`)

- `protoc-gen-go` and `protoc-gen-go-grpc` plugins

## Installation

Install the Protocol Buffers compiler (`protoc`):

```sh

# On Ubuntu

sudo apt-get install -y protobuf-compiler

# On macOS

brew install protobuf

```

Install the Go plugins for Protocol Buffers:

```sh

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

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

```

Ensure the `protoc-gen-go` and `protoc-gen-go-grpc` binaries are in your PATH:

```sh

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

```

## Generating Code

To generate the Go code from the Protocol Buffers definitions, run the following script:

On Unix-based systems:

```sh

./gen.sh

```

On Windows:

```sh

gen.cmd

```

## Security

If you discover a security vulnerability within this package, please send an e-mail to 

## Contributing

Fork -> Patch -> Push -> Pull Request

## License

This project is licensed under the Apache License, Version 2.0.

See the [LICENSE](LICENSE) file for details.