root

package module
v0.0.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 8, 2022 License: Apache-2.0 Imports: 4 Imported by: 0

README

Ponos

Background

πόνος - pain in greek!

Introduction

Ponos is tool which the Mattermost SRE team uses daily to eliminate toil work with ChatOps tools. It includes the followings:

  • Ponos microservice: it's responsible for the business logic of the toil work
  • Ponos Mattemost App: it's the ChatOps based on Mattermost App Framework which interacts with Ponos service.

Developing

Running

For Ponos HTTP service you need a running provisioner and management of workspaces:

export AWS_REGION=us-east-1
export AWS_PROFILE="<profile-for-infra-migrations>"
export PONOS_ACCOUNT_ID="<aws-account-id-for-testing>"
export PONOS_KMS_KEY="<aws-kms-id-for-testing>"
export PONOS_PROVISIONER_ADDRESS=<your-provisioner-url>
export PONOS_WORKSPACES_ADDRESS=<your-workspaces-url>
export BUILD_SERVICE=server
make run

For Ponos ChatOps Mattermost App you need to run the following:

export PONOS_APP_ROOT_URL=http://<your-ip>:3000
export BUILD_SERVICE=app
make run
Testing

Running tests:

make test
Docker

Docker build and run locally Ponos Service.

make docker-build

docker run --rm -p 3000:3000 \
    -e PONOS_PROVISIONER_ADDRESS=https://<your-url> \
    -e PONOS_WORKSPACES_ADDRESS=https://<your-url>  mattermost/ponos-service:dev-local

Documentation

Index

Constants

This section is empty.

Variables

View Source
var AppManifest apps.Manifest
View Source
var Manifest model.Manifest
View Source
var Static embed.FS

Static is preloaded with the contents of the ./static directory.

Functions

This section is empty.

Types

This section is empty.

Directories

Path Synopsis
cmd
app
internal
api
tools/exechelper
Package exechelper streamlines the running of external commands while both capturing and logging their output.
Package exechelper streamlines the running of external commands while both capturing and logging their output.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL