configfetcher

package module

v0.2.0 Latest Latest Go to latest Published: Apr 12, 2021 License: Unlicense Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/jamesattensure/configfetcher

Links

Open Source Insights

README ¶

Config Fetcher

Installation

go get -u github.com/jamesattensure/configfetcher

Documentation ¶

Overview ¶

Package configfetcher provides a simple abstraction to fetch config values from a file or GCP Secrets Manager to populate a struct.

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Data ¶

type Data struct {
	ConfigData []byte
	GcloudVars
	ConfigStruct interface{}
}

Data contains everything needed to interact with this abstraction

func (*Data) GetConfigStruct ¶ added in v0.2.0

func (d *Data) GetConfigStruct(configType string) error

GetConfigStruct populates the Data.ConfigStruct interface with the data from Data.ConfigData It expects either `ReadGCPSMSecret()` or `ReadFile()` has been ran to populate Data.ConfigData

func (*Data) ReadFile ¶ added in v0.2.0

func (d *Data) ReadFile(filePath string) (*Data, error)

ReadFile returns the Data struct after attempting to read the data from a file

func (*Data) ReadGCPSMSecret ¶ added in v0.2.0

func (d *Data) ReadGCPSMSecret() (*Data, error)

ReadGCPSMSecret returns the Data struct and error after attempting to fetch the environment variables:

`PROJECT_ID`      required
`SECRET_NAME`     required
`SECRET_VERSION`  optional

type GcloudVars ¶ added in v0.2.0

type GcloudVars struct {
	ProjectID     string
	SecretName    string
	SecretVersion string
}

GcloudVars contains the data needed to connect to GCP Secret Manager

Source Files ¶

View all Source files

configfetcher.go

Directories ¶

Path	Synopsis
example

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