CLOUDP-181606 Deprecate current Data Lake commands (#2048)

Co-authored-by: Wojciech Trocki <[email protected]>
Co-authored-by: zach-carr <[email protected]>

Author: 3 people

Makefile

@@ -111,12 +111,12 @@ gen-docs: gen-docs-mongocli gen-docs-atlascli ## Generate docs for commands
 .PHONY: gen-docs-mongocli
 gen-docs-mongocli: ## Generate docs for mongocli commands
 	@echo "==> Generating docs for mongocli"
-	go run ./tools/mongoclidocs/main.go
+	go run -ldflags "$(MCLI_LINKER_FLAGS)" ./tools/mongoclidocs/main.go
 
 .PHONY: gen-docs-atlascli
 gen-docs-atlascli: ## Generate docs for atlascli commands
 	@echo "==> Generating docs for atlascli"
-	go run ./tools/atlasclidocs/main.go
+	go run -ldflags "$(ATLAS_LINKER_FLAGS)" ./tools/atlasclidocs/main.go
 
 .PHONY: build
 build: build-mongocli ## Generate a binary for mongocli

build/ci/evergreen.yml

@@ -794,27 +794,6 @@ tasks:
           MCLI_OPS_MANAGER_URL: ${mcli_ops_manager_url}
           MCLI_SERVICE: cloud
           E2E_TAGS: atlas,networking
-  # datalake requires cloud provider role authentication and an s3 bucket created
-  - name: atlas_datalake_e2e
-    tags: ["e2e","datalake","atlas"]
-    must_have_test_results: true
-    depends_on:
-      - name: compile
-        variant: "code_health"
-        patch_optional: true
-    commands:
-      - func: "install gotestsum"
-      - func: "e2e test"
-        vars:
-          MCLI_ORG_ID: ${atlas_org_id}
-          MCLI_PROJECT_ID: ${atlas_project_id}
-          MCLI_PRIVATE_API_KEY: ${atlas_private_api_key}
-          MCLI_PUBLIC_API_KEY: ${atlas_public_api_key}
-          MCLI_OPS_MANAGER_URL: ${mcli_ops_manager_url}
-          MCLI_SERVICE: cloud
-          E2E_TAGS: atlas,datalake
-          E2E_TEST_BUCKET: ${e2e_test_bucket}
-          E2E_CLOUD_ROLE_ID: ${e2e_cloud_role_id}
   # datafederation requires cloud provider role authentication and an s3 bucket created
   - name: atlas_datafederation_db_e2e
     tags: ["e2e","datafederation","atlas"]
@@ -1505,16 +1484,6 @@ buildvariants:
       go_base_path: ""
     tasks:
       - name: ".e2e .livemigrations .atlas"
-  - name: e2e_atlas_datalake
-    display_name: "E2E Atlas Datalake Tests"
-    run_on:
-      - rhel80-small
-    expansions:
-      go_root: "/opt/golang/go1.19"
-      go_bin: "/opt/golang/go1.19/bin"
-      go_base_path: ""
-    tasks:
-      - name: ".e2e .datalake .atlas"
   - name: e2e_atlas_datafederation
     display_name: "E2E Atlas Data Federation Tests"
     run_on:

docs/atlascli/command/atlas-dataLakes-create.txt renamed to docs/atlascli/command/atlas-dataFederation-create.txt

@@ -1,8 +1,8 @@
-.. _atlas-dataLakes-create:
+.. _atlas-dataFederation-create:
 
-======================
-atlas dataLakes create
-======================
+===========================
+atlas dataFederation create
+===========================
 
 .. default-domain:: mongodb
 
@@ -12,17 +12,17 @@ atlas dataLakes create
    :depth: 1
    :class: singlecol
 
-Create a new federated database instance for your project.
+Creates a new Data Federation database.
 
-To learn more about Atlas Data Federation (previously named Atlas Data Lake), see https://www.mongodb.com/docs/atlas/data-federation/overview/.
+To use this command, you must authenticate with a user account or an API key that has the Project Owner role.
 
 Syntax
 ------
 
 .. code-block::
    :caption: Command Syntax
 
-   atlas dataLakes create <name> [options]
+   atlas dataFederation create <name> [options]
 
 .. Code end marker, please don't delete this comment
 
@@ -40,7 +40,7 @@ Arguments
    * - name
      - string
      - true
-     - Name of the federated database instance to create.
+     - Name of the data federation database.
 
 Options
 -------
@@ -53,6 +53,18 @@ Options
      - Type
      - Required
      - Description
+   * - --awsRoleId
+     - string
+     - false
+     - Amazon Resource Name (ARN) of the role which Atlas Data Federation uses for accessing the data stores.
+   * - --awsTestS3Bucket
+     - string
+     - false
+     - Name of an Amazon S3 data bucket which Atlas Data Federation uses to validate the provided role.
+   * - -f, --file
+     - string
+     - false
+     - Path to an optional JSON configuration file that defines data federation settings.
    * - -h, --help
      - 
      - false
@@ -65,14 +77,10 @@ Options
      - string
      - false
      - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
-   * - --role
+   * - --region
      - string
-     - true
-     - Amazon Resource Name (ARN) of the role which Atlas Data Federation uses for accessing the data stores.
-   * - --testBucket
-     - string
-     - true
-     - Name of an Amazon S3 data bucket which Atlas Data Federation uses to validate the provided role.
+     - false
+     - Name of the region to which Atlas Data Federation routes client connections for data processing.
 
 Inherited Options
 -----------------
@@ -97,13 +105,13 @@ If the command succeeds, the CLI returns output similar to the following sample.
 
 .. code-block::
 
-   Data lake '<Name>' created.
-   
+   Data federation <Name> created.
 
 Examples
 --------
 
 .. code-block::
 
-   # Create a federated database instance named myFDI in the project with the ID 5e2211c17a3e5a48f5497de3:
-   atlas dataLakes create myFDI --projectId 5e2211c17a3e5a48f5497de3 --output json
+   # create data federation database:
+   atlas dataFederation create DataFederation1 --region us_east_1 --awsRoleId role --awsTestS3Bucket bucket
+

docs/atlascli/command/atlas-privateEndpoints-dataLakes-aws-delete.txt renamed to docs/atlascli/command/atlas-dataFederation-delete.txt

@@ -1,8 +1,8 @@
-.. _atlas-privateEndpoints-dataLakes-aws-delete:
+.. _atlas-dataFederation-delete:
 
-===========================================
-atlas privateEndpoints dataLakes aws delete
-===========================================
+===========================
+atlas dataFederation delete
+===========================
 
 .. default-domain:: mongodb
 
@@ -12,7 +12,7 @@ atlas privateEndpoints dataLakes aws delete
    :depth: 1
    :class: singlecol
 
-Delete a specific Data Lake private endpoint for your project.
+Remove the specified data federation database from your project.
 
 To use this command, you must authenticate with a user account or an API key that has the Project Owner role.
 
@@ -22,7 +22,7 @@ Syntax
 .. code-block::
    :caption: Command Syntax
 
-   atlas privateEndpoints dataLakes aws delete <privateEndpointId> [options]
+   atlas dataFederation delete <name> [options]
 
 .. Code end marker, please don't delete this comment
 
@@ -37,10 +37,10 @@ Arguments
      - Type
      - Required
      - Description
-   * - privateEndpointId
+   * - name
      - string
      - true
-     - Unique 22-character alphanumeric string that identifies the private endpoint.
+     - Name of the data federation database.
 
 Options
 -------
@@ -89,12 +89,14 @@ If the command succeeds, the CLI returns output similar to the following sample.
 
 .. code-block::
 
-   Private endpoint '<Name>' deleted
+   '<Name>' deleted
 
 
 Examples
 --------
 
 .. code-block::
 
-   atlas privateEndpoint dataLake aws delete vpce-0fcd9d80bbafe1607 --force
+   # deletes data federation 'DataFederation1':
+   atlas dataFederation delete DataFederation1
+

docs/atlascli/command/atlas-dataLakes-describe.txt renamed to docs/atlascli/command/atlas-dataFederation-describe.txt

@@ -1,8 +1,8 @@
-.. _atlas-dataLakes-describe:
+.. _atlas-dataFederation-describe:
 
-========================
-atlas dataLakes describe
-========================
+=============================
+atlas dataFederation describe
+=============================
 
 .. default-domain:: mongodb
 
@@ -12,17 +12,17 @@ atlas dataLakes describe
    :depth: 1
    :class: singlecol
 
-Return the details for the specified federated database instance.
+Return the details for the specified data federation database for your project.
 
-To learn more about Atlas Data Federation (previously named Atlas Data Lake), see https://www.mongodb.com/docs/atlas/data-federation/overview/.
+To use this command, you must authenticate with a user account or an API key that has the Project Owner role.
 
 Syntax
 ------
 
 .. code-block::
    :caption: Command Syntax
 
-   atlas dataLakes describe <name> [options]
+   atlas dataFederation describe <name> [options]
 
 .. Code end marker, please don't delete this comment
 
@@ -40,7 +40,7 @@ Arguments
    * - name
      - string
      - true
-     - Name of the federated database instance to retrieve.
+     - Name of the data federation database.
 
 Options
 -------
@@ -82,21 +82,11 @@ Inherited Options
      - false
      - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.
 
-Output
-------
-
-If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.
-
-.. code-block::
-
-   NAME     STATE
-   <Name>   <State>
-   
-
 Examples
 --------
 
 .. code-block::
 
-   # Return the details for the federated database instance named myFDI in the project with the ID 5e2211c17a3e5a48f5497de3:
-   atlas dataLakes describe myFDI --projectId 5e2211c17a3e5a48f5497de3 --output json
+   # retrieves data federation 'DataFederation1':
+   atlas dataFederation describe DataFederation1
+

docs/atlascli/command/atlas-dataLakes-list.txt renamed to docs/atlascli/command/atlas-dataFederation-list.txt

@@ -1,8 +1,8 @@
-.. _atlas-dataLakes-list:
+.. _atlas-dataFederation-list:
 
-====================
-atlas dataLakes list
-====================
+=========================
+atlas dataFederation list
+=========================
 
 .. default-domain:: mongodb
 
@@ -12,17 +12,17 @@ atlas dataLakes list
    :depth: 1
    :class: singlecol
 
-Return all federated database instances for your project.
+Returns all data federation databases for your project.
 
-To learn more about Atlas Data Federation (previously named Atlas Data Lake), see https://www.mongodb.com/docs/atlas/data-federation/overview/.
+To use this command, you must authenticate with a user account or an API key that has the Project Read Only role.
 
 Syntax
 ------
 
 .. code-block::
    :caption: Command Syntax
 
-   atlas dataLakes list [options]
+   atlas dataFederation list [options]
 
 .. Code end marker, please don't delete this comment
 
@@ -49,6 +49,10 @@ Options
      - string
      - false
      - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
+   * - --type
+     - string
+     - false
+     - Type of Federated Database Instances to return.
 
 Inherited Options
 -----------------
@@ -71,5 +75,6 @@ Examples
 
 .. code-block::
 
-   # Return a JSON-formatted list of all federated database instances in the project with the ID 5e2211c17a3e5a48f5497de3:
-   atlas dataLakes list --projectId 5e2211c17a3e5a48f5497de3 --output json
+   # list all data federation databases:
+   atlas dataFederation list
+