feat: allow to configure the runner name #57

maigl · 2023-01-11T20:35:32Z

This allows to set a individual runner-prefix for each runner pool.

Currently all runner instances are called something likegarm-b55ac285-02bd-46dc-8b6e-c7f2f2e8441a,
no matter how many pools or even garm instances there are. This makes it a little bit tricky to manage larger numbers of runners.

The runner-prefix will be use to prefix name of the runners.
This is especially useful if you want to have multiple runner pools with runners with various capabilities.

Again, this is just an example of how we would imagine such a feature, but some remarks:

The (very long) UUID is replaced by a (shorter) https://github.com/teris-io/shortid.
It's generally a bit cumbersome to add new config values, in this case there are a number of structs that need this new field .. probably we should work towards easier configuration

Looking forward to hearing your ideas to this.

Michael Kuhnt michael.kuhnt@mercedes-benz.com Mercedes-Benz Tech Innovation GmbH (ProviderInformation)

gabriel-samfira · 2023-01-11T22:42:08Z

Hi @maigl !

Would it be possible to get a short user story for this change?

From a provider perspective, instances should be tagged with all the tags you set on the pool, plus controller ID and pool ID. You could add any arbitrary tag you wish.

In providers such as OpenStack, this means you can filter servers by tag using something like:

openstack seerver list --tag some-specific-tag-assigned-to-pool

which would list only instances with that tag. You could potentially specify multiple tags to filter even further. I figured it was easier to categorize and filter resources by tag rather than name. It also fits well with use case like GPU/FPGA enabled pools of runners.

Other than that, I see no reason not to make the name of the runner more configurable. It may be worth adding a Name field to pools, and making the runner name a combination of Owner-PoolName-ShortID. Although that may be more difficult to do well, given that updating from versions where a name was not set may be problematic. A prefix should be fine as well, if this feature is something that is really needed.

What do you think?

maigl · 2023-01-12T15:44:08Z

Clearly, this feature only helps humans to distinguish runner instances.
From a functional perspective one definitely wants to use 'label's.

But still, this feature is more than pure vanity, especially when you have many pools with many many runners.
E.g. in github you cannot filter the runners by label and the name is displayed very prominently. And in the cloud provider (e.g. aws or openstack) you see a long list with VMs all named garm-xxx.

Another example is: In a workflow run you can see:

Set up job:
Current runner version: '2.299.1'
Runner name: 'garm-2a76ebd8-7aba-4a79-9281-dc0f5ca3e045'
Runner group name: 'Default'
Machine name: 'garm-2a76ebd8-7aba-4a79-9281-dc0f5ca3e045'

you see the runner name, but not the labels that where used to pick this runner.

In a debugging scenario it would help much to directly see the pool this runner belongs to.

gabriel-samfira · 2023-01-12T15:48:25Z

Sounds good.

Do you think it would be worth using something like owner-repo-poolName-shortID / OrgOrEnterprise-poolName-shortID as the runner name?

maigl · 2023-01-12T17:07:27Z

.. I think this could be nice .. however, in our case owner will almost always be 'enterprise'.

I have the feeling it would be nice to have the possibility to freely set the name, like a "full name override".

gabriel-samfira · 2023-01-12T17:17:27Z

Fair enough. Will have a proper look over this PR soon.

gabriel-samfira

Just a few small changes, but otherwise looks good!

gabriel-samfira · 2023-01-13T07:54:47Z

database/sql/util.go

@@ -218,6 +219,9 @@ func (s *sqlDatabase) updatePool(pool Pool, param params.UpdatePoolParams) (para
 		pool.Image = param.Image
 	}

+	// no check necessary, we have sane defaults
+	pool.RunnerPrefix = param.RunnerPrefix


I am concerned that if we ever add another code path that will use this function and we forget to add proper sane defaults there as well, this will come back to bite us in the behind. I suggest you attach a function to the params.UpdatePoolParams{} called something like GetRunnerPrefix() that checks if the prefix is set, and returns a DefaultRunnerPrefix (let's avoid magic strings) if it's empty.

This way we can be sure that a prefix makes it into the store, and we won't have to care about it being empty when we retrieve an entity and look for a prefix.

Here is an example for the bootstrap timeout:

https://github.com/cloudbase/garm/blob/main/params/params.go#L164-L169

Something similar to this could be done for the runner prefix.

I am so silly. I said params.UpdatePoolParams{} should have that function, but in fact this is more useful in params.Pool{} as that is actually acted upon when creating the actual runner.

Sorry about this. I don't know what I was thinking...

This will allow you to just use pool.GetRunnerPrefix() here:

https://github.com/cloudbase/garm/pull/57/files#diff-0928304a4f9afb0bf84875a5a19d4d42692d7ed54843569166a233b61cbb7603R404

In fact, you could then use pool.GetRunnerPrefix(), anywhere you call pool.RunnerPrefix ensuring you'll always get a sane value.

gabriel-samfira · 2023-01-13T07:55:44Z

params/params.go

@@ -138,6 +138,7 @@ type Tag struct {

 type Pool struct {
 	ID                     string        `json:"id"`
+	RunnerPrefix		   string        `json:"runner_prefix"`


Please run gofmt -w -s on changed files. I find it useful to set up the IDE/Code editor to do it automatically. I think the vs code golang plugin does this out of the box.

No worries at all 😄

gabriel-samfira · 2023-01-13T07:56:56Z

runner/pool/pool.go

-	name := fmt.Sprintf("garm-%s", uuid.New())
+	prefix := pool.RunnerPrefix
+	if prefix == "" {
+		prefix = "garm"


Let's define a constant or a variable DefaultRunnerPrefix. We may need to use it in more than one place and will make our lives easier if we decide to use another default.

gabriel-samfira · 2023-01-13T07:57:18Z

runner/pool/pool.go

+	if prefix == "" {
+		prefix = "garm"
+	}
+	name := fmt.Sprintf("%s-%s", prefix, shortid.MustGenerate())


Love the short ID idea!

.. I changed that a little bit, to avoid having '-' and '_' in the short id. However, I'm tempted to add some unicode smileys :)

maigl · 2023-01-19T07:48:45Z

Hi, thanks for the review .. and sorry for the late response.

I will update the PR soon.

maigl · 2023-01-19T10:26:08Z

some remarks .. I noticed that in the garm-cli there are special sub-commands for org pool cmd/garm-cli/cmd/org_pool.go and also repo_pool.go but no enterprise_pool.go.

gabriel-samfira · 2023-01-19T10:43:38Z

some remarks .. I noticed that in the garm-cli there are special sub-commands for org pool cmd/garm-cli/cmd/org_pool.go and also repo_pool.go but no enterprise_pool.go.

Yes. During the first weeks of garm's existance, I thought it would be useful to have things like:

garm-cli repo pool list [repo_id]

and:

garm-cli repo pool show [repo_ID] [pool_id]

But realized that it's a bit cumbersome, and typing less using:

garm-cli pool list --repo [repo_id]

and:

garm-cli pool show [pool_id] # The pool ID is unique

is a lot friendlier. To be honest I think we can remove the pool sub-command from orgs and repos.

Edit: same goes for the runner sub-command

gabriel-samfira · 2023-01-19T11:33:43Z

Merging as is. Will make that change when I remove the runner and pool sub-commands from the org and repo sections of the CLI.

Thanks for the PR!

maigl force-pushed the runner-prefix branch from a02f91d to 9e43e33 Compare January 12, 2023 20:15

gabriel-samfira requested changes Jan 13, 2023

View reviewed changes

maigl force-pushed the runner-prefix branch 2 times, most recently from 61ff715 to dac5667 Compare January 13, 2023 15:52

feat: allow to configure the runner name

6af3025

maigl force-pushed the runner-prefix branch from dac5667 to 6af3025 Compare January 19, 2023 10:13

maigl requested a review from gabriel-samfira January 19, 2023 10:26

gabriel-samfira approved these changes Jan 19, 2023

View reviewed changes

gabriel-samfira merged commit c92dfb5 into cloudbase:main Jan 19, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: allow to configure the runner name #57

feat: allow to configure the runner name #57

maigl commented Jan 11, 2023

gabriel-samfira commented Jan 11, 2023 •

edited

Loading

maigl commented Jan 12, 2023

gabriel-samfira commented Jan 12, 2023

maigl commented Jan 12, 2023

gabriel-samfira commented Jan 12, 2023

gabriel-samfira left a comment

gabriel-samfira Jan 13, 2023 •

edited

Loading

gabriel-samfira Jan 16, 2023

maigl Jan 19, 2023

gabriel-samfira Jan 19, 2023

gabriel-samfira Jan 19, 2023

gabriel-samfira Jan 19, 2023

gabriel-samfira Jan 13, 2023

maigl Jan 19, 2023

gabriel-samfira Jan 19, 2023

gabriel-samfira Jan 13, 2023

maigl Jan 19, 2023

gabriel-samfira Jan 13, 2023

maigl Jan 19, 2023

maigl commented Jan 19, 2023

maigl commented Jan 19, 2023

gabriel-samfira commented Jan 19, 2023 •

edited

Loading

gabriel-samfira commented Jan 19, 2023

feat: allow to configure the runner name #57

feat: allow to configure the runner name #57

Conversation

maigl commented Jan 11, 2023

gabriel-samfira commented Jan 11, 2023 • edited Loading

maigl commented Jan 12, 2023

gabriel-samfira commented Jan 12, 2023

maigl commented Jan 12, 2023

gabriel-samfira commented Jan 12, 2023

gabriel-samfira left a comment

Choose a reason for hiding this comment

gabriel-samfira Jan 13, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

maigl commented Jan 19, 2023

maigl commented Jan 19, 2023

gabriel-samfira commented Jan 19, 2023 • edited Loading

gabriel-samfira commented Jan 19, 2023

gabriel-samfira commented Jan 11, 2023 •

edited

Loading

gabriel-samfira Jan 13, 2023 •

edited

Loading

gabriel-samfira commented Jan 19, 2023 •

edited

Loading