Story #15528

[docs] better explain the relationship between API server, controller and nginx in install docs

Added by Peter Amstutz 8 months ago. Updated 8 months ago.

Status:
New
Priority:
Normal
Assigned To:
-
Category:
-
Target version:
Start date:
Due date:
% Done:

0%

Estimated time:
Story points:
-

Description

Feedback from gitter:

clients will contact port 443
nginx will forward to controller (internal port), controller forwards to the Rails API server (different internal port)

perfect.. Just one comment: wht you write here should be integrated inside the documentation :-)

Also:

This is set in install-api

geo $external_client { ... }

but is actually used in install-controller:

proxy_set_header X-External-Client $external_client;

Both parts should be listed in install-controller, along with a better explanation of what it is used for and the failure mode (keep_services.accessible doesn't work) if it isn't configured correctly.


Related issues

Related to Arvados - Story #15572: Update migration and install docsResolved12/17/2019

History

#1 Updated by Peter Amstutz 8 months ago

  • Status changed from New to In Progress

#2 Updated by Peter Amstutz 8 months ago

  • Description updated (diff)
  • Status changed from In Progress to New

#3 Updated by Peter Amstutz 8 months ago

  • Description updated (diff)

#4 Updated by Tom Morris 8 months ago

  • Tracker changed from Bug to Story
  • Target version changed from 2019-08-14 Sprint to Arvados Future Sprints

#5 Updated by Peter Amstutz 5 months ago

  • Related to Story #15572: Update migration and install docs added

Also available in: Atom PDF