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

Add support for configuring default namespace #3334

Merged
merged 1 commit into from Mar 4, 2024

Conversation

AlanGreene
Copy link
Member

@AlanGreene AlanGreene commented Feb 28, 2024

Changes

Resolves #3297

When the Dashboard deployment's --default-namespace arg is set, this configures teh default namespace selected when loading the application instead of 'All Namespaces' being selected.

This behaviour will only be triggered when the Dashboard is loaded with no path on the URL, i.e. only for the root (which automatically redirects to the About page).

The reason for this limitation is that handling the default namespace configuration as part of the normal namespace processing would break the ability to select 'All Namespaces' from the namespace filter dropdown, as well as causing issues with URL consistency. It would also be impossible to differentiate between a user attempting to visit a namespaced page (e.g. PipelineRuns) with 'All Namespaces' selected, vs. with no selection which would be expected to use the default namespace instead.

/kind feature

Submitter Checklist

As the author of this PR, please check off the items in this checklist:

  • Docs included if any changes are user facing
  • Tests included if any functionality added or changed
  • Follows the commit message standard
  • Meets the Tekton contributor standards (including
    functionality, content, code)
  • Has a kind label. You can add one by adding a comment on this PR that contains /kind <type>. Valid types are bug, cleanup, design, documentation, feature, flake, misc, question, tep
  • Release notes block below has been updated with any user facing changes (new features, significant UI changes, API changes, bug fixes, changes requiring upgrade notices or deprecation warnings)
  • Release notes contains the string "action required" if the change requires additional action from users switching to the new release

Release Notes

Add the ability to configure the default namespace selected in the UI instead of 'All Namespaces' when the user visits the application root (i.e. `/`).

@tekton-robot
Copy link
Contributor

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@tekton-robot tekton-robot added kind/feature Categorizes issue or PR as related to a new feature. do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Feb 28, 2024
@AlanGreene AlanGreene removed the request for review from skaegi February 28, 2024 22:43
@AlanGreene
Copy link
Member Author

/kind documentation
/test all

@tekton-robot tekton-robot added the kind/documentation Categorizes issue or PR as related to documentation. label Feb 28, 2024
@AlanGreene
Copy link
Member Author

Some additional testing required to ensure compatibility between this new config option and the existing tenant namespaces behaviour, and no other unexpected side effects.

@AlanGreene AlanGreene marked this pull request as ready for review March 4, 2024 12:07
@tekton-robot tekton-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 4, 2024
@tekton-robot tekton-robot requested a review from skaegi March 4, 2024 12:07
@AlanGreene AlanGreene requested review from briangleeson and removed request for skaegi March 4, 2024 12:07
Copy link
Contributor

@briangleeson briangleeson 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, just a minor string suggestion

cmd/dashboard/main.go Outdated Show resolved Hide resolved
docs/dev/README.md Outdated Show resolved Hide resolved
When the Dashboard deployment's `--default-namespace` arg is set,
this configures teh default namespace selected when loading the
application instead of 'All Namespaces' being selected.

This behaviour will only be triggered when the Dashboard is
loaded with no path on the URL, i.e. only for the root (which
automatically redirects to the About page).

The reason for this limitation is that handling the default
namespace configuration as part of the normal namespace processing
would break the ability to select 'All Namespaces' from the
namespace filter dropdown, as well as causing issues with URL
consistency. It would also be impossible to differentiate between
a user attempting to visit a namespaced page (e.g. PipelineRuns)
with 'All Namespaces' selected, vs. with no selection which would
be expected to use the default namespace instead.
@AlanGreene
Copy link
Member Author

Thanks Brian, updated those strings 👍

Copy link
Contributor

@briangleeson briangleeson left a comment

Choose a reason for hiding this comment

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

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Mar 4, 2024
@tekton-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: briangleeson

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 4, 2024
@tekton-robot tekton-robot merged commit 00b0886 into tektoncd:main Mar 4, 2024
7 of 8 checks passed
@AlanGreene AlanGreene deleted the defaultNamespace branch March 4, 2024 15:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/documentation Categorizes issue or PR as related to documentation. kind/feature Categorizes issue or PR as related to a new feature. lgtm Indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Ability to select an initial namespace on GUI
3 participants