NET-5398: Update UI server to include if v2 is enabled #20353
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
WenInCode
force-pushed
the
NET-5398/add-V2Enabled-to-config
branch
from
c9330f7 to
85aac2b
Compare
WenInCode
force-pushed
the
NET-5398/add-V2Enabled-to-config
branch
from
85aac2b to
05cd0a2
Compare
|
This PR has diffs in |
WenInCode
force-pushed
the
NET-5398/add-V2Enabled-to-config
branch
from
05cd0a2 to
ddb730c
Compare
ellacai
reviewed
Jan 26, 2024
| @@ -31,6 +31,14 @@ func uiTemplateDataFromConfig(cfg *config.RuntimeConfig) (map[string]interface{} | |||
| uiCfg["metrics_provider_options"] = json.RawMessage(cfg.UIConfig.MetricsProviderOptionsJSON) | |||
| } | |||
|
|
|||
| v2CatalogEnabled := false | |||
| for _, experiment := range cfg.Experiments { | |||
| if experiment == "resource-apis" { | |||
There was a problem hiding this comment.
v1/agent/self is an interesting endpoint 🤔 and the DebugConfig field seems to be completely undocumented on the consul apis page.
Does "enabled" here mean the DC has a V2 service registered or just that it has the permission to register one?
There was a problem hiding this comment.
My understanding is it's like a feature flag, not telling you that you actually have services registered. However, if you have this experiment enabled, requests to V1 catalog endpoints don't succeed.
4 tasks
ndhanushkodi
approved these changes
Jan 26, 2024
WenInCode
force-pushed
the
NET-5398/add-V2Enabled-to-config
branch
from
32a25b8 to
2b8feba
Compare
4 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
For NET-5398 we need to not render the rest of the ui app if v2 catalog is enabled and show a message as to why it's disabled and link out to help resources. Right now this would require another network request on app boot and we would have to wait until that resolves before rendering the rest of the app.
I saw that experiments is a part of the runtime config so I figured we could add a
V2CatalogEnabledproperty to the config that we pass to the UI app. With this, we can immediately check if V2 is enabled and render the help page, or immediately proceed with normal app operations if it's not enabled.Enabled:
Disabled:
Testing & Reproduction steps
I've tested this by building the ui and the consul and then running it with and without the resources-api experiment enabled. Reference the linked issues below for more instructions.
Links
NET-5398
Running Consul with v2 enabled
Original slack question about how to determine v2 is enabled
PR Checklist