parse

Documentation

Index

• Constants
• func BadScopeErr(resource client.Object, want declared.Scope) status.ResourceError
• func OptionsForScope(options validate.Options, scope declared.Scope) validate.Options
• func Run(ctx context.Context, p Parser)
• type FileSource
• type Parser
  • func NewNamespaceRunner(clusterName, syncName, reconcilerName string, scope declared.Scope, ...) (Parser, error)
  • func NewRootRunner(clusterName, syncName, reconcilerName string, format filesystem.SourceFormat, ...) (Parser, error)

Constants

const (
	// RenderingInProgress means that the configs are still being rendered by Config Sync.
	RenderingInProgress string = "Rendering is still in progress"

	// RenderingSucceeded means that the configs have been rendered successfully.
	RenderingSucceeded string = "Rendering succeeded"

	// RenderingFailed means that the configs have failed to be rendered.
	RenderingFailed string = "Rendering failed"

	// RenderingSkipped means that the configs don't need to be rendered.
	RenderingSkipped string = "Rendering skipped"

	// RenderingRequired means that the configs require rendering but the
	// hydration-controller is not currently running.
	RenderingRequired string = "Rendering required but is currently disabled"
	// RenderingNotRequired means that the configs do not require rendering but the
	// hydration-controller is currently running.
	RenderingNotRequired string = "Rendering not required but is currently enabled"
)

Functions

func BadScopeErr

func BadScopeErr(resource client.Object, want declared.Scope) status.ResourceError

BadScopeErr reports that the passed resource declares a Namespace for a different Namespace repository.

func OptionsForScope

func OptionsForScope(options validate.Options, scope declared.Scope) validate.Options

OptionsForScope returns new Options that have been updated for the given Scope.

func Run

func Run(ctx context.Context, p Parser)

Run keeps checking whether a parse-apply-watch loop is necessary and starts a loop if needed.

Types

type FileSource

type FileSource struct {
	// SourceDir is the path to the symbolic link of the source repository.
	SourceDir cmpath.Absolute
	// HydratedRoot is the path to the root of the hydrated directory.
	HydratedRoot string
	// RepoRoot is the absolute path to the parent directory of SourceRoot and HydratedRoot.
	RepoRoot cmpath.Absolute
	// HydratedLink is the relative path to the symbolic link of the hydrated configs.
	HydratedLink string
	// SyncDir is the path to the directory of policies within the source repository.
	SyncDir cmpath.Relative
	// SourceType is the type of the source repository, must be git or oci.
	SourceType v1beta1.SourceType
	// SourceRepo is the source repo to sync.
	SourceRepo string
	// SourceBranch is the branch of the source repo to sync.
	SourceBranch string
	// SourceRev is the revision of the source repo to sync.
	SourceRev string
}

FileSource includes all settings to configure where a Parser reads files from.

type Parser

type Parser interface {
	SetSyncStatus(ctx context.Context, newStatus syncStatus) error

	// SyncErrors returns all the sync errors, including remediator errors,
	// validation errors, applier errors, and watch update errors.
	SyncErrors() status.MultiError
	// Syncing returns true if the updater is running.
	Syncing() bool
	// K8sClient returns the Kubernetes client that talks to the API server.
	K8sClient() client.Client
	// contains filtered or unexported methods
}

Parser represents a parser that can be pointed at and continuously parse a source.

func NewNamespaceRunner

func NewNamespaceRunner(clusterName, syncName, reconcilerName string, scope declared.Scope, fileReader reader.Reader, c client.Client, pollingPeriod, resyncPeriod, retryPeriod, statusUpdatePeriod time.Duration, fs FileSource, dc discovery.DiscoveryInterface, resources *declared.Resources, app applier.Applier, rem remediator.Interface, renderingEnabled bool) (Parser, error)

NewNamespaceRunner creates a new runnable parser for parsing a Namespace repo.

func NewRootRunner

func NewRootRunner(clusterName, syncName, reconcilerName string, format filesystem.SourceFormat, fileReader reader.Reader, c client.Client, pollingPeriod, resyncPeriod, retryPeriod, statusUpdatePeriod time.Duration, fs FileSource, dc discovery.DiscoveryInterface, resources *declared.Resources, app applier.Applier, rem remediator.Interface, renderingEnabled bool) (Parser, error)

NewRootRunner creates a new runnable parser for parsing a Root repository.