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

Shuffle hardware inventory for tinkerbell before reservation #8264

Merged
merged 2 commits into from
Jul 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions internal/test/e2e/run.go
Original file line number Diff line number Diff line change
Expand Up @@ -217,6 +217,13 @@ func RunTests(conf instanceRunConf, inventoryCatalogue map[string]*hardwareCatal
} else {
hardwareCatalogue = inventoryCatalogue[nonAirgappedHardware]
}
conf.Logger.Info("Shuffling hardware inventory for tinkerbell")
// shuffle hardware to introduce randomness during hardware reservation.
Copy link
Member

Choose a reason for hiding this comment

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

nit: I would expand more on why randomness is desired. We don't do this to introduce randomness, we do this to avoid picking up the same machines on every run. Randomness is just the mechanism to achieve that goal.

// we do not want quick e2e runs to always pick the first few available hardware from the list and over-populate the boot entries
// this will quickly break the booting process as the hardware runs out of boot space to store these entries.
// randomly picking the hardware will distribute the boot entries across these hardware during each run
// ideally for long term we want a clear cleanup of the boot entries in the hardware
hardwareCatalogue.shuffleHardware()
err = reserveTinkerbellHardware(&conf, hardwareCatalogue)
if err != nil {
return "", nil, err
Expand Down
10 changes: 10 additions & 0 deletions internal/test/e2e/tinkerbell_hardware_queue.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package e2e

import (
"fmt"
"math/rand"
"sync"
"time"

Expand Down Expand Up @@ -42,6 +43,15 @@ func (hwQu *hardwareCatalogue) releaseHardware(hws []*api.Hardware) {
hwQu.mu.Unlock()
}

func (hwQu *hardwareCatalogue) shuffleHardware() {
hwQu.mu.Lock()
random := rand.New(rand.NewSource(time.Now().UnixNano()))
random.Shuffle(len(hwQu.hws), func(i, j int) {
hwQu.hws[i], hwQu.hws[j] = hwQu.hws[j], hwQu.hws[i]
})
hwQu.mu.Unlock()
}

func newHardwareCatalogue(hws []*api.Hardware) *hardwareCatalogue {
return &hardwareCatalogue{
hws: hws,
Expand Down
Loading