From 4db8ee39ca14975e5d52cf51e750f856c7ee684b Mon Sep 17 00:00:00 2001
From: Billy Tat <btat@suse.com>
Date: Wed, 20 May 2020 09:05:38 -0700
Subject: [PATCH] Add external blobstore content (#806)

---
 xml/cap_depl_aks.xml          |  5 +++
 xml/cap_depl_caasp.xml        |  5 +++
 xml/cap_depl_eks.xml          |  5 +++
 xml/cap_depl_gke.xml          |  5 +++
 xml/repeated-content-decl.ent | 59 +++++++++++++++++++++++++++++++++++
 5 files changed, 79 insertions(+)

diff --git a/xml/cap_depl_aks.xml b/xml/cap_depl_aks.xml
index bd1992b4..21a57f5f 100644
--- a/xml/cap_depl_aks.xml
+++ b/xml/cap_depl_aks.xml
@@ -379,6 +379,11 @@ export NODEPOOL_NAME="mypool"
   &high-availability;
  </sect1>
 
+ <sect1 xml:id="sec-cap-aks-external-blobstore">
+  <!-- Entry defined in xml/repeated-content-decl.ent -->
+  &external-blobstore;
+ </sect1>
+
  <sect1 xml:id="sec-cap-aks-external-database">
   <!-- Entry defined in xml/repeated-content-decl.ent -->
   &external-database;
diff --git a/xml/cap_depl_caasp.xml b/xml/cap_depl_caasp.xml
index 148523db..8ae1c9f9 100644
--- a/xml/cap_depl_caasp.xml
+++ b/xml/cap_depl_caasp.xml
@@ -320,6 +320,11 @@ sed's/"namespace": "default"/"namespace": "scf"/' | kubectl create --filename -
   &high-availability;
  </sect1>
 
+ <sect1 xml:id="sec-cap-caasp-external-blobstore">
+  <!-- Entry defined in xml/repeated-content-decl.ent -->
+  &external-blobstore;
+ </sect1>
+
  <sect1 xml:id="sec-cap-caasp-external-database">
   <!-- Entry defined in xml/repeated-content-decl.ent -->
   &external-database;
diff --git a/xml/cap_depl_eks.xml b/xml/cap_depl_eks.xml
index a56c1af3..363222e2 100644
--- a/xml/cap_depl_eks.xml
+++ b/xml/cap_depl_eks.xml
@@ -317,6 +317,11 @@ allowVolumeExpansion: true
   &high-availability;
  </sect1>
 
+ <sect1 xml:id="sec-cap-eks-external-blobstore">
+  <!-- Entry defined in xml/repeated-content-decl.ent -->
+  &external-blobstore;
+ </sect1>
+
  <sect1 xml:id="sec-cap-eks-external-database">
   <!-- Entry defined in xml/repeated-content-decl.ent -->
   &external-database;
diff --git a/xml/cap_depl_gke.xml b/xml/cap_depl_gke.xml
index 8d203b98..12024bb8 100644
--- a/xml/cap_depl_gke.xml
+++ b/xml/cap_depl_gke.xml
@@ -261,6 +261,11 @@
   &high-availability;
  </sect1>
 
+ <sect1 xml:id="sec-cap-gke-external-blobstore">
+  <!-- Entry defined in xml/repeated-content-decl.ent -->
+  &external-blobstore;
+ </sect1>
+
  <sect1 xml:id="sec-cap-gke-external-database">
   <!-- Entry defined in xml/repeated-content-decl.ent -->
   &external-database;
diff --git a/xml/repeated-content-decl.ent b/xml/repeated-content-decl.ent
index b172ed8d..8cb48539 100644
--- a/xml/repeated-content-decl.ent
+++ b/xml/repeated-content-decl.ent
@@ -1744,6 +1744,65 @@ perl -ne &apos;/^sizing/..0 and do { print $.,":",$_ if /^ [a-z]/ || /high avail
   </sect3>
  </sect2>'>
 
+<!--ENTITY external-blobstore...............................................-->
+
+<!ENTITY external-blobstore
+'<title xmlns="http://docbook.org/ns/docbook">
+  External Blobstore
+ </title>
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+  &cf; Application Runtime (CFAR) uses a blobstore (see
+  <link xlink:href="https://docs.cloudfoundry.org/concepts/cc-blobstore.html"/>)
+  to store the source code that developers push, stage, and run. This  section
+  explains how to configure an external blobstore for the Cloud Controller
+  component of your &productname; deployment.
+ </para>
+ <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+  &productname; relies on <filename>ops files</filename> (see
+  <link xlink:href="https://github.com/cloudfoundry/cf-deployment/blob/master/operations/README.md"/>)
+  provided by cf-deployment (see <link xlink:href="https://github.com/cloudfoundry/cf-deployment"/>)
+  releases for external blobstore configurations. The default configuration for
+  the blobstore is <literal>singleton</literal>.
+ </para>
+ <sect2 xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+  <title>Configuration</title>
+  <para>
+   Currently &productname; supports Amazon Simple Storage Service (Amazon S3,
+   see <link xlink:href="https://aws.amazon.com/s3/"/>) as an external blobstore
+   . In order to configure Amazon S3 as an external blobstore, set the following
+   in your <filename>kubecf-config-values.yaml</filename> file and replace the
+   example values.
+  </para>
+<screen>features:
+  blobstore:
+    provider: s3
+    s3:
+      aws_region: <replaceable>"us-east-1"</replaceable>
+      blobstore_access_key_id:  <replaceable>AWS-ACCESS-KEY-ID</replaceable>
+      blobstore_secret_access_key: <replaceable>AWS-SECRET-ACCESS-KEY></replaceable>
+      # User provided value for the blobstore admin password.
+      blobstore_admin_users_password: <replaceable>PASSWORD</replaceable>
+      # The following values are used as S3 bucket names. The buckets are automatically created if not present.
+      app_package_directory_key: <replaceable>APP-BUCKET-NAME</replaceable>
+      buildpack_directory_key: <replaceable>BUILDPACK-BUCKET-NAME</replaceable>
+      droplet_directory_key: <replaceable>DROPLET-BUCKET-NAME</replaceable>
+      resource_directory_key: <replaceable>RESOURCE-BUCKET-NAME</replaceable>
+</screen>
+  <warning>
+   <title><literal>us-east-1</literal> as Only Valid Region</title>
+   <para>
+    Currently, there is a limitation where only <literal>us-east-1</literal> can
+    be chosen as the <literal>aws_region</literal>. For more information about
+    this issue, see
+    <link xlink:href="https://github.com/cloudfoundry-incubator/kubecf/issues/656"/>.
+   </para>
+  </warning>
+  <para>
+   Ensure the supplied AWS credentials have appropriate permissions as described
+   at <link xlink:href="https://docs.cloudfoundry.org/deploying/common/cc-blobstore-config.html#fog-aws-iam"/>.
+  </para>
+ </sect2>'>
+
 <!--ENTITY external-database................................................-->
 
 <!ENTITY external-database