16006: Add cloud install worksheets
authorPeter Amstutz <peter.amstutz@curii.com>
Fri, 10 Jan 2020 22:40:03 +0000 (17:40 -0500)
committerPeter Amstutz <peter.amstutz@curii.com>
Fri, 10 Jan 2020 22:40:03 +0000 (17:40 -0500)
Arvados-DCO-1.1-Signed-off-by: Peter Amstutz <peter.amstutz@curii.com>

doc/Rakefile
doc/install/install-manual-prerequisites.html.textile.liquid
doc/install/new_cluster_checklist_AWS.xlsx [new file with mode: 0644]
doc/install/new_cluster_checklist_Azure.xlsx [new file with mode: 0644]
doc/zenweb-fix-body.rb [new file with mode: 0644]

index 71d86c32dc4ba14adc63147c6e3da61184f165d4..82028ed0d848c75123d367ae8ca3e80b1fb5605e 100644 (file)
 require "rubygems"
 require "colorize"
 
+module Zenweb
+  class Site
+    @binary_files = %w[png jpg gif eot svg ttf woff2? ico pdf m4a t?gz xlsx]
+  end
+end
+
 task :generate => [ :realclean, 'sdk/python/arvados/index.html', 'sdk/R/arvados/index.html', 'sdk/java-v2/javadoc/index.html' ] do
   vars = ['baseurl', 'arvados_cluster_uuid', 'arvados_api_host', 'arvados_workbench_host']
   vars.each do |v|
@@ -21,6 +27,10 @@ task :generate => [ :realclean, 'sdk/python/arvados/index.html', 'sdk/R/arvados/
   end
 end
 
+file ["install/new_cluster_checklist_Azure.xlsx", "install/new_cluster_checklist_AWS.xlsx"] do |t|
+  cp(t, t)
+end
+
 file "sdk/python/arvados/index.html" do |t|
   if File.exists? "no-sdk"
     next
@@ -147,6 +157,7 @@ end
 require "zenweb/tasks"
 load "zenweb-textile.rb"
 load "zenweb-liquid.rb"
+load "zenweb-fix-body.rb"
 
 task :extra_wirings do
   $website.pages["sdk/python/python.html.textile.liquid"].depends_on("sdk/python/arvados/index.html")
index c341dea031dcd0b6fc7490105dc748bafc956b79..817aadfa36d59a67957b83b84a897170c02a6482 100644 (file)
@@ -9,7 +9,7 @@ Copyright (C) The Arvados Authors. All rights reserved.
 SPDX-License-Identifier: CC-BY-SA-3.0
 {% endcomment %}
 
-Before attempting installation, you should begin by reviewing supported platforms, choosing backends for identity, storage, and scheduling, and decide how you will distribute Arvados services onto machines.  You should also choose an Arvados Cluster ID, choose your hostnames, and aquire TLS certificates.  It may be helpful to make notes as you go along.
+Before attempting installation, you should begin by reviewing supported platforms, choosing backends for identity, storage, and scheduling, and decide how you will distribute Arvados services onto machines.  You should also choose an Arvados Cluster ID, choose your hostnames, and aquire TLS certificates.  It may be helpful to make notes as you go along using one of these worksheets:  "New cluster checklist for AWS":new_cluster_checklist_AWS.xlsx - "New cluster checklist for Azure":new_cluster_checklist_Azure.xlsx
 
 The Arvados storage subsystem is called "keep".  The compute subsystem is called "crunch".
 
@@ -96,7 +96,7 @@ h2(#machines). Hardware (or virtual machines)
 
 Choose how to allocate Arvados services to machines.  We recommend that each machine start with a clean installation of a supported GNU/Linux distribution.
 
-For a production installation, this is a reasonable starting point: 
+For a production installation, this is a reasonable starting point:
 
 <div class="offset1">
 table(table table-bordered table-condensed).
diff --git a/doc/install/new_cluster_checklist_AWS.xlsx b/doc/install/new_cluster_checklist_AWS.xlsx
new file mode 100644 (file)
index 0000000..34acbdb
Binary files /dev/null and b/doc/install/new_cluster_checklist_AWS.xlsx differ
diff --git a/doc/install/new_cluster_checklist_Azure.xlsx b/doc/install/new_cluster_checklist_Azure.xlsx
new file mode 100644 (file)
index 0000000..499c337
Binary files /dev/null and b/doc/install/new_cluster_checklist_Azure.xlsx differ
diff --git a/doc/zenweb-fix-body.rb b/doc/zenweb-fix-body.rb
new file mode 100644 (file)
index 0000000..869e366
--- /dev/null
@@ -0,0 +1,22 @@
+require 'zenweb'
+
+module ZenwebTextile
+  VERSION = '0.0.1'
+end
+
+module Zenweb
+  class Page
+    alias_method :old_body, :body
+    def body
+      # Don't try to parse binary files as text
+      if /\.(?:#{Site.binary_files.join("|")})$/ =~ path
+        @body ||= File.binread path
+      else
+        @body ||= begin
+                    _, body = Zenweb::Config.split path
+                    body.strip
+                  end
+      end
+    end
+  end
+end