Skip to content

DOCS-3806: Add gssapiServiceName, gssapiHostName #2001

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

DOCS-3806: Add gssapiServiceName, gssapiHostName #2001

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions source/includes/options-mongodump.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,20 @@ inherit:
file: options-shared.yaml
---
program: mongodump
name: gssapiServiceName
inherit:
name: gssapiServiceName
program: _shared
file: options-shared.yaml
---
program: mongodump
name: gssapiHostName
inherit:
name: gssapiHostName
program: _shared
file: options-shared.yaml
---
program: mongodump
name: dbpath
inherit:
name: dbpath
Expand Down
14 changes: 14 additions & 0 deletions source/includes/options-mongoexport.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,20 @@ inherit:
file: options-shared.yaml
---
program: mongoexport
name: gssapiServiceName
inherit:
name: gssapiServiceName
program: _shared
file: options-shared.yaml
---
program: mongoexport
name: gssapiHostName
inherit:
name: gssapiHostName
program: _shared
file: options-shared.yaml
---
program: mongoexport
name: dbpath
inherit:
name: dbpath
Expand Down
14 changes: 14 additions & 0 deletions source/includes/options-mongofiles.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,20 @@ inherit:
file: options-shared.yaml
---
program: mongofiles
name: gssapiServiceName
inherit:
name: gssapiServiceName
program: _shared
file: options-shared.yaml
---
program: mongofiles
name: gssapiHostName
inherit:
name: gssapiHostName
program: _shared
file: options-shared.yaml
---
program: mongofiles
name: dbpath
inherit:
name: dbpath
Expand Down
14 changes: 14 additions & 0 deletions source/includes/options-mongoimport.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,20 @@ inherit:
file: options-shared.yaml
---
program: mongoimport
name: gssapiServiceName
inherit:
name: gssapiServiceName
program: _shared
file: options-shared.yaml
---
program: mongoimport
name: gssapiHostName
inherit:
name: gssapiHostName
program: _shared
file: options-shared.yaml
---
program: mongoimport
name: dbpath
inherit:
name: dbpath
Expand Down
14 changes: 14 additions & 0 deletions source/includes/options-mongooplog.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,20 @@ inherit:
file: options-shared.yaml
---
program: mongooplog
name: gssapiServiceName
inherit:
name: gssapiServiceName
program: _shared
file: options-shared.yaml
---
program: mongooplog
name: gssapiHostName
inherit:
name: gssapiHostName
program: _shared
file: options-shared.yaml
---
program: mongooplog
name: dbpath
directive: option
args: <path>
Expand Down
14 changes: 14 additions & 0 deletions source/includes/options-mongorestore.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,20 @@ inherit:
file: options-shared.yaml
---
program: mongorestore
name: gssapiServiceName
inherit:
name: gssapiServiceName
program: _shared
file: options-shared.yaml
---
program: mongorestore
name: gssapiHostName
inherit:
name: gssapiHostName
program: _shared
file: options-shared.yaml
---
program: mongorestore
name: dbpath
inherit:
name: dbpath
Expand Down
8 changes: 8 additions & 0 deletions source/includes/options-mongos.exe.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,14 @@ inherit:
file: options-mongod.exe.yaml
---
program: mongos.exe
default: "MongoS"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is gssapiServiceName supposed to be here?

name: gssapiServiceName
inherit:
name: gssapiServiceName
program: mongod.exe
file: options-mongod.exe.yaml
---
program: mongos.exe
name: serviceDisplayName
default: "Mongo DB Router"
inherit:
Expand Down
14 changes: 14 additions & 0 deletions source/includes/options-mongostat.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,20 @@ inherit:
file: options-shared.yaml
---
program: mongostat
name: gssapiServiceName
inherit:
name: gssapiServiceName
program: _shared
file: options-shared.yaml
---
program: mongostat
name: gssapiHostName
inherit:
name: gssapiHostName
program: _shared
file: options-shared.yaml
---
program: mongostat
name: noheaders
directive: option
args: null
Expand Down
14 changes: 14 additions & 0 deletions source/includes/options-mongotop.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,20 @@ inherit:
file: options-shared.yaml
---
program: mongotop
name: gssapiServiceName
inherit:
name: gssapiServiceName
program: _shared
file: options-shared.yaml
---
program: mongotop
name: gssapiHostName
inherit:
name: gssapiHostName
program: _shared
file: options-shared.yaml
---
program: mongotop
name: locks
directive: option
args: null
Expand Down
52 changes: 52 additions & 0 deletions source/includes/options-shared.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -350,4 +350,56 @@ directive: option
description: |
Specifies the name of the database on which to run the {{program}}.
optional: true
---
program: _shared
name: gssapiServiceName
args: null
directive: option
description: |
Non-default name of the service using SASL. This option allows you to
override the default :doc:`Kerberos
</tutorial/control-access-to-mongodb-with-kerberos-authentication>`
service name component of the :doc:`Kerberos
</tutorial/control-access-to-mongodb-with-kerberos-authentication>`
principal name, on a per-instance basis. If unspecified, the default
value is ``mongodb``.

If you use a non-default value, update the
:setting:`~security.gssapiServiceName` setting with the same value to
allow the mongo shell and any drivers to connect to the :program:`mongo`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should the mongo shell be {{ program }} ?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, we accidentally have
allow the mongo shell and any drivers to connect to the :program:mongo shell. Guessing typo?

shell.

MongoDB permits setting this option only at startup. The
:dbcommand:`setParameter` can not change this setting.

This option is available only in MongoDB Enterprise.

.. important:: Ensure that your driver supports alternate service names.
optional: true
---
program: _shared
name: gssapiHostName
args: null
directive: option
description: |
Non-default hostname of a service using SASL where the hostname of a
machine does not match the hostname resolved by DNS. Some clients and
drivers use the machine hostname as the fully qualified domain name for
:doc:`Kerberos
</tutorial/control-access-to-mongodb-with-kerberos-authentication>`
authentication.

This option allows you to override the default :doc:`Kerberos
</tutorial/control-access-to-mongodb-with-kerberos-authentication>`
hostname component of the :doc:`Kerberos
</tutorial/control-access-to-mongodb-with-kerberos-authentication>`
principal hostname, on a per-instance basis.

This setting permits the mongo shell, drivers, and tools to connect to
the :program:`mongod`.

This option is available only in MongoDB Enterprise.

.. important:: Ensure that your driver supports alternate hostnames.
optional: true
...
4 changes: 4 additions & 0 deletions source/reference/configuration-options.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,8 @@ Core Options

.. include:: /includes/option/setting-conf-security.sasl.serviceName.rst

.. include:: /includes/option/setting-conf-security.gssapiServiceName.rst

.. include:: /includes/option/setting-conf-security.sasl.saslauthdSocketPath.rst

.. include:: /includes/option/setting-conf-security.javascriptEnabled.rst
Expand Down Expand Up @@ -250,6 +252,8 @@ Windows Service Options

.. include:: /includes/option/setting-conf-processManagement.windowsService.serviceName.rst

.. include:: /includes/option/setting-conf-processManagement.windowsService.gssapiServiceName.rst

.. include:: /includes/option/setting-conf-processManagement.windowsService.displayName.rst

.. include:: /includes/option/setting-conf-processManagement.windowsService.description.rst
Expand Down
2 changes: 2 additions & 0 deletions source/reference/program/mongo.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,8 @@ SSL Options

.. include:: /includes/option/option-mongo-sslAllowInvalidCertificates.rst

.. include:: /includes/option/option-mongo-gssapiHostName.rst
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to include the gssapiServiceName as well?


Files
-----

Expand Down
4 changes: 4 additions & 0 deletions source/reference/program/mongodump.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,10 @@ Options

.. include:: /includes/option/option-mongodump-authenticationMechanism.rst

.. include:: /includes/option/option-mongodump-gssapiServiceName.rst

.. include:: /includes/option/option-mongodump-gssapiHostName.rst

.. include:: /includes/option/option-mongodump-dbpath.rst

.. include:: /includes/option/option-mongodump-directoryperdb.rst
Expand Down
4 changes: 4 additions & 0 deletions source/reference/program/mongoexport.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,10 @@ Options

.. include:: /includes/option/option-mongoexport-authenticationMechanism.rst

.. include:: /includes/option/option-mongoexport-gssapiServiceName.rst

.. include:: /includes/option/option-mongoexport-gssapiHostName.rst

.. include:: /includes/option/option-mongoexport-dbpath.rst

.. include:: /includes/option/option-mongoexport-directoryperdb.rst
Expand Down
4 changes: 4 additions & 0 deletions source/reference/program/mongofiles.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,10 @@ Options

.. include:: /includes/option/option-mongofiles-authenticationMechanism.rst

.. include:: /includes/option/option-mongofiles-gssapiServiceName.rst

.. include:: /includes/option/option-mongofiles-gssapiHostName.rst

.. include:: /includes/option/option-mongofiles-dbpath.rst

.. include:: /includes/option/option-mongofiles-directoryperdb.rst
Expand Down
4 changes: 4 additions & 0 deletions source/reference/program/mongoimport.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,10 @@ Options

.. include:: /includes/option/option-mongoimport-authenticationMechanism.rst

.. include:: /includes/option/option-mongoimport-gssapiServiceName.rst

.. include:: /includes/option/option-mongoimport-gssapiHostName.rst

.. include:: /includes/option/option-mongoimport-dbpath.rst

.. include:: /includes/option/option-mongoimport-directoryperdb.rst
Expand Down
4 changes: 4 additions & 0 deletions source/reference/program/mongooplog.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,10 @@ Options

.. include:: /includes/option/option-mongooplog-authenticationMechanism.rst

.. include:: /includes/option/option-mongooplog-gssapiServiceName.rst

.. include:: /includes/option/option-mongooplog-gssapiHostName.rst

.. include:: /includes/option/option-mongooplog-dbpath.rst

.. include:: /includes/option/option-mongooplog-directoryperdb.rst
Expand Down
4 changes: 4 additions & 0 deletions source/reference/program/mongorestore.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,10 @@ Options

.. include:: /includes/option/option-mongorestore-authenticationMechanism.rst

.. include:: /includes/option/option-mongorestore-gssapiServiceName.rst

.. include:: /includes/option/option-mongorestore-gssapiHostName.rst

.. include:: /includes/option/option-mongorestore-dbpath.rst

.. include:: /includes/option/option-mongorestore-directoryperdb.rst
Expand Down
2 changes: 2 additions & 0 deletions source/reference/program/mongos.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,8 @@ SSL Options
.. include:: /includes/option/option-mongos-sslFIPSMode.rst


.. include:: /includes/option/option-mongo-gssapiServiceName.rst
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this supposed to be here? I want to say no


Audit Options
~~~~~~~~~~~~~

Expand Down
4 changes: 4 additions & 0 deletions source/reference/program/mongostat.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,10 @@ Options

.. include:: /includes/option/option-mongostat-authenticationMechanism.rst

.. include:: /includes/option/option-mongostat-gssapiServiceName.rst

.. include:: /includes/option/option-mongostat-gssapiHostName.rst

.. include:: /includes/option/option-mongostat-noheaders.rst

.. include:: /includes/option/option-mongostat-rowcount.rst
Expand Down
4 changes: 4 additions & 0 deletions source/reference/program/mongotop.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,10 @@ Options

.. include:: /includes/option/option-mongotop-authenticationMechanism.rst

.. include:: /includes/option/option-mongotop-gssapiServiceName.rst

.. include:: /includes/option/option-mongotop-gssapiHostName.rst

.. include:: /includes/option/option-mongotop-locks.rst

.. include:: /includes/option/option-mongotop-<sleeptime>.rst
Expand Down