[JENKINS-70729] Rework clouds management into multiple pages #7658

Vlatombe · 2023-02-17T09:21:31Z

cf. the idea I described in https://groups.google.com/g/jenkinsci-dev/c/71eTUHSFE9I/m/J4Jzx6kwAgAJ

Separate entry under Manage Jenkins
One configuration page per cloud
One index page per cloud

Here are a few screenshots

Details

See JENKINS-70729.

Testing done

Created clouds of type:

Updated clouds
Deleted clouds

Installed downstream PR for Azure which demonstrates overriding the icon: jenkinsci/azure-vm-agents-plugin#383

Proposed changelog entries

Rework clouds management into multiple pages to better scale to large numbers of clouds. Users of EC2 Plugin should update it to version 2.0.7 or newer for compatibility.

Proposed upgrade guidelines

N/A

Submitter checklist

The Jira issue, if it exists, is well-described.
The changelog entries and upgrade guidelines are appropriate for the audience affected by the change (users or developers, depending on the change) and are in the imperative mood (see examples).
- Fill in the Proposed upgrade guidelines section only if there are breaking changes or changes that may require extra steps from users during upgrade.
There is automated testing or an explanation as to why this change has no tests.
New public classes, fields, and methods are annotated with @Restricted or have @since TODO Javadocs, as appropriate.
New deprecations are annotated with @Deprecated(since = "TODO") or @Deprecated(forRemoval = true, since = "TODO"), if applicable.
New or substantially changed JavaScript is not defined inline and does not call eval to ease future introduction of Content Security Policy (CSP) directives (see documentation).
For dependency updates, there are links to external changelogs and, if possible, full differentials.
For new APIs and extension points, there is a link to at least one consumer.

Desired reviewers

@mention

Maintainer checklist

Before the changes are marked as ready-for-merge:

There are at least two (2) approvals for the pull request and no outstanding requests for change.
Conversations in the pull request are over, or it is explicit that a reviewer is not blocking the change.
Changelog entries in the pull request title and/or Proposed changelog entries are accurate, human-readable, and in the imperative mood.
Proper changelog labels are set so that the changelog can be generated automatically.
If the change needs additional upgrade steps from users, the upgrade-guide-needed label is set and there is a Proposed upgrade guidelines section in the pull request title (see example).
If it would make sense to backport the change to LTS, a Jira issue must exist, be a Bug or Improvement, and be labeled as lts-candidate to be considered (see query).

* Separate entry under Manage Jenkins * One configuration page per cloud * One index page per cloud

timja · 2023-03-04T12:42:45Z

Looks really nice, the only cloud I could get to actually work currently is one from mock-slave.
but excited for this and happy to help on it.

(pushed one quick fix for layout)

timja · 2023-03-04T16:37:16Z

Adding descriptor to the request made all the plugins views now load on create.
and I was also able to save the Kubernetes plugin now.

Can't save Azure or EC2. Both fail with:

Query parameter 'name' is required

core/src/main/java/jenkins/agents/CloudSet.java

core/src/main/java/hudson/slaves/Cloud.java

Vlatombe · 2023-03-04T18:28:39Z

Can't save Azure or EC2. Both fail with:
Query parameter 'name' is required

Should work now. EC2 has an odd behaviour because the persisted name differs from the name displayed in the UI.

timja · 2023-03-05T15:44:07Z

It looks good to me.

I think only thing left is to look at the empty state when there's no clouds.

I'm not 100% sold on the table, there's not much being displayed there but I don't think we have anything better. Anyway it's a lot better than before.

ATH being checked here: jenkinsci/acceptance-test-harness#1047

daniel-beck

Why does this not adapt /configureClouds/, instead creating a separate page? If that's deliberate, why does that page remain, essentially duplicating the UI, and why does it remain linked from the empty All view shown after installation, as well as the admin monitor recommending setup of an agent or cloud?

Was a UI similar to plugin manager's "Available" and "Uploads" being different sections of the same top-level page considered, with "Manage Clouds" one page and "Manage Nodes" the other? If yes, what are the drawbacks compared to completely separate top-level items? Given that clouds create a subset of agents, completely separating them again this way (not even having direct navigation between them) seems very awkward.

The "New Cloud" UI is very awkward when there are no clouds installed, very much unlike /configureClouds/ (which replaces the regular UI with a helpful message). This should be reviewed.

Downstream PRs to cloud implementations like Kubernetes should be filed as needed, if they adapted their UI to show only few fields by default, to limit initial complexity in the potentially giant list (screenshot in PR description).

Permissions checks seem way off, need lots more validation to ensure this works as intended.

core/src/main/resources/jenkins/management/Messages.properties

core/src/main/resources/hudson/slaves/Cloud/delete.properties

core/src/main/resources/hudson/slaves/Cloud/index.jelly

core/src/main/resources/hudson/slaves/Cloud/sidepanel.jelly

core/src/main/resources/jenkins/agents/CloudSet/new.jelly

core/src/main/resources/jenkins/agents/CloudSet/sidepanel.jelly

core/src/main/resources/hudson/slaves/Cloud/configure.jelly

Vlatombe · 2023-04-26T13:19:50Z

There are remaining plugins that do not support custom names (listed above). For these plugins, the user experience is the following:

when creating such a cloud, the user entered name is ignored. Instead the name computed by the plugin is used. A warning is reported in such a case. The same is applicable if you copy an existing cloud.
When encountering a cloud with a duplicate name, they are accessed by their index instead of their name to allow consistent editing, and deletion.

With that, I think we don't need to keep a fallback UI even for plugins that may not have been updated to support user provided names.

core/src/main/java/jenkins/agents/CloudSet.java

timja · 2023-04-26T21:17:19Z

/label ready-for-merge

This PR is now ready for merge, after ~24 hours, we will merge it if there's no negative feedback.

Thanks!

core/src/main/resources/jenkins/agents/CloudSet/_new.jelly

jglick

Not attempting to review this in its entirety, just a buglet I noticed. Fine to restore ready-for-merge so far as I am concerned.

timja · 2023-04-27T17:45:34Z

/label ready-for-merge

This PR is now ready for merge, after ~24 hours, we will merge it if there's no negative feedback.

Thanks!

Follows up jenkinsci#7658 For consistency with 45e656c

Support clouds without a config.jelly Follows up #7658 For consistency with 45e656c

basil · 2023-06-06T18:02:45Z

Causes JENKINS-71371.

basil · 2023-08-14T22:25:25Z

Causes JENKINS-71825.

jenkinsci/jenkins#7658 reworks cloud management to use multiple pages instead of a single large page. That rework also requires that a cloud may not be named with an empty string. The docker plugin specifically tested that a cloud was allowed to have an empty string as its name, but performed no other operations with a cloud that is named with an empty string. Cloud named with an empty string may have worked prior to Jenkins 2.403, but they would have been complicated to manage, especially in a controller with multiple clouds defined. A cloud named with an empty string is much more difficult to manage. It is better to mention in the changelog that clouds are no longer allowed to have an empty name rather than wrestling with all the ways that an empty name will break cloud administration. https://issues.jenkins.io/browse/JENKINS-70729 is the enhancement request that implements the change. https://issues.jenkins.io/browse/JENKINS-71825 is the bug report for the automated test failure that started this investigation.

amends jenkinsci#173 due to jenkinsci/jenkins#7658 bumps the baseline to avoid the redirect or adding a TODO

Rework clouds management into multiple pages

6da6aa1

* Separate entry under Manage Jenkins * One configuration page per cloud * One index page per cloud

Vlatombe added the work-in-progress The PR is under active development, not ready to the final review label Feb 17, 2023

Vlatombe and others added 2 commits February 17, 2023 15:34

Fix broken test + spotbugs

2551c94

Use one column layout

a09ec32

timja added 4 commits March 4, 2023 14:15

Progress

082f650

Fix azure plugin

ed9117c

Remove redundant permission check

fe0315e

Improve icon accessibility

6dc25b1

Vlatombe commented Mar 4, 2023

View reviewed changes

core/src/main/java/jenkins/agents/CloudSet.java Outdated Show resolved Hide resolved

Vlatombe commented Mar 4, 2023

View reviewed changes

core/src/main/java/hudson/slaves/Cloud.java Outdated Show resolved Hide resolved

Clouds compatibility

72fe6a8

timja added 2 commits March 4, 2023 21:53

Merge branch 'master' into manage-clouds

8254ed9

Consistent casing and titles across cloud pages

a9be4d0

This was referenced Mar 5, 2023

Add icon for new cloud layout jenkinsci/azure-vm-agents-plugin#383

Closed

Test clouds rework jenkinsci/acceptance-test-harness#1047

Closed

timja removed the work-in-progress The PR is under active development, not ready to the final review label Mar 5, 2023

timja marked this pull request as ready for review March 5, 2023 15:33

timja requested review from a team March 5, 2023 15:33

timja added the needs-security-review Awaiting review by a security team member label Mar 5, 2023

daniel-beck previously requested changes Mar 5, 2023

View reviewed changes

timja reviewed Apr 26, 2023

View reviewed changes

core/src/main/java/jenkins/agents/CloudSet.java Outdated Show resolved Hide resolved

Update core/src/main/java/jenkins/agents/CloudSet.java

ac990a9

comment-ops-bot bot added the ready-for-merge The PR is ready to go, and it will be merged soon if there is no negative feedback label Apr 26, 2023

jglick reviewed Apr 26, 2023

View reviewed changes

core/src/main/resources/jenkins/agents/CloudSet/_new.jelly Outdated Show resolved Hide resolved

jglick removed the ready-for-merge The PR is ready to go, and it will be merged soon if there is no negative feedback label Apr 26, 2023

Make the config.jelly optional

45e656c

timja requested a review from jglick April 27, 2023 10:46

jglick reviewed Apr 27, 2023

View reviewed changes

comment-ops-bot bot added the ready-for-merge The PR is ready to go, and it will be merged soon if there is no negative feedback label Apr 27, 2023

timja merged commit 4963094 into jenkinsci:master Apr 28, 2023

Vlatombe added a commit to Vlatombe/jenkins that referenced this pull request May 9, 2023

Support clouds without a config.jelly

f1e67f5

Follows up jenkinsci#7658 For consistency with 45e656c

Vlatombe mentioned this pull request May 9, 2023

Support clouds without a config.jelly #7972

Merged

14 tasks

NotMyFault pushed a commit that referenced this pull request May 10, 2023

Support clouds without a config.jelly (#7972)

54929d0

Support clouds without a config.jelly Follows up #7658 For consistency with 45e656c

benipeled mentioned this pull request May 14, 2023

AWS EC2 API Rate exceeded jenkinsci/ec2-fleet-plugin#364

Closed

Vlatombe deleted the manage-clouds branch July 4, 2023 07:41

car-roll mentioned this pull request Jul 28, 2023

Test support for cloud management changes jenkinsci/ec2-plugin#875

Merged

jglick mentioned this pull request Jul 28, 2023

[JENKINS-71737] Fix redirect when submitting cloud changes #8310

Closed

5 tasks

MarkEWaite mentioned this pull request Sep 3, 2023

[JENKINS-71959] Rename blank cloud names to be non-blank jenkinsci/docker-plugin#1010

Merged

6 tasks

carpnick mentioned this pull request Oct 17, 2023

Edit cloud configuration failed in Jenkins web GUI jenkinsci/codebuild-cloud-plugin#26

Closed

scherler mentioned this pull request Oct 24, 2023

[JENKINS-72176] Split cloud management page into multiple pages jenkinsci/kubernetes-plugin#1443

Merged

jtnord mentioned this pull request May 2, 2024

Minor UX changes jenkinsci/google-compute-engine-plugin#173

Merged

jtnord added a commit to jtnord/google-compute-engine-plugin that referenced this pull request May 2, 2024

update link to configure clouds

b1b19c8

amends jenkinsci#173 due to jenkinsci/jenkins#7658 bumps the baseline to avoid the redirect or adding a TODO

jtnord mentioned this pull request May 2, 2024

update link to configure clouds jenkinsci/google-compute-engine-plugin#457

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[JENKINS-70729] Rework clouds management into multiple pages #7658

[JENKINS-70729] Rework clouds management into multiple pages #7658

Vlatombe commented Feb 17, 2023 •

edited

Loading

timja commented Mar 4, 2023

timja commented Mar 4, 2023

Vlatombe commented Mar 4, 2023

timja commented Mar 5, 2023 •

edited

Loading

daniel-beck left a comment

Vlatombe commented Apr 26, 2023 •

edited

Loading

timja commented Apr 26, 2023

jglick left a comment

timja commented Apr 27, 2023

basil commented Jun 6, 2023

basil commented Aug 14, 2023

[JENKINS-70729] Rework clouds management into multiple pages #7658

[JENKINS-70729] Rework clouds management into multiple pages #7658

Conversation

Vlatombe commented Feb 17, 2023 • edited Loading

Testing done

Proposed changelog entries

Proposed upgrade guidelines

Submitter checklist

Desired reviewers

Maintainer checklist

timja commented Mar 4, 2023

timja commented Mar 4, 2023

Vlatombe commented Mar 4, 2023

timja commented Mar 5, 2023 • edited Loading

daniel-beck left a comment

Choose a reason for hiding this comment

Vlatombe commented Apr 26, 2023 • edited Loading

timja commented Apr 26, 2023

jglick left a comment

Choose a reason for hiding this comment

timja commented Apr 27, 2023

basil commented Jun 6, 2023

basil commented Aug 14, 2023

Vlatombe commented Feb 17, 2023 •

edited

Loading

timja commented Mar 5, 2023 •

edited

Loading

Vlatombe commented Apr 26, 2023 •

edited

Loading