Lyrid's Deployment Configuration
Lyrid's deployment is configured by setting the .lyrid-definition.yml situated at the root of your repository. It is how Lyrid's platform recognizes how to package, build, and run your code within Lyrid.
Lyrid Definition Breakdown
name: <Application Name>
description: <Application Description>
ignoreFiles: <Files to Ignore>
modules:
- name: <Module Name>
language: <Language Name>
web: <Framework Name>
description: <Module description>
functions:
- name: <Function Name>
entry: <Entrypoint>
description: <Function Description>
Application Name (required)
Application Description
File to Ignore (required)
Module Name (required)
Language Name (required)
Framework Name (required)
Module Description
Function Name
Entrypoint
Function Description
File Structure
Some combinations of languages or frameworks would require following a certain schema:
- Go
- Python
- NodeJS (Express)
- C#
<AppName>.<ModuleName>
│ .env << Environment Variable
│ .lyrid-definition.yml << Module Definition
│ go.mod
│ main.go << Main
│
└───<FunctionName>
entry.go << Entry Function
<AppName>.<ModuleName>
│ .env << Environment Variable
│ .lyrid-definition.yml << Module Definition
│ main.py << Main
│ requirements.txt
│ __init__.py
│
└───<FunctionName>
entry.py << Entry Function
__init__.py
<AppName>.<ModuleName>
│ .env << Environment Variable
│ .lyrid-definition.yml << Module Definition
│ index.js << Main
│ package.json
│
└───src
└───<FunctionName>
entry.js << Entry Function
index.js
<AppName>.<ModuleName>
│ .env << Environment Variable
│ .lyrid-definition.yml << Module Definition
│ DotNetApp.DotNetModule.csproj
│ Program.cs << Main
│
└───DotNetFunction
entry.cs << Entry Function
Entry Function
Entry function is the location that will be the wrapped by the platform to create a Lyrid Function.
note
For the languages/frameworks that follow the schema above, ensure that the names in .lyrid-definition.yml
match the names in the given file structure.