DOCSP-8454: Migrate TLS Options to docs-node (#43)

* DOCSP-8454: add table for TLS options, add connection page

Author: Chris Cho

snooty.toml

@@ -1,5 +1,5 @@
 name = "node"
-toc_landing_pages = ["/crud", "/crud/read-operations", "/crud/write-operations"]
+#toc_landing_pages = ["/crud", "/crud/read-operations", "/crud/write-operations"]
 
 [constants]
 version = 4.0

source/code-snippets/authentication/cr.js

@@ -0,0 +1,33 @@
+// ignored first line
+const { MongoClient } = require("mongodb");
+const fs = require("fs");
+
+// specify the placeholder values for your environment in the following lines
+const username = encodeURIComponent("<username>");
+const password = encodeURIComponent("<password>");
+const clusterUrl = "<MongoDB cluster url>";
+
+
+// Replace the following with your MongoDB deployment's connection
+// string.
+const uri = 
+  `mongodb+srv://${username}:${password}@${clusterUrl}/?authMechanism=${authMechanism}&tls=true&tlsCertificateKeyFile=${clientPEMFile}`;
+
+// Create a new MongoClient
+const client = new MongoClient(uri);
+
+// Function to connect to the server
+async function run() {
+  try {
+    // Connect the client to the server
+    await client.connect();
+
+    // Establish and verify connection
+    await client.db("admin").command({ ping: 1 });
+    console.log("Connected successfully to server");
+  } finally {
+    // Ensures that the client will close when you finish/error
+    await client.close();
+  }
+}
+run().catch(console.dir);

source/code-snippets/authentication/default.js

@@ -0,0 +1,33 @@
+// ignored first line
+const { MongoClient } = require("mongodb");
+
+// specify the placeholder values for your environment in the following lines
+const username = encodeURIComponent("<username>");
+const password = encodeURIComponent("<password>");
+const clusterUrl = "<MongoDB cluster url>";
+
+const authMechanism = "DEFAULT";
+
+// Replace the following with your MongoDB deployment's connection
+// string.
+const uri = 
+  `mongodb+srv://${username}:${password}@${clusterUrl}/?authMechanism=${authMechanism}`;
+
+// Create a new MongoClient
+const client = new MongoClient(uri);
+
+// Function to connect to the server
+async function run() {
+  try {
+    // Connect the client to the server
+    await client.connect();
+
+    // Establish and verify connection
+    await client.db("admin").command({ ping: 1 });
+    console.log("Connected successfully to server");
+  } finally {
+    // Ensures that the client will close when you finish/error
+    await client.close();
+  }
+}
+run().catch(console.dir);

source/code-snippets/authentication/sha1.js

@@ -0,0 +1,33 @@
+// ignored first line
+const { MongoClient } = require("mongodb");
+
+// specify the placeholder values for your environment in the following lines
+const username = encodeURIComponent("<username>");
+const password = encodeURIComponent("<password>");
+const clusterUrl = "<MongoDB cluster url>";
+
+const authMechanism = "SCRAM-SHA-1";
+
+// Replace the following with your MongoDB deployment's connection
+// string.
+const uri = 
+  `mongodb+srv://${username}:${password}@${clusterUrl}/?authMechanism=${authMechanism}`;
+
+// Create a new MongoClient
+const client = new MongoClient(uri);
+
+// Function to connect to the server
+async function run() {
+  try {
+    // Connect the client to the server
+    await client.connect();
+
+    // Establish and verify connection
+    await client.db("admin").command({ ping: 1 });
+    console.log("Connected successfully to server");
+  } finally {
+    // Ensures that the client will close when you finish/error
+    await client.close();
+  }
+}
+run().catch(console.dir);

source/code-snippets/authentication/sha256.js

@@ -0,0 +1,33 @@
+// ignored first line
+const { MongoClient } = require("mongodb");
+
+// specify the placeholder values for your environment in the following lines
+const username = encodeURIComponent("<username>");
+const password = encodeURIComponent("<password>");
+const clusterUrl = "<MongoDB cluster url>";
+
+const authMechanism = "SCRAM-SHA-256";
+
+// Replace the following with your MongoDB deployment's connection
+// string.
+const uri = 
+  `mongodb+srv://${username}:${password}@${clusterUrl}/?authMechanism=${authMechanism}`;
+
+// Create a new MongoClient
+const client = new MongoClient(uri);
+
+// Function to connect to the server
+async function run() {
+  try {
+    // Connect the client to the server
+    await client.connect();
+
+    // Establish and verify connection
+    await client.db("admin").command({ ping: 1 });
+    console.log("Connected successfully to server");
+  } finally {
+    // Ensures that the client will close when you finish/error
+    await client.close();
+  }
+}
+run().catch(console.dir);

source/code-snippets/authentication/x509.js

@@ -0,0 +1,34 @@
+// ignored first line
+const { MongoClient } = require("mongodb");
+const fs = require("fs");
+
+const username = encodeURIComponent("<client certificate distinguished name>");
+const clusterUrl = "<MongoDB cluster url>";
+const clientPEMFile = encodeURIComponent(
+  "<path to the client pem certificate file>",
+);
+const authMechanism = "MONGODB-X509";
+
+// Replace the following with your MongoDB deployment's connection
+// string.
+const uri = 
+  `mongodb+srv://${username}@${clusterUrl}/?authMechanism=${authMechanism}&tls=true&tlsCertificateKeyFile=${clientPEMFile}`;
+
+// Create a new MongoClient
+const client = new MongoClient(uri);
+
+// Function to connect to the server
+async function run() {
+  try {
+    // Connect the client to the server
+    await client.connect();
+
+    // Establish and verify connection
+    await client.db("admin").command({ ping: 1 });
+    console.log("Connected successfully to server");
+  } finally {
+    // Ensures that the client will close when you finish/error
+    await client.close();
+  }
+}
+run().catch(console.dir);

source/code-snippets/connection/srv.js

@@ -0,0 +1,23 @@
+const { MongoClient } = require("mongodb");
+
+// Connection URI
+const uri =
+  "mongodb+srv://sample-hostname:27017/?poolSize=20&useUnifiedTopology=true";
+
+// Create a new MongoClient
+const client = new MongoClient(uri);
+
+async function run() {
+  try {
+    // Connect the client to the server
+    await client.connect();
+
+    // Establish and verify connection
+    await client.db("admin").command({ ping: 1 });
+    console.log("Connected successfully to server");
+  } finally {
+    // Ensures that the client will close when you finish/error
+    await client.close();
+  }
+}
+run().catch(console.dir);

source/fundamentals.txt

@@ -5,8 +5,8 @@ Fundamentals
 .. default-domain:: mongodb
 
 .. toctree::
-   :caption: CRUD Operations
 
+   /fundamentals/connection
    /fundamentals/crud
    /fundamentals/authentication
    /fundamentals/logging

source/fundamentals/authentication.txt

@@ -15,7 +15,7 @@ Overview
 These guides show you how to authenticate to a MongoDB instance using the
 Node.js driver.
 
-The `Authentication Mechanisms <authentication-mechanisms>`_ guide contains
+The `Authentication Mechanisms <authentication/authentication-mechanisms>`_ guide contains
 sample connection code using each authentication mechanism supported in the
 MongoDB Community Edition which includes:
 
@@ -26,7 +26,7 @@ MongoDB Community Edition which includes:
 - ``X.509``
 
 The
-`Enterprise Authentication Mechanisms <authentication-mechanisms-enterprise>`_
+`Enterprise Authentication Mechanisms <authentication/authentication-mechanisms-enterprise>`_
 guide contains sample connection code using authentication mechanisms
 available only in MongoDB Enterprise Edition which includes:
 

source/fundamentals/authentication/enterprise-mechanisms.txt

@@ -2,7 +2,7 @@
 Enterprise Authentication Mechanisms
 ====================================
 
-In this section, you can find sample code for connection to MongoDB with each
+In this guide, you can find sample code for connection to MongoDB with each
 authentication mechanism available in the MongoDB Enterprise Edition:
 ``Kerberos (GSSAPI/SSPI)`` and  ``LDAP (PLAIN)``.