status

Documentation

Overview

Package status implements status reporting.

Index

• type Config
• type Plugin
  • func New(config []byte, manager *plugins.Manager) (*Plugin, error)
  • func (p *Plugin) Start(ctx context.Context) error
  • func (p *Plugin) Stop(ctx context.Context)
  • func (p *Plugin) Update(status bundle.Status)
• type UpdateRequestV1

Types

type Config

type Config struct {
	Service       string `json:"service"`
	PartitionName string `json:"partition_name,omitempty"`
}

Config contains configuration for the plugin.

type Plugin

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

Plugin implements status reporting. Updates can be triggered by the caller.

func New

func New(config []byte, manager *plugins.Manager) (*Plugin, error)

New returns a new Plugin with the given config.

func (*Plugin) Start

func (p *Plugin) Start(ctx context.Context) error

Start starts the plugin.

func (*Plugin) Stop

func (p *Plugin) Stop(ctx context.Context)

Stop stops the plugin.

func (*Plugin) Update

func (p *Plugin) Update(status bundle.Status)

Update notifies the plugin with a new bundle.Status.

type UpdateRequestV1

type UpdateRequestV1 struct {
	Labels map[string]string `json:"labels"`
	Bundle bundle.Status     `json:"bundle"`
}

UpdateRequestV1 represents the status update message that OPA sends to remote HTTP endpoints.