Documentation
¶
Index ¶
- Constants
- func BindableTypes() []string
- func Check(path string, target any, value any) error
- func IndexPath(path string, index int) string
- func JoinPath(path, key string) string
- func KeysOf(union Keyed) []string
- func PathName(path string) string
- func ProviderIDs() []string
- func ProviderNamedAlone(id string) bool
- func ProviderSchema[E, D ~string](id string, options any, edges []E, dns []D) ([]byte, error)
- func Schema() ([]byte, error)
- func SecretVariable(placeholder string) (string, bool)
- type AlsoAString
- type AppConfig
- type AppDomainConfig
- type Binding
- type Bindings
- type BucketBinding
- type BuildConfig
- type DiscoveryConfig
- type DnsDescriptor
- type DnsOptions
- type Document
- type EdgeDescriptor
- type EdgeOptions
- type HealthConfig
- type InlineRecord
- type Keyed
- type Lookup
- type PostgresBinding
- type PostgresTLS
- type ProjectDomainConfig
- type ProviderDescriptor
- type Ref
- type RegistryConfig
- type Selector
- type StringList
- type Text
- type UnknownKeyError
Constants ¶
View Source
const ( TierProduction = "production" TierPreview = "preview" )
View Source
const SchemaDialect = "https://json-schema.org/draft/2020-12/schema"
Variables ¶
This section is empty.
Functions ¶
func BindableTypes ¶
func BindableTypes() []string
func ProviderIDs ¶
func ProviderIDs() []string
func ProviderNamedAlone ¶
func ProviderSchema ¶
func SecretVariable ¶
Types ¶
type AlsoAString ¶
type AlsoAString interface {
AlsoAString()
}
type AppConfig ¶
type AppConfig struct {
Name string `` /* 132-byte string literal not displayed */
Path string `json:"path" doc:"The app's directory, relative to the config."`
Entrypoint string `json:"entrypoint,omitempty" doc:"The file the app is served from, when it is not the one ocel would detect."`
Compute string `` /* 162-byte string literal not displayed */
Framework string `` /* 157-byte string literal not displayed */
Arch string `` /* 172-byte string literal not displayed */
Folder string `json:"folder,omitempty" doc:"The variables folder this app reads, when it does not read the project's own."`
Domains *AppDomainConfig `json:"domains,omitempty" doc:"The hostnames this app is served on."`
Build *BuildConfig `json:"build,omitempty" doc:"How a container app's image is built."`
Health *HealthConfig `json:"health,omitempty" doc:"How a container app is checked before it is served."`
}
type AppDomainConfig ¶
type AppDomainConfig struct {
Production StringList `json:"production,omitempty" doc:"The hostnames production is served on."`
}
type Binding ¶
type Binding struct {
Published string
Production *InlineRecord
Preview *InlineRecord
}
type Bindings ¶
func (*Bindings) UnmarshalJSON ¶
type BucketBinding ¶
type BucketBinding struct {
Endpoint *Text `json:"endpoint,omitempty"`
Region *Text `json:"region,omitempty"`
Bucket *Text `json:"bucket,omitempty"`
Prefix *Text `json:"prefix,omitempty"`
PathStyle bool `json:"pathStyle,omitempty"`
AccessKeyID *Ref `json:"accessKeyId,omitempty"`
SecretAccessKey *Ref `json:"secretAccessKey,omitempty"`
PublicBaseURL *Text `json:"publicBaseUrl,omitempty"`
}
type BuildConfig ¶
type BuildConfig struct {
Dockerfile string `json:"dockerfile,omitempty" doc:"The Dockerfile to build from. A relative path resolves against the app's directory."`
Context string `` /* 149-byte string literal not displayed */
Command string `json:"command,omitempty" doc:"The command that builds the app inside the image. Left off, the app's own build script runs."`
}
type DiscoveryConfig ¶
type DiscoveryConfig struct {
Paths []string `` /* 162-byte string literal not displayed */
}
type DnsDescriptor ¶
type DnsDescriptor = Selector[DnsOptions, dnsSelector]
type DnsOptions ¶
type DnsOptions struct {
Zone string `json:"zone,omitempty" doc:"The zone the records are written into. Omit it and ocel picks the zone that covers the hostname."`
}
type Document ¶
type Document struct {
Schema string `` /* 144-byte string literal not displayed */
Slug string `` /* 162-byte string literal not displayed */
Bindings Bindings `` /* 449-byte string literal not displayed */
Transforms StringList `` /* 255-byte string literal not displayed */
Discovery *DiscoveryConfig `json:"discovery,omitempty" doc:"Where the resources an app declares are found."`
Provider *ProviderDescriptor `` /* 181-byte string literal not displayed */
Edge *EdgeDescriptor `` /* 205-byte string literal not displayed */
DNS *DnsDescriptor `` /* 161-byte string literal not displayed */
AllowDegraded []string `` /* 174-byte string literal not displayed */
Apps []AppConfig `json:"apps,omitempty" doc:"The apps this project deploys. Left off, ocel detects one at the project root."`
Domains *ProjectDomainConfig `json:"domains,omitempty" doc:"The hostnames this project is served on."`
Registry *RegistryConfig `json:"registry,omitempty" doc:"Where this project's container images are pushed."`
}
type EdgeDescriptor ¶
type EdgeDescriptor = Selector[EdgeOptions, edgeSelector]
type EdgeOptions ¶
type EdgeOptions struct{}
type HealthConfig ¶
type HealthConfig struct {
Path string `` /* 137-byte string literal not displayed */
}
type InlineRecord ¶
type InlineRecord struct {
Postgres *PostgresBinding
Bucket *BucketBinding
}
type PostgresBinding ¶
type PostgresTLS ¶
type ProjectDomainConfig ¶
type ProjectDomainConfig struct {
Production StringList `json:"production,omitempty" doc:"The hostnames production is served on."`
Preview string `json:"preview,omitempty" doc:"The wildcard hostname previews are served under, such as *.preview.example.com."`
}
type ProviderDescriptor ¶
type ProviderDescriptor = Selector[json.RawMessage, providerSelector]
type RegistryConfig ¶
type Selector ¶
func (*Selector[O, K]) UnmarshalJSON ¶
type StringList ¶
type StringList []string
func (*StringList) UnmarshalJSON ¶
func (s *StringList) UnmarshalJSON(data []byte) error
type Text ¶
func (*Text) UnmarshalJSON ¶
type UnknownKeyError ¶
func (UnknownKeyError) Error ¶
func (e UnknownKeyError) Error() string
Source Files
¶
Click to show internal directories.
Click to hide internal directories.