Idea #15572
closed
Update migration and install docs
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.
Related issues
Updated by Eric Biagiotti over 5 years ago
- Related to Idea #13648: [Epic] Use one cluster configuration file for all components added
Updated by Tom Clegg about 5 years ago
- Target version set to Arvados Future Sprints
- Release set to 22
Updated by Peter Amstutz about 5 years ago
- Target version changed from Arvados Future Sprints to 2019-11-20 Sprint
Updated by Eric Biagiotti about 5 years ago
- Related to Bug #15541: Update websockets doc.go to match cluster config added
Updated by Eric Biagiotti about 5 years ago
- Related to Bug #15542: Update crunch-dispatch-slurm usage.go to match cluster config added
Updated by Peter Amstutz about 5 years ago
Also noticed that admin/metrics.html, admin/health-checks.html and admin/management-token.html are out of date.
Updated by Peter Amstutz about 5 years ago
- Target version changed from 2019-11-20 Sprint to 2019-12-04 Sprint
Updated by Peter Amstutz about 5 years ago
Say something about keepstore replication.
Updated by Peter Amstutz almost 5 years ago
Say something about how new users can't see other users, by default. (hmm).
Updated by Peter Amstutz almost 5 years ago
Say something about SystemRootToken https://dev.arvados.org/issues/15795#note-7
Updated by Peter Amstutz almost 5 years ago
Update references to install docs in code (eg comments, messages to user).
Updated by Peter Amstutz almost 5 years ago
- Related to Idea #15528: [docs] better explain the relationship between API server, controller and nginx in install docs added
Updated by Peter Amstutz almost 5 years ago
- Status changed from New to In Progress
Updated by Peter Amstutz almost 5 years ago
- Target version changed from 2019-12-04 Sprint to 2020-01-02 Sprint
Updated by Ward Vandewege almost 5 years 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'.
Updated by Peter Amstutz almost 5 years ago
WebDAVDownload.ExternalURL needs trailing slash
Updated by Ward Vandewege almost 5 years ago
I reviewed this branch, and pushed a bunch of small tweaks in e90e8437a7812058749477f2e53b48aacdd73225.
LGTM!
Updated by Peter Amstutz almost 5 years ago
- Status changed from In Progress to Resolved