2755: incorporate code review

[arvados.git] / services / api / config / application.yml.example

diff --git a/services/api/config/application.yml.example b/services/api/config/application.yml.example
index dcfcb42f186404df4b42da0fb1f318dd7f70e501..030e23894f00a5436354d36cf946272bdea616a2 100644 (file)
--- a/services/api/config/application.yml.example
+++ b/services/api/config/application.yml.example
@@ -11,31 +11,44 @@
 # 5. Section in application.default.yml called "common"
 
 development:
+  # The blob_signing_key is a string of alphanumeric characters used
+  # to sign permission hints for Keep locators. It must be identical
+  # to the permission key given to Keep.  If you run both apiserver
+  # and Keep in development, change this to a hardcoded string and
+  # make sure both systems use the same value.
+  blob_signing_key: ~
 
 production:
   # At minimum, you need a nice long randomly generated secret_token here.
+  # Use a long string of alphanumeric characters (at least 36).
   secret_token: ~
 
+  # blob_signing_key is required and must be identical to the
+  # permission secret provisioned to Keep.
+  # Use a long string of alphanumeric characters (at least 36).
+  blob_signing_key: ~
+
   uuid_prefix: bogus
 
-  # This is suitable for AWS; see common section below for a static example.
-  compute_node_nameservers: <%=
+  # compute_node_domain: example.org
+  # compute_node_nameservers:
+  #   - 127.0.0.1
+  #   - 192.168.1.1
+  #
+  # The version below is suitable for AWS.
+  # Uncomment and change <%# to <%= to use it.
+  # compute_node_nameservers: <%#
     require 'net/http'
     ['local', 'public'].collect do |iface|
       Net::HTTP.get(URI("http://169.254.169.254/latest/meta-data/#{iface}-ipv4")).match(/^[\d\.]+$/)[0]
     end << '172.16.0.23'
   %>
-  # You must customize these. See config.defaults.yml for information.
-  compute_node_ami: ~
-  compute_node_ec2_tag_enable: ~
-  compute_node_domain: ~
-  compute_node_spot_bid: ~
 
 test:
   uuid_prefix: zzzzz
+  secret_token: <%= rand(2**512).to_s(36) %>
 
 common:
-  secret_token: ~
-  compute_node_nameservers:
-    - 192.168.0.1
-    - 172.16.0.1
+  #git_repositories_dir: /var/cache/git
+  #git_internal_dir: /var/cache/arvados/internal.git
+