From 6160b7425d9da6cc9d245b7cc754e81427f8ac9c Mon Sep 17 00:00:00 2001 From: Ward Vandewege Date: Tue, 3 Aug 2021 11:15:20 -0400 Subject: [PATCH] 17591: be more explicit about the required TLS certificates and DNS hostnames. Arvados-DCO-1.1-Signed-off-by: Ward Vandewege --- .../install-keep-web.html.textile.liquid | 2 +- ...l-manual-prerequisites.html.textile.liquid | 51 +++++++++++++++++-- 2 files changed, 49 insertions(+), 4 deletions(-) diff --git a/doc/install/install-keep-web.html.textile.liquid b/doc/install/install-keep-web.html.textile.liquid index 5ff9f44194..9f63d1bcfc 100644 --- a/doc/install/install-keep-web.html.textile.liquid +++ b/doc/install/install-keep-web.html.textile.liquid @@ -90,7 +90,7 @@ Note the trailing slash. {% include 'notebox_begin' %} Whether you choose to serve collections from their own subdomain or from a single domain, it's important to keep in mind that they should be served from me same _site_ as Workbench for the inline previews to work. -Please check "keep-web's URL pattern guide":/api/keep-web-urls.html#same-site to learn more. +Please check "keep-web's URL pattern guide":../api/keep-web-urls.html#same-site to learn more. {% include 'notebox_end' %} h2. Set InternalURLs diff --git a/doc/install/install-manual-prerequisites.html.textile.liquid b/doc/install/install-manual-prerequisites.html.textile.liquid index ab4a65a0c8..77b46358ba 100644 --- a/doc/install/install-manual-prerequisites.html.textile.liquid +++ b/doc/install/install-manual-prerequisites.html.textile.liquid @@ -142,7 +142,7 @@ You may also use a different method to pick the cluster identifier. The cluster h2(#dnstls). DNS entries and TLS certificates -The following services are normally public-facing and require DNS entries and corresponding TLS certificates. Get certificates from your preferred TLS certificate provider. We recommend using "Let's Encrypt":https://letsencrypt.org/. You can run several services on same node, but each distinct hostname requires its own TLS certificate. +The following services are normally public-facing and require DNS entries and corresponding TLS certificates. Get certificates from your preferred TLS certificate provider. We recommend using "Let's Encrypt":https://letsencrypt.org/. You can run several services on same node, but each distinct hostname requires a valid, matching TLS certificate. This guide uses the following hostname conventions. A later part of this guide will describe how to set up Nginx virtual hosts. @@ -151,17 +151,62 @@ table(table table-bordered table-condensed). |_. Function|_. Hostname| |Arvados API|@ClusterID.example.com@| |Arvados Git server|git.@ClusterID.example.com@| +|Arvados Webshell|webshell.@ClusterID.example.com@| |Arvados Websockets endpoint|ws.@ClusterID.example.com@| |Arvados Workbench|workbench.@ClusterID.example.com@| |Arvados Workbench 2|workbench2.@ClusterID.example.com@| |Arvados Keepproxy server|keep.@ClusterID.example.com@| |Arvados Keep-web server|download.@ClusterID.example.com@ _and_ -*.collections.@ClusterID.example.com@ or -*--collections.@ClusterID.example.com@ or +*.collections.@ClusterID.example.com@ _or_ +*--collections.@ClusterID.example.com@ _or_ collections.@ClusterID.example.com@ (see the "keep-web install docs":install-keep-web.html)| +Setting up Arvados is easiest when Wildcard TLS and wildcard DNS are available. It is also possible to set up Arvados without wildcard TLS and DNS. The table below lists the required TLS certificates and DNS hostnames in each scenario. + +
+table(table table-bordered table-condensed). +||_. Wildcard TLS and DNS available|_. Wildcard TLS available|_. Other| +|TLS|*.@ClusterID.example.com@ +@ClusterID.example.com@ +*.collections.@ClusterID.example.com@|*.@ClusterID.example.com@ +@ClusterID.example.com@|@ClusterID.example.com@ +git.@ClusterID.example.com@ +webshell.@ClusterID.example.com@ +ws.@ClusterID.example.com@ +workbench.@ClusterID.example.com@ +workbench2.@ClusterID.example.com@ +keep.@ClusterID.example.com@ +download.@ClusterID.example.com@ +collections.@ClusterID.example.com@| +|DNS|@ClusterID.example.com@ +git.@ClusterID.example.com@ +webshell.@ClusterID.example.com@ +ws.@ClusterID.example.com@ +workbench.@ClusterID.example.com@ +workbench2.@ClusterID.example.com@ +keep.@ClusterID.example.com@ +download.@ClusterID.example.com@ +*.collections.@ClusterID.example.com@|@ClusterID.example.com@ +git.@ClusterID.example.com@ +webshell.@ClusterID.example.com@ +ws.@ClusterID.example.com@ +workbench.@ClusterID.example.com@ +workbench2.@ClusterID.example.com@ +keep.@ClusterID.example.com@ +download.@ClusterID.example.com@ +collections.@ClusterID.example.com@|@ClusterID.example.com@ +git.@ClusterID.example.com@ +webshell.@ClusterID.example.com@ +ws.@ClusterID.example.com@ +workbench.@ClusterID.example.com@ +workbench2.@ClusterID.example.com@ +keep.@ClusterID.example.com@ +download.@ClusterID.example.com@ +collections.@ClusterID.example.com@| +
+ {% include 'notebox_begin' %} It is also possible to create your own certificate authority, issue server certificates, and install a custom root certificate in the browser. This is out of scope for this guide. {% include 'notebox_end' %} -- 2.30.2