From 4b9317289ef903fb74d681d3bf245d038be23514 Mon Sep 17 00:00:00 2001 From: Ward Vandewege Date: Tue, 1 Jul 2014 16:38:11 -0400 Subject: [PATCH] Add documentation to doc.arvados.org for the local Docker install. --- doc/_config.yml | 5 +- doc/_includes/_alert_docker.liquid | 4 + doc/install/index.html.textile.liquid | 18 ++- .../install-docker.html.textile.liquid | 112 ++++++++++++++++++ 4 files changed, 135 insertions(+), 4 deletions(-) create mode 100644 doc/_includes/_alert_docker.liquid create mode 100644 doc/install/install-docker.html.textile.liquid diff --git a/doc/_config.yml b/doc/_config.yml index f3d34cb13e..bf19c95758 100644 --- a/doc/_config.yml +++ b/doc/_config.yml @@ -115,8 +115,11 @@ navbar: - admin/index.html.md.liquid - admin/cheat_sheet.html.textile.liquid installguide: - - Install: + - Overview: - install/index.html.textile.liquid + - Docker: + - install/install-docker.html.textile.liquid + - Manual installation: - install/install-sso.html.textile.liquid - install/install-api-server.html.textile.liquid - install/install-workbench-app.html.textile.liquid diff --git a/doc/_includes/_alert_docker.liquid b/doc/_includes/_alert_docker.liquid new file mode 100644 index 0000000000..c80af9079e --- /dev/null +++ b/doc/_includes/_alert_docker.liquid @@ -0,0 +1,4 @@ +
+ +

The Docker installation is not feature complete. We do not have a Docker container yet for crunch-dispatch and the arvados compute nodes. This means that running pipelines from a Docker-based Arvados install is currently not supported without additional manual configuration. Without that manual configuration, it is possible to use arv-crunch-job to run a 'local' job against your Docker-based Arvados installation. To do this, please refer to the Debugging a Crunch script page.

+
diff --git a/doc/install/index.html.textile.liquid b/doc/install/index.html.textile.liquid index 5bf35f36f5..944a695110 100644 --- a/doc/install/index.html.textile.liquid +++ b/doc/install/index.html.textile.liquid @@ -1,12 +1,24 @@ --- layout: default navsection: installguide -title: Overview +title: Installation overview ... -{% include 'alert_stub' %} +Arvados can be installed in multiple ways. Arvados does not depend on any particular cloud operating stack. Arvados runs on one or more GNU/Linux system(s). Arvados is being developed on Debian and Ubuntu GNU/Linux. + +The simplest way to try out Arvados is to use the Docker-based installation, which installs Arvados in a series of Docker containers. + +For larger scale installations, a manual installation is more appropriate. + +h2. Docker -h2. Installation Overview +{% include 'alert_docker' %} + +"Installing with Docker":install-docker.html + +h2. Manual installation + +{% include 'alert_stub' %} # Set up a cluster, or use Amazon # Create and mount Keep volumes diff --git a/doc/install/install-docker.html.textile.liquid b/doc/install/install-docker.html.textile.liquid new file mode 100644 index 0000000000..93629e978e --- /dev/null +++ b/doc/install/install-docker.html.textile.liquid @@ -0,0 +1,112 @@ +--- +layout: default +navsection: installguide +title: Installing with Docker +... + +h2. Prerequisites: + +# A GNU/Linux (virtual) machine +# A working Docker installation + +h2. Download the source tree + + +
~$ cd $HOME # (or wherever you want to install)
+~$ git clone https://github.com/curoverse/arvados.git
+
 + +See also: "Downloading the source code":https://arvados.org/projects/arvados/wiki/Download on the Arvados wiki. + +h2. Building the Arvados Docker containers + +First we need a suitable @config.yml@ file. + + +
~$ cd arvados/docker
+~$ cp config.yml.example config.yml
+
 + +Now it's time to edit the @config.yml@ file and fill in suitable values for at a minimum these parameters: + +
+PUBLIC_KEY_PATH
+API_HOSTNAME
+API_AUTO_ADMIN_USER
+
+ +h2. Running the Arvados Docker containers + +The @arvdock@ command can be used to start and stop the docker containers. It has a number of options: + + +
~$ cd arvados/docker
+~$ ./arvdock -h
+
+usage: ./arvdock (start|stop|restart|test) [options]
+
+./arvdock start/stop/restart options:
+  -d [port], --doc[=port]        Documentation server (default port 9898)
+  -w [port], --workbench[=port]  Workbench server (default port 9899)
+  -s [port], --sso[=port]        SSO server (default port 9901)
+  -a [port], --api[=port]        API server (default port 9900)
+  -k, --keep                     Keep servers
+  --ssh                          Enable SSH access to server containers
+  -h, --help                     Display this help and exit
+
+  If no options are given, the action is applied to all servers.
+
+./arvdock test [testname] [testname] ...
+  By default, all tests are run.
+
+
+ + +The @--ssh@ option can be useful to debug issues with the Docker containers; it allows you to ssh into the running containers as the @root@ user, provided you have access to the private key that matches the public key specified in @config.yml@'s PUBLIC_KEY_PATH variable. + +Start the docker containers: + + +
~$ cd arvados/docker
+~$ ./arvdock start
+sso_server
+Starting container:
+  /usr/bin/docker.io run -d -i -t -p 9901:443 --name sso_server arvados/sso
+api_server
+Starting container:
+  /usr/bin/docker.io run -d -i -t -p 9900:443 --name api_server --link sso_server:sso arvados/api
+keep_server_0
+Starting container:
+  /usr/bin/docker.io run -d -i -t -p 25107:25107 --name keep_server_0 -v /tmp/tmp.aCSx8Pq6Wb:/dev/keep-0 --link api_server:api arvados/keep
+keep_server_1
+Starting container:
+  /usr/bin/docker.io run -d -i -t -p 25108:25107 --name keep_server_1 -v /tmp/tmp.m4OQ9WB73G:/dev/keep-0 --link api_server:api arvados/keep
+doc_server
+Starting container:
+  /usr/bin/docker.io run -d -i -t -p 9898:80 --name doc_server arvados/doc
+
+*****************************************************************
+You can access the Arvados documentation at http://localhost:9898
+*****************************************************************
+
+workbench_server
+Starting container:
+  /usr/bin/docker.io run -d -i -t -p 9899:80 --name workbench_server --link api_server:api arvados/workbench
+
+*****************************************************************
+You can access the Arvados workbench at http://localhost:9899
+*****************************************************************
+
 + +h2. Accessing workbench + +Point your browser to the Dockerized workbench: + + +
https://localhost:9899
+
+ + +Now use the google account you specified as @API_AUTO_ADMIN_USER@ in @config.yml@ to log in. You will be prompted *twice* by your browser that you are accessing a site with an untrusted SSL certificate. This is normal; by default the Arvados Docker installation uses self-signed SSL certificates for the SSO and API servers, respectively. + + -- 2.30.2