gcpbucketstorage

README

gcpbucketstorage

Package gcpbucketstorage is an Ambient plugin that provides storage in GCP Cloud Storage.

Import: github.com/ambientkit/plugin/storage/gcpbucketstorage

Version: 1.0.0

Plugin Type

The plugin can be used as the following core types:

• Logger: false
• Storage System: true
• Router: false
• Template Engine: false
• Session Manager: false

Grants

The plugin does not request any grants.

Settings

The plugin does not have any settings.

Routes

The plugin does not have any routes.

Middleware

The plugin does not have any middleware.

FuncMap

The plugin does not have a FuncMap.

Assets

The plugin does not inject any assets.

Embedded Files

The plugin does not have any embedded files.

Example Usage

package main

import (
	"log"

	"github.com/ambientkit/ambient"
	"github.com/ambientkit/ambient/pkg/ambientapp"
	"github.com/ambientkit/plugin/logger/zaplogger"
	"github.com/ambientkit/plugin/storage/gcpbucketstorage"
)

func main() {
	var (
		// StorageSitePath is the location of the site file.
		StorageSitePath = "storage/site.bin"
		// StorageSessionPath is the location of the session file.
		StorageSessionPath = "storage/session.bin"
	)

	plugins := &ambient.PluginLoader{
		// Core plugins are implicitly trusted.
		Router:         nil,
		TemplateEngine: nil,
		SessionManager: nil,
		// Trusted plugins are those that are typically needed to boot so they
		// will be enabled and given full access.
		TrustedPlugins: map[string]bool{},
		Plugins:        []ambient.Plugin{},
		Middleware:     []ambient.MiddlewarePlugin{
			// Middleware - executes top to bottom.
		},
	}
	_, _, err := ambientapp.NewApp("myapp", "1.0",
		zaplogger.New(),
		ambient.StoragePluginGroup{
			Storage: gcpbucketstorage.New(StorageSitePath, StorageSessionPath),
		},
		plugins)
	if err != nil {
		log.Fatalln(err.Error())
	}
}

---

Docgen by Ambient

Documentation

Overview

Package gcpbucketstorage is an Ambient plugin that provides storage in GCP Cloud Storage.

Index

• Constants
• type Plugin
  • func New(sitePath string, sessionPath string) *Plugin
  • func (p *Plugin) PluginName() string
  • func (p *Plugin) PluginVersion() string
  • func (p *Plugin) Storage(logger ambient.Logger) (ambient.DataStorer, ambient.SessionStorer, error)

Examples

• New

Constants

const (
	// BucketEnv is the Google Storage bucket environment variable.
	BucketEnv = "AMB_GCP_BUCKET"
)

Types

type Plugin

type Plugin struct {
	// contains filtered or unexported fields
}

Plugin represents an Ambient plugin.

func New

func New(sitePath string, sessionPath string) *Plugin

New returns an Ambient plugin that provides storage in GCP Cloud Storage.

Example

package main

import (
	"log"

	"github.com/ambientkit/ambient"
	"github.com/ambientkit/ambient/pkg/ambientapp"
	"github.com/ambientkit/plugin/logger/zaplogger"
	"github.com/ambientkit/plugin/storage/gcpbucketstorage"
)

func main() {
	var (
		// StorageSitePath is the location of the site file.
		StorageSitePath = "storage/site.bin"
		// StorageSessionPath is the location of the session file.
		StorageSessionPath = "storage/session.bin"
	)

	plugins := &ambient.PluginLoader{
		// Core plugins are implicitly trusted.
		Router:         nil,
		TemplateEngine: nil,
		SessionManager: nil,
		// Trusted plugins are those that are typically needed to boot so they
		// will be enabled and given full access.
		TrustedPlugins: map[string]bool{},
		Plugins:        []ambient.Plugin{},
		Middleware:     []ambient.MiddlewarePlugin{
			// Middleware - executes top to bottom.
		},
	}
	_, _, err := ambientapp.NewApp("myapp", "1.0",
		zaplogger.New(),
		ambient.StoragePluginGroup{
			Storage: gcpbucketstorage.New(StorageSitePath, StorageSessionPath),
		},
		plugins)
	if err != nil {
		log.Fatalln(err.Error())
	}
}

func (*Plugin) PluginName

func (p *Plugin) PluginName() string

PluginName returns the plugin name.

func (*Plugin) PluginVersion

func (p *Plugin) PluginVersion() string

PluginVersion returns the plugin version.

func (*Plugin) Storage

func (p *Plugin) Storage(logger ambient.Logger) (ambient.DataStorer, ambient.SessionStorer, error)

Storage returns data and session storage.