restapi

package
v0.0.0-...-3fd5aad Latest Latest
Warning

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

Go to latest
Published: Oct 8, 2018 License: Apache-2.0 Imports: 44 Imported by: 0

Documentation

Overview

Package restapi lunaform This is a RESTful server for managing Terraform plan and apply jobs and the auditing of actions to approve those apply jobs. The inspiration for this project is the AWS CloudFormation API's. The intention is to implement a locking mechanism not only for the terraform state, but for the plan and apply of terraform modules. Once a `module` plan starts, it is instantiated as a `stack` within the nomencalture of `lunaform`.

Schemes:
  http
  https
Host: localhost
BasePath: /api
Version: 0.0.1-alpha
License: Apache 2.0 https://github.com/getlunaform/lunaform/blob/master/LICENSE
Contact: <drew.sonne@gmail.com>

Consumes:
- application/vnd.lunaform.v1+json

Produces:
- application/vnd.lunaform.v1+json

swagger:meta

Index

Constants

View Source
const (
	TF_STACK_STATUS_WAITING_FOR_DEPLOYMENT = "waiting_for_deployment"
	TF_STACK_STATUS_DEPLOY_FAIL            = "deployment_failed"
	TF_STACK_STATUS_DEPLOY_SUCEED          = "deployment_succeeded"
	TF_DEPLOYMENT_STATUS_PENDING           = "pending"
	TF_DEPLOYMENT_STATUS_DEPLOYING         = "deploying"
	TF_DEPLOYMENT_STATUS_SUCCESS           = "finished"
	TF_DEPLOYMENT_STATUS_FAIL              = "failed"
)
View Source
const (
	DB_TABLE_TF_WORKSPACE              = database.DBTableRecordType("lf-workspace")
	DB_TABLE_TF_MODULE                 = database.DBTableRecordType("lf-module")
	DB_TABLE_TF_STACK                  = database.DBTableRecordType("lf-stack")
	DB_TABLE_TF_STATEBACKEND           = database.DBTableRecordType("lf-statebackend")
	DB_TABLE_TF_PROVIDER               = database.DBTableRecordType("lf-provider")
	DB_TABLE_TF_PROVIDER_CONFIGURATION = database.DBTableRecordType("lf-provider-configuration")
	DB_TABLE_AUTH_USER                 = database.DBTableRecordType("lf-auth-user")
)
View Source
const (
	DB_TABLE_AUTH_APIKEY = "lf-auth-apikey"
)

Variables

View Source
var (
	// SwaggerJSON embedded version of the swagger document used at generation time
	SwaggerJSON json.RawMessage
	// FlatSwaggerJSON embedded flattened version of the swagger document used at generation time
	FlatSwaggerJSON json.RawMessage
)

Debug when true turns on verbose logging

Functions

func DebugLog

func DebugLog(format string, args ...interface{})

func ListResourceGroupsController

func ListResourceGroupsController(ch *helpers.ContextHelper) resources.ListResourceGroupsHandlerFunc

ListResourceGroupsController provides a list of resource groups. This is an exploratory read-only endpoint.

func ListResourcesController

func ListResourcesController(ch *helpers.ContextHelper) resources.ListResourcesHandlerFunc

ListResourcesController provides a list of resources under the identity tag. This is an exploratory read-only endpoint.

func ListTfModulesController

ListTfModulesController provides a list of modules

func NewTfDeployment

func NewTfDeployment(workspace string) *models.ResourceTfDeployment

Types

type CfgBackend

type CfgBackend struct {
	DatabaseType string      `json:"database_type"`
	Database     interface{} `json:"database"`
	IdentityType string      `json:"identity_type"`
	Identity     interface{} `json:"identity"`
}

CfgBackend describes how the server can load the backend database and the primary managed Identity Provider

type CfgIdentity

type CfgIdentity struct {
	Defaults []CfgIdentityDefault `json:"defaults"`
}

CfgIdentity describes the structure of options for Identity Providers

type CfgIdentityDefault

type CfgIdentityDefault struct {
	User     string `json:"username"`
	Password string `json:"password"`
}

CfgIdentityDefault allows the setting of a username and password for a default user. This value will only be used when initialising a new managed Identity Provider, and will be ignored on subsequent boots. @TODO Restrict this to only be for the `admin` user @TODO Allow a force cli option when booting to reset the password

type CommonServerErrorResponder

type CommonServerErrorResponder struct {
	Payload *models.ServerError
	// contains filtered or unexported fields
}

func NewServerErrorResponse

func NewServerErrorResponse(code int, errorString string) (r *CommonServerErrorResponder)

func (*CommonServerErrorResponder) Error

func (cser *CommonServerErrorResponder) Error()

func (*CommonServerErrorResponder) WriteResponse

func (cser *CommonServerErrorResponder) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type ConfigFileFlags

type ConfigFileFlags struct {
	ConfigFile  string `short:"c" long:"config" description:"Path to configuration on disk"`
	Version     bool   `short:"V" long:"version" description:"Print lunarform version and quit"`
	AdminApiKey string `long:"api-key" description:"Override the admin user's api key.'"`
}

ConfigFileFlags for loading settings for the server

type Configuration

type Configuration struct {
	Identity CfgIdentity `json:"identity"`
	Backend  CfgBackend  `json:"backend"`
}

Configuration describes the structure of options in the server config file

type Server

type Server struct {
	EnabledListeners []string         `long:"scheme" description:"the listeners to enable, this can be repeated and defaults to the schemes in the swagger spec"`
	CleanupTimeout   time.Duration    `long:"cleanup-timeout" description:"grace period for which to wait before shutting down the server" default:"10s"`
	MaxHeaderSize    flagext.ByteSize `` /* 231-byte string literal not displayed */

	SocketPath flags.Filename `long:"socket-path" description:"the unix socket to listen on" default:"/var/run/lunaform.sock"`

	Host         string        `long:"host" description:"the IP to listen on" default:"localhost" env:"HOST"`
	Port         int           `long:"port" description:"the port to listen on for insecure connections, defaults to a random value" env:"PORT"`
	ListenLimit  int           `long:"listen-limit" description:"limit the number of outstanding requests"`
	KeepAlive    time.Duration `` /* 169-byte string literal not displayed */
	ReadTimeout  time.Duration `long:"read-timeout" description:"maximum duration before timing out read of the request" default:"30s"`
	WriteTimeout time.Duration `long:"write-timeout" description:"maximum duration before timing out write of the response" default:"60s"`

	TLSHost           string         `long:"tls-host" description:"the IP to listen on for tls, when not specified it's the same as --host" env:"TLS_HOST"`
	TLSPort           int            `long:"tls-port" description:"the port to listen on for secure connections, defaults to a random value" env:"TLS_PORT"`
	TLSCertificate    flags.Filename `long:"tls-certificate" description:"the certificate to use for secure connections" env:"TLS_CERTIFICATE"`
	TLSCertificateKey flags.Filename `long:"tls-key" description:"the private key to use for secure conections" env:"TLS_PRIVATE_KEY"`
	TLSCACertificate  flags.Filename `long:"tls-ca" description:"the certificate authority file to be used with mutual tls auth" env:"TLS_CA_CERTIFICATE"`
	TLSListenLimit    int            `long:"tls-listen-limit" description:"limit the number of outstanding requests"`
	TLSKeepAlive      time.Duration  `` /* 160-byte string literal not displayed */
	TLSReadTimeout    time.Duration  `long:"tls-read-timeout" description:"maximum duration before timing out read of the request"`
	TLSWriteTimeout   time.Duration  `long:"tls-write-timeout" description:"maximum duration before timing out write of the response"`
	// contains filtered or unexported fields
}

Server for the lunaform API

func NewServer

func NewServer(api *operations.LunaformAPI) *Server

NewServer creates a new api lunaform server but does not configure it

func (*Server) ConfigureAPI

func (s *Server) ConfigureAPI()

ConfigureAPI configures the API and handlers.

func (*Server) ConfigureFlags

func (s *Server) ConfigureFlags()

ConfigureFlags configures the additional flags defined by the handlers. Needs to be called before the parser.Parse

func (*Server) Fatalf

func (s *Server) Fatalf(f string, args ...interface{})

Fatalf logs message either via defined user logger or via system one if no user logger is defined. Exits with non-zero status after printing

func (*Server) GetHandler

func (s *Server) GetHandler() http.Handler

GetHandler returns a handler useful for testing

func (*Server) HTTPListener

func (s *Server) HTTPListener() (net.Listener, error)

HTTPListener returns the http listener

func (*Server) Listen

func (s *Server) Listen() error

Listen creates the listeners for the server

func (*Server) Logf

func (s *Server) Logf(f string, args ...interface{})

Logf logs message either via defined user logger or via system one if no user logger is defined.

func (*Server) Serve

func (s *Server) Serve() (err error)

Serve the api

func (*Server) SetAPI

func (s *Server) SetAPI(api *operations.LunaformAPI)

SetAPI configures the server with the specified API. Needs to be called before Serve

func (*Server) SetHandler

func (s *Server) SetHandler(handler http.Handler)

SetHandler allows for setting a http handler on this server

func (*Server) Shutdown

func (s *Server) Shutdown() error

Shutdown server and clean up resources

func (*Server) TLSListener

func (s *Server) TLSListener() (net.Listener, error)

TLSListener returns the https listener

func (*Server) UnixListener

func (s *Server) UnixListener() (net.Listener, error)

UnixListener returns the domain socket listener

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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