config: UI configuration block with Vault/Consul links #11555

tgross · 2021-11-22T19:27:10Z

Add ui block to agent configuration to enable/disable the web UI and
provide the web UI with links to Vault/Consul.

This PR should probably wait pending on the RFC I've circulated earlier today. But this is what it looks like with this configuration block:

ui {
  enabled = true
  consul {
    base_url = "https://consul.example.com:8500/ui"
  }
  vault {
    base_url = "https://vault.example.com:8200/ui"
  }
}

It shows up like the following in the API:

$ curl -s localhost:4646/v1/agent/self | jq '.config.UI'
{
  "Consul": {
    "BaseURL": "https://consul.example.com:8500/ui"
  },
  "Enabled": true,
  "Vault": {
    "BaseURL": "https://vault.example.com:8200/ui"
  }
}

ChaiWithJai

I shouldn't be approving this. But, great job!

lgfa29

LGTM. A few comments and suggestions, but none are blockers.

lgfa29 · 2021-11-23T21:28:17Z

command/agent/http.go

 		s.mux.Handle("/ui/", http.StripPrefix("/ui/", s.handleUI(http.FileServer(&UIAssetWrapper{FileSystem: assetFS()}))))
+		s.logger.Debug("UI is enabled")
 	} else {
 		// Write the stubHTML
 		s.mux.HandleFunc("/ui/", func(w http.ResponseWriter, r *http.Request) {
 			w.Write([]byte(stubHTML))


stubHTML is only set when building without the ui build tag. This results in the /ui endpoint to return a 200 and a empty page.

Looking at Vault and Consul, they each do different things. Vault returns 404 response code and a an error message:

Consul returns a 200 and generic content body:

Personally I would say Vault's seems to be the most correct approach, but no strong feelings. I think we could move this handler registration to the else clause below and add a generic 404 body content in the handleRootFallthrough handler.

Yeah I'd intentionally not touched the existing behavior for the fallthrough, but a 404 does sound a lot nicer. Will do.

Actually, having tried it just now I don't think that's very user friendly. If you go to http://localhost:4646 you end up getting a redirect to http://localhost:4646/ui with just the browser's 404 page. Having some stub content there and filling it out so that it does something more similar to Consul seems nicer.

(If the UI is disabled in the build, you get an explanation of that from https://github.com/hashicorp/nomad/blob/main/command/agent/stub_asset.go)

Fixed in 8006bd6

website/content/docs/configuration/ui.mdx

website/data/docs-nav-data.json

jrasell

LGTM!

Add `ui` block to agent configuration to enable/disable the web UI and provide the web UI with links to Vault/Consul.

Co-authored-by: Luiz Aoqui <[email protected]>

tgross · 2021-11-24T16:21:28Z

I realized just as I pressed the squash button that the branch name f-ui-* got filtered from running all the unit tests. The new test here does pass and this change is fairly safe, but I'll keep an eye on the next build on main just to make sure we didn't miss anything 😊

$ go test ./nomad/structs/config -run TestUIConfig_Merge
ok      github.com/hashicorp/nomad/nomad/structs/config 0.004s

The `TestHTTPServer_Limits_Error` test never starts the agent so it had an incomplete configuration, which caused panics in the test. Fix the configuration. The PR #11555 had a branch name like `f-ui-*` which caused CI to skip the unit tests over the HTTP handler setup, so this wasn't caught in PR review.

This reverts commit 1160817.

github-actions · 2022-11-08T02:33:25Z

I'm going to lock this pull request because it has been closed for 120 days ⏳. This helps our maintainers find and focus on the active contributions.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

tgross requested review from ChaiWithJai, jazzyfresh and lgfa29 November 22, 2021 19:29

tgross added this to the 1.2.2 milestone Nov 22, 2021

tgross added the theme/ui label Nov 22, 2021

tgross self-assigned this Nov 22, 2021

tgross marked this pull request as ready for review November 22, 2021 19:30

tgross added the theme/config label Nov 22, 2021

ChaiWithJai reviewed Nov 22, 2021

View reviewed changes

lgfa29 approved these changes Nov 23, 2021

View reviewed changes

jrasell approved these changes Nov 24, 2021

View reviewed changes

vercel bot deployed to Preview – nomad-storybook-and-ui November 24, 2021 15:45 View deployment

vercel bot deployed to Preview – nomad November 24, 2021 15:45 View deployment

tgross and others added 4 commits November 24, 2021 10:50

config: UI configuration block with Vault/Consul links

1d78a29

Add `ui` block to agent configuration to enable/disable the web UI and provide the web UI with links to Vault/Consul.

Apply suggestions from code review

4999304

Co-authored-by: Luiz Aoqui <[email protected]>

website ordering fixup

57f045d

display message in stub when UI is disabled

8006bd6

tgross force-pushed the f-ui-config-block branch from 6ac6d56 to 8006bd6 Compare November 24, 2021 16:05

vercel bot temporarily deployed to Preview – nomad November 24, 2021 16:05 Inactive

vercel bot deployed to Preview – nomad-storybook-and-ui November 24, 2021 16:05 View deployment

tgross merged commit 1160817 into main Nov 24, 2021

tgross deleted the f-ui-config-block branch November 24, 2021 16:20

tgross mentioned this pull request Nov 24, 2021

config: fix test-only failures in UI handler setup #11571

Merged

tgross added a commit that referenced this pull request Dec 14, 2021

Revert "config: UI configuration block with Vault/Consul links (#11555)"

9a4f846

This reverts commit 1160817.

lgfa29 added a commit that referenced this pull request Dec 18, 2021

changelog: add entries for #11555, #11557, and #11687

2f1cc57

lgfa29 mentioned this pull request Dec 18, 2021

changelog: add entries for #11555, #11557, and #11687 #11706

Merged

lgfa29 added a commit that referenced this pull request Dec 20, 2021

changelog: add entries for #11555, #11557, and #11687 (#11706)

84ef826

github-actions bot locked as resolved and limited conversation to collaborators Nov 8, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

config: UI configuration block with Vault/Consul links #11555

config: UI configuration block with Vault/Consul links #11555

tgross commented Nov 22, 2021 •

edited

Loading

ChaiWithJai left a comment

lgfa29 left a comment

lgfa29 Nov 23, 2021

tgross Nov 24, 2021

tgross Nov 24, 2021 •

edited

Loading

tgross Nov 24, 2021

jrasell left a comment

tgross commented Nov 24, 2021

github-actions bot commented Nov 8, 2022

config: UI configuration block with Vault/Consul links #11555

config: UI configuration block with Vault/Consul links #11555

Conversation

tgross commented Nov 22, 2021 • edited Loading

ChaiWithJai left a comment

Choose a reason for hiding this comment

lgfa29 left a comment

Choose a reason for hiding this comment

lgfa29 Nov 23, 2021

Choose a reason for hiding this comment

tgross Nov 24, 2021

Choose a reason for hiding this comment

tgross Nov 24, 2021 • edited Loading

Choose a reason for hiding this comment

tgross Nov 24, 2021

Choose a reason for hiding this comment

jrasell left a comment

Choose a reason for hiding this comment

tgross commented Nov 24, 2021

github-actions bot commented Nov 8, 2022

tgross commented Nov 22, 2021 •

edited

Loading

tgross Nov 24, 2021 •

edited

Loading