Module schema

Source
Expand description

This module holds schema defintions for Deploy configurations and other types.

Structs§

ARecord
AaaaRecord
AppConfigCapabilityMapV1
Restricted version of super::CapabilityMapV1, with only a select subset of settings.
AppConfigCapabilityMemoryV1
Memory capability settings.
AppConfigV1
User-facing app.yaml config file for apps.
AppMeta
Well-known annotations used by the backend.
AppScalingConfigV1
AppScheduledTask
AppStateV1
AppV1Spec
Describes a backend application.
AppVersionV1Spec
Describes a backend application.
AppVersionV1State
AppVolume
AppVolumeMount
BaseClaims
Basic JWT claims.
CNameRecord
CaaRecord
CapabilityCpuV1
CapabilityFileSystemV1
CapabilityLocalityCityV1
CapabilityLocalityContinentV1
CapabilityLocalityCountryV1
CapabilityLocalityV1
The locality configuration allows a workload author to place the workloads that respond to requests at different densities in different locations.
CapabilityLoggingV1
Configure log capturing.
CapabilityMapV1
CapabilityMemorySwapV1
Configuration for swap memory.
CapabilityMemoryV1
Memory settings.
CapabilityNetworkDnsV1
CapabilityNetworkGatewayV1
CapabilityNetworkV1
Instance network configuration.
CapabilityPersistentMemoryV1
CapabilityWasiV1
WASI related configuration.
CapabilityWebGatewayV1
CronJobSpecV1
A cronjob.
CronTab
Crontab schedule.
CronTabParseError
DNameRecord
DnsRecordCommon
DnsRecordSpecV1
Entity
An entity with associated data.
EntityKind
Represents an entity kind as a string.
EntityMeta
Common entity metadata.
EntityState
State of an entity.
EntityStateComponent
Single component of an entities state.
EntityTypeSpecV1
EntityUri
Represents an entity URI.
EntityUriParseError
EnvVarV1
FileEntity
Entity loaded from a file.
FsPermissionsV1
FsVolumeConfig
FullEntity
An entity with associated data, including state.
GenericEntity
Generic, untyped entity.
HttpRouteHeaderMatch
HttpRouteMatch
HttpRouteV1
An HTTP route of an HTTP router.
HttpRouterSpecV1
IpBlacklistEntrySpec
JobDefinition
JobInvocation
JobInvocationOutputFetch
JobInvocationOutputSpawn
JobInvokeFetch
JobSpecV1
JobStatusV1
MxRecord
NetworkDnsAllowedHostsV1
NetworkEgressV1
NetworkFilterV1
NetworkGatewayTlsAutoCertsV1
NetworkGatewayTlsV1
NetworkIngressV1
NetworkTokenV1
NetworkVpnV1
NsRecord
PtrRecord
Seconds
SoaRecord
SrvRecord
StringWebcIdent
Wrapper around [WebcPackageIdentifierV1].
TxtRecord
VolumeMountV1
VolumeSourceShared
WebcIdent
Parsed representation of a WebC package source.
WebcPackagePathV1
WebcPackageVersionV1Alpha1Spec
WebcParseError
WorkloadV2
Spawn a new workload on demand.

Enums§

AnyEntity
BanScope
CapabilityV1
CgiDialect
The CGI dialect to use when running a CGI workload.
CronSchedule
DnsRecordData
DnsRecordKind
EntityKindParseError
Error that can occur when parsing an EntityKind.
EntityOrRef
Represents either an inline entity definition, or a reference to an entity.
EntityUriParseErrorKind
EnvVarSourceV1
HttpMethod
HttpRouteHandlerV1
HttpRouteHeaderValueMatch
HttpRoutePathMatch
JobInvocationOutput
JobInvoke
MemorySwappinessV1
Determines the “swappiness” of memory.
NodeApiPermission
Node API permission scopes.
RunnerKind
VolumeSourceV1

Constants§

APP_ID_PREFIX

Traits§

EntityDescriptorConst
A marker trait for entity types.
Merge
Extend values with defaults.

Functions§

deserialize_entity_yaml_typed
Deserialize a typed entity from YAML.
deserialize_json
Deserialize JSON to a given type using serde-path-to-error.
load_fixture_dir
Load fixtures from YAML files in the specified directory. Descends into subdirectories. Each file can contain multiple entities as separate YAML documents.
parse_upcast_app_version_yaml
Parse either a deprecated AppV1 or a new AppVersionV1 from yaml.

Type Aliases§

AppV1
AppVersionV1
CronJobId
EntityTypeSpec
HttpRouterV1
IpBlacklistEntry
Job
JobId
JsonEntity
WebcPackageVersion