From 945ed810382ab6f76f2d3619a08b9796fc33319e Mon Sep 17 00:00:00 2001 From: Troy McConaghy Date: Fri, 9 Jun 2017 14:32:39 +0200 Subject: [PATCH] Responses to review comments from @krish7919 on #1526 --- .../node-config-map-and-secrets.rst | 16 +++++++++++----- .../node-on-kubernetes.rst | 2 +- k8s/configuration/config-map.yaml | 7 ++++--- 3 files changed, 16 insertions(+), 9 deletions(-) diff --git a/docs/server/source/production-deployment-template/node-config-map-and-secrets.rst b/docs/server/source/production-deployment-template/node-config-map-and-secrets.rst index 03f56afe..6e25c77b 100644 --- a/docs/server/source/production-deployment-template/node-config-map-and-secrets.rst +++ b/docs/server/source/production-deployment-template/node-config-map-and-secrets.rst @@ -1,5 +1,5 @@ -How to Configure Your BigchainDB Node -===================================== +How to Configure a BigchainDB Node +================================== This page outlines the steps to set a bunch of configuration settings in your BigchainDB node. @@ -23,6 +23,12 @@ That file already contains many comments to help you understand each data value, but we make some additional remarks on some of the values below. +Note: None of the data values in ``config-map.yaml`` need +to be base64-encoded. (This is unlike ``secret.yaml``, +where all data values must be base64-encoded. +This is true of all Kubernetes ConfigMaps and Secrets.) + + vars ~~~~ @@ -53,12 +59,12 @@ of all *other* nodes in your BigchainDB cluster * If you're deploying the first node in the cluster, the value should be ``""`` (an empty string). * If you're deploying the second node in the cluster, - the value should be one public key inside double quotes - (*not* base64-encoded). For example, + the value should be one public key inside double quotes. + For example, ``"EPQk5i5yYpoUwGVM8VKZRjM8CYxB6j8Lu8i8SG7kGGce"`` * If there are two or more other nodes already in the cluster, the value should be a colon-separated list of public keys - inside double quotes (with no base64 encoding anywhere). + inside double quotes. For example, ``"DPjpKbmbPYPKVAuf6VSkqGCf5jzrEh69Ldef6TrLwsEQ:EPQk5i5yYpoUwGVM8VKZRjM8CYxB6j8Lu8i8SG7kGGce"`` diff --git a/docs/server/source/production-deployment-template/node-on-kubernetes.rst b/docs/server/source/production-deployment-template/node-on-kubernetes.rst index c16ac787..44c91fec 100644 --- a/docs/server/source/production-deployment-template/node-on-kubernetes.rst +++ b/docs/server/source/production-deployment-template/node-on-kubernetes.rst @@ -101,7 +101,7 @@ That means you can visit the dashboard in your web browser at Step 3: Configure Your BigchainDB Node -------------------------------------- -See the page titled :ref:`How to Configure Your BigchainDB Node`. +See the page titled :ref:`How to Configure a BigchainDB Node`. Step 4: Start the NGINX Service diff --git a/k8s/configuration/config-map.yaml b/k8s/configuration/config-map.yaml index e21cf411..231f5b33 100644 --- a/k8s/configuration/config-map.yaml +++ b/k8s/configuration/config-map.yaml @@ -1,3 +1,5 @@ +## Note: data values do NOT have to be base64-encoded in this file. + ## vars is common environment variables for this BigchaindB node apiVersion: v1 kind: ConfigMap @@ -31,8 +33,7 @@ metadata: name: bdb-keyring namespace: default data: - # Colon-separated list of all *other* nodes' BigchainDB public keys - # with no base64 encoding anywhere + # Colon-separated list of all *other* nodes' BigchainDB public keys. bdb-keyring: "<':' separated list of public keys>" --- apiVersion: v1 @@ -41,6 +42,6 @@ metadata: name: bdb-public-key namespace: default data: - # BigchainDB public key of *this* node, not base64-encoded. + # BigchainDB public key of *this* node. # Example: "EPQk5i5yYpoUwGVM8VKZRjM8CYxB6j8Lu8i8SG7kGGce" bdb-public-key: ""