grizzly

package

Go to main page

Versions in this module

v0

v0.4.2

May 14, 2024

Changes in this version

+ type BrowserInterface struct

+ func NewBrowserInterface(registry Registry, resourcePath string, port int) (*BrowserInterface, error)

+ func (i BrowserInterface) Open(resources Resources) error

+ type HTTPEndpoint struct

+ Handler http.HandlerFunc

+ Method string

+ URL string

type Provider

+ Validate func() error

type Resource

+ func (r *Resource) HasSpecString(key string) bool

+ func (r *Resource) SetSpec(spec map[string]any)

type Resources

+ func NewResources(resources ...Resource) Resources

+ func (r Resources) Add(resources ...Resource)

+ func (r Resources) AsList() []Resource

+ func (r Resources) FindByFilename(path string) (Resource, bool)

+ func (r Resources) First() Resource

+ func (r Resources) ForEach(callback func(Resource) error) error

+ func (r Resources) GroupByKind() map[string]Resources

+ func (r Resources) Merge(resources Resources)

type Server

+ CurrentContext string

+ Resources Resources

+ func (s *Server) IframeHandler(w http.ResponseWriter, r *http.Request)

+ func (s *Server) ParseResources(resourcesPath string) (Resources, error)

+ func (s *Server) SetContext(currentContext string)

+ func (s *Server) SetFormatting(onlySpec bool, outputFormat string)

+ func (s *Server) SetParser(parser Parser, parserOpts ParserOptions)

+ func (s *Server) URL(path string) string

+ func (s *Server) UpdateResource(name string, resource Resource) error

+ func (s *Server) Watch()

+ type UnrecognisedFormatError struct

+ File string

+ func NewUnrecognisedFormatError(file string) UnrecognisedFormatError

+ func (e UnrecognisedFormatError) Error() string

+ type Watcher struct

+ func NewWatcher(watcherFunc func(path string) error) (*Watcher, error)

+ func (w *Watcher) Wait() error

+ func (w *Watcher) Watch(path string) error

v0.4.1

Apr 11, 2024

Changes in this version

+ var ResourceAdded = EventType

+ var ResourceFailure = EventType

+ var ResourceNotChanged = EventType

+ var ResourceNotFound = EventType

+ var ResourcePulled = EventType

+ var ResourceUpdated = EventType

+ func EventToColoredText(event Event) string

+ func EventToPlainText(event Event) string

+ func Pluraliser(count int, name string) string

+ func SendError(w http.ResponseWriter, msg string, err error, code int)

+ func Snapshot(registry Registry, resources Resources, expiresSeconds int) error

+ type ChainParser struct

+ func NewChainParser(formatParsers []FormatParser, continueOnError bool) *ChainParser

+ func (parser *ChainParser) Parse(resourcePath string, options ParserOptions) (Resources, error)

+ type Event struct

+ Details string

+ ResourceRef string

+ Type EventType

+ type EventFormatter func(event Event) string

+ type EventSeverity uint8

+ const Error

+ const Info

+ const Notice

+ type EventType struct

+ HumanReadable string

+ ID string

+ Severity EventSeverity

+ type FilteredParser struct

+ func NewFilteredParser(registry Registry, decorated Parser, targets []string) *FilteredParser

+ func (parser *FilteredParser) Parse(resourcePath string, options ParserOptions) (Resources, error)

+ type FormatParser interface

+ Accept func(file string) bool

+ Parse func(file string, options ParserOptions) (Resources, error)

+ type JSONParser struct

+ func NewJSONParser(registry Registry) *JSONParser

+ func (parser *JSONParser) Accept(file string) bool

+ func (parser *JSONParser) Parse(file string, options ParserOptions) (Resources, error)

+ type JsonnetParser struct

+ func NewJsonnetParser(registry Registry, jsonnetPaths []string) *JsonnetParser

+ func (parser *JsonnetParser) Accept(file string) bool

+ func (parser *JsonnetParser) Parse(file string, options ParserOptions) (Resources, error)

+ type ParseError struct

+ Err error

+ File string

+ func (err ParseError) Error() string

type Parser

+ func DefaultParser(registry Registry, targets []string, jsonnetPaths []string, opts ...ParserOpt) Parser

+ type ParserOpt func(config *parsersConfig)

+ func ParserContinueOnError(continueOnError bool) ParserOpt

+ type ParserOptions struct

+ DefaultFolderUID string

+ DefaultResourceKind string

type Provider

+ Name func() string

type Resource

+ Body map[string]interface{}

+ Source Source

+ func (r *Resource) Ref() ResourceRef

+ func (r *Resource) SetSource(source Source)

+ type ResourceRef struct

+ Kind string

+ Name string

+ func NewResourceRef(kind string, name string) ResourceRef

+ func (ref ResourceRef) Equal(other ResourceRef) bool

+ func (ref ResourceRef) String() string

type Resources

+ func (r Resources) Filter(predicate func(Resource) bool) Resources

+ func (r Resources) Find(ref ResourceRef) (Resource, bool)

+ type Server struct

+ OnlySpec bool

+ OpenBrowser bool

+ OutputFormat string

+ Parser WatchParser

+ Port int

+ Registry Registry

+ ResourcePath string

+ UserAgent string

+ func (p *Server) ProxyRequestHandler(w http.ResponseWriter, r *http.Request)

+ func (p *Server) RootHandler(w http.ResponseWriter, _ *http.Request)

+ func (p *Server) Start() error

+ type SnapshotHandler interface

+ Snapshot func(resource Resource, expiresSeconds int) error

+ type Source struct

+ Format string

+ Location string

+ Path string

+ Rewritable bool

+ type Summary struct

+ EventCounts map[EventType]int

+ func (summary Summary) AsString(resourceLabel string) string

+ type WriterRecorder struct

+ func NewWriterRecorder(out io.Writer, eventFormatter EventFormatter) *WriterRecorder

+ func (recorder *WriterRecorder) Record(event Event)

+ func (recorder *WriterRecorder) Summary() Summary

+ type YAMLParser struct

+ func NewYAMLParser(registry Registry) *YAMLParser

+ func (parser *YAMLParser) Accept(file string) bool

+ func (parser *YAMLParser) Parse(file string, options ParserOptions) (Resources, error)

v0.4.0

Feb 28, 2024

Changes in this version

+ func DetectEnvelope(data any) bool

+ func Serve(registry Registry, parser WatchParser, resourcePath string, port int, ...) error

+ func ValidateEnvelope(data any) error

+ type BaseHandler struct

+ Provider Provider

+ func NewBaseHandler(provider Provider, kind string, usesFolders bool) BaseHandler

+ func (h *BaseHandler) APIVersion() string

+ func (h *BaseHandler) Detect(map[string]any) bool

+ func (h *BaseHandler) GetUID(resource Resource) (string, error)

+ func (h *BaseHandler) Kind() string

+ func (h *BaseHandler) Prepare(existing, resource Resource) *Resource

+ func (h *BaseHandler) Sort(resources Resources) Resources

+ func (h *BaseHandler) Unprepare(resource Resource) *Resource

+ func (h *BaseHandler) UsesFolders() bool

+ type ErrorPrimitiveReached struct

+ func (e ErrorPrimitiveReached) Error() string

+ func (e ErrorPrimitiveReached) WithContainingObj(obj map[string]any, err error) ErrorPrimitiveReached

+ type GrizzlyServer struct

+ OnlySpec bool

+ OpenBrowser bool

+ OutputFormat string

+ Parser WatchParser

+ Port int

+ Registry Registry

+ ResourcePath string

+ Token string

+ Url string

+ User string

+ UserAgent string

+ func NewGrizzlyServer(registry Registry, parser WatchParser, resourcePath string, port int, ...) (*GrizzlyServer, error)

+ func (p *GrizzlyServer) ProxyRequestHandler(w http.ResponseWriter, r *http.Request)

+ func (p *GrizzlyServer) RootHandler(w http.ResponseWriter, r *http.Request)

+ func (p *GrizzlyServer) Start() error

type Handler

+ Detect func(map[string]any) bool

+ GetSpecUID func(resource Resource) (string, error)

+ Sort func(resources Resources) Resources

+ UsesFolders func() bool

+ type ProxyEndpoint struct

+ Handler func(http.ResponseWriter, *http.Request)

+ Method string

+ Url string

+ type ProxyHandler interface

+ GetProxyEndpoints func(p GrizzlyServer) []ProxyEndpoint

+ ProxyURL func(Resource) (string, error)

+ type ProxyProvider interface

+ SetupProxy func() (*httputil.ReverseProxy, error)

type Registry

+ HandlerOrder []Handler

+ func NewRegistry(providers []Provider) Registry

+ func (r *Registry) Detect(data any) string

+ func (r *Registry) GetProxyProvider() (*ProxyProvider, error)

+ func (r *Registry) HandlerMatchesTarget(handler Handler, targets []string) bool

+ func (r *Registry) ResourceMatchesTarget(kind string, UID string, targets []string) bool

+ func (r *Registry) Sort(resources Resources) Resources

type Resource

+ func ResourceFromMap(data map[string]interface{}) (Resource, error)

v0.3.1

Jan 23, 2024

Changes in this version

+ func Format(resourcePath string, resource *Resource, format string, onlySpec bool) ([]byte, string, string, error)

+ func WriteFile(filename string, content []byte) error

type Opts

+ HasOnlySpec bool

+ OnlySpec bool

+ OutputFormat string

type Resource

+ func (r *Resource) JSON() (string, error)

v0.3.0

Jan 4, 2024

Changes in this version

+ func MarshalSpecToJSON(resource Resource, filename string) error

type Opts

+ FolderUID string

+ JSONSpec bool

type Resources

+ func ParseDashboardJSON(jsonFile string, opts Opts) (Resources, error)

+ func ParseJSON(resourceFile string, opts Opts) (Resources, error)

v0.2.1

Feb 17, 2023

v0.2.0

Apr 19, 2022

Changes in this version

+ var ErrHandlerNotFound = errors.New("handler not found")

+ func ConfigureProviderRegistry(providers []Provider)

+ func FindResourceFiles(resourcePath string) ([]string, error)

+ func ListRemote(opts Opts) error

+ func MarshalYAML(resource Resource, filename string) error

+ func Pull(resourcePath string, opts Opts) error

type Handler

+ FindResourceFiles func(dir string) ([]string, error)

+ GetUID func(resource Resource) (string, error)

+ ListRemote func() ([]string, error)

+ ResourceFilePath func(resource Resource, filetype string) string

+ Validate func(resource Resource) error

+ type LoggingOpts struct

+ LogLevel string

+ type Opts struct

+ Directory bool

+ JsonnetPaths []string

+ Targets []string

type Resource

+ func NewResource(apiVersion, kind, name string, spec map[string]interface{}) Resource

+ func (r *Resource) DeleteSpecKey(key string)

+ func (r *Resource) GetMetadata(key string) string

+ func (r *Resource) GetSpecString(key string) (string, bool)

+ func (r *Resource) GetSpecValue(key string) interface{}

+ func (r *Resource) HasMetadata(key string) bool

+ func (r *Resource) Name() string

+ func (r *Resource) SetMetadata(key, value string)

+ func (r *Resource) SetSpecString(key, value string)

+ func (r *Resource) SetSpecValue(key string, value interface{})

+ func (r *Resource) Spec() map[string]interface{}

+ func (r *Resource) SpecAsJSON() (string, error)

+ func (r *Resource) YAML() (string, error)

+ func (r Resource) String() string

type Resources

+ func ParseFile(opts Opts, resourceFile string) (Resources, error)

+ func ParseJsonnet(jsonnetFile string, opts Opts) (Resources, error)

+ func ParseYAML(yamlFile string, opts Opts) (Resources, error)

+ func (r Resources) Len() int

+ func (r Resources) Less(i, j int) bool

+ func (r Resources) Swap(i, j int)

+ type WatchParser interface

+ Name func() string

+ Parse func() (Resources, error)

v0.2.0-beta3

Oct 28, 2021

v0.2.0-beta2

Oct 12, 2021

v0.2.0-beta1

Sep 23, 2021

v0.1.0

Feb 27, 2021

Changes in this version

+ var ErrNotFound = errors.New("not found")

+ var ErrNotImplemented = errors.New("not implemented")

+ func Apply(config Config, resources Resources) error

+ func Diff(config Config, resources Resources) error

+ func Export(config Config, exportDir string, resources Resources) error

+ func Get(config Config, UID string) error

+ func List(config Config, resources Resources) error

+ func Listen(config Config, UID, filename string) error

+ func Preview(config Config, resources Resources, opts *PreviewOpts) error

+ func Show(config Config, resources Resources) error

+ func Watch(config Config, watchDir string, parser Parser) error

+ type APIErr struct

+ Body []byte

+ Err error

+ func (e APIErr) Error() string

+ type Config struct

+ JsonnetPath string

+ Notifier Notifier

+ Registry Registry

+ type ExtendedImporter struct

+ func (i *ExtendedImporter) Import(importedFrom, importedPath string) (contents jsonnet.Contents, foundAt string, err error)

+ type Handler interface

+ APIVersion func() string

+ Add func(resource Resource) error

+ GetByUID func(UID string) (*Resource, error)

+ GetExtension func() string

+ GetJSONPaths func() []string

+ GetRemote func(uid string) (*Resource, error)

+ GetRemoteRepresentation func(uid string) (string, error)

+ GetRepresentation func(uid string, resource Resource) (string, error)

+ Kind func() string

+ Parse func(path string, i interface{}) (ResourceList, error)

+ Prepare func(existing, resource Resource) *Resource

+ Unprepare func(resource Resource) *Resource

+ Update func(existing, resource Resource) error

+ type ListenHandler interface

+ Listen func(notifier Notifier, UID, filename string) error

+ type MultiResourceHandler interface

+ Apply func(notifier Notifier, resources ResourceList) error

+ Diff func(notifier Notifier, resources ResourceList) error

+ type Notifier struct

+ func (n *Notifier) Added(resource Resource)

+ func (n *Notifier) Error(resource *Resource, msg string)

+ func (n *Notifier) HasChanges(resource Resource, diff string)

+ func (n *Notifier) Info(resource *Resource, msg string)

+ func (n *Notifier) NoChanges(resource Resource)

+ func (n *Notifier) NotFound(resource Resource)

+ func (n *Notifier) NotSupported(resource Resource, behaviour string)

+ func (n *Notifier) Updated(resource Resource)

+ func (n *Notifier) Warn(resource *Resource, msg string)

+ type Parser interface

+ Name func() string

+ Parse func(config Config) (Resources, error)

+ type PreviewHandler interface

+ Preview func(resource Resource, notifier Notifier, opts *PreviewOpts) error

+ type PreviewOpts struct

+ ExpiresSeconds int

+ type Provider interface

+ APIVersion func() string

+ GetHandlers func() []Handler

+ Group func() string

+ Version func() string

+ type Registry struct

+ HandlerByName map[string]Handler

+ HandlerByPath map[string]Handler

+ Handlers []Handler

+ Providers []Provider

+ func NewProviderRegistry() Registry

+ func (r *Registry) GetHandler(path string) (Handler, error)

+ func (r *Registry) RegisterProvider(provider Provider) error

+ type Resource struct

+ Detail interface{}

+ Filename string

+ Handler Handler

+ JSONPath string

+ UID string

+ func (r *Resource) APIVersion() string

+ func (r *Resource) GetRemoteRepresentation() (string, error)

+ func (r *Resource) GetRepresentation() (string, error)

+ func (r *Resource) Key() string

+ func (r *Resource) Kind() string

+ func (r *Resource) MatchesTarget(targets []string) bool

+ type ResourceList map[string]Resource

+ type Resources map[Handler]ResourceList

+ func Parse(config Config, jsonnetFile string, targets []string) (Resources, error)

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