| Safe Haskell | None |
|---|---|
| Language | GHC2021 |
Ecluse.Config.Types
Description
Settings and load refusals shared by the decoders and composition root.
Ecluse.Config resolves the settings into a Config.
Synopsis
- data Url
- mkUrl :: Text -> Text -> Either Text Url
- unUrl :: Url -> Text
- data HttpScheme
- splitHttpScheme :: Text -> Maybe (HttpScheme, Text)
- data StoreTag
- storeTagName :: StoreTag -> Text
- taggedKeyPath :: Text -> StoreTag -> Text -> Text
- data Target = Target {}
- data PrivateEndpoint = PrivateEndpoint {
- preTarget :: Target
- preToken :: Maybe Secret
- preConsent :: DeletionConsent
- data DeletionConsent
- data MirrorWrite
- = WriteRegistry Secret
- | WriteCodeArtifact (Maybe Natural)
- | WriteVerdaccio Secret DeletionConsent
- data MirrorEndpoint = MirrorEndpoint {
- meUrl :: RegistryUrl
- meWrite :: MirrorWrite
- meUploadUrl :: Maybe RegistryUrl
- meUsername :: Maybe Text
- meTarget :: MirrorEndpoint -> Target
- data PublicationEndpoint = PublicationEndpoint {
- peTarget :: Target
- peUploadUrl :: Maybe RegistryUrl
- peToken :: Maybe Secret
- peUsername :: Maybe Text
- data MintPlan
- = MintCodeArtifact CodeArtifactConfig
- | MintStatic Secret
- data ControlPlane
- = ControlCodeArtifact CodeArtifactStore
- | ControlProtocol Secret DeletionConsent
- | ControlNone
- data StoreBackend
- = BackendRegistry Secret
- | BackendCodeArtifact CodeArtifactConfig CodeArtifactStore
- | BackendVerdaccio Secret DeletionConsent
- sbTag :: StoreBackend -> StoreTag
- sbMint :: StoreBackend -> MintPlan
- sbControl :: StoreBackend -> ControlPlane
- data FirstParty = (Eq entry, Show entry, Typeable entry) => FirstParty (FirstPartyNames entry) (NonEmpty entry)
- newtype MountIntegrity = MountIntegrity {
- miMinTrusted :: Maybe MinTrustedIntegrity
- data MountConfig = MountConfig {}
- data AppConfig = AppConfig {
- cfgServer :: ServerSettings
- cfgQueue :: QueueSettings
- cfgLimits :: LimitsSettings
- cfgCache :: CacheSettings
- cfgIntegrity :: IntegritySettings
- cfgEgress :: EgressSettings
- cfgAdvisories :: AdvisoriesSettings
- cfgMirrorState :: Maybe AdvisoryStoreUrl
- cfgRuntime :: RuntimeSettings
- cfgObservability :: ObservabilitySettings
- cfgDredger :: DredgerSettings
- cfgMounts :: Map Ecosystem MountConfig
- data ServerSettings = ServerSettings {
- srvPort :: Int
- srvPublicUrl :: Maybe Url
- srvAuthToken :: Maybe Secret
- srvHelpMessage :: Maybe Text
- srvShutdownDrainTimeout :: Int
- srvMetadataGzip :: MetadataCompression
- data QueueTarget
- data QueueUrl
- queueUrlText :: QueueUrl -> Text
- queueUrlTarget :: QueueUrl -> Maybe QueueTarget
- data QueueSettings = QueueSettings {}
- data AdvisoryStoreTarget = S3Store Text (Maybe Text)
- data AdvisoryStoreUrl
- advisoryStoreUrlText :: AdvisoryStoreUrl -> Text
- advisoryStoreTarget :: AdvisoryStoreUrl -> AdvisoryStoreTarget
- data LimitsSettings = LimitsSettings {}
- data CacheSettings = CacheSettings {}
- data IntegritySettings = IntegritySettings {
- intMinPublic :: MinIntegrity
- intMinTrusted :: MinTrustedIntegrity
- data EgressSettings = EgressSettings {
- egrAdditionalBlockedRanges :: [IPRange]
- egrOperatorContact :: Maybe OperatorContact
- data AdvisoriesSettings = AdvisoriesSettings {
- advUrl :: Maybe AdvisoryStoreUrl
- advPollInterval :: NominalDiffTime
- advCompileInterval :: NominalDiffTime
- advDataDir :: FilePath
- advOsvExportBaseUrl :: Url
- advEpssFeedUrl :: Url
- advSourcePathRecording :: SourcePathRecording
- advQuietTime :: Map Ecosystem NominalDiffTime
- advEpssQuietTime :: NominalDiffTime
- advMaxAgeSeconds :: Maybe NominalDiffTime
- advMaxShrink :: Percent
- advEpssLossCap :: Percent
- data RuntimeSettings = RuntimeSettings {}
- data ObservabilitySettings = ObservabilitySettings {
- obsLogFormat :: LogFormat
- obsLogLevel :: LogLevel
- obsTelemetry :: TelemetrySwitch
- data DredgerSettings = DredgerSettings {}
- data QuotaOverride = QuotaOverride {}
- data MountRegistries = MountRegistries {
- regPublicUpstream :: RegistryUrl
- regMode :: MountMode
- data MountMode
- = Mirrored MirroredLegs
- | ServeOnly (Maybe RegistryUrl)
- data MirroredLegs = MirroredLegs {
- mlPrivateUpstream :: RegistryUrl
- mlMirrorTarget :: MirrorTarget
- regPrivateUpstream :: MountRegistries -> Maybe RegistryUrl
- regMirrorTarget :: MountRegistries -> Maybe MirrorTarget
- data MirrorTarget = MirrorTarget {
- mtUrl :: RegistryUrl
- mtBackend :: StoreBackend
- mtUploadUrl :: RegistryUrl
- mtUsername :: Maybe Text
- data Mount = Mount {
- mountEcosystem :: Ecosystem
- mountRegistries :: MountRegistries
- mountPolicy :: [PrecededRule]
- mountInactiveRules :: Map Text RuleInactivity
- type MountMap = Map Ecosystem Mount
- data RuleInactivity = NoAdvisorySource
- data Config = Config {}
- data ConfigError
- = ParseError Text
- | PolicyErrors [PolicyError]
- | SharedPolicyErrors [PolicyError]
- | PublicUrlRequired
- | MountMissingPrivateUpstream Ecosystem
- | CodeArtifactHostMismatch Ecosystem Text
- | CodeArtifactFormatUnsupported Ecosystem Text
- | CodeArtifactRepositoryMissing Ecosystem Text Text
- | UploadUrlRefused Ecosystem Text
- renderConfigError :: ConfigError -> Text
- shippedMountRules :: [(Text, NonEmpty Ecosystem)]
Documentation
An operator-configured http(s) URL, whitespace-trimmed. mkUrl is the only builder, so no
value exists carrying credential material, another scheme, or an authority the egress gate misses.
mkUrl :: Text -> Text -> Either Text Url Source #
Build a Url from a configuration key and the value written under it, the key naming every
refusal. The credential refusal runs first, because the two refusals below it quote the value.
data HttpScheme Source #
The scheme a configured http(s) URL writes.
Instances
| Show HttpScheme Source # | |
Defined in Ecluse.Config.Types Methods showsPrec :: Int -> HttpScheme -> ShowS # show :: HttpScheme -> String # showList :: [HttpScheme] -> ShowS # | |
| Eq HttpScheme Source # | |
Defined in Ecluse.Config.Types | |
splitHttpScheme :: Text -> Maybe (HttpScheme, Text) Source #
Split a URL into the scheme it writes and the text after the separator, or Nothing for
neither http nor https. It is the one scheme check the configuration layer shares.
Which store backend an endpoint names: the one key under it, which the load validates the URL against, never a guess from the host.
Constructors
| TagRegistry | Any host that speaks the ecosystem's protocol, authenticated by a static token. |
| TagCodeArtifact | A CodeArtifact repository endpoint, which mints its own write token. |
| TagVerdaccio | A Verdaccio development store, authenticated by a static token. |
Instances
storeTagName :: StoreTag -> Text Source #
The tag as an operator writes it, and as a refusal names it.
taggedKeyPath :: Text -> StoreTag -> Text -> Text Source #
A key's path under an endpoint's tag, as refusals name it: mirrorTarget.codeArtifact.uploadUrl.
An endpoint as a mount declares it: the tag naming its store, and the URL under that tag.
data PrivateEndpoint Source #
A private read endpoint with maintenance authority used only by Dredger.
Constructors
| PrivateEndpoint | |
Fields
| |
Instances
| Show PrivateEndpoint Source # | |
Defined in Ecluse.Config.Types Methods showsPrec :: Int -> PrivateEndpoint -> ShowS # show :: PrivateEndpoint -> String # showList :: [PrivateEndpoint] -> ShowS # | |
| Eq PrivateEndpoint Source # | |
Defined in Ecluse.Config.Types Methods (==) :: PrivateEndpoint -> PrivateEndpoint -> Bool # (/=) :: PrivateEndpoint -> PrivateEndpoint -> Bool # | |
data DeletionConsent Source #
Whether the operator consented to ecluse dredger deleting from a Verdaccio store. No other tag carries it.
Constructors
| DeletionPermitted | |
| DeletionWithheld |
Instances
| Show DeletionConsent Source # | |
Defined in Ecluse.Config.Types Methods showsPrec :: Int -> DeletionConsent -> ShowS # show :: DeletionConsent -> String # showList :: [DeletionConsent] -> ShowS # | |
| Eq DeletionConsent Source # | |
Defined in Ecluse.Config.Types Methods (==) :: DeletionConsent -> DeletionConsent -> Bool # (/=) :: DeletionConsent -> DeletionConsent -> Bool # | |
data MirrorWrite Source #
How the mirror write, Écluse's one standing credential, authenticates: a minting tag carries no static token, and any other requires one.
Constructors
| WriteRegistry Secret | Any protocol-speaking host: the operator's static write token. |
| WriteCodeArtifact (Maybe Natural) | A CodeArtifact repository: the requested lifetime of the token it mints. |
| WriteVerdaccio Secret DeletionConsent | A Verdaccio store: its static write token, and the operator's deletion consent. |
Instances
| Show MirrorWrite Source # | |
Defined in Ecluse.Config.Types Methods showsPrec :: Int -> MirrorWrite -> ShowS # show :: MirrorWrite -> String # showList :: [MirrorWrite] -> ShowS # | |
| Eq MirrorWrite Source # | |
Defined in Ecluse.Config.Types | |
data MirrorEndpoint Source #
A declared mirrorTarget: where the mirror writes, and how that write authenticates.
Constructors
| MirrorEndpoint | |
Fields
| |
Instances
| Show MirrorEndpoint Source # | |
Defined in Ecluse.Config.Types Methods showsPrec :: Int -> MirrorEndpoint -> ShowS # show :: MirrorEndpoint -> String # showList :: [MirrorEndpoint] -> ShowS # | |
| Eq MirrorEndpoint Source # | |
Defined in Ecluse.Config.Types Methods (==) :: MirrorEndpoint -> MirrorEndpoint -> Bool # (/=) :: MirrorEndpoint -> MirrorEndpoint -> Bool # | |
meTarget :: MirrorEndpoint -> Target Source #
The mirror endpoint as the collision rules read it. The tag comes from meWrite.
data PublicationEndpoint Source #
A publication endpoint and the credential that replaces an authenticated edge token.
Constructors
| PublicationEndpoint | |
Fields
| |
Instances
| Show PublicationEndpoint Source # | |
Defined in Ecluse.Config.Types Methods showsPrec :: Int -> PublicationEndpoint -> ShowS # show :: PublicationEndpoint -> String # showList :: [PublicationEndpoint] -> ShowS # | |
| Eq PublicationEndpoint Source # | |
Defined in Ecluse.Config.Types Methods (==) :: PublicationEndpoint -> PublicationEndpoint -> Bool # (/=) :: PublicationEndpoint -> PublicationEndpoint -> Bool # | |
How a mount's mirror write authenticates, projected from its resolved StoreBackend.
Constructors
| MintCodeArtifact CodeArtifactConfig | A CodeArtifact mirror target: the mint identity parsed from its host. |
| MintStatic Secret | Any other mirror target: an operator-supplied static write token. |
Instances
data ControlPlane Source #
The control plane a mount's store offers, the face ecluse dredger deletes through.
Constructors
| ControlCodeArtifact CodeArtifactStore | The CodeArtifact repository the target addresses, which the load has vetted. |
| ControlProtocol Secret DeletionConsent | A store with no vendor control plane, swept through the ecosystem protocol's own verbs: its write token, and the operator's consent to delete from it. |
| ControlNone | The tag names no control plane this build implements. |
Instances
| Show ControlPlane Source # | |
Defined in Ecluse.Config.Types Methods showsPrec :: Int -> ControlPlane -> ShowS # show :: ControlPlane -> String # showList :: [ControlPlane] -> ShowS # | |
| Eq ControlPlane Source # | |
Defined in Ecluse.Config.Types | |
data StoreBackend Source #
A mount's store backend, resolved once at load (Ecluse.Config.Target), so no two roles infer a different one. The tag discriminates, so no arm pairs one store's mint with another's plane.
Constructors
| BackendRegistry Secret | A protocol-speaking host: its static write token, and no control plane. |
| BackendCodeArtifact CodeArtifactConfig CodeArtifactStore | A CodeArtifact repository: the identity it mints from, and the store a sweep deletes in. |
| BackendVerdaccio Secret DeletionConsent | A Verdaccio store: its static write token, and the operator's deletion consent. |
Instances
| Show StoreBackend Source # | |
Defined in Ecluse.Config.Types Methods showsPrec :: Int -> StoreBackend -> ShowS # show :: StoreBackend -> String # showList :: [StoreBackend] -> ShowS # | |
| Eq StoreBackend Source # | |
Defined in Ecluse.Config.Types | |
sbTag :: StoreBackend -> StoreTag Source #
The tag a backend was declared under.
sbMint :: StoreBackend -> MintPlan Source #
How the mirror write to this backend authenticates.
sbControl :: StoreBackend -> ControlPlane Source #
The control plane this build reaches for a backend.
data FirstParty #
Constructors
| (Eq entry, Show entry, Typeable entry) => FirstParty (FirstPartyNames entry) (NonEmpty entry) |
Instances
| Show FirstParty | |
Defined in Ecluse.Core.Registry.FirstParty Methods showsPrec :: Int -> FirstParty -> ShowS # show :: FirstParty -> String # showList :: [FirstParty] -> ShowS # | |
| Eq FirstParty | |
Defined in Ecluse.Core.Registry.FirstParty | |
newtype MountIntegrity Source #
A mount's refinements of the global integrity group, under its own integrity key. Each is Nothing at the global setting.
Constructors
| MountIntegrity | |
Fields
| |
Instances
| Show MountIntegrity Source # | |
Defined in Ecluse.Config.Types Methods showsPrec :: Int -> MountIntegrity -> ShowS # show :: MountIntegrity -> String # showList :: [MountIntegrity] -> ShowS # | |
| Eq MountIntegrity Source # | |
Defined in Ecluse.Config.Types Methods (==) :: MountIntegrity -> MountIntegrity -> Bool # (/=) :: MountIntegrity -> MountIntegrity -> Bool # | |
data MountConfig Source #
Endpoint and activation settings for one mount before resolution.
Constructors
| MountConfig | |
Fields
| |
Instances
| Show MountConfig Source # | |
Defined in Ecluse.Config.Types Methods showsPrec :: Int -> MountConfig -> ShowS # show :: MountConfig -> String # showList :: [MountConfig] -> ShowS # | |
| Eq MountConfig Source # | |
Defined in Ecluse.Config.Types | |
Application settings, before active mounts resolve their layered policies.
Constructors
| AppConfig | |
Fields
| |
data ServerSettings Source #
The server group: the inbound edge Écluse itself presents.
Constructors
| ServerSettings | |
Fields
| |
Instances
| Show ServerSettings Source # | |
Defined in Ecluse.Config.Types Methods showsPrec :: Int -> ServerSettings -> ShowS # show :: ServerSettings -> String # showList :: [ServerSettings] -> ShowS # | |
| Eq ServerSettings Source # | |
Defined in Ecluse.Config.Types Methods (==) :: ServerSettings -> ServerSettings -> Bool # (/=) :: ServerSettings -> ServerSettings -> Bool # | |
data QueueTarget Source #
A recognised mirror-queue destination, parsed from the queue URL's shape.
Constructors
| SqsTarget Text | An SQS queue URL, carrying the region parsed from its host. |
| PubSubTarget Text Text | A Pub/Sub topic resource, carrying its project and topic. |
Instances
| Show QueueTarget Source # | |
Defined in Ecluse.Config.Queue.Internal Methods showsPrec :: Int -> QueueTarget -> ShowS # show :: QueueTarget -> String # showList :: [QueueTarget] -> ShowS # | |
| Eq QueueTarget Source # | |
Defined in Ecluse.Config.Queue.Internal | |
queue.url as parsed at load (mkQueueUrl): the value as written,
with the backend its shape names, or no backend when only the SQS endpoint override can dial it.
queueUrlText :: QueueUrl -> Text Source #
The value as written, trimmed.
queueUrlTarget :: QueueUrl -> Maybe QueueTarget Source #
The backend the value's shape names, Nothing when it names none.
data QueueSettings Source #
The queue group: the mirror queue's destination, depth cap, and redelivery budget. The
URL's shape decides the backend, and the load derives it once (Ecluse.Config.QueueTarget).
Constructors
| QueueSettings | |
Fields
| |
Instances
| Show QueueSettings Source # | |
Defined in Ecluse.Config.Types Methods showsPrec :: Int -> QueueSettings -> ShowS # show :: QueueSettings -> String # showList :: [QueueSettings] -> ShowS # | |
| Eq QueueSettings Source # | |
Defined in Ecluse.Config.Types Methods (==) :: QueueSettings -> QueueSettings -> Bool # (/=) :: QueueSettings -> QueueSettings -> Bool # | |
data AdvisoryStoreTarget Source #
A recognised advisory-database store, parsed from the URL's scheme. It carries the bucket and the optional key prefix under which the compiled artifacts live.
Instances
| Show AdvisoryStoreTarget Source # | |
Defined in Ecluse.Config.Advisory.Internal Methods showsPrec :: Int -> AdvisoryStoreTarget -> ShowS # show :: AdvisoryStoreTarget -> String # showList :: [AdvisoryStoreTarget] -> ShowS # | |
| Eq AdvisoryStoreTarget Source # | |
Defined in Ecluse.Config.Advisory.Internal Methods (==) :: AdvisoryStoreTarget -> AdvisoryStoreTarget -> Bool # (/=) :: AdvisoryStoreTarget -> AdvisoryStoreTarget -> Bool # | |
data AdvisoryStoreUrl Source #
advisories.url as parsed at load (mkAdvisoryStoreUrl): the
value as written, with the store its scheme names.
Instances
| Show AdvisoryStoreUrl Source # | |
Defined in Ecluse.Config.Advisory.Internal Methods showsPrec :: Int -> AdvisoryStoreUrl -> ShowS # show :: AdvisoryStoreUrl -> String # showList :: [AdvisoryStoreUrl] -> ShowS # | |
| Eq AdvisoryStoreUrl Source # | |
Defined in Ecluse.Config.Advisory.Internal Methods (==) :: AdvisoryStoreUrl -> AdvisoryStoreUrl -> Bool # (/=) :: AdvisoryStoreUrl -> AdvisoryStoreUrl -> Bool # | |
advisoryStoreUrlText :: AdvisoryStoreUrl -> Text Source #
The value as written, trimmed.
advisoryStoreTarget :: AdvisoryStoreUrl -> AdvisoryStoreTarget Source #
The store the value's scheme names.
data LimitsSettings Source #
The limits group: the hostile-input bounds. The memory plan computes unset tenant-sized caps, and the rest stay pinned.
Constructors
| LimitsSettings | |
Fields
| |
Instances
| Show LimitsSettings Source # | |
Defined in Ecluse.Config.Types Methods showsPrec :: Int -> LimitsSettings -> ShowS # show :: LimitsSettings -> String # showList :: [LimitsSettings] -> ShowS # | |
| Eq LimitsSettings Source # | |
Defined in Ecluse.Config.Types Methods (==) :: LimitsSettings -> LimitsSettings -> Bool # (/=) :: LimitsSettings -> LimitsSettings -> Bool # | |
data CacheSettings Source #
The cache group: the metadata cache's TTL and its computed-by-default bounds.
Constructors
| CacheSettings | |
Fields
| |
Instances
| Show CacheSettings Source # | |
Defined in Ecluse.Config.Types Methods showsPrec :: Int -> CacheSettings -> ShowS # show :: CacheSettings -> String # showList :: [CacheSettings] -> ShowS # | |
| Eq CacheSettings Source # | |
Defined in Ecluse.Config.Types Methods (==) :: CacheSettings -> CacheSettings -> Bool # (/=) :: CacheSettings -> CacheSettings -> Bool # | |
data IntegritySettings Source #
Global integrity floors. A mount can refine the trusted floor through MountIntegrity.
Constructors
| IntegritySettings | |
Fields
| |
Instances
| Show IntegritySettings Source # | |
Defined in Ecluse.Config.Types Methods showsPrec :: Int -> IntegritySettings -> ShowS # show :: IntegritySettings -> String # showList :: [IntegritySettings] -> ShowS # | |
| Eq IntegritySettings Source # | |
Defined in Ecluse.Config.Types Methods (==) :: IntegritySettings -> IntegritySettings -> Bool # (/=) :: IntegritySettings -> IntegritySettings -> Bool # | |
data EgressSettings Source #
Outbound identity and extra blocked target ranges.
Constructors
| EgressSettings | |
Fields
| |
Instances
| Show EgressSettings Source # | |
Defined in Ecluse.Config.Types Methods showsPrec :: Int -> EgressSettings -> ShowS # show :: EgressSettings -> String # showList :: [EgressSettings] -> ShowS # | |
| Eq EgressSettings Source # | |
Defined in Ecluse.Config.Types Methods (==) :: EgressSettings -> EgressSettings -> Bool # (/=) :: EgressSettings -> EgressSettings -> Bool # | |
data AdvisoriesSettings Source #
The advisories group: the OSV/CVE pipeline's store, cadences, and upstream feeds.
Constructors
| AdvisoriesSettings | |
Fields
| |
Instances
| Show AdvisoriesSettings Source # | |
Defined in Ecluse.Config.Types Methods showsPrec :: Int -> AdvisoriesSettings -> ShowS # show :: AdvisoriesSettings -> String # showList :: [AdvisoriesSettings] -> ShowS # | |
| Eq AdvisoriesSettings Source # | |
Defined in Ecluse.Config.Types Methods (==) :: AdvisoriesSettings -> AdvisoriesSettings -> Bool # (/=) :: AdvisoriesSettings -> AdvisoriesSettings -> Bool # | |
data RuntimeSettings Source #
The runtime group: the process-sizing overrides. Unset, each is computed from the runtime
posture (cgroups, RTS, file-descriptor limit), with its provenance boot-logged.
Constructors
| RuntimeSettings | |
Fields | |
Instances
| Show RuntimeSettings Source # | |
Defined in Ecluse.Config.Types Methods showsPrec :: Int -> RuntimeSettings -> ShowS # show :: RuntimeSettings -> String # showList :: [RuntimeSettings] -> ShowS # | |
| Eq RuntimeSettings Source # | |
Defined in Ecluse.Config.Types Methods (==) :: RuntimeSettings -> RuntimeSettings -> Bool # (/=) :: RuntimeSettings -> RuntimeSettings -> Bool # | |
data ObservabilitySettings Source #
The observability group: log shape, log level, and telemetry switch.
Constructors
| ObservabilitySettings | |
Fields
| |
Instances
| Show ObservabilitySettings Source # | |
Defined in Ecluse.Config.Types Methods showsPrec :: Int -> ObservabilitySettings -> ShowS # show :: ObservabilitySettings -> String # showList :: [ObservabilitySettings] -> ShowS # | |
| Eq ObservabilitySettings Source # | |
Defined in Ecluse.Config.Types Methods (==) :: ObservabilitySettings -> ObservabilitySettings -> Bool # (/=) :: ObservabilitySettings -> ObservabilitySettings -> Bool # | |
data DredgerSettings Source #
The dredger group: the sweep's pacing, its deletion cap, and the names it walks. Only ecluse dredger reads it.
Constructors
| DredgerSettings | |
Fields
| |
Instances
| Show DredgerSettings Source # | |
Defined in Ecluse.Config.Types Methods showsPrec :: Int -> DredgerSettings -> ShowS # show :: DredgerSettings -> String # showList :: [DredgerSettings] -> ShowS # | |
| Eq DredgerSettings Source # | |
Defined in Ecluse.Config.Types Methods (==) :: DredgerSettings -> DredgerSettings -> Bool # (/=) :: DredgerSettings -> DredgerSettings -> Bool # | |
data QuotaOverride Source #
One store's declared request capacity. It supplies the capacity a backend publishes none of, and a shared scope joins two endpoints of one pool so the sweep paces them together.
Constructors
| QuotaOverride | |
Fields
| |
Instances
| Show QuotaOverride Source # | |
Defined in Ecluse.Config.Types Methods showsPrec :: Int -> QuotaOverride -> ShowS # show :: QuotaOverride -> String # showList :: [QuotaOverride] -> ShowS # | |
| Eq QuotaOverride Source # | |
Defined in Ecluse.Config.Types Methods (==) :: QuotaOverride -> QuotaOverride -> Bool # (/=) :: QuotaOverride -> QuotaOverride -> Bool # | |
data MountRegistries Source #
A resolved mount's endpoints: the public upstream it gates, and what it does with the rest.
Constructors
| MountRegistries | |
Fields
| |
Instances
| Show MountRegistries Source # | |
Defined in Ecluse.Config.Types Methods showsPrec :: Int -> MountRegistries -> ShowS # show :: MountRegistries -> String # showList :: [MountRegistries] -> ShowS # | |
| Eq MountRegistries Source # | |
Defined in Ecluse.Config.Types Methods (==) :: MountRegistries -> MountRegistries -> Bool # (/=) :: MountRegistries -> MountRegistries -> Bool # | |
Whether a mount mirrors. A declared mirrorTarget makes it Mirrored, which always carries the private upstream it reads back.
Constructors
| Mirrored MirroredLegs | The mount mirrors admitted public artifacts, and it needs both legs. |
| ServeOnly (Maybe RegistryUrl) | The mount never writes. It still merges the optional private upstream when present. |
data MirroredLegs Source #
A mirrored mount's two required halves: the readable private upstream, and the mirror target with its derived write credential.
Constructors
| MirroredLegs | |
Fields
| |
Instances
| Show MirroredLegs Source # | |
Defined in Ecluse.Config.Types Methods showsPrec :: Int -> MirroredLegs -> ShowS # show :: MirroredLegs -> String # showList :: [MirroredLegs] -> ShowS # | |
| Eq MirroredLegs Source # | |
Defined in Ecluse.Config.Types | |
regPrivateUpstream :: MountRegistries -> Maybe RegistryUrl Source #
The mount's private upstream, when it has one. It is total over both mount modes.
regMirrorTarget :: MountRegistries -> Maybe MirrorTarget Source #
The mount's mirror target (with its derived credential), when it mirrors.
data MirrorTarget Source #
A mirror target married to the backend resolved from the tag it was declared under.
Constructors
| MirrorTarget | |
Fields
| |
Instances
| Show MirrorTarget Source # | |
Defined in Ecluse.Config.Types Methods showsPrec :: Int -> MirrorTarget -> ShowS # show :: MirrorTarget -> String # showList :: [MirrorTarget] -> ShowS # | |
| Eq MirrorTarget Source # | |
Defined in Ecluse.Config.Types | |
One resolved mount: its ecosystem, its endpoints, and the rules in precedence order.
Constructors
| Mount | |
Fields
| |
type MountMap = Map Ecosystem Mount Source #
The mounts a load resolved, keyed by the ecosystem each was declared under.
data RuleInactivity Source #
Why a shipped rule an advisory source activates does not run, when no operator patch enabled or disabled it.
Constructors
| NoAdvisorySource | No |
Instances
| Show RuleInactivity Source # | |
Defined in Ecluse.Config.Types Methods showsPrec :: Int -> RuleInactivity -> ShowS # show :: RuleInactivity -> String # showList :: [RuleInactivity] -> ShowS # | |
| Eq RuleInactivity Source # | |
Defined in Ecluse.Config.Types Methods (==) :: RuleInactivity -> RuleInactivity -> Bool # (/=) :: RuleInactivity -> RuleInactivity -> Bool # | |
A completed load: the document's settings and the mounts resolved against them.
Constructors
| Config | |
Fields
| |
data ConfigError Source #
Why a load was refused. renderConfigError writes each one as the boot reports it.
Constructors
| ParseError Text | |
| PolicyErrors [PolicyError] | |
| SharedPolicyErrors [PolicyError] | Shared rule errors that include suppression of a shipped npm mount default. |
| PublicUrlRequired | A mount is active but |
| MountMissingPrivateUpstream Ecosystem | A mount declares a |
| CodeArtifactHostMismatch Ecosystem Text | A |
| CodeArtifactFormatUnsupported Ecosystem Text | A |
| CodeArtifactRepositoryMissing Ecosystem Text Text | A |
| UploadUrlRefused Ecosystem Text | A write target sets |
Instances
| Show ConfigError Source # | |
Defined in Ecluse.Config.Types Methods showsPrec :: Int -> ConfigError -> ShowS # show :: ConfigError -> String # showList :: [ConfigError] -> ShowS # | |
| Eq ConfigError Source # | |
Defined in Ecluse.Config.Types | |
renderConfigError :: ConfigError -> Text Source #
Render a load refusal, including the mount remedy for a misplaced shared suppression.
shippedMountRules :: [(Text, NonEmpty Ecosystem)] Source #
The rule names config/default.yaml ships under mount rules, with the mounts that ship each. The shared layer defines none.