download

Documentation

Overview

Deprecated: This package is intended for older projects transitioning from OPA v0.x and will remain for the lifetime of OPA v1.x, but its use is not recommended. For newer features and behaviours, such as defaulting to the Rego v1 syntax, use the corresponding components in the github.com/open-policy-agent/opa/v1 package instead. See https://www.openpolicyagent.org/docs/latest/v0-compatibility/ for more information.

Package download implements low-level OPA bundle downloading.

Index

• type Config
• type Downloader
  • func New(config Config, client rest.Client, path string) *Downloader
• type HTTPError
• type OCIDownloader
  • func NewOCI(config Config, client rest.Client, path, storePath string) *OCIDownloader
• type PollingConfig
• type Update

Types

type Config

type Config = v1.Config

Config represents the configuration for the downloader.

type Downloader

type Downloader = v1.Downloader

Downloader implements low-level OPA bundle downloading. Downloader can be started and stopped. After starting, the downloader will request bundle updates from the remote HTTP endpoint that the client is configured to connect to.

func New

func New(config Config, client rest.Client, path string) *Downloader

New returns a new Downloader that can be started.

type HTTPError

type HTTPError = v1.HTTPError

type OCIDownloader

type OCIDownloader = v1.OCIDownloader

func NewOCI

func NewOCI(config Config, client rest.Client, path, storePath string) *OCIDownloader

NewOCI returns a new Downloader that can be started.

type PollingConfig

type PollingConfig = v1.PollingConfig

PollingConfig represents polling configuration for the downloader.

type Update

type Update = v1.Update

Update contains the result of a download. If an error occurred, the Error field will be non-nil. If a new bundle is available, the Bundle field will be non-nil.