reader

Documentation

Overview

Package reader is for reading manifest files

Index

• type BrokerPakReader
  • func DownloadAndOpenBrokerpak(pakURI string) (*BrokerPakReader, error)
  • func OpenBrokerPak(pakPath string) (*BrokerPakReader, error)
  • func (pak *BrokerPakReader) Close() error
  • func (pak *BrokerPakReader) Contents() []*zip.File
  • func (pak *BrokerPakReader) ExtractPlatformBins(destination string) error
  • func (pak *BrokerPakReader) Manifest() (*manifest.Manifest, error)
  • func (pak *BrokerPakReader) Services() ([]tf.TfServiceDefinitionV1, error)
  • func (pak *BrokerPakReader) Validate() error

Types

type BrokerPakReader

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

BrokerPakReader reads bundled together Terraform and service definitions.

func DownloadAndOpenBrokerpak

func DownloadAndOpenBrokerpak(pakURI string) (*BrokerPakReader, error)

DownloadAndOpenBrokerpak downloads a (potentially remote) brokerpak to the local filesystem and opens it.

func OpenBrokerPak

func OpenBrokerPak(pakPath string) (*BrokerPakReader, error)

OpenBrokerPak opens the file at the given path as a BrokerPakReader.

func (*BrokerPakReader) Close

func (pak *BrokerPakReader) Close() error

Close closes the underlying reader for the BrokerPakReader.

func (*BrokerPakReader) Contents

func (pak *BrokerPakReader) Contents() []*zip.File

func (*BrokerPakReader) ExtractPlatformBins

func (pak *BrokerPakReader) ExtractPlatformBins(destination string) error

ExtractPlatformBins extracts the binaries for the current platform to the given destination.

func (*BrokerPakReader) Manifest

func (pak *BrokerPakReader) Manifest() (*manifest.Manifest, error)

Manifest fetches the manifest out of the package.

func (*BrokerPakReader) Services

func (pak *BrokerPakReader) Services() ([]tf.TfServiceDefinitionV1, error)

Services gets the list of services included in the pack.

func (*BrokerPakReader) Validate

func (pak *BrokerPakReader) Validate() error

Validate checks the manifest service definitions for syntactic and limited semantic errors. The manifest has previously been validated during parsing.