[DOCS-11243] Docs for SERVER-32738: Add --ssl-provider build option Created: 24/Jan/18  Updated: 27/Oct/23  Resolved: 04/Apr/18

Status: Closed
Project: Documentation
Component/s: Server
Affects Version/s: None
Fix Version/s: 3.7.2

Type: Task Priority: Major - P3
Reporter: Kay Kim (Inactive) Assignee: Allison Reinheimer Moore
Resolution: Gone away Votes: 0
Labels: connection, ssl
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified
Environment:

Issue Links:
Documented
documents SERVER-32738 Add --ssl-provider build option Closed
Participants:
Days since reply: 6 years, 3 weeks ago
Epic Link: DOCS: 4.0 Server
Story Points: 1

 Description   

Documentation Request Summary:

This diff adds a build options `--ssl-provider`. When the Native TLS epic (PM-305) is complete, the three options ('auto', 'native', and 'openssl') will be settable at build time to select the crypto engine to use with mongoDB.

'auto' is the default and will have the same effect as 'native' when building on Windows or OSX/iOS, and will fallback to 'openssl' on all other platforms.

'native' instructs windows/apple builds to use their OS native crypto libraries.

'openssl' forces all platforms to use the OpenSSL library (current state).

Ticket Scope

Work to do

Description

Added an --ssl-provider SCons flag to use when building the server.

Scope of changes (files that need work and how much)

This won't actually need any changes to the manual. We will need docs for PM-305 itself (which does have numerous changes that touch the manual), but this one is specifically about building the server, which is not something we document.

Impact to other docs outside of this product

Someone will (probably) need to do an update to https://github.com/mongodb/mongo/wiki/Build-Mongodb-From-Source, but that's not something we maintain.

MVP (work and date?)

n/a

Resources (e.g. Scope Docs, Invision)

PM-305 Design Document https://docs.google.com/document/d/1YmjxQoZXqPew6tZDcfGFiDNe0OCMjBtml-0leN-sSQ0/edit#

Checklist

[ x ] Read product documentation (design, spec, scope docs)
[ x ] Look at the code



 Comments   
Comment by Jeffrey Allen [ 24/Jan/18 ]

We will need to update the following page to indicate the new build option: https://docs.mongodb.com/manual/tutorial/configure-ssl-clients/

The relevant package component pages will also need to be updated:
https://docs.mongodb.com/manual/reference/program/mongo/#mongo-shell-ssl
https://docs.mongodb.com/manual/reference/program/mongod/#tls-ssl-options

Generated at Thu Feb 08 08:02:24 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.