From: Ward Vandewege Date: Wed, 10 Feb 2021 14:19:22 +0000 (-0500) Subject: Documentation: include the cluster id namespace explanation on the X-Git-Tag: 2.2.0~130 X-Git-Url: https://git.arvados.org/arvados.git/commitdiff_plain/ea194f11512bbe272fd9a2767c43870b25216de7 Documentation: include the cluster id namespace explanation on the prerequisites page. No issue # Arvados-DCO-1.1-Signed-off-by: Ward Vandewege --- diff --git a/doc/architecture/federation.html.textile.liquid b/doc/architecture/federation.html.textile.liquid index 7512828430..1ae8b60064 100644 --- a/doc/architecture/federation.html.textile.liquid +++ b/doc/architecture/federation.html.textile.liquid @@ -20,9 +20,9 @@ h2(#cluster_id). Cluster identifiers Clusters are identified by a five-digit alphanumeric id (numbers and lowercase letters). There are 36 ^5^ = 60466176 possible cluster identifiers. -* For automated tests purposes, use "z****" +* For automated test purposes, use "z****" * For experimental/local-only/private clusters that won't ever be visible on the public Internet, use "x****" -* For long-lived clusters, we recommend reserving a cluster id. Contact "info@curii.com":mailto:info@curii.com +* For long-lived clusters, we recommend reserving a cluster id. Contact "info@curii.com":mailto:info@curii.com for more information. Cluster identifiers are mapped API server hosts one of two ways: diff --git a/doc/install/install-manual-prerequisites.html.textile.liquid b/doc/install/install-manual-prerequisites.html.textile.liquid index 8f45b29a4f..364e8cd2bb 100644 --- a/doc/install/install-manual-prerequisites.html.textile.liquid +++ b/doc/install/install-manual-prerequisites.html.textile.liquid @@ -119,7 +119,13 @@ For a small demo installation, it is possible to run all the Arvados services on h2(#clusterid). Arvados Cluster ID -Each Arvados installation should have a cluster identifier, which is a unique 5-character lowercase alphanumeric string. Here is one way to make a random 5-character string: +Each Arvados installation is identified by a cluster identifier, which is a unique 5-character lowercase alphanumeric string. There are 36 5 = 60466176 possible cluster identifiers. + +* For automated test purposes, use “z****” +* For experimental/local-only/private clusters that won’t ever be visible on the public Internet, use “x****” +* For long-lived clusters, we recommend reserving a cluster id. Contact "info@curii.com":mailto:info@curii.com for more information. + +Here is one way to make a random 5-character string: 
~$ tr -dc 0-9a-z </dev/urandom | head -c5; echo