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

Remove Flux version from /v1/version response and page footers #3876

Merged
merged 1 commit into from
Jul 24, 2023

Conversation

makkes
Copy link
Member

@makkes makkes commented Jul 24, 2023

The Flux version has been displayed in two locations of the UI: In the footer of every page and on the "Flux Runtime" page. To display the Flux version in these locations, two different ways to retrieve said version have been implemented:

  1. On the "Flux Runtime" page the version is retrieved from the Flux deployment objects for each cluster WeGO knows about.
  2. In the footer the version is retrieved from the /v1/version endpoint which in turn tries to find the Flux namespace on the cluster that it runs on.

In order to properly display the Flux version properly, the UI user would have to be allowed to list (1) Namespaces on the management cluster and (2) Flux deployments on all clusters including the management cluster.

This leads to situations where one of these two permissions is not set and the user will see a Flux version properly rendered in one location but not the other which is potentially confusing.

In order to improve the user experience, this change completely drops the rendering of the Flux version in the footer so that there is only one consistent method to fetch the Flux version. Users that aren't allowed to list the Flux runtime information will not be able to find out the Flux version, anyway, so for those users rendering an "-" in the footer doesn't provide any information. All others can refer to the "Flux Runtime" page and will see all Flux versions on all clusters together with additional runtime information.

closes #3665

@makkes makkes force-pushed the drop-flux-version branch 2 times, most recently from 649a750 to 2943b10 Compare July 24, 2023 14:16
The Flux version has been displayed in two locations of the UI: In the
footer of every page and on the "Flux Runtime" page. To display the
Flux version in these locations, two different ways to retrieve said
version have been implemented:

1. On the "Flux Runtime" page the version is retrieved from the Flux
   deployment objects for each cluster WeGO knows about.
2. In the footer the version is retrieved from the /v1/version
   endpoint which in turn tries to find the Flux namespace on the
   cluster that it runs on.

In order to properly display the Flux version properly, the UI user
would have to be allowed to list (1) Namespaces on the management
cluster and (2) Flux deployments on all clusters including the
management cluster.

This leads to situations where one of these two permissions is not set
and the user will see a Flux version properly rendered in one location
but not the other which is potentially confusing.

In order to improve the user experience, this change completely drops
the rendering of the Flux version in the footer so that there is only
one consistent method to fetch the Flux version. Users that aren't
allowed to list the Flux runtime information will not be able to find
out the Flux version, anyway, so for those users rendering an "-" in
the footer doesn't provide any information. All others can refer to
the "Flux Runtime" page and will see all Flux versions on all clusters
together with additional runtime information.

closes #3665
Copy link
Contributor

@bigkevmcd bigkevmcd left a comment

Choose a reason for hiding this comment

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

Looks good to me, thanks for this.

@makkes
Copy link
Member Author

makkes commented Jul 24, 2023

@bigkevmcd @luizbafilho can one of you merge this for me, please? I don't have permission.

@bigkevmcd bigkevmcd merged commit 06af70d into main Jul 24, 2023
23 checks passed
@bigkevmcd bigkevmcd deleted the drop-flux-version branch July 24, 2023 18:23
@chanwit chanwit added the area/ui Issues that require front-end work label Jul 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/ui Issues that require front-end work
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Flux version not shown
4 participants