servicectl

README

System Control

A tool for systems that use:

• https://github.com/alexfalkowski/go-service
• https://github.com/alexfalkowski/go-service-template
• https://github.com/alexfalkowski/go-client-template

Cache

The ability to handle the cache configuration.

Redis

Handle redis configuration.

❯ ./servicectl redis --help
Redis cache.

Usage:
  servicectl redis [flags]

Flags:
  -h, --help     help for redis
  -v, --verify   verify connection

Global Flags:
  -i, --input string    input config location (format kind:location)

Crypto

The ability to handle the cryptography configuration.

AES

Handle AES configuration.

❯ ./servicectl aes --help
AES crypto.

Usage:
  servicectl aes [flags]

Flags:
  -h, --help     help for aes
  -r, --rotate   rotate key
  -v, --verify   verify key

Global Flags:
  -i, --input string    input config location (format kind:location)

HMAC

Handle HMAC configuration.

❯ ./servicectl hmac --help
HMAC crypto.

Usage:
  servicectl hmac [flags]

Flags:
  -h, --help     help for hmac
  -r, --rotate   rotate key
  -v, --verify   verify key

Global Flags:
  -i, --input string    input config location (format kind:location)

RSA

Handle RSA configuration.

❯ ./servicectl rsa --help
RSA crypto.

Usage:
  servicectl rsa [flags]

Flags:
  -h, --help     help for rsa
  -r, --rotate   rotate keys
  -v, --verify   verify keys

Global Flags:
  -i, --input string    input config location (format kind:location)

Ed25519

Handle Ed25519 configuration.

❯ ./servicectl ed25519 --help
Ed25519 crypto.

Usage:
  servicectl ed25519 [flags]

Flags:
  -h, --help     help for ed25519
  -r, --rotate   rotate keys
  -v, --verify   verify keys

Global Flags:
  -i, --input string    input config location (format kind:location)

Database

The ability to handle the database configuration.

PG

Handle pg configuration.

❯ ./servicectl pg --help
Postgres DB.

Usage:
  servicectl pg [flags]

Flags:
  -h, --help     help for pg
  -v, --verify   verify connection

Global Flags:
  -i, --input string    input config location (format kind:location)

Feature

The ability to handle the feature configuration.

❯ ./servicectl feature --help
Feature flags.

Usage:
  servicectl feature [flags]

Flags:
  -h, --help     help for feature
  -v, --verify   verify connection

Global Flags:
  -i, --input string    input config location (format kind:location)

Hook

The ability to handle the hook configuration.

❯ ./servicectl hook --help
Webhook.

Usage:
  servicectl hook [flags]

Flags:
  -h, --help   help for hook
  -s, --sign   sign webhook

Global Flags:
  -i, --input string    input config location (format kind:location)

NET

The ability to handle the net configuration.

HTTP

Handle HTTP configuration.

❯ ./servicectl http --help
HTTP Server.

Usage:
  servicectl http [flags]

Flags:
  -h, --help     help for http
  -v, --verify   verify server

Global Flags:
  -i, --input string    input config location (format kind:location)

gRPC

Handle gRPC configuration.

❯ ./servicectl grpc --help
gRPC Server.

Usage:
  servicectl grpc [flags]

Flags:
  -h, --help     help for grpc
  -v, --verify   verify server

Global Flags:
  -i, --input string    input config location (format kind:location)

Development

If you would like to contribute, here is how you can get started.

Structure

The project follows the structure in golang-standards/project-layout.

Dependencies

Please make sure that you have the following installed:

• Ruby
• Golang

Style

This project favours the Uber Go Style Guide

Setup

Check out CI.

Changes

To see what has changed, please have a look at CHANGELOG.md