on-prem: cloud provider config modal (COMPOSER-2488) #3103

kingsleyzissou · 2025-04-14T10:27:32Z

Add a modal/page to configure the osbuild-worker with the required configs for the various cloud providers

JIRA: COMPOSER-2488

codecov · 2025-04-16T10:26:37Z

Codecov Report

Attention: Patch coverage is 7.52351% with 295 lines in your changes missing coverage. Please review.

Project coverage is 83.67%. Comparing base (a1700a3) to head (4e3565a).

Files with missing lines	Patch %	Lines
src/Components/CloudProviderConfig/AWSConfig.tsx	0.00%	166 Missing and 1 partial ⚠️
...onents/CloudProviderConfig/CloudProviderConfig.tsx	0.00%	67 Missing and 1 partial ⚠️
...omponents/CloudProviderConfig/validators/index.tsx	0.00%	27 Missing and 1 partial ⚠️
src/Components/ImagesTable/Status.tsx	67.85%	9 Missing ⚠️
...Components/sharedComponents/ImageBuilderHeader.tsx	25.00%	9 Missing ⚠️
src/Router.tsx	0.00%	9 Missing ⚠️
src/test/mocks/cockpit/cockpitFile.ts	16.66%	5 Missing ⚠️

@@            Coverage Diff             @@
##             main    #3103      +/-   ##
==========================================
- Coverage   84.69%   83.67%   -1.03%     
==========================================
  Files         187      190       +3     
  Lines       23417    23712     +295     
  Branches     2416     2420       +4     
==========================================
+ Hits        19833    19840       +7     
- Misses       3567     3852     +285     
- Partials       17       20       +3

Files with missing lines	Coverage Δ
...Components/CreateImageWizard/CreateImageWizard.tsx	`97.21% <100.00%> (ø)`
src/test/mocks/cockpit/cockpitFile.ts	`19.60% <16.66%> (-2.14%)`	⬇️
src/Components/ImagesTable/Status.tsx	`83.47% <67.85%> (-0.30%)`	⬇️
...Components/sharedComponents/ImageBuilderHeader.tsx	`90.76% <25.00%> (-6.69%)`	⬇️
src/Router.tsx	`0.00% <0.00%> (ø)`
...omponents/CloudProviderConfig/validators/index.tsx	`0.00% <0.00%> (ø)`
...onents/CloudProviderConfig/CloudProviderConfig.tsx	`0.00% <0.00%> (ø)`
src/Components/CloudProviderConfig/AWSConfig.tsx	`0.00% <0.00%> (ø)`

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a1700a3...4e3565a. Read the comment docs.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

kingsleyzissou · 2025-04-29T16:45:41Z

Last step remaining is to restart the worker and then this is ready.

package.json

kingsleyzissou · 2025-04-30T11:07:04Z

src/store/cockpit/types.ts

+export type AWSWorkerConfig =
+  | {
+      bucket?: string | undefined;
+      region?: string | undefined;


The region isn't actually used at all by the osbuild-worker, but it makes sense to save this info here for the on-prem version

kingsleyzissou · 2025-04-30T11:31:24Z

src/Components/CloudProviderConfig/CloudProviderConfig.tsx

+        Error
+      </Title>
+      <EmptyStateBody>
+        There was an error reading the `/etc/osbuild-worker/osbuild-worker.toml`


Maybe the copy here could be improved, any suggestions?

Let's sort out copy later.

kingsleyzissou · 2025-05-01T10:05:22Z

I added a note to the the guides about configuring the worker globally for AWS uploads, since this PR essentially follows that pattern.

osbuild/osbuild.github.io#159

graphite-app · 2025-05-07T12:50:04Z

src/store/cockpit/cockpitApi.ts

+            await cockpit.spawn(['systemctl', 'stop', 'osbuild-*'], {
+              superuser: 'require',
+            });
+
+            await cockpit.spawn(
+              [
+                'systemctl',
+                'start',
+                'osbuild-composer.socket',
+                'osbuild-composer',
+              ],
+              {
+                superuser: 'require',
+              }
+            );


The code stops all osbuild services with osbuild-* but only explicitly starts osbuild-composer.socket and osbuild-composer. Since this PR is configuring the osbuild-worker, it should also explicitly start the osbuild-worker service to ensure it picks up the new configuration. Consider adding it to the services being started.

Suggested change

await cockpit.spawn(['systemctl', 'stop', 'osbuild-*'], {

superuser: 'require',

});

await cockpit.spawn(

[

'systemctl',

'start',

'osbuild-composer.socket',

'osbuild-composer',

],

{

superuser: 'require',

}

);

await cockpit.spawn(['systemctl', 'stop', 'osbuild-*'], {

superuser: 'require',

});

await cockpit.spawn(

[

'systemctl',

'start',

'osbuild-composer.socket',

'osbuild-composer',

'osbuild-worker',

],

{

superuser: 'require',

}

);

Spotted by Diamond

Is this helpful? React 👍 or 👎 to let us know.

I'm on the fence about this. We do sort of need to restart the osbuild-local-worker.socket but this is taken care of by restarting the service and the osbuild-composer.socket. @croissanne do you have any opinions on this?

Analytics was enabled for on-prem which broke the images table. This commit disables the analytics for the on-prem frontend.

A select box with dropdown options makes more sense for the AWS region from a UX point of view.

This simplifies the validation and will make it easier to validate the whole form later on.

Setup the footer for the AWS config step.

Create a few types to help stick to conventions and tidy up the code.

Add a query to load the `/etc/osbuild-worker/osbuild-worker.toml` config and use this to set the state of the `cloudConfig` store slice.

Add an error component to improve the UI when there is an issue reading the `osbuild-worker.toml` file.

This is still a wip since the form fields aren't yet disabled when the config toggle is set to off.

Create the `osbuild-worker.toml` file if it doesn't exist already.

Add the `modify` file function which performs atomic modifications to a file.

Add an endpoint to update the worker config.

Save the AWS config modifications to the `osbuild-worker.toml` file.

Restart osbuild-composer and the worker after updating the config, this is a necessary step for osbuild-composer to register the changes.

kingsleyzissou force-pushed the worker-modal branch 11 times, most recently from 06d6e30 to 8affe64 Compare April 16, 2025 10:13

kingsleyzissou force-pushed the worker-modal branch 2 times, most recently from b540c5b to 11f0e9f Compare April 16, 2025 11:29

kingsleyzissou force-pushed the worker-modal branch 2 times, most recently from fae04a1 to 33544e8 Compare April 29, 2025 16:45

kingsleyzissou force-pushed the worker-modal branch 4 times, most recently from ece3737 to c1de9c7 Compare April 30, 2025 11:03

kingsleyzissou commented Apr 30, 2025

View reviewed changes

package.json Outdated Show resolved Hide resolved

kingsleyzissou commented Apr 30, 2025

View reviewed changes

kingsleyzissou force-pushed the worker-modal branch from c1de9c7 to 5d5963c Compare April 30, 2025 11:30

kingsleyzissou commented Apr 30, 2025

View reviewed changes

kingsleyzissou changed the title ~~[wip] on-prem: cloud provider config modal~~ on-prem: cloud provider config modal Apr 30, 2025

kingsleyzissou requested review from croissanne and lucasgarfield April 30, 2025 11:43

kingsleyzissou marked this pull request as ready for review April 30, 2025 11:43

kingsleyzissou changed the title ~~on-prem: cloud provider config modal~~ on-prem: cloud provider config modal (COMPOSER-2488) Apr 30, 2025

kingsleyzissou force-pushed the worker-modal branch 2 times, most recently from 422fca4 to 5dadefc Compare May 7, 2025 12:48

graphite-app bot reviewed May 7, 2025

View reviewed changes

kingsleyzissou force-pushed the worker-modal branch 2 times, most recently from 48da3b7 to 4e3565a Compare May 8, 2025 10:59

kingsleyzissou added 15 commits May 14, 2025 13:35

CloudStatus: disable analytics for on-prem

afe2fc5

Analytics was enabled for on-prem which broke the images table. This commit disables the analytics for the on-prem frontend.

cloudConfigSlice: add new slice

cfb9c3d

cloudConfig: add aws config fields

50eef09

cloudConfig: use select for region

dd34d29

A select box with dropdown options makes more sense for the AWS region from a UX point of view.

cloudConfig: switch validators to hooks

09c83f4

This simplifies the validation and will make it easier to validate the whole form later on.

cloudConfig: configure the footer

73b2e62

Setup the footer for the AWS config step.

cockpitApi: add worker config types

c9a4402

Create a few types to help stick to conventions and tidy up the code.

cockpitApi: get worker config

ed5410e

Add a query to load the `/etc/osbuild-worker/osbuild-worker.toml` config and use this to set the state of the `cloudConfig` store slice.

cloudConfig: error component

0aad07f

Add an error component to improve the UI when there is an issue reading the `osbuild-worker.toml` file.

cloudConfig: toggle aws config

892f8ac

This is still a wip since the form fields aren't yet disabled when the config toggle is set to off.

cockpitApi: create worker config file

f52ca54

Create the `osbuild-worker.toml` file if it doesn't exist already.

test/mocks: add cockpit modify

169fae1

Add the `modify` file function which performs atomic modifications to a file.

store/cockpitApi: add worker config mutation

8dbe5bc

Add an endpoint to update the worker config.

cloudConfig: save the aws configs

55501c9

Save the AWS config modifications to the `osbuild-worker.toml` file.

cloudConfig: restart worker on submit

2954939

Restart osbuild-composer and the worker after updating the config, this is a necessary step for osbuild-composer to register the changes.

kingsleyzissou force-pushed the worker-modal branch from 4e3565a to 2954939 Compare May 14, 2025 12:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

on-prem: cloud provider config modal (COMPOSER-2488) #3103

on-prem: cloud provider config modal (COMPOSER-2488) #3103

kingsleyzissou commented Apr 14, 2025 •

edited

Loading

codecov bot commented Apr 16, 2025 •

edited

Loading

kingsleyzissou commented Apr 29, 2025 •

edited

Loading

kingsleyzissou Apr 30, 2025

kingsleyzissou Apr 30, 2025

lucasgarfield May 8, 2025

kingsleyzissou commented May 1, 2025

graphite-app bot May 7, 2025

kingsleyzissou May 8, 2025

on-prem: cloud provider config modal (COMPOSER-2488) #3103

Are you sure you want to change the base?

on-prem: cloud provider config modal (COMPOSER-2488) #3103

Conversation

kingsleyzissou commented Apr 14, 2025 • edited Loading

codecov bot commented Apr 16, 2025 • edited Loading

Codecov Report

kingsleyzissou commented Apr 29, 2025 • edited Loading

kingsleyzissou Apr 30, 2025

Choose a reason for hiding this comment

kingsleyzissou Apr 30, 2025

Choose a reason for hiding this comment

lucasgarfield May 8, 2025

Choose a reason for hiding this comment

kingsleyzissou commented May 1, 2025

graphite-app bot May 7, 2025

Choose a reason for hiding this comment

kingsleyzissou May 8, 2025

Choose a reason for hiding this comment

kingsleyzissou commented Apr 14, 2025 •

edited

Loading

codecov bot commented Apr 16, 2025 •

edited

Loading

kingsleyzissou commented Apr 29, 2025 •

edited

Loading