gromit

README

Gromit

This is ostensibly a cobra app.

% ./gromit --help
A longer description that spans multiple lines and likely contains
examples and usage of using your application. For example:

Cobra is a CLI library for Go that empowers applications.
This application is a tool to generate the needed files
to quickly create a Cobra application.

Usage:
  gromit [command]

Available Commands:
  client      Interact with the gromit server
  help        Help about any command
  serve       Run endpoint for github requests

Flags:
      --config string   config file (default is $HOME/.gromit.yaml)
  -h, --help            help for gromit
  -t, --toggle          Help message for toggle

Use "gromit [command] --help" for more information about a command.

Server

This runs at gromit.dev.tyk.technology and listens for the requests that come in from the int-images Github Actions.

% ./gromit serve --help
Runs an HTTPS server, bound to 443 that can be accesses only via mTLS. 

This endpoint is notified by the int-image workflows in the various repos when there is a new build

Usage:
  gromit serve [flags]

Flags:
      --certpath string   path to rootca and key pair. Expects files named ca.pem, server(-key).pem (default "certs")
  -h, --help              help for serve

Global Flags:
      --config string   config file (default is $HOME/.gromit.yaml)

To test gromit run locally

docker build -t grun . && docker run --rm --name gr0 \
-e GROMIT_TABLENAME=DeveloperEnvironments \
-e GROMIT_REPOS=tyk,tyk-analytics,tyk-pump \
-e AWS_ACCESS_KEY_ID=keyid \
-e AWS_SECRET_ACCESS_KEY=secret \
-e AWS_REGION=eu-central-1 \
-e TF_API_TOKEN=secret \
-e GROMIT_DOMAIN=dev.tyk.technology \
grun run

Documentation

Overview

Copyright © 2020 Alok G Singh <alok@tyk.io>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.