gke

Documentation

Overview

Copyright © 2020 A. Jensen <jensen.aaro@gmail.com>

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

Index

• Constants
• Variables
• func Alive() (context.Context, context.CancelFunc)
• func InstanceName() string
• func NewServer(ctx context.Context, handler http.Handler, lg Logger) (*http.Server, error)
• func OnGCE() bool
• func ProjectID() string
• type LogClient
  • func NewLogClient(ctx context.Context) (LogClient, func(), error)
  • func NewLogClientWithOptions(ctx context.Context, parent LogParentId, opts ...logging.LoggerOption) (LogClient, func(), error)
• type LogId
  • func NewLogId() LogId
• type LogParentId
  • func NewLogParentId() LogParentId
• type Logger
  • func NewLogger(logc LogClient) (Logger, func(), error)
  • func NewLoggerWithOptions(logc LogClient, logId LogId, opts ...logging.LoggerOption) (Logger, func(), error)
• type StorageClient
  • func NewStorageClient(ctx context.Context) (StorageClient, func(), error)

Constants

const RequestContextKey = requestContextKey(`gkeRequestContextKey`)

Variables

var (
	LogGke bool = true
	LogStd bool = true
)

Functions

func Alive

func Alive() (context.Context, context.CancelFunc)

Alive returns a context that is used to communicate a shutdown to various parts of an application.

func InstanceName

func InstanceName() string

func NewServer

func NewServer(ctx context.Context, handler http.Handler, lg Logger) (*http.Server, error)

func OnGCE

func OnGCE() bool

func ProjectID

func ProjectID() string

Types

type LogClient

type LogClient interface {
	Logger(logID string) Logger
}

func NewLogClient

func NewLogClient(ctx context.Context) (LogClient, func(), error)

func NewLogClientWithOptions

func NewLogClientWithOptions(ctx context.Context, parent LogParentId, opts ...logging.LoggerOption) (LogClient, func(), error)

type LogId

type LogId string

func NewLogId

func NewLogId() LogId

type LogParentId

type LogParentId string

func NewLogParentId

func NewLogParentId() LogParentId

type Logger

type Logger interface {
	StandardLogger(severity logging.Severity) *log.Logger
	Log(entry logging.Entry)
	Logf(severity logging.Severity, format string, args ...interface{}) string
	Infof(format string, args ...interface{}) string
	Noticef(format string, args ...interface{}) string
	Warnf(format string, args ...interface{}) string
	Errorf(format string, args ...interface{}) string
	InfoErr(err error) error
	NoticeErr(err error) error
	WarnErr(err error) error
	ErrorErr(err error) error
	Flush() error
}

func NewLogger

func NewLogger(logc LogClient) (Logger, func(), error)

func NewLoggerWithOptions

func NewLoggerWithOptions(logc LogClient, logId LogId, opts ...logging.LoggerOption) (Logger, func(), error)

type StorageClient

type StorageClient interface {
	HMACKeyHandle(projectID, accessID string) *storage.HMACKeyHandle
	CreateHMACKey(ctx context.Context, projectID, serviceAccountEmail string, opts ...storage.HMACKeyOption) (*storage.HMACKey, error)
	ListHMACKeys(ctx context.Context, projectID string, opts ...storage.HMACKeyOption) *storage.HMACKeysIterator
	ServiceAccount(ctx context.Context, projectID string) (string, error)
	Bucket(name string) *storage.BucketHandle
	Buckets(ctx context.Context, projectID string) *storage.BucketIterator
}

func NewStorageClient

func NewStorageClient(ctx context.Context) (StorageClient, func(), error)