ecluse
Safe HaskellNone
LanguageGHC2021

Ecluse.Composition.BootError

Description

Aggregated startup refusals, the advisories a boot logs beside them, and their operator-facing rendering.

Synopsis

Documentation

data BootError Source #

A reason the composition root refuses to start. The root aggregates them, so one run reports every problem.

Constructors

PolicyBootError PolicyError

A rule policy did not resolve (surfaced by loadConfig).

MissingAdapter Ecosystem

A configured mount's ecosystem has no adapter, so Écluse cannot serve it.

UnresolvedCredential Ecosystem

A mount has no mirror-write provider. Every mount derives one from its mirror target, so this is a safety net.

QueueProviderUnavailable Text

The queue URL names a backend this binary cannot run.

QueueRegionMissing

AWS_ENDPOINT_URL_SQS is set but AWS_REGION is not, and an emulator or VPC endpoint carries no region.

QueueUrlUnrecognised Text

ECLUSE_QUEUE__URL names no backend this binary knows, and carries the value. Guessing one would misroute mirror jobs.

QueueEndpointMalformed Secret

AWS_ENDPOINT_URL_SQS is not a parseable URL. It can carry a credential, so the value stays redacted.

AwsEndpointMalformed Secret

AWS_ENDPOINT_URL is not a parseable URL. Refused rather than dropped, so a typo never dials real AWS.

CodeArtifactMintFailed (NonEmpty Text) Text

The eager mint threw, carrying every configured consumer key and the rendered exception.

MirrorTargetWithoutPublish Ecosystem

A mount declares a mirror target this build cannot write for its ecosystem, so it is refused rather than booted half-wired.

MirrorCompanionMismatch Ecosystem

A mirror target's adapter prepares native companions that disagree with its durable declaration.

MirrorStateRequired Ecosystem

A durable mirror role cannot retain or validate its expected inventory without durable state.

UploadConfigurationRequired Ecosystem Text

An active native writer lacks the Basic username its credential convention needs. Carries the key path.

PublicationTargetWithoutPublish Ecosystem

A publication target has no adapter that can write its ecosystem's protocol.

FirstPartyMissing Ecosystem

A publication target with no first-party namespaces leaves the anti-shadowing guard nothing to enforce.

FirstPartyWithoutPrivateUpstream Ecosystem

First-party names have no private authority, so every lookup would return 404.

PublishStaticCredentialNeedsEdge Ecosystem StoreTag

A static publish credential without ECLUSE_SERVER__AUTH_TOKEN would let anyone publish as Écluse.

PublicationTargetOnPublicUpstream Ecosystem Ecosystem Text

A publication target shares a host with the named mount's public upstream, so a relayed credential would reach it.

PublicationTargetOnMountEndpoint Ecosystem Ecosystem Text Text

A publication target is also the named mount's endpoint under the named key, so a publish would reach another role.

MirrorTargetOnPublicUpstream Ecosystem Ecosystem Text

A mirror target shares a host with the named mount's public upstream, so the mirror-write credential would reach it.

MirrorTargetOnMountEndpoint Ecosystem Ecosystem Text Text

A mirror target is also the named mount's endpoint under the named key, so a sweep would delete another role's data.

PrivateUpstreamOnPublicUpstream Ecosystem Text

One repository receives caller credentials and bypasses the public rules through the private leg.

PrivateUpstreamUnsafe Ecosystem UnsafeReason

The private upstream can serve public content, which would be trusted as private. Carries what the backend reported.

PrivateUpstreamProbeFailed Ecosystem Text

Asking the private upstream what it aggregates threw, so nothing was settled about it.

StoreTagConflict Ecosystem Text Ecosystem Text Text

Two endpoints name the carried registry under different tags, so they disagree about what serves that store.

MemoryPlanOverrideUnsafe [Text]

An explicit memory override breaks the plan's invariant even at every tenant's minimum. A computed plan degrades instead.

SplitRoleNeedsDurableQueue Text

A split-deployment role selected over the in-memory queue, whose jobs never leave their process.

MirrorRoleWithoutMirroring

The mirror worker launched with no mount declaring a mirror target, so it has nothing to drain.

MirrorQueueUnavailable Text

Building the mirror-queue backend threw. The rendered exception tells a transient fault from a permanent one.

AdvisorySyncUnavailable Text

Preparing the advisory sync threw. The rendered exception tells a transient fault from a permanent one.

StoreMaintenanceUnavailable Ecosystem StoreMaintenanceReason

A vetted mirror store has no maintenance backend the Dredger can sweep it with, carrying why.

DredgerQuotaScopeConflict Text Text Text

Two dredger.quotaOverrides entries define one capacity pool differently: the pool and both keys.

DredgerChunkPauseBeneathFloor NominalDiffTime NominalDiffTime

The pause between sweep chunks is beneath its floor. Only the deleting role reads it, so only that role refuses.

AdvisoryDenyWithoutStore Ecosystem (NonEmpty Text)

A mount's rules refuse without advisory evidence and no store is configured. Carries the rule names, in policy order.

RuleBlockedOnMount Ecosystem RuleType Text

An active mount carries a rule its adapter blocks, with the declared reason.

RuleRevocationUnsupported Ecosystem RuleType

A rule's revocation reach needs upstream availability updates the Dredger does not read.

PilotWithoutEcosystem

An advisory store with no mount leaves ecluse pilot no ecosystem to compile for.

ProgressWindowNotPositive Int

The progress window is zero or negative. Carries the configured seconds.

ProgressWindowNotBelowServeCap Int Int

The progress window is not below the serve-path cap, so the floor could never fire first. Window and cap, in seconds.

MinProgressBytesNotPositive Int

The progress floor's byte count is zero or negative. Carries the configured count.

Instances

Instances details
Show BootError Source # 
Instance details

Defined in Ecluse.Composition.BootError

Eq BootError Source # 
Instance details

Defined in Ecluse.Composition.BootError

data StoreMaintenanceReason Source #

Why a mount's mirror target reached no store maintenance handle.

Constructors

NoControlPlane StoreTag

The mount's store tag names no control plane this build implements.

DeletionNotPermitted StoreTag

The mount's store carries no operator consent to delete from it.

NoProtocolMaintenance

The store's only control plane is the ecosystem protocol, which spells no listing or version delete.

PrivateCacheUnavailable Text

The declared private cache lacks a supported maintenance or authentication operation.

ClientBuildFailed Text

Building the cleared backend's client against the live environment threw.

data Advisory Source #

A finding a role boots on and warns about. The deleting role refuses the collapses below instead.

Constructors

MirrorTargetOnPrivateUpstream Ecosystem Ecosystem RegistryUrl

A mirror target is also the named mount's private upstream, at the carried registry. Both mounts are carried, as they can differ.

MirrorTargetOnOwnPublicationTarget Ecosystem RegistryUrl

A mount's mirror target is also its own publication target, at the carried registry.

DredgerQuotaOverrideUnmatched Text

A dredger.quotaOverrides entry, carried as its key, names a store no mount declares.

RemediationSkipsWithoutStore Ecosystem

A mount's remediation rule skips with no advisory store, so it admits no fix and every admission logs the skip.

PrivateUpstreamUndecided Ecosystem UndecidabilityReason

Whether the private upstream serves public content stayed open, so verifying it stays the operator's. Carries why.

Instances

Instances details
Show Advisory Source # 
Instance details

Defined in Ecluse.Composition.BootError

Eq Advisory Source # 
Instance details

Defined in Ecluse.Composition.BootError

refuseOnThrow :: (Text -> BootError) -> IO a -> IO (Either [BootError] a) Source #

Fold a thrown fault into the named boot error, so a phase that dials a live environment refuses through the aggregate.

renderBootError :: BootError -> Text Source #

Render a BootError as a human-facing line for the aggregated failure block.

renderBootErrors :: [BootError] -> Text Source #

Render an aggregated refusal as the one block a failed launch reports.

renderAdvisory :: Advisory -> Text Source #

Render an advisory as the warning a boot logs and ecluse check-config prints, so neither words it its own way.