Skip to content

feat(serverless-orchestration): local service #4556

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 20 commits into
base: master
Choose a base branch
from

Conversation

Reinis-FRP
Copy link
Contributor

Motivation

When developing bots it is important to have local test environment that is as close as possible to production. This allows also testing exact cloud configuration locally.

Summary

Adds helper scripts and documentation on how to run serverless orchestration in a local docker service.

Details

Currently, this does not support running bots that require access to GCP Datastore and caching service.

Testing

Check a box to describe how you tested these changes and list the steps for reviewers to test.

  • Ran end-to-end test, running the code as in production
  • New unit tests created
  • Existing tests adequate, no new tests required
  • All existing tests pass
  • Untested

Issue(s)

Fixes #XXXX

Reinis-FRP added 20 commits May 3, 2023 21:20
Signed-off-by: Reinis Martinsons <reinis@umaproject.org>
Signed-off-by: Reinis Martinsons <reinis@umaproject.org>
Signed-off-by: Reinis Martinsons <reinis@umaproject.org>
Signed-off-by: Reinis Martinsons <reinis@umaproject.org>
Signed-off-by: Reinis Martinsons <reinis@umaproject.org>
Signed-off-by: Reinis Martinsons <reinis@umaproject.org>
Signed-off-by: Reinis Martinsons <reinis@umaproject.org>
Signed-off-by: Reinis Martinsons <reinis@umaproject.org>
Signed-off-by: Reinis Martinsons <reinis@umaproject.org>
Signed-off-by: Reinis Martinsons <reinis@umaproject.org>
Signed-off-by: Reinis Martinsons <reinis@umaproject.org>
Signed-off-by: Reinis Martinsons <reinis@umaproject.org>
Signed-off-by: Reinis Martinsons <reinis@umaproject.org>
Signed-off-by: Reinis Martinsons <reinis@umaproject.org>
Signed-off-by: Reinis Martinsons <reinis@umaproject.org>
Signed-off-by: Reinis Martinsons <reinis@umaproject.org>
Signed-off-by: Reinis Martinsons <reinis@umaproject.org>
Signed-off-by: Reinis Martinsons <reinis@umaproject.org>
Signed-off-by: Reinis Martinsons <reinis@umaproject.org>
Signed-off-by: Reinis Martinsons <reinis@umaproject.org>
@mrice32 mrice32 requested a review from Copilot April 22, 2025 20:12
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR introduces local service support for serverless orchestration.

  • Adds a docker-compose configuration for local hub, spoke, and scheduler services.
  • Provides documentation (README) on building and running the services locally.
  • Updates the main README to reference the local testing instructions.

Reviewed Changes

Copilot reviewed 3 out of 17 changed files in this pull request and generated no comments.

File Description
packages/serverless-orchestration/local-docker/docker-compose.yml Introduces a docker-compose setup for local service orchestration.
packages/serverless-orchestration/local-docker/README.md Adds detailed instructions for building and running locally.
packages/serverless-orchestration/README.md Updates the main README to include a reference to local testing docs.
Files not reviewed (14)
  • .dockerignore: Language not supported
  • packages/serverless-orchestration/.gitignore: Language not supported
  • packages/serverless-orchestration/local-docker/bot-configs/schedule.json.example: Language not supported
  • packages/serverless-orchestration/local-docker/hub.env.template: Language not supported
  • packages/serverless-orchestration/local-docker/scheduler/Dockerfile: Language not supported
  • packages/serverless-orchestration/local-docker/scheduler/entrypoint.sh: Language not supported
  • packages/serverless-orchestration/local-docker/scheduler/run-bots.sh: Language not supported
  • packages/serverless-orchestration/local-docker/scripts/docker-build.sh: Language not supported
  • packages/serverless-orchestration/local-docker/scripts/docker-down.sh: Language not supported
  • packages/serverless-orchestration/local-docker/scripts/docker-up.sh: Language not supported
  • packages/serverless-orchestration/local-docker/scripts/json-to-env.sh: Language not supported
  • packages/serverless-orchestration/local-docker/scripts/update-config.sh: Language not supported
  • packages/serverless-orchestration/local-docker/spoke.env.template: Language not supported
  • packages/serverless-orchestration/package.json: Language not supported
Comments suppressed due to low confidence (1)

packages/serverless-orchestration/local-docker/docker-compose.yml:14

  • [nitpick] The scheduler service image name differs from the hub and spoke services. Consider using a consistent naming convention (e.g. umaprotocol/scheduler:local) for clarity.
    image: scheduler:local

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant