Skip to content

Latest commit

 

History

History
205 lines (155 loc) · 8 KB

README.md

File metadata and controls

205 lines (155 loc) · 8 KB
Raw

Staging workflow

Lexbox (formerly Language Depot)

Repo Structure

  • backend - dotnet API
  • backend/FwLite - FieldWorks lite application
  • frontend - SvelteKit app
  • hgweb - hgweb Dockerfile and config
  • otel - Open Telemetry collector config
  • deployment - k8s config for production, staging, develop and local development environments

files related to a specific service should be in a folder named after the service. There are some exceptions:

  • LexBox.sln visual studio expects the sln to be at the root of the repo and can make things difficult otherwise

Other files, like skaffold.yaml, should be at the root of the repo, because they're related to all services.

Development

Prerequisites

  • docker and compose
    • enable Kubernetes in the Docker Desktop settings

Setup

  • install Taskfile
    • windows: winget install Task.Task
    • linux: sudo snap install task --classic or other options on their website
    • mac: brew install go-task/tap/go-task
    • via npm: npm install -g @go-task/cli
  • install Skaffold and add it to your path
    • the file you will download is NOT an installer, just a standalone runnable .exe (on Windows) or binary (on Linux)
    • on Linux, a good practice is to create $HOME/.local/bin and put binaries there; most distributions automatically add $HOME/.local/bin to your path if it exists
      • don't forget to run chmod +x $HOME/.local/bin/skaffold
    • on Windows, we suggest creating a bin folder in your home folder. Put the Skaffold binary there, then do the following:
      • go to your System properties, click the Advanced tab, and click Environment Variables...
      • Click the Path variable (in either User or System, User is recommended) and click the Edit... button
      • Add C:\Users\YOUR_USER_NAME\bin to the list and click OK
  • clone the repo
  • run git push to make sure your GitHub credentials are set up
    • on Windows, allow the Git Credential Manager to log in to GitHub via your browser
    • on Linux, upload your SSH key to your GitHub account if you haven't done so already, then run git remote set-url --push origin [email protected]:sillsdev/languageforge-lexbox
  • on Windows, open PowerShell and run Set-ExecutionPolicy -ExecutionPolicy RemoteSigned
    • this is necessary before running task setup below, which uses a PowerShell script to download seed data
  • run task setup, which:
    • initializes a local.env file
    • tells Git to use our ignore revs file
    • checks out Git submodules
    • downloads the FLEx repo for the project seed data

Extra setup steps for Windows

If you're running Windows, you may need to add the following lines to your C:\Windows\system32\drivers\etc\hosts file:

127.0.0.1 resumable.localhost
127.0.0.1 hg.localhost
127.0.0.1 admin.localhost

On Linux, anything with a .localhost domain is automatically mapped to 127.0.0.1 so you don't need to edit your /etc/hosts file.

Kubernetes workflow

task up

The full app will be running at http://localhost after everything starts. There are some additional urls below to access specific parts of the system.

Local workflow

Prerequisites

  • The SvelteKit UI requires: node v20+
  • The .NET API requires: dotnet sdk v8+

Running the project

There are various ways to run the project. Here are a few suggestions:

For developing the .NET API

  • task infra-up starts all necessary infrastructure in k8s
  • task api:only starts the api locally

For developing the SvelteKit UI

  1. In two seperate consoles:
  • task backend-up starts all necessary infrastructure + the .NET API in k8s
  • task ui:only starts the ui locally
  1. In a shared console:
  • task ui-dev

The SvelteKit UI will be available at http://localhost:3000.

Important

The SvelteKit UI is always available in k8s at http://localhost, but will not be reliable unless the entire project is started with task up.

For developing the .NET API and the SvelteKit UI

  • task infra-up starts all necessary infrastructure in k8s
  • task api:only starts the api locally
  • task ui:only starts the ui locally

If the k8s deployments are already running

  • infra-forward forwards the infrastructure ports for the API
  • backend-forward forwards the infrastructure + backend ports for the UI

Project urls

Seeded data

Once the database is created by the dotnet backend, it will also seed some data in the database. The following users are available, password for them all is just pass:

There will also be a single project, Sena 3. There will not be an hg repository however, see optional setup below if this is desired.

Architecture

flowchart TD
    Chorus --> lexbox-api

    subgraph lexbox pod 
        lexbox-api --> otel
    end
    lexbox-api --> hgweb
    lexbox-api --> hgresumable
    subgraph hg pod 
        hgweb
        hgresumable
    end
    hgweb --> hg[hg file system]
    hgresumable --> hg
    lexbox-api --> hg

    ui["ui (sveltekit)"] --> lexbox-api
    lexbox-api ---> db[(postgres)]
Loading

More info on the frontend and backend can be found in their respective READMEs:

Operational environment

Staging

flowchart LR
    Chorus(["Chorus (e.g. FLEx)"]) -- "https:(hg-staging|resumable-staging)" --- proxy
    Web -- https://staging.languagedepot.org --- proxy([ingress])

    proxy ---|http:5158/api or /hg| api([lexbox-api])
    proxy ---|http:3000| node([sveltekit])

    api -- postgres:5432 --- db([db])
    db -- volume-map:db-data --- data[//var/lib/postgresql/]
  
    api -- http:8088/hg --- hgweb([hgweb])
    hgweb -- /var/hg/repos --- repos
    api -- /hg-repos --- repos

    api -- http:80 --- hgresumable([hgresumable])
    hgresumable -- /var/vcs/public --- repos
    hgresumable -- hgresumable-cache --- cache[//var/cache/hgresume/]

    node <-->|http:5158/api & email| api

    api -- gRPC:4317 --- otel-collector([otel-collector])
    proxy ---|http:4318/traces| otel-collector
    node -- gRPC:4317 --- otel-collector
Loading

Monitoring & Analytics

This project is instrumented with OpenTelemetry (OTEL). The exported telemetry data can be viewed in Honeycomb.

For your local environment to send traces to Honeycomb, you will need to set the HONEYCOMB_API_KEY environment variable in the deployment/local-dev/local.env file. You can get the key from here.

Traces can be accessed directly with a URL like this: https://ui.honeycomb.io/sil-language-forge/environments/[test|staging|prod]/trace?trace_id=_TRACE_ID_. Yes, bookmark it!

In the application, a trace ID (aka "Error code") shown at the bottom of an error message can be Ctrl+clicked to navigate to the trace in Honeycomb.

Error example