lotus.yaml

The configuration file used for Lotus definitions

Type LotusManifest
File match lotus.yaml
Schema URL https://catalog.lintel.tools/schemas/schemastore/lotus-yaml/latest.json
Source https://grnhse-vpc-assets.s3.amazonaws.com/jsonschemas/lotus.yaml.json

Validate with Lintel

npx @lintel/lintel check
Type: LotusManifest

Definitions

Autoscaling object
metrics AutoscalingMetrics[] required
AutoscalingMetrics object
name string required
query string required
average_value integer required

nolint:tagliatelle

ClientOf object
name string required
type string required
application string
Component object
name string required

Unique name for the component. It must be DNS-friendly

maxLength=45pattern=^[a-z][a-z0-9-\.]*[a-z0-9]$
type string required

The type of component.

Values: "http" "worker" "predeploy" "postdeploy" "grpc-sso-proxy" "cron"
command string required

Command describes how to run the workload

livenessProbe object
10 nested properties
exec object
1 nested properties
command string[]
httpGet object
5 nested properties
port object required
path string
host string
scheme string
httpHeaders HTTPHeader[]
tcpSocket object
2 nested properties
port object required
host string
grpc object
2 nested properties
port integer required
service string required
initialDelaySeconds integer
timeoutSeconds integer
periodSeconds integer
successThreshold integer
failureThreshold integer
terminationGracePeriodSeconds integer
readinessProbe object
10 nested properties
exec object
1 nested properties
command string[]
httpGet object
5 nested properties
port object required
path string
host string
scheme string
httpHeaders HTTPHeader[]
tcpSocket object
2 nested properties
port object required
host string
grpc object
2 nested properties
port integer required
service string required
initialDelaySeconds integer
timeoutSeconds integer
periodSeconds integer
successThreshold integer
failureThreshold integer
terminationGracePeriodSeconds integer
startupProbe object
10 nested properties
exec object
1 nested properties
command string[]
httpGet object
5 nested properties
port object required
path string
host string
scheme string
httpHeaders HTTPHeader[]
tcpSocket object
2 nested properties
port object required
host string
grpc object
2 nested properties
port integer required
service string required
initialDelaySeconds integer
timeoutSeconds integer
periodSeconds integer
successThreshold integer
failureThreshold integer
terminationGracePeriodSeconds integer
progressDeadlineSeconds integer

Used for deployments that need longer than the default 5 minutes to start up

service_name string

The service name is only useful for grpc-sso-proxy components. If present, a health service will be spun up for the service name, and it can be possible to perform auto updates of binaries.

rollingUpdate object
2 nested properties
maxUnavailable object
3 nested properties
Type integer required
IntVal integer required
StrVal string required
maxSurge object
3 nested properties
Type integer required
IntVal integer required
StrVal string required
sso_proxy object
4 nested properties
enabled boolean
pass_auth_header boolean

pass OIDC IDToken to upstream via Authorization Bearer header

allow_bearer_auth boolean

skip requests that have verified JWT bearer tokens

skip_auth string[]

bypass authentication for requests that match the method & path. Format: method=path_regex OR path_regex alone for all methods

autoscaling object
1 nested properties
metrics AutoscalingMetrics[] required
expose_metrics object
2 nested properties
enabled boolean required
port integer

optional port to expose metrics on, defaults to 8080

Datastore object
name string required
maxLength=24pattern=^[a-z][a-z0-9-\.]*[a-z0-9]$
type string required
className string
disableFirewallRules boolean
postgresOptions object
elasticsearchOptions object
kafkaOptions object
kafkaClientOptions object
kafkaConnectorOptions object
opensearchOptions object
allowedClientApplications string[]

apps that will connect to the datastores for this app

clientOf object
3 nested properties
name string required
type string required
application string
ExecAction object
command string[]
ExposeMetrics object
enabled boolean required
port integer

optional port to expose metrics on, defaults to 8080

GRPCAction object
port integer required
service string required
HTTPGetAction object
port object required
3 nested properties
Type integer required
IntVal integer required
StrVal string required
path string
host string
scheme string
httpHeaders HTTPHeader[]
HTTPHeader object
name string required
value string required
IntOrString object
Type integer required
IntVal integer required
StrVal string required
LotusManifest object
name string required

The application name should match the repository's

maxLength=45pattern=^[a-z][a-z0-9-\.]*[a-z0-9]$
components Component[] required

Workloads to run

auth_tokens string[]

Tokens minted to securely interact with other applications

firewall_rules string[]

Named egress rules

datastores Datastore[]

List of datastores to provision

Probe object
exec object
1 nested properties
command string[]
httpGet object
5 nested properties
port object required
3 nested properties
Type integer required
IntVal integer required
StrVal string required
path string
host string
scheme string
httpHeaders HTTPHeader[]
tcpSocket object
2 nested properties
port object required
3 nested properties
Type integer required
IntVal integer required
StrVal string required
host string
grpc object
2 nested properties
port integer required
service string required
initialDelaySeconds integer
timeoutSeconds integer
periodSeconds integer
successThreshold integer
failureThreshold integer
terminationGracePeriodSeconds integer
RollingUpdateDeployment object
maxUnavailable object
3 nested properties
Type integer required
IntVal integer required
StrVal string required
maxSurge object
3 nested properties
Type integer required
IntVal integer required
StrVal string required
SSOProxy object
enabled boolean
pass_auth_header boolean

pass OIDC IDToken to upstream via Authorization Bearer header

allow_bearer_auth boolean

skip requests that have verified JWT bearer tokens

skip_auth string[]

bypass authentication for requests that match the method & path. Format: method=path_regex OR path_regex alone for all methods

TCPSocketAction object
port object required
3 nested properties
Type integer required
IntVal integer required
StrVal string required
host string