Skip to content
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

feat: run Glee in container, edit Glee local #738

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

Conversation

eelcofolkertsma
Copy link

Description
Setting/maintaining a fully functional node environment on local machine can be overwhelming and hard to debug. A container is much easier to deploy/manage

How will this change help?
The prerequisite effort to install Docker or equivalent is shared over many projects.
On download of the compose.yaml a simple "docker compose up" launches the Glee server with default settings. From there you can modify the Glee files and stop/restart the Glee server to explore all features of Glee

No need to worry about install of node, .gyp, python etc

Related issue(s)
Resolves #735

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

@eelcofolkertsma eelcofolkertsma changed the title Run Glee in container, edit Glee local feat: Run Glee in container, edit Glee local Mar 12, 2024
@eelcofolkertsma eelcofolkertsma marked this pull request as draft March 12, 2024 15:29
@eelcofolkertsma eelcofolkertsma changed the title feat: Run Glee in container, edit Glee local feat: run Glee in container, edit Glee local Mar 12, 2024
@eelcofolkertsma
Copy link
Author

As described in enhancement issue:
develop a docker compose file for easy launch of glee server in container with Glee files exposed on local file system
The container assures Glee runs in well controlled environment (node, npm, python, .gyp etc)
Local exposure allows to use editor of personal preference

A usage file explains how to deploy a container, edit the glee files, and stop/restart Glee for new input. Usage assume almost zero docker knowledge and focuses on bare minimum to run the Glee server

@coveralls
Copy link

Pull Request Test Coverage Report for Build 8251511962

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 72.884%

Totals Coverage Status
Change from base Build 8239916406: 0.0%
Covered Lines: 388
Relevant Lines: 483

💛 - Coveralls

@KhudaDad414
Copy link
Member

@eelcofolkertsma please mark the PR as Ready for Review when it's ready. thanks. 🙇

@eelcofolkertsma
Copy link
Author

eelcofolkertsma commented Mar 18, 2024 via email

@eelcofolkertsma
Copy link
Author

Current approach

  • Docker-compose.yaml to launch persistent container with asyncapi/cli and shared folder between container and local file system
  • Open command prompt in container (docker exec)
  • Use standard asyncapi commands to create Glee tutorial project and initialize (Npm run) and start server (Npm run dev). Keep terminal connected for Glee log
  • Switch to an editor that can modify Glee in local file system and tweak as desired. See at Glee log how server follows asyncapi.yaml and functions updates
  • Send test messages and have fun

One can terminate/remove container with docker compose down command

One can "factory reset" the Glee files with forced new Glee

It is basic setup with lots of possible improvements.

I shall wire stuff together over next week, including usage document. I shall also as for some feedback to decide if further evolution makes sense

Copy link

sonarcloud bot commented Apr 1, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

@KhudaDad414
Copy link
Member

@eelcofolkertsma are you still working on this?

@eelcofolkertsma
Copy link
Author

@eelcofolkertsma are you still working on this?

Yes, I am. Progress is slow, in part other priorities did have to go first, in part issue is more tough than I expected.
But I am sure something will result and it will be reported under this topic

Thanks for asking ;-)

Copy link
Contributor

This pull request has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 120 days if no further activity occurs. To unstale this pull request, add a comment with detailed explanation.

There can be many reasons why some specific pull request has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this pull request forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️

@github-actions github-actions bot added the stale label Aug 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[FEATURE] Run Glee in a container
3 participants