X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/5dd20e4a0aac7428a68dabbf5ec2c6800f32957b..cc952178056bf6d29471f6986306fb673dcf394a:/doc/install/install-keepproxy.html.textile.liquid diff --git a/doc/install/install-keepproxy.html.textile.liquid b/doc/install/install-keepproxy.html.textile.liquid index f46e6500b5..db24953fcc 100644 --- a/doc/install/install-keepproxy.html.textile.liquid +++ b/doc/install/install-keepproxy.html.textile.liquid @@ -3,10 +3,18 @@ layout: default navsection: installguide title: Install Keepproxy server ... +{% comment %} +Copyright (C) The Arvados Authors. All rights reserved. -The Keepproxy server is a gateway into your Keep storage. Unlike the Keepstore servers, which are only accessible on the local LAN, Keepproxy is designed to provide secure access into Keep from anywhere on the internet. +SPDX-License-Identifier: CC-BY-SA-3.0 +{% endcomment %} -By convention, we use the following hostname for the Keepproxy: +The Keepproxy server is a gateway into your Keep storage. Unlike the Keepstore servers, which are only accessible on the local LAN, Keepproxy is suitable for clients located elsewhere on the internet. Specifically, in contrast to Keepstore: +* A client writing through Keepproxy generates less network traffic: the client sends a single copy of a data block, and Keepproxy sends copies to the appropriate Keepstore servers. +* A client can write through Keepproxy without precomputing content hashes. Notably, the browser-based upload feature in Workbench requires Keepproxy. +* Keepproxy checks API token validity before processing requests. (Clients that can connect directly to Keepstore can use it as scratch space even without a valid API token.) + +By convention, we use the following hostname for the Keepproxy server:
table(table table-bordered table-condensed). @@ -36,32 +44,26 @@ Verify that Keepproxy is functional: 
~$ keepproxy -h
-Usage of default:
-  -default-replicas=2: Default number of replicas to write if not specified by the client.
-  -listen=":25107": Interface on which to listen for requests, in the format ipaddr:port. e.g. -listen=10.0.1.24:8000. Use -listen=:port to listen on all network interfaces.
-  -no-get=false: If set, disable GET operations
-  -no-put=false: If set, disable PUT operations
-  -pid="": Path to write pid file
+...
+Usage: keepproxy [-config path/to/keepproxy.yml]
+...
h3. Create an API token for the Keepproxy server -The Keepproxy server needs a token to talk to the API server. - -On the API server, use the following command to create the token: - - -
~/arvados/services/api/script$ RAILS_ENV=production bundle exec ./get_anonymous_user_token.rb
-hoShoomoo2bai3Ju1xahg6aeng1siquuaZ1yae2gi2Uhaeng2r
-
 +{% assign railscmd = "bundle exec ./script/get_anonymous_user_token.rb --get" %} +{% assign railsout = "zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz" %} +The Keepproxy server needs a token to talk to the API server. On the API server, use the following command to create the token. {% include 'install_rails_command' %} h3. Set up the Keepproxy service -We recommend you run Keepproxy under "runit":http://smarden.org/runit/ or a similar supervisor. Make sure the launcher sets the envirnoment variables @ARVADOS_API_TOKEN@ (with the token you just generated), @ARVADOS_API_HOST@, and, if needed, @ARVADOS_API_HOST_INSECURE@. The core keepproxy command to run is: +Install runit to supervise the keepproxy daemon. {% include 'install_runit' %} + +The run script for the keepproxy service should set the environment variables @ARVADOS_API_TOKEN@ (with the token you just generated), @ARVADOS_API_HOST@, and, if needed, @ARVADOS_API_HOST_INSECURE@. The core keepproxy command to run is: -
ARVADOS_API_TOKEN=[generated token] ARVADOS_API_HOST=uuid_prefix.your.domain exec keepproxy
+
ARVADOS_API_TOKEN={{railsout}} ARVADOS_API_HOST=uuid_prefix.your.domain exec keepproxy
 

 
 
@@ -71,33 +73,57 @@ Because the Keepproxy is intended for access from anywhere on the internet, it i
 
 This is best achieved by putting a reverse proxy with SSL support in front of Keepproxy. Keepproxy itself runs on port 25107 by default; your reverse proxy can run on port 443 and pass requests to Keepproxy on port 25107.
 
-If possible, the proxy should be configured to add CORS headers to its own error responses -- otherwise in-browser applications can't report proxy errors. For example, in nginx >= 1.7.5:
-
 
+upstream keepproxy {
+  server                127.0.0.1:25107;
+}
+
 server {
-  server_name keep.example.com
+  listen                  [your public IP address]:443 ssl;
+  server_name             keep.uuid_prefix.your.domain;
+
+  proxy_connect_timeout   90s;
+  proxy_read_timeout      300s;
+  proxy_set_header        X-Real-IP $remote_addr;
+  proxy_http_version      1.1;
+  proxy_request_buffering off;
+
+  ssl                     on;
+  ssl_certificate         /etc/nginx/keep.uuid_prefix.your.domain-ssl.crt;
+  ssl_certificate_key     /etc/nginx/keep.uuid_prefix.your.domain-ssl.key;
+
   # Clients need to be able to upload blocks of data up to 64MiB in size.
-  client_max_body_size 70m;
-  ...
-  add_header 'Access-Control-Allow-Methods' 'GET, HEAD, POST, PUT, OPTIONS' always
-  add_header 'Access-Control-Allow-Origin' '*' always
-  add_header 'Access-Control-Allow-Headers' 'Authorization, Content-Length, Content-Type, X-Keep-Desired-Replicas' always
-  add_header 'Access-Control-Max-Age' '86486400' always
+  client_max_body_size    64m;
+
+  location / {
+    proxy_pass            http://keepproxy;
+  }
 }
 

 
-*Warning:* Make sure you don't inadvertently add CORS headers for services _other than keepproxy_ while you're doing this.
+Note: if the Web uploader is failing to upload data and there are no logs from keepproxy, be sure to check the nginx proxy logs.  In addition to "GET" and "PUT", The nginx proxy must pass "OPTIONS" requests to keepproxy, which should respond with appropriate Cross-origin resource sharing headers.  If the CORS headers are not present, brower security policy will cause the upload request to silently fail.  The CORS headers are generated by keepproxy and should not be set in nginx.
 
 h3. Tell the API server about the Keepproxy server
 
-The API server needs to be informed about the presence of your Keepproxy server. Please execute the following commands on your shell server.
+The API server needs to be informed about the presence of your Keepproxy server.
+
+First, if you don't already have an admin token, create a superuser token.
+
+{% include 'create_superuser_token' %}
+
+Configure your environment to run @arv@ using the output of create_superuser_token.rb:
+
+
+export ARVADOS_API_HOST=zzzzz.example.com
+export ARVADOS_API_TOKEN=zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz
+

 
 
-
~$ prefix=`arv --format=uuid user current | cut -d- -f1`
-~$ echo "Site prefix is '$prefix'"
+
~$ uuid_prefix=`arv --format=uuid user current | cut -d- -f1`
+~$ echo "Site prefix is '$uuid_prefix'"
 ~$ read -rd $'\000' keepservice <<EOF; arv keep_service create --keep-service "$keepservice"
 {
- "service_host":"keep.$prefix.your.domain",
+ "service_host":"keep.$uuid_prefix.your.domain",
  "service_port":443,
  "service_ssl_flag":true,
  "service_type":"proxy"
@@ -105,3 +131,12 @@ The API server needs to be informed about the presence of your Keepproxy server.
 EOF
 

 
+h3. Testing keepproxy
+
+Log into a host that is on an external network from your private Arvados network.  The host should be able to contact your keepproxy server (eg keep.$uuid_prefix.arvadosapi.com), but not your keepstore servers (eg keep[0-9].$uuid_prefix.arvadosapi.com).
+
+Install the "Python SDK":{{site.baseurl}}/sdk/python/sdk-python.html
+
+@ARVADOS_API_HOST@ and @ARVADOS_API_TOKEN@ must be set in the environment.
+
+You should now be able to use @arv-put@ to upload collections and @arv-get@ to fetch collections, for an example see "Testing keep.":install-keepstore.html#testing on the keepstore install page.