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/>.

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/>.

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/>.

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 AliveContext() (context.Context, context.CancelFunc)
• func Do(f func(context.Context) error)
• func InstanceID() string
• func InstanceName() string
• func NewServer(ctx context.Context, handler http.Handler, lg Logger) (*http.Server, error)
• func OnGCE() bool
• func WaitForCleanup(timeout time.Duration) error
• type LogClient
  • func NewLogClient(ctx context.Context) (LogClient, func(), error)
  • func (lc LogClient) Logger(logId string, opts ...logging.LoggerOption) Logger
• type Logger
  • func (l Logger) Alert(args ...interface{})
  • func (l Logger) AlertErr(err error) error
  • func (l Logger) Alertf(format string, args ...interface{}) string
  • func (l Logger) Critical(args ...interface{})
  • func (l Logger) CriticalErr(err error) error
  • func (l Logger) Criticalf(format string, args ...interface{}) string
  • func (l Logger) Debug(args ...interface{})
  • func (l Logger) DebugErr(err error) error
  • func (l Logger) Debugf(format string, args ...interface{}) string
  • func (l Logger) Default(args ...interface{})
  • func (l Logger) DefaultErr(err error) error
  • func (l Logger) Defaultf(format string, args ...interface{}) string
  • func (l Logger) Emergency(args ...interface{})
  • func (l Logger) EmergencyErr(err error) error
  • func (l Logger) Emergencyf(format string, args ...interface{}) string
  • func (l Logger) Error(args ...interface{})
  • func (l Logger) ErrorErr(err error) error
  • func (l Logger) Errorf(format string, args ...interface{}) string
  • func (l Logger) Info(args ...interface{})
  • func (l Logger) InfoErr(err error) error
  • func (l Logger) Infof(format string, args ...interface{}) string
  • func (l Logger) Notice(args ...interface{})
  • func (l Logger) NoticeErr(err error) error
  • func (l Logger) Noticef(format string, args ...interface{}) string
  • func (l Logger) StandardLogger(severity logging.Severity) *stdlog.Logger
  • func (l Logger) Warning(args ...interface{})
  • func (l Logger) WarningErr(err error) error
  • func (l Logger) Warningf(format string, args ...interface{}) string
• type MetadataType
  • func Metadata() *MetadataType
• type StorageClient
  • func NewStorageClient(ctx context.Context) (StorageClient, func(), error)

Constants

const RequestContextKey = requestContextKey(`gkeRequestContextKey`)

Variables

var (
	LogGke bool
	LogStd bool
)

Functions

func AliveContext

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

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

func Do

func Do(f func(context.Context) error)

func InstanceID

func InstanceID() string

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 WaitForCleanup

func WaitForCleanup(timeout time.Duration) error

Types

type LogClient

type LogClient struct {
	log.Client
}

func NewLogClient

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

func (LogClient) Logger

func (lc LogClient) Logger(logId string, opts ...logging.LoggerOption) Logger

type Logger

type Logger struct {
	log.Logger
}

func (Logger) Alert

func (l Logger) Alert(args ...interface{})

func (Logger) AlertErr

func (l Logger) AlertErr(err error) error

func (Logger) Alertf

func (l Logger) Alertf(format string, args ...interface{}) string

func (Logger) Critical

func (l Logger) Critical(args ...interface{})

func (Logger) CriticalErr

func (l Logger) CriticalErr(err error) error

func (Logger) Criticalf

func (l Logger) Criticalf(format string, args ...interface{}) string

func (Logger) Debug

func (l Logger) Debug(args ...interface{})

func (Logger) DebugErr

func (l Logger) DebugErr(err error) error

func (Logger) Debugf

func (l Logger) Debugf(format string, args ...interface{}) string

func (Logger) Default

func (l Logger) Default(args ...interface{})

func (Logger) DefaultErr

func (l Logger) DefaultErr(err error) error

func (Logger) Defaultf

func (l Logger) Defaultf(format string, args ...interface{}) string

func (Logger) Emergency

func (l Logger) Emergency(args ...interface{})

func (Logger) EmergencyErr

func (l Logger) EmergencyErr(err error) error

func (Logger) Emergencyf

func (l Logger) Emergencyf(format string, args ...interface{}) string

func (Logger) Error

func (l Logger) Error(args ...interface{})

func (Logger) ErrorErr

func (l Logger) ErrorErr(err error) error

func (Logger) Errorf

func (l Logger) Errorf(format string, args ...interface{}) string

func (Logger) Info

func (l Logger) Info(args ...interface{})

func (Logger) InfoErr

func (l Logger) InfoErr(err error) error

func (Logger) Infof

func (l Logger) Infof(format string, args ...interface{}) string

func (Logger) Notice

func (l Logger) Notice(args ...interface{})

func (Logger) NoticeErr

func (l Logger) NoticeErr(err error) error

func (Logger) Noticef

func (l Logger) Noticef(format string, args ...interface{}) string

func (Logger) StandardLogger

func (l Logger) StandardLogger(severity logging.Severity) *stdlog.Logger

func (Logger) Warning

func (l Logger) Warning(args ...interface{})

func (Logger) WarningErr

func (l Logger) WarningErr(err error) error

func (Logger) Warningf

func (l Logger) Warningf(format string, args ...interface{}) string

type MetadataType

type MetadataType struct {
	OnGCE              bool
	ProjectID          string
	InstanceID         string
	InstanceName       string
	ExternalIP         string
	InternalIP         string
	Hostname           string
	Zone               string
	InstanceTags       []string
	InstanceAttributes map[string]string
	ProjectAttributes  map[string]string
}

func Metadata

func Metadata() *MetadataType

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)