From 6b763d5e5027755afcd50a8844a5a53ef12827c0 Mon Sep 17 00:00:00 2001 From: Adrian Velonis Date: Tue, 7 Jan 2025 09:54:58 -0600 Subject: [PATCH] PD-5464: MongoDB config roles OSS/Pro --- .../database-mongodb-configure-prerequisites.flsnp | 3 ++- ...er-roles-mongodb-pro.htm => config-user-roles.htm} | 11 +++++------ Content/start/tutorials/mongodb-pro/home.htm | 10 +++++----- .../mongodb-community-enterprise-server.htm | 8 ++++---- Project/TOCs/TOC.fltoc | 2 +- 5 files changed, 17 insertions(+), 17 deletions(-) rename Content/start/tutorials/mongodb-pro/{config-user-roles-mongodb-pro.htm => config-user-roles.htm} (79%) diff --git a/Content/Z_Resources/Snippets/text/database-mongodb-configure-prerequisites.flsnp b/Content/Z_Resources/Snippets/text/database-mongodb-configure-prerequisites.flsnp index 7aa88b137..09a87e40a 100644 --- a/Content/Z_Resources/Snippets/text/database-mongodb-configure-prerequisites.flsnp +++ b/Content/Z_Resources/Snippets/text/database-mongodb-configure-prerequisites.flsnp @@ -3,7 +3,8 @@

Configure MongoDB

    -
  1. Ensure that your MongoDB Pro Extension User Roles are established before continuing.
    2. +
  2. + Configure User Roles for MongoDB before continuing.
  3. Download and Install mongosh if it is not already installed on your machine.

    4. mongosh is mandatory to use MongoDB with and it must be accessible to . We recommend that mongosh is in the system PATH environment variable. If it is not, that location of mongosh must be manually specified in the liquibase.mongosh.conf file.

  4. Download Java 11. The MongoDB Pro extension requires it.
    5. diff --git a/Content/start/tutorials/mongodb-pro/config-user-roles-mongodb-pro.htm b/Content/start/tutorials/mongodb-pro/config-user-roles.htm similarity index 79% rename from Content/start/tutorials/mongodb-pro/config-user-roles-mongodb-pro.htm rename to Content/start/tutorials/mongodb-pro/config-user-roles.htm index 1a3eed8ba..95b0ca1bf 100644 --- a/Content/start/tutorials/mongodb-pro/config-user-roles-mongodb-pro.htm +++ b/Content/start/tutorials/mongodb-pro/config-user-roles.htm @@ -6,10 +6,9 @@ - -

    Configuring User Roles for MongoDB Pro

    -

    The MongoDB Pro Extension accesses MongoDB as a user and respects all MongoDB role-based security structures. That means that you must provide sufficient privileges to the user ID that is using so that can operate the way you want.

    -

    This guide discusses two approaches to creating a user with sufficient privileges for and the MongoDB Pro Extension to perform all of their functionality. The two methods include the built-in roles method and the user-defined role method. It is possible to create more restrictive setups, but depending on which restrictions are imposed, some and Mongo DB Pro Extension features may not work.

    +

    Configure User Roles for MongoDB

    +

    The MongoDB Pro Extension and OSS extension access MongoDB as a user and respects all MongoDB role-based security structures. That means that you must provide sufficient privileges to the user ID that is using so that can operate the way you want.

    +

    This guide discusses two approaches to creating a user with sufficient privileges for and the MongoDB extension to perform all of their functionality. The two methods include the built-in roles method and the user-defined role method. It is possible to create more restrictive setups, but depending on which restrictions are imposed, some and MongoDB extension features may not work.

    Role requirements

    The two methods to create a user with privileges for include the built-in roles method and the user-defined role method. The built-in role method allows you to provide different levels of access commonly needed in a database system. The user-defined role method allows for custom role creation when the built-in roles cannot describe the privileges necessary for the job.

    Permissions: roles required to manage non-administrative database changes

    @@ -29,8 +28,8 @@

    Roles Required to Manage Administrative Tasks

    As a MongoDB administrator, you have the ability to create a user using these standard roles or you can create your own custom roles. supports both approaches as long as the resulting permissions meet the above requirements.

    Built-in roles method

    -

    This method allows you to create a user that has readWrite and dbAdmin roles. when dbAdmin roles are enabled, this user can run the MongoDB extension directly from the administrative perspective. As mentioned above, the built-in role method allows you to provide different levels of access commonly needed in a database system. If you need a user to have administrative access, use this guide.

    -

    Without dbAdmin role permissions, you cannot run the MongoDB Pro extension from the administrative perspective.

    +

    This method allows you to create a user that has readWrite and dbAdmin roles. when dbAdmin roles are enabled, this user can run the MongoDB extension directly from the administrative perspective. As mentioned above, the built-in role method allows you to provide different levels of access commonly needed in a database system. If you need a user to have administrative access, use this guide.

    +

    Without dbAdmin role permissions, you cannot run the MongoDB extension from the administrative perspective.

    Create a user with the built-in readWrite and dbAdmin roles by executing the following code in one of two ways:

    1. With your own user, password, and database content, use Mongo Shell directly in MongoDB to execute the code.
      2. diff --git a/Content/start/tutorials/mongodb-pro/home.htm b/Content/start/tutorials/mongodb-pro/home.htm index 14fd8f444..616b0d6b2 100644 --- a/Content/start/tutorials/mongodb-pro/home.htm +++ b/Content/start/tutorials/mongodb-pro/home.htm @@ -12,7 +12,7 @@

      Using MongoDB Pro with MongoDB

      You can use with several MongoDB providers, including MongoDB Atlas, MongoDB Community Server, MongoDB Enterprise Server, and the Amazon DocumentDB clone. The MongoDB Pro extension lets you use all the features of with MongoDB, including Policy Checks, Secrets Management, and [%=General.StructuredLogging%]. These features enhance your database's security, reliability, and compatibility with other tools in your development pipeline.

      Using with MongoDB is similar to using it with other databases. You still track changes within s in s, and use commands such as update and rollback to deploy changes and manage your database. However, because MongoDB does not use SQL, you cannot use SQL s or commands that generate SQL output.

      -

      To learn how to specify changes in each format, see Use Native Executors with MongoDB Pro.

      +

      To learn how to specify changes in each format, see Use Native Executors with MongoDB Pro.

      Getting started tutorials

      To learn how to configure the MongoDB Pro extension with your installation of MongoDB, see the following topics:

        @@ -51,7 +51,7 @@

        Supported commands

      • Policy checks commands. For example, copy, show, and run are supported.
      • All other commands, unless otherwise specified in the Limitations section.
      -

      For more information, see About [%=General.Liquibase%] Commands.

      +

      For more information, see [%=General.Liquibase%] Commands.

      Supported policy checks

      You can use -scoped policy checks in MongoDB Pro. For example:

        @@ -68,7 +68,7 @@

        Supported policy checks

      • RollbackRequired
        • -
      • RequireChangesetDisUUID +
      • RequireChangesetIDisUUID
      • SqlUserDefinedPatternCheck
        • @@ -79,7 +79,7 @@

        Limitations

        // changeset authorname:1 runWith:mongosh
      •  preconditions are not supported.
      • The modifyChangeSets tag is not supported.
        • -
      • MongoDB is a NoSQL database, so you cannot use any commands that generate SQL output (such as update-sql and changelog-sync-sql). MongoDB also does not support the database inspection command family (such as diff and generate-changelog). Learn more About [%=General.Liquibase%] Commands here.
        • +
      • MongoDB is a NoSQL database, so you cannot use any commands that generate SQL output (such as update-sql and changelog-sync-sql). MongoDB also does not support the database inspection command family (such as diff and generate-changelog). Learn more [%=General.Liquibase%] Commands here.
      • policy checks have limited support. Database-scoped policy checks are not supported because they are database-specific.
      • OIDC authentication is supported only for MongoDB Atlas. LDAP and Kerberos authentication are not supported for any MongoDB platform. Learn more about MongoDB authentication here: authentication.
      @@ -165,7 +165,7 @@

      Deprecated database versions

      Related links

      • - Configuring User Roles for MongoDB Pro + Configure User Roles for MongoDB
      diff --git a/Content/start/tutorials/mongodb-pro/mongodb-community-enterprise-server.htm b/Content/start/tutorials/mongodb-pro/mongodb-community-enterprise-server.htm index a99a965e0..296734360 100644 --- a/Content/start/tutorials/mongodb-pro/mongodb-community-enterprise-server.htm +++ b/Content/start/tutorials/mongodb-pro/mongodb-community-enterprise-server.htm @@ -9,7 +9,7 @@

      Using MongoDB Pro with MongoDB Community and Enterprise Server

      MongoDB offers several NoSQL database products. This guide describes how to use MongoDB Pro with MongoDB Community Server and MongoDB Enterprise Server. You need a license key to use it.

      -

      This guide does not imply support for third-party clones or emulations of MongoDB. For a tutorial on using with Amazon DocumentDB, see MongoDB Pro and Amazon DocumentDB. This guide also does not describe the community-maintained MongoDB extension. For information on that extension, see Contribute Docs: Use Liquibase with MongoDB.

      +

      This guide does not imply support for third-party clones or emulations of MongoDB. For a tutorial on using with Amazon DocumentDB, see Using [%=General.Liquibase%] MongoDB Pro with Amazon DocumentDB. This guide also does not describe the community-maintained MongoDB extension. For information on that extension, see Contribute Docs: Use Liquibase with MongoDB.

      Verified database versions

      @@ -73,13 +73,13 @@

      Test connection

      Related links

      • - MongoDB Pro Extension User Roles + Configure User Roles for MongoDB
      • - MongoDB Pro and Amazon DocumentDB + Using [%=General.Liquibase%] MongoDB Pro with Amazon DocumentDB
      • - MongoDB Atlas + Using [%=General.Liquibase%] MongoDB Pro with MongoDB Atlas
      • Contributor Docs: Open Source MongoDB Extension
        • diff --git a/Project/TOCs/TOC.fltoc b/Project/TOCs/TOC.fltoc index d0bb6b21e..223c4e481 100644 --- a/Project/TOCs/TOC.fltoc +++ b/Project/TOCs/TOC.fltoc @@ -130,7 +130,7 @@ Link="/Content/start/tutorials/mongodb-pro/mongodb-community-enterprise-server.htm" xmlns:MadCap="http://www.madcapsoftware.com/Schemas/MadCap.xsd" /> + Link="/Content/start/tutorials/mongodb-pro/config-user-roles.htm" xmlns:MadCap="http://www.madcapsoftware.com/Schemas/MadCap.xsd" />