v1

Documentation

Index

• Constants
• Variables
• func BuildBundle(p base.FileProducer, opts ...ManifestOption) (base.Bundle, error)
• func ReadBundle(p base.FileProducer) (base.Bundle, error)
• type Bundle
  • func (b *Bundle) BundleFormatVersion() string
  • func (b *Bundle) Document() map[string]interface{}
  • func (b *Bundle) Manifest() interface{}
  • func (b *Bundle) Modules() map[string]*ast.Module
  • func (b *Bundle) Provider() data.Provider
  • func (b *Bundle) SourceInfo() base.SourceInfo
  • func (b *Bundle) Validate() error
• type Manifest
  • func (m *Manifest) Validate() error
• type ManifestOption
  • func WithRevision(r string) ManifestOption
  • func WithVCSType(t string) ManifestOption
  • func WithVCSURI(u string) ManifestOption
• type VCSMetadata

Constants

const VERSION = "v1"

Variables

var ErrInvalidBundle = errors.New("invalid bundle")

var ErrInvalidManifest = errors.New("invalid manifest")

Functions

func BuildBundle

func BuildBundle(p base.FileProducer, opts ...ManifestOption) (base.Bundle, error)

func ReadBundle

func ReadBundle(p base.FileProducer) (base.Bundle, error)

Types

type Bundle

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

func (*Bundle) BundleFormatVersion

func (b *Bundle) BundleFormatVersion() string

func (*Bundle) Document

func (b *Bundle) Document() map[string]interface{}

func (*Bundle) Manifest

func (b *Bundle) Manifest() interface{}

func (*Bundle) Modules

func (b *Bundle) Modules() map[string]*ast.Module

func (*Bundle) Provider

func (b *Bundle) Provider() data.Provider

func (*Bundle) SourceInfo

func (b *Bundle) SourceInfo() base.SourceInfo

func (*Bundle) Validate

func (b *Bundle) Validate() error

type Manifest

type Manifest struct {
	base.Manifest
	Name                string      `json:"name"`
	PolicyEngineVersion string      `json:"policy_engine_version"`
	Revision            string      `json:"revision"`
	VCS                 VCSMetadata `json:"vcs"`
}

func (*Manifest) Validate

func (m *Manifest) Validate() error

type ManifestOption

type ManifestOption func(m *Manifest)

func WithRevision

func WithRevision(r string) ManifestOption

func WithVCSType

func WithVCSType(t string) ManifestOption

func WithVCSURI

func WithVCSURI(u string) ManifestOption

type VCSMetadata

type VCSMetadata struct {
	Type string `json:"type"`
	URI  string `json:"uri"`
}