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

Improve readme #119

Merged
merged 3 commits into from
Jul 28, 2023
Merged

Improve readme #119

merged 3 commits into from
Jul 28, 2023

Conversation

FrostyX
Copy link
Collaborator

@FrostyX FrostyX commented Jul 27, 2023

I am converting the README to markdown, adding the list of known resalloc allocation scripts, and motivation for why to use the project.

README.md Outdated

Resalloc's concept of _resources_ is intentionally vague and general. Whatever
your allocation scripts spawn and return to resalloc, those are your
_resources_. It can be virtual machines, docker containers, IP addresses, TODO,
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I wanted to emphasize that resalloc doesn't necessarily have to be used only for VM spawning, so I wanted to list a couple of different resources. Do you have any good ones?

Copy link
Owner

Choose a reason for hiding this comment

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

Whatever you put here; disk volumes, network devices, ... I think it is fine eventually. It could work even with people :-) even though the abstraction would deserve yet another iteration to better support asynchronous "human resources".

self-hosted sever is for free. Resalloc prioritizes to be wallet-friendly.
- Web interface - It is possible to optionally run a web UI and let users see
what, and how many resources are available. For example, see
[Copr resources](https://download.copr.fedorainfracloud.org/resalloc).
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

The list is long enough ... but did I forget something important?

Copy link
Owner

Choose a reason for hiding this comment

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

This is awesome, thank you very much for the docs! We can continue in a different PR, but something that comes to my mind:

  • resource recycling and security -> I can get the very same resource again for multiple tasks just to not waste the resource allocation time, and potentially fixed price for spawning
  • fair client service -> despite the overall complicated logic in allocation, the sooner the client comes the earlier is served
  • logging -> each resource has it's own set of "live" logs you may monitor by tail -f

README.md Outdated
Typical client use-cases
------------------------

1. get the resource, and wait till it is ready
Copy link
Owner

Choose a reason for hiding this comment

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

this is old text, but "ask for a resource" would sound better

README.md Outdated
small number of resources that are ready to be used immediately.
- Livechecks - Clouds are unreliable. VMs can break while starting or become
unresponsive for various reasons. Resalloc periodically checks the livelines
of all resources and makes sure we doesn't leak money.
Copy link
Owner

Choose a reason for hiding this comment

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

"sure we doesn't leak money" => "makes sure money doesn't leak?"

@FrostyX
Copy link
Collaborator Author

FrostyX commented Jul 27, 2023

Updated

@praiskup praiskup merged commit 4a5a9af into praiskup:main Jul 28, 2023
1 of 2 checks passed
@praiskup
Copy link
Owner

Thank you!

[Copr resources](https://download.copr.fedorainfracloud.org/resalloc).

Resalloc was created to accomodate the ever growing
[farm of Copr builders](https://pavel.raiskup.cz/blog/copr-farm-of-builders.html).
Copy link
Owner

Choose a reason for hiding this comment

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

To be even more precise, the history is much longer - I used to have a shell-only solution (I don't think it was ever published). The motivation was to have the same VM allocator tool both for Copr (the Red Hat) instance and the CI (Jenkins based) for the https://github.com/sclorg images (the team doesn't use resalloc anymore).

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.

2 participants