Add navigation helpers to the end of the sections in the manual.

Add missing newlines in the test cases and samples.

Author: brownleej

config/samples/client.yaml

@@ -90,4 +90,4 @@ spec:
               value: /var/dynamic-conf/lib
           volumeMounts:
             - name: dynamic-conf
-              mountPath: /var/dynamic-conf
+              mountPath: /var/dynamic-conf

config/samples/cluster.yaml

@@ -4,4 +4,4 @@ kind: FoundationDBCluster
 metadata:
   name: sample-cluster
 spec:
-  version: 6.2.30
+  version: 6.2.30

config/samples/restore.yaml

@@ -15,4 +15,4 @@ spec:
   # object store at `https://object-store.example:443`. It also assumes that you
   # have previously created a backup with the name `sample-cluster` using a
   # bucket named `fdb-backups`.
-  backupURL: "blobstore://account@object-store.example:443/sample-cluster?bucket=fdb-backups"
+  backupURL: "blobstore://account@object-store.example:443/sample-cluster?bucket=fdb-backups"

config/tests/README.md

@@ -9,4 +9,4 @@ Most of these test cases are built using kustomize, and you can apply them by
 using kubectl. Example: `kubectl apply -k config/tests/base`. The `multi_kc` and
 `multi_dc` test cases have special test scripts to support a multi-stage
 creation process. Example: `bash config/tests/multi_dc/create.bash`. Those
-directories also contain `apply.bash` and `delete.bash` scripts.
+directories also contain `apply.bash` and `delete.bash` scripts.

config/tests/backup/base/kustomization.yaml

@@ -1,4 +1,4 @@
 bases:
 - "../../base"
 resources:
-- backup.yaml
+- backup.yaml

config/tests/backup/restore/kustomization.yaml

@@ -1,4 +1,4 @@
 bases:
 - "../stopped"
 resources:
-- "restore.yaml"
+- "restore.yaml"

config/tests/backup/restore/restore.yaml

@@ -4,4 +4,4 @@ metadata:
  name: test-cluster
 spec:
  destinationClusterName: test-cluster
- backupURL: "blobstore://minio@minio-service:9000/test-cluster?bucket=fdb-backups"
+ backupURL: "blobstore://minio@minio-service:9000/test-cluster?bucket=fdb-backups"

config/tests/backup/stopped/backup.yaml

@@ -3,4 +3,4 @@ kind: FoundationDBBackup
 metadata:
   name: test-cluster
 spec:
-  backupState: Stopped
+  backupState: Stopped

config/tests/backup/stopped/kustomization.yaml

@@ -1,4 +1,4 @@
 bases:
 - "../base"
 patchesStrategicMerge:
-- backup.yaml
+- backup.yaml

config/tests/base/kustomization.yaml

@@ -1,3 +1,3 @@
 # This file provides a basic cluster designed for local testing of the operator.
 resources:
-- cluster.yaml
+- cluster.yaml

config/tests/client/kustomization.yaml

@@ -1,4 +1,4 @@
 bases:
 - "../base"
 resources:
-- client.yaml
+- client.yaml

config/tests/multi_dc/create.bash

@@ -25,4 +25,4 @@ applyFile $DIR/final.yaml dc3 $connectionString
 
 checkReconciliationLoop test-cluster-dc1
 checkReconciliationLoop test-cluster-dc2
-checkReconciliationLoop test-cluster-dc3
+checkReconciliationLoop test-cluster-dc3

config/tests/multi_dc/delete.bash

@@ -1,3 +1,3 @@
 #! /bin/bash
 
-kubectl delete fdb -l cluster-group=test-cluster
+kubectl delete fdb -l cluster-group=test-cluster

config/tests/multi_kc/create.bash

@@ -25,4 +25,4 @@ applyFile $DIR/final.yaml dc3 $connectionString
 
 checkReconciliationLoop test-cluster-dc1
 checkReconciliationLoop test-cluster-dc2
-checkReconciliationLoop test-cluster-dc3
+checkReconciliationLoop test-cluster-dc3

config/tests/multi_kc/delete.bash

@@ -1,3 +1,3 @@
 #! /bin/bash
 
-kubectl delete fdb -l cluster-group=test-cluster
+kubectl delete fdb -l cluster-group=test-cluster

config/tests/tls/kustomization.yaml

@@ -7,4 +7,4 @@ patchesJson6902:
     group: apps.foundationdb.org
     version: v1beta1
     kind: FoundationDBCluster
-    name: test-cluster
+    name: test-cluster

config/tests/tls/tls.yaml

@@ -39,4 +39,4 @@
 - op: add
   path: "/spec/sidecarContainer"
   value:
-    enableTls: true
+    enableTls: true

docs/manual/customization.md

@@ -191,4 +191,8 @@ You can build this kind of configuration easily from the sample deployment by ch
 
 * Delete the configuration for the `WATCH_NAMESPACE` variable
 * Change the Roles to ClusterRoles
-* Change the RoleBindings to ClusterRoleBindings
+* Change the RoleBindings to ClusterRoleBindings
+
+## Next
+
+You can continue on to the [next section](fault_domains.md) or go back to the [table of contents](index.md).

docs/manual/fault_domains.md

@@ -181,4 +181,8 @@ operator does not yet create these automatically. To aid in creation of PDBs the
 operator preferentially selects coordinators from just storage pods, then if
 there are not enough storage pods, or the storage pods are not spread across
 enough fault domains it also considers log pods, and finally transaction pods as
-well.
+well.
+
+## Next
+
+You can continue on to the [next section](tls.md) or go back to the [table of contents](index.md).

docs/manual/getting_started.md

@@ -87,3 +87,6 @@ Note that:
 * The name of the config map will depend on the name of your cluster.
 * For long-running applications you should ensure that your cluster file is writeable by your application.
 
+## Next
+
+You can continue on to the [next section](warnings.md) or go back to the [table of contents](index.md).

docs/manual/index.md

@@ -12,4 +12,4 @@ This document assumes that you are generally familiar with Kubernetes. For more
 1. [Scaling](scaling.md)
 1. [Customization](customization.md)
 1. [Controlling Fault Domains](fault_domains.md)
-1. [Running with TLS](tls.md)
+1. [Running with TLS](tls.md)

docs/manual/operations.md

@@ -65,3 +65,7 @@ The name of a cluster is immutable, and it is included in the names of all of th
 4.  Delete the `sample-cluster` resource.
 
 At that point, you will be left with just the resources for `sample-cluster-2`. You can continue performing operations on `sample-cluster-2` as normal. You can also change or remove the `instanceIDPrefix` if you had to set it to a different value earlier in the process.
+
+## Next
+
+You can continue on to the [next section](scaling.md) or go back to the [table of contents](index.md).

docs/manual/scaling.md

@@ -88,4 +88,8 @@ spec:
     storage: 5
 ```
 
-This will run the configuration command on the database, and may also add or remove processes to match the new configuration.
+This will run the configuration command on the database, and may also add or remove processes to match the new configuration.
+
+## Next
+
+You can continue on to the [next section](customization.md) or go back to the [table of contents](index.md).

docs/manual/tls.md

@@ -95,4 +95,8 @@ If you want to run any clusters with TLS, you must configure the operator to sup
 
 Connections to FDB will use the peer verification logic provided by the FDB client, which can be configured with peer verification rules in the same way as we support for the server. However, there is no mechanism to set these rules on a per-cluster basis, so it may not be beneficial to define them on the operator's side of the connection.
 
-Connections to the sidecar will use the peer verification logic provided by go's tls library. This means that the sidecar's certificate must be valid for the pod's IP. You can disable verification for the connections to the sidecar by setting the environment variable `DISABLE_SIDECAR_TLS_CHECK=1` on the operator, but this will also disable the validation of the certificate chain, so it is not recommended to use this in real environments.
+Connections to the sidecar will use the peer verification logic provided by go's tls library. This means that the sidecar's certificate must be valid for the pod's IP. You can disable verification for the connections to the sidecar by setting the environment variable `DISABLE_SIDECAR_TLS_CHECK=1` on the operator, but this will also disable the validation of the certificate chain, so it is not recommended to use this in real environments.
+
+## Next
+
+You can go back to the [table of contents](index.md).

docs/manual/warnings.md

@@ -40,3 +40,7 @@ The `podTemplate` field allows you to customize nearly every part of the pods th
 You should be careful when changing images, environment variables, commands, or arguments for the built-in containers. Your custom values may interfere with how the operator is using them. Even if you can make your usage work with the current version of the operator, subsequent releases of the operator may change its behavior in a way that introduces conflicts.
 
 Other than the above, you can make any modifications to the pod definition you need to suit your requirements.
+
+## Next
+
+You can continue on to the [next section](operations.md) or go back to the [table of contents](index.md).