lookup

README

Metadata for health

For now this is a file based lookup which could be externalised, internationalised and even replaced all together with a better solution.

Initial metadata files are:

• Information links to more details on what a specific health check is

The data is currently in a ./static_data/info.yaml file

go-bindata is used to build the static data into an Asset

To regenerate run make bind

Documentation

Overview

Code generated for package lookup by go-bindata DO NOT EDIT. (@generated) sources: pkg/health/lookup/static_data/info.yaml

Index

• func Asset(name string) ([]byte, error)
• func AssetDir(name string) ([]string, error)
• func AssetInfo(name string) (os.FileInfo, error)
• func AssetNames() []string
• func MustAsset(name string) []byte
• func RestoreAsset(dir, name string) error
• func RestoreAssets(dir, name string) error
• type LoopkupData
  • func NewLookupData() (LoopkupData, error)

Functions

func Asset

func Asset(name string) ([]byte, error)

Asset loads and returns the asset for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetDir

func AssetDir(name string) ([]string, error)

AssetDir returns the file names below a certain directory embedded in the file by go-bindata. For example if you run go-bindata on data/... and data contains the following hierarchy:

data/
  foo.txt
  img/
    a.png
    b.png

then AssetDir("data") would return []string{"foo.txt", "img"} AssetDir("data/img") would return []string{"a.png", "b.png"} AssetDir("foo.txt") and AssetDir("notexist") would return an error AssetDir("") will return []string{"data"}.

func AssetInfo

func AssetInfo(name string) (os.FileInfo, error)

AssetInfo loads and returns the asset info for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetNames

func AssetNames() []string

AssetNames returns the names of the assets.

func MustAsset

func MustAsset(name string) []byte

MustAsset is like Asset but panics when Asset would return an error. It simplifies safe initialization of global variables.

func RestoreAsset

func RestoreAsset(dir, name string) error

RestoreAsset restores an asset under the given directory

func RestoreAssets

func RestoreAssets(dir, name string) error

RestoreAssets restores an asset under the given directory recursively

Types

type LoopkupData

type LoopkupData struct {
	Info map[string]string
}

LoopkupData contains bind data from yaml

func NewLookupData

func NewLookupData() (LoopkupData, error)

NewLookupData will return struct containing maps for looking up static health information and suggested fix links todo lets find a better way to lookup this metadata rather than using a csv in the codebase?