Story #15572

Update migration and install docs

Added by Eric Biagiotti 11 months ago. Updated 6 months ago.

Status:
Resolved
Priority:
Normal
Assigned To:
Category:
-
Target version:
Start date:
12/17/2019
Due date:
% Done:

100%

Estimated time:
(Total: 0.00 h)
Story points:
3.0
Release relationship:
Auto

Description

Go through the install docs and attempt to install components using a multi-VM setup to test recommended installation procedure. Correct documentation where needed.

  • /admin/config-migration.html
    • Write an introductory paragraph describing that "arvados-server config-check" and "arvados-server config-dump" are the recommended/easy way to migrate legacy configs other than RailsAPI/Workbench1.
    • Make sure there is an entry for each relevant component.
  • /admin/upgrading.html
    • Make sure the entries regarding config migration follow a similar pattern (i.e. point to the migration page)

Also noticed that admin/metrics.html, admin/health-checks.html and admin/management-token.html are out of date.


Subtasks

Task #15801: Review 15572-new-install-docsResolvedWard Vandewege


Related issues

Related to Arvados - Story #13648: [Epic] Use one cluster configuration file for all componentsResolved

Related to Arvados - Bug #15541: Update websockets doc.go to match cluster configResolved

Related to Arvados - Bug #15542: Update crunch-dispatch-slurm usage.go to match cluster configResolved

Related to Arvados - Story #15528: [docs] better explain the relationship between API server, controller and nginx in install docsNew

Associated revisions

Revision 9f4a1c37
Added by Peter Amstutz 6 months ago

Merge branch '15572-new-install-docs' refs #15572

Arvados-DCO-1.1-Signed-off-by: Peter Amstutz <>

Revision fc0e284d (diff)
Added by Peter Amstutz 6 months ago

Update default config with go generate refs #15572

Arvados-DCO-1.1-Signed-off-by: Peter Amstutz <>

History

#1 Updated by Eric Biagiotti 11 months ago

  • Related to Story #13648: [Epic] Use one cluster configuration file for all components added

#2 Updated by Eric Biagiotti 9 months ago

  • Description updated (diff)

#3 Updated by Eric Biagiotti 9 months ago

  • Story points set to 3.0

#4 Updated by Tom Clegg 9 months ago

  • Target version set to Arvados Future Sprints
  • Release set to 22

#5 Updated by Peter Amstutz 8 months ago

  • Target version changed from Arvados Future Sprints to 2019-11-20 Sprint

#6 Updated by Peter Amstutz 8 months ago

  • Assigned To set to Peter Amstutz

#7 Updated by Eric Biagiotti 8 months ago

  • Related to Bug #15541: Update websockets doc.go to match cluster config added

#8 Updated by Eric Biagiotti 8 months ago

  • Related to Bug #15542: Update crunch-dispatch-slurm usage.go to match cluster config added

#9 Updated by Peter Amstutz 8 months ago

Also noticed that admin/metrics.html, admin/health-checks.html and admin/management-token.html are out of date.

#10 Updated by Peter Amstutz 8 months ago

  • Description updated (diff)

#11 Updated by Peter Amstutz 8 months ago

  • Target version changed from 2019-11-20 Sprint to 2019-12-04 Sprint

#12 Updated by Peter Amstutz 8 months ago

Say something about keepstore replication.

#13 Updated by Peter Amstutz 8 months ago

Say something about how new users can't see other users, by default. (hmm).

#14 Updated by Peter Amstutz 8 months ago

Say something about SystemRootToken https://dev.arvados.org/issues/15795#note-7

#15 Updated by Peter Amstutz 8 months ago

Update references to install docs in code (eg comments, messages to user).

#16 Updated by Peter Amstutz 7 months ago

  • Related to Story #15528: [docs] better explain the relationship between API server, controller and nginx in install docs added

#17 Updated by Peter Amstutz 7 months ago

  • Status changed from New to In Progress

#18 Updated by Peter Amstutz 7 months ago

  • Target version changed from 2019-12-04 Sprint to 2020-01-02 Sprint

#19 Updated by Ward Vandewege 7 months ago

A few quick review comments:

1. http://local.doc.arvados.org/install/configure-azure-blob-storage.html has outdated azure cli commands. Change to:

azure config mode arm
~$ az login
~$ az group create exampleGroupName eastus2
~$ az storage account create --sku Standard_LRS --kind BlobStorage --encryption-services blob --access-tier Hot --https-only true --location eastus2 --resource-group exampleGroupName --name exampleStorageAccountName
~$ az storage account keys list --resource-group exampleGroupName --account-name exampleStorageAccountName
[
  {
    "keyName": "key1",
    "permissions": "Full",
    "value": "zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz==" 
  },
  {
    "keyName": "key2",
    "permissions": "Full",
    "value": "yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy==" 
  }
]
~$ AZURE_STORAGE_ACCOUNT="exampleStorageAccountName" \
AZURE_STORAGE_ACCESS_KEY="zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz==" \
az storage container create --name exampleContainerName

2. http://local.doc.arvados.org/install/install-dispatch-cloud.html

=> ClientSecret is unmasked in the example configuration

=> Add some detail on setting up those credentials:

a) SubscriptionID and TenantID: from output of `az account list`, e.g.:

$ az account list
[
  {
    "cloudName": "AzureCloud",
    "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX",
    "isDefault": true,
    "name": "Your Subscription",
    "state": "Enabled",
    "tenantId": "YYYYYYYY-YYYY-YYYY-YYYYYYYY",
    "user": {
      "name": "you@example.com",
      "type": "user" 
    }
  }
]

SubscriptionID is XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX and TenantID is YYYYYYYY-YYYY-YYYY-YYYYYYYY.

c) We you need to create a "service principal" to use as a delegated authority for API access.

$ az ad app create --display-name "Arvados Dispatch Cloud (ClusterID)" --homepage "https://arvados.org" --identifier-uris "https://ClusterID.arvadosapi.com" --end-date 2299-12-31 --password <Your_Password>

$ az ad sp create "<appId>"  
(appId is part of the response of the previous command)

$ az role assignment create --assignee "<objectId>" --role Owner --scope /subscriptions/{subscriptionId}/
(objectId is part of the response of the previous command)

ClientID is the 'appId' value.
ClientSecret is what was provided as 'Your_Password'.

#20 Updated by Peter Amstutz 7 months ago

WebDAVDownload.ExternalURL needs trailing slash

#21 Updated by Ward Vandewege 7 months ago

I reviewed this branch, and pushed a bunch of small tweaks in e90e8437a7812058749477f2e53b48aacdd73225.

LGTM!

#22 Updated by Peter Amstutz 6 months ago

  • Status changed from In Progress to Resolved

Also available in: Atom PDF