Implement provider options #154

jacobweinstock · 2023-09-19T14:57:07Z

Description

This implements the provider options now available in the connection crd for machine and task controllers. Also, updated dependencies for controller-runtime and kubernetes client libraries.

Why is this needed

Fixes: #

How Has This Been Tested?

How are existing users impacted? What migration steps/scripts do we need?

Checklist:

I have:

updated the documentation and/or roadmap (if required)
added unit or e2e tests
provided instructions on how to upgrade

Moving the provider options under connection allows the options to be available to both the machine and task controllers. Signed-off-by: Jacob Weinstock <jakobweinstock@gmail.com>

codecov · 2023-09-19T14:58:22Z

Codecov Report

Merging #154 (4023da7) into main (a9b033b) will increase coverage by 1.35%.
Report is 10 commits behind head on main.
The diff coverage is 67.66%.

❗ Current head 4023da7 differs from pull request most recent head a5ed4b5. Consider uploading reports for the commit a5ed4b5 to get more accurate results

@@            Coverage Diff             @@
##             main     #154      +/-   ##
==========================================
+ Coverage   61.82%   63.17%   +1.35%     
==========================================
  Files           4        5       +1     
  Lines         351      478     +127     
==========================================
+ Hits          217      302      +85     
- Misses        100      137      +37     
- Partials       34       39       +5

Files	Coverage Δ
controller/job.go	`53.96% <ø> (ø)`
controller/kube.go	`95.65% <95.65%> (ø)`
controller/task.go	`67.93% <87.50%> (ø)`
controller/machine.go	`78.88% <88.88%> (ø)`
controller/client.go	`48.14% <48.14%> (ø)`

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

This is optional as it is not required when using the RPC provider. Signed-off-by: Jacob Weinstock <jakobweinstock@gmail.com>

This makes the provider opts in the CRD operational via the bmclib client. Rename pkg; controllers -> controller: this is the preferred practive in Go. Added a requeue interval. Signed-off-by: Jacob Weinstock <jakobweinstock@gmail.com>

Implements provider options defined in the connection of a task CR. Signed-off-by: Jacob Weinstock <jakobweinstock@gmail.com>

controller-gen doesn't format the imports like goimports does so the CI run of goimports will fail. This provides a make goal to run the go fmt and goimports. Signed-off-by: Jacob Weinstock <jakobweinstock@gmail.com>

This will exercise the provider option logic. Signed-off-by: Jacob Weinstock <jakobweinstock@gmail.com>

Signed-off-by: Jacob Weinstock <jakobweinstock@gmail.com>

main.go

controller/machine.go

main.go

Signed-off-by: Jacob Weinstock <jakobweinstock@gmail.com>

This allows for the fields to not be included when nil is various applications. Signed-off-by: Jacob Weinstock <jakobweinstock@gmail.com>

Signed-off-by: Jacob Weinstock <jakobweinstock@gmail.com>

jacobweinstock · 2023-09-29T17:20:07Z

@Mergifyio queue

mergify · 2023-09-29T17:20:10Z

queue

🛑 The pull request has been removed from the queue `default`

The pull request can't be updated.

You can take a look at Queue: Embarked in merge queue check runs for more details.

In case of a failure due to a flaky test, you should first retrigger the CI.
Then, re-embark the pull request into the merge queue by posting the comment
@mergifyio refresh on the pull request.

jacobweinstock · 2023-09-29T17:23:42Z

@Mergifyio refresh

mergify · 2023-09-29T17:23:44Z

refresh

✅ Pull request refreshed

jacobweinstock · 2023-09-29T17:27:08Z

@Mergifyio queue

mergify · 2023-09-29T17:27:13Z

queue

🛑 The pull request has been removed from the queue `default`

The pull request can't be updated.

You can take a look at Queue: Embarked in merge queue check runs for more details.

In case of a failure due to a flaky test, you should first retrigger the CI.
Then, re-embark the pull request into the merge queue by posting the comment
@mergifyio refresh on the pull request.

jacobweinstock · 2023-09-29T17:27:27Z

@Mergifyio refresh

mergify · 2023-09-29T17:27:29Z

refresh

✅ Pull request refreshed

jacobweinstock · 2023-09-29T17:29:27Z

@Mergifyio unqueue

mergify · 2023-09-29T17:29:30Z

unqueue

☑️ The pull request is not queued

jacobweinstock · 2023-09-29T17:29:51Z

@Mergifyio queue

mergify · 2023-09-29T17:29:54Z

queue

🛑 The pull request has been removed from the queue `default`

The pull request can't be updated.

You can take a look at Queue: Embarked in merge queue check runs for more details.

In case of a failure due to a flaky test, you should first retrigger the CI.
Then, re-embark the pull request into the merge queue by posting the comment
@mergifyio refresh on the pull request.

Update API around provider options:

d04165d

Moving the provider options under connection allows the options to be available to both the machine and task controllers. Signed-off-by: Jacob Weinstock <jakobweinstock@gmail.com>

jacobweinstock added 10 commits September 20, 2023 09:37

Make AuthSecretRef optional:

1656c1c

This is optional as it is not required when using the RPC provider. Signed-off-by: Jacob Weinstock <jakobweinstock@gmail.com>

Add provider opts to task controller:

2fc3dc9

Implements provider options defined in the connection of a task CR. Signed-off-by: Jacob Weinstock <jakobweinstock@gmail.com>

Add goimports to make fmt goal:

4a2f0b7

controller-gen doesn't format the imports like goimports does so the CI run of goimports will fail. This provides a make goal to run the go fmt and goimports. Signed-off-by: Jacob Weinstock <jakobweinstock@gmail.com>

Add a provider option for all tests in machine and task:

d0211cc

This will exercise the provider option logic. Signed-off-by: Jacob Weinstock <jakobweinstock@gmail.com>

Clean up

41b0172

Signed-off-by: Jacob Weinstock <jakobweinstock@gmail.com>

Add tests for RPC provider in machine and task controllers:

b57491f

Signed-off-by: Jacob Weinstock <jakobweinstock@gmail.com>

Fix linting issue

e345487

Signed-off-by: Jacob Weinstock <jakobweinstock@gmail.com>

Add doc sections for provider options

1073292

Signed-off-by: Jacob Weinstock <jakobweinstock@gmail.com>

Fix linting issues in yaml examples

c9d0250

Signed-off-by: Jacob Weinstock <jakobweinstock@gmail.com>

jacobweinstock commented Sep 20, 2023

View reviewed changes

main.go Outdated Show resolved Hide resolved

jacobweinstock requested review from chrisdoherty4 and pokearu September 20, 2023 17:34

jacobweinstock marked this pull request as ready for review September 20, 2023 17:41

chrisdoherty4 reviewed Sep 25, 2023

View reviewed changes

controller/machine.go Outdated Show resolved Hide resolved

controller/machine.go Outdated Show resolved Hide resolved

main.go Outdated Show resolved Hide resolved

jacobweinstock added 4 commits September 25, 2023 13:29

rename func for improved clarity

50ea581

Signed-off-by: Jacob Weinstock <jakobweinstock@gmail.com>

Remove unneeded const

eaffeb8

Signed-off-by: Jacob Weinstock <jakobweinstock@gmail.com>

Make RPCOptions fields pointers:

71a983d

This allows for the fields to not be included when nil is various applications. Signed-off-by: Jacob Weinstock <jakobweinstock@gmail.com>

Update to handle pointers

2980676

Signed-off-by: Jacob Weinstock <jakobweinstock@gmail.com>

jacobweinstock requested a review from chrisdoherty4 September 29, 2023 00:06

jacobweinstock added the ready-to-merge Mergify: Ready for Merging label Sep 29, 2023

Update for new controller runtime version

a5ed4b5

Signed-off-by: Jacob Weinstock <jakobweinstock@gmail.com>

chrisdoherty4 approved these changes Sep 29, 2023

View reviewed changes

jacobweinstock merged commit 8cfe37e into tinkerbell:main Sep 29, 2023
5 of 6 checks passed

jacobweinstock deleted the provider-opts-implementation branch September 29, 2023 17:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement provider options #154

Implement provider options #154

jacobweinstock commented Sep 19, 2023 •

edited

Loading

codecov bot commented Sep 19, 2023 •

edited

Loading

jacobweinstock commented Sep 29, 2023

mergify bot commented Sep 29, 2023 •

edited

Loading

jacobweinstock commented Sep 29, 2023

mergify bot commented Sep 29, 2023

jacobweinstock commented Sep 29, 2023

mergify bot commented Sep 29, 2023

jacobweinstock commented Sep 29, 2023

mergify bot commented Sep 29, 2023

jacobweinstock commented Sep 29, 2023

mergify bot commented Sep 29, 2023

jacobweinstock commented Sep 29, 2023

mergify bot commented Sep 29, 2023

Implement provider options #154

Implement provider options #154

Conversation

jacobweinstock commented Sep 19, 2023 • edited Loading

Description

Why is this needed

How Has This Been Tested?

How are existing users impacted? What migration steps/scripts do we need?

Checklist:

codecov bot commented Sep 19, 2023 • edited Loading

Codecov Report

jacobweinstock commented Sep 29, 2023

mergify bot commented Sep 29, 2023 • edited Loading

🛑 The pull request has been removed from the queue default

jacobweinstock commented Sep 29, 2023

mergify bot commented Sep 29, 2023

✅ Pull request refreshed

jacobweinstock commented Sep 29, 2023

mergify bot commented Sep 29, 2023

🛑 The pull request has been removed from the queue default

jacobweinstock commented Sep 29, 2023

mergify bot commented Sep 29, 2023

✅ Pull request refreshed

jacobweinstock commented Sep 29, 2023

mergify bot commented Sep 29, 2023

☑️ The pull request is not queued

jacobweinstock commented Sep 29, 2023

mergify bot commented Sep 29, 2023

🛑 The pull request has been removed from the queue default

jacobweinstock commented Sep 19, 2023 •

edited

Loading

codecov bot commented Sep 19, 2023 •

edited

Loading

mergify bot commented Sep 29, 2023 •

edited

Loading

🛑 The pull request has been removed from the queue `default`

🛑 The pull request has been removed from the queue `default`

🛑 The pull request has been removed from the queue `default`