h2(#keep). Configure Keep storage
The @multi_host/aws@ template uses S3 for storage. Arvados also supports "filesystem storage":configure-fs-storage.html and "Azure blob storage":configure-azure-blob-storage.html . Keep storage configuration can be found in @local_config_dir/pillars/arvados.sls@ in the section @arvados.cluster.Volumes@.
h3. Object storage in S3 (AWS Specific)
Open @local_config_dir/pillars/arvados.sls@ and edit as follows:
# In the @arvados.cluster.Volumes@ section, set @Region@ to the appropriate AWS region (e.g. 'us-east-1')
# Set @IAMRole@ to the name of the `KeepstoreRole` generated by CloudFormation. Just use the part after the '/' (not the arn:aws:iam.... stuff at the beginning).
# Set @Bucket@ to the value of `KeepBucket1`
{% include 'ssl_config_multi' %}
h2(#create_a_compute_image). Create a compute image
{% include 'branchname' %}
On cloud installations, containers are dispatched in Docker daemons running in the compute instances, which need some special setup. Follow "the instructions build a cloud compute node image":https://doc.arvados.org/install/crunch2-cloud/install-compute-node.html using the "compute image builder script":https://github.com/arvados/arvados/tree/{{ branchname }}/tools/compute-images .
Once you have that image created, Open @local_config_dir/pillars/arvados.sls@ and edit as follows (AWS specific settings described here, configuration for Azure is similar):
# In the @arvados.cluster.Containers.CloudVMs@ section:
## Set @ImageID@ to the AMI output from Packer
## Set @Region@ to the appropriate AWS region
## Set @AdminUsername@ to the admin user account on the image
## Set the @SecurityGroupIDs@ list to the VPC security group which you set up to allow SSH connections to these nodes
## Set @SubnetID@ to the value of SubnetId of your VPC
# Update @arvados.cluster.Containers.DispatchPrivateKey@ and paste the contents of the @~/.ssh/id_dispatcher@ file you generated in an earlier step.
# Update @arvados.cluster.InstanceTypes@ as necessary. If t3 and m5/c5 node types are not available, replace them with t2 and m4/c4. You'll need to double check the values for Price and IncludedScratch/AddedScratch for each type that is changed.
h2(#further_customization). Further customization of the installation
If you are installing on AWS and following the naming conventions recommend in this guide, then likely no further configuration is necessary and you can begin installation.
If your infrastructure differs from the setup proposed above (ie, using AWS RDS or an existing DB server), you can still use the installer, but additional customization will be necessary.
This is done by editing the Saltstack pillars and states files found in @local_config_dir@. In particular, @local_config_dir/pillars/arvados.sls@ has the template used to produce the Arvados configuration file that is distributed to all the nodes.
Any extra salt state file you add under @local_config_dir/states@ will be added to the salt run and applied to the hosts.
h2(#installation). Begin installation
At this point, you are ready to run the installer script in deploy mode that will conduct all of the Arvados installation.
Run this in ~/arvados-setup-xarv1:
./installer.sh deploy
This will deploy all the nodes. It will take a while and produce a lot of logging. If it runs into an error, it will stop.
h3(#test-install). Run diagnostics to confirming the cluster is working
When everything has finished, you can run the diagnostics.
Depending on where you are running the installer, you need to provide @-internal-client@ or @-external-client@.
You are probably an "internal client" if you are running the diagnostics from one of the Arvados machines inside the VPC.
You are an "external client" if you running the diagnostics from your workstation outside of the VPC.
./installer.sh diagnostics (-internal-client|-external-client)
h3(#debugging). Debugging issues
Most service logs go to @/var/log/syslog@
The logs for Rails API server and for Workbench can be found in
@/var/www/arvados-api/current/log/production.log@
and
@/var/www/arvados-workbench/current/log/production.log@
on the appropriate instances.
Workbench2 is a client-side Javascript application, if it having trouble loading, check the browser's developer console.
h3(#iterating). Iterating on config changes
You can iterate on the config and maintain the cluster by making changes to @local.params@ and @local_config_dir@ and running @installer.sh deploy@ again.
If you are debugging a configuration issue on a specific node, you can speed up the cycle a bit by deploying just one node:
./installer.sh deploy keep0.xarv1.example.com@
However, once you have a final configuration, you should run a full deploy to ensure that the configuration has been synchronized on all the nodes.
h3(#common-problems). Common problems and solutions
h4. Missing ENA support (AWS Specific)
If the AMI wasn't built with ENA (extended networking) support and the instance type requires it, it'll fail to start. You'll see an error in syslog on the node that runs @arvados-dispatch-cloud@. The solution is to build a new AMI with --aws-ena-support true
h4. PG::UndefinedTable: ERROR: relation \"api_clients\" does not exist
The arvados-api-server package sets up the database as a post-install script. If the database host or password wasn't set correctly (or quoted correctly) at the time that package is installed, it won't be able to set up the database.
This will manifest as an error like this:
#
If this happens, you need to
1. correct the database information
2. run @./installer.sh deploy xarv1.example.com@ to update the configuration on the API/controller node
3. On the API/controller server node, run this command to re-run the post-install script, which will set up the database:
dpkg-reconfigure arvados-api-server
4. Re-run @./installer.sh deploy@ again to synchronize everything, and so that the install steps that need to contact the API server are run successfully.
{% include 'install_ca_cert' %}
h2(#initial_user). Initial user and login
At this point you should be able to log into the Arvados cluster. The initial URL will be
* https://workbench.${CLUSTER}.${DOMAIN}
By default, the provision script creates an initial user for testing purposes. This user is configured as administrator of the newly created cluster.
Assuming you didn't change these values in the @local.params@ file, the initial credentials are:
* User: 'admin'
* Password: 'password'
* Email: 'admin@${CLUSTER}.${DOMAIN}'
h2(#post_install). After the installation
As part of the operation of @installer.sh@, it automatically creates a @git@ repository with your configuration templates. You should retain this repository but be aware that it contains sensitive information (passwords and tokens used by the Arvados services).
As described in "Iterating on config changes":#iterating you may use @installer.sh deploy@ to re-run the Salt to deploy configuration changes and upgrades. However, be aware that the configuration templates created for you by @installer.sh@ are a snapshot which are not automatically kept up to date.
When deploying upgrades, consult the "Arvados upgrade notes":{{site.baseurl}}/admin/upgrading.html to see if changes need to be made to the configuration file template in @local_config_dir/pillars/arvados.sls@.
See "Maintenance and upgrading":{{site.baseurl}}/admin/maintenance-and-upgrading.html for more information.