Merge pull request #1824 from bigchaindb/update-tectonic-docs

Update tectonic installation guide

docs/server/source/production-deployment-template/node-on-kubernetes.rst

@@ -424,13 +424,14 @@ LRS means locally-redundant storage: three replicas
 in the same data center.
 Premium storage is higher-cost and higher-performance.
 It uses solid state drives (SSD).
-At the time of writing,
-when we created a storage account with SKU ``Premium_LRS``
-and tried to use that,
-the PersistentVolumeClaim would get stuck in a "Pending" state.
+You can create a `storage account <https://docs.microsoft.com/en-us/azure/storage/common/storage-create-storage-account>`_
+for Premium storage and associate it with your Azure resource group. 
 For future reference, the command to create a storage account is
 `az storage account create <https://docs.microsoft.com/en-us/cli/azure/storage/account#create>`_.
 
+.. Note::
+    Please refer to `Azure documentation <https://docs.microsoft.com/en-us/azure/virtual-machines/windows/premium-storage>`_
+    for the list of VMs that are supported by Premium Storage.
 
 The Kubernetes template for configuration of Storage Class is located in the
 file ``mongodb/mongo-sc.yaml``.
@@ -438,6 +439,10 @@ file ``mongodb/mongo-sc.yaml``.
 You may have to update the ``parameters.location`` field in the file to
 specify the location you are using in Azure.
 
+If you want to use a custom storage account with the Storage Class, you
+can also update `parameters.storageAccount` and provide the Azure storage
+account name. 
+
 Create the required storage classes using:
 
 .. code:: bash
@@ -447,15 +452,6 @@ Create the required storage classes using:
 
 You can check if it worked using ``kubectl get storageclasses``.
 
-**Azure.** Note that there is no line of the form
-``storageAccount: <azure storage account name>``
-under ``parameters:``. When we included one
-and then created a PersistentVolumeClaim based on it,
-the PersistentVolumeClaim would get stuck
-in a "Pending" state.
-Kubernetes just looks for a storageAccount
-with the specified skuName and location.
-
 
 Step 11: Create Kubernetes Persistent Volume Claims
 ---------------------------------------------------

docs/server/source/production-deployment-template/tectonic-azure.rst

@@ -47,7 +47,9 @@ when following the steps above:
    ``tectonic-cluster-CLUSTER``.
 
 #. Set the ``tectonic_base_domain`` to ``""`` if you want to use Azure managed
-   DNS. You will be assigned a ``cloudapp.azure.com`` sub-domain by default.
+   DNS. You will be assigned a ``cloudapp.azure.com`` sub-domain by default and
+   you can skip the ``Configuring Azure DNS`` section from the Tectonic installation
+   guide.
    
 #. Set the ``tectonic_cl_channel`` to ``"stable"`` unless you want to
    experiment or test with the latest release.
@@ -76,6 +78,14 @@ when following the steps above:
 #. Set the ``tectonic_azure_ssh_key`` to the path of the public key created in
    the previous step.
 
+#. We recommend setting up or using a CA(Certificate Authority) to generate Tectonic
+   Console's server certificate(s) and adding it to your trusted authorities on the client side,
+   accessing the Tectonic Console i.e. Browser. If you already have a CA(self-signed or otherwise),
+   Set the ``tectonic_ca_cert`` and ``tectonic_ca_key`` configurations with the content
+   of PEM-encoded certificate and key files, respectively. For more information about, how to set
+   up a self-signed CA, Please refer to
+   :doc:`How to Set up self-signed CA <ca-installation>`.
+
 #. Note that the ``tectonic_azure_client_secret`` is the same as the
    ``ARM_CLIENT_SECRET``.
 
@@ -85,6 +95,10 @@ when following the steps above:
    ``test-cluster`` and specified the datacenter as ``westeurope``, the Tectonic
    console will be available at ``test-cluster.westeurope.cloudapp.azure.com``.
 
+#. Note that, if you do not specify ``tectonic_ca_cert``, a CA certificate will
+   be generated automatically and you will encounter the untrusted certificate
+   message on your client(Browser), when accessing the Tectonic Console.
+
 
 Step 4: Configure kubectl
 -------------------------

docs/server/source/production-deployment-template/template-kubernetes-azure.rst

@@ -105,6 +105,21 @@ Finally, you can deploy an ACS using something like:
    --orchestrator-type kubernetes \
    --debug --output json
 
+.. Note::
+    Please refer to `Azure documentation <https://docs.microsoft.com/en-us/cli/azure/acs?view=azure-cli-latest#az_acs_create>`_
+    for a comprehensive list of options available for `az acs create`. 
+    Please tune the following parameters as per your requirement:
+
+    * Master count.
+
+    * Agent count.
+
+    * Agent VM size.
+
+    * **Optional**: Master storage profile.
+
+    * **Optional**: Agent storage profile.
+
 
 There are more options. For help understanding all the options, use the built-in help:
 

k8s/mongodb/mongo-sc.yaml

@@ -7,8 +7,12 @@ metadata:
   name: slow-db
 provisioner: kubernetes.io/azure-disk
 parameters:
-  skuName: Standard_LRS
+  skuName: Premium_LRS #[Premium_LRS, Standard_LRS]
   location: westeurope
+  # If you have created a different storage account e.g. for Premium Storage
+  #storageAccount: <Storage account name>
+  # Use Managed Disk(s) with VMs using Managed Disks(Only used for Tectonic deployment)
+  #kind: Managed
 ---
 ######################################################################
 # This YAML section desribes a StorageClass for the mongodb configDB # 
@@ -19,5 +23,9 @@ metadata:
   name: slow-configdb
 provisioner: kubernetes.io/azure-disk
 parameters:
-  skuName: Standard_LRS
+  skuName: Premium_LRS #[Premium_LRS, Standard_LRS]
   location: westeurope
+  # If you have created a different storage account e.g. for Premium Storage
+  #storageAccount: <Storage account name>
+  # Use Managed Disk(s) with VMs using Managed Disks(Only used for Tectonic deployment)
+  #kind: Managed