From dce67dfb3c02ff1d98613c94aaf16d4d623a8b2e Mon Sep 17 00:00:00 2001 From: Melanija Cvetic Date: Mon, 16 Dec 2024 12:01:39 +0000 Subject: [PATCH] Testing moving all docs bar atlas-kubernetes --- build/ci/copy.bara.sky.template | 7 +- docs/command/atlas-kubernetes-operator.txt | 61 --------- docs/command/atlas-kubernetes.txt | 63 --------- docs/command/atlas-liveMigrations-create.txt | 126 ++++++++++++++++++ docs/command/atlas-liveMigrations-cutover.txt | 82 ++++++++++++ docs/command/atlas-liveMigrations.txt | 67 ++++++++++ 6 files changed, 280 insertions(+), 126 deletions(-) delete mode 100644 docs/command/atlas-kubernetes-operator.txt delete mode 100644 docs/command/atlas-kubernetes.txt create mode 100644 docs/command/atlas-liveMigrations-create.txt create mode 100644 docs/command/atlas-liveMigrations-cutover.txt create mode 100644 docs/command/atlas-liveMigrations.txt diff --git a/build/ci/copy.bara.sky.template b/build/ci/copy.bara.sky.template index f20d057..7571aef 100644 --- a/build/ci/copy.bara.sky.template +++ b/build/ci/copy.bara.sky.template @@ -21,10 +21,13 @@ core.workflow( body = "Copies Atlas CLI commands from the source repo. See the attached Netlify comment for build log and staging.", integrates = [], ), - origin_files = glob(["docs/command/atlas-kubernetes**"]), - destination_files = glob(["source/command/atlas-kubernetes**"]), + origin_files = glob(["docs/command/**"]), + destination_files = glob(["source/command/**"]), authoring = authoring.pass_thru(author), transformations = [ + # Move all files from docs/command to source/command core.move("docs/command", "source/command"), + # Add this exclude transformation to keep atlas-kubernetes files in destination + core.exclude_paths(glob(["source/command/atlas-kubernetes**"])), ], ) diff --git a/docs/command/atlas-kubernetes-operator.txt b/docs/command/atlas-kubernetes-operator.txt deleted file mode 100644 index 47d7302..0000000 --- a/docs/command/atlas-kubernetes-operator.txt +++ /dev/null @@ -1,61 +0,0 @@ -.. _atlas-kubernetes-operator: - -========================= -atlas kubernetes operator -========================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage Atlas Kubernetes Operator. - -This command manages the Atlas Kubernetes Operator. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for operator - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - 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. - -Related Commands ----------------- - -* :ref:`atlas-kubernetes-operator-install` - Install Atlas Kubernetes Operator to a cluster. - - -.. toctree:: - :titlesonly: - - install - diff --git a/docs/command/atlas-kubernetes.txt b/docs/command/atlas-kubernetes.txt deleted file mode 100644 index 5c8586c..0000000 --- a/docs/command/atlas-kubernetes.txt +++ /dev/null @@ -1,63 +0,0 @@ -.. _atlas-kubernetes: - -================ -atlas kubernetes -================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage Kubernetes resources. - -This command provides access to Kubernetes features within Atlas. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for kubernetes - -Inherited Options ------------------ - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -P, --profile - - string - - 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. - -Related Commands ----------------- - -* :ref:`atlas-kubernetes-config` - Manage Kubernetes configuration resources. -* :ref:`atlas-kubernetes-operator` - Manage Atlas Kubernetes Operator. - - -.. toctree:: - :titlesonly: - - config - operator - diff --git a/docs/command/atlas-liveMigrations-create.txt b/docs/command/atlas-liveMigrations-create.txt new file mode 100644 index 0000000..dbdd664 --- /dev/null +++ b/docs/command/atlas-liveMigrations-create.txt @@ -0,0 +1,126 @@ +.. _atlas-liveMigrations-create: + +=========================== +atlas liveMigrations create +=========================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create a new push live migration. + +To migrate using scripts, use mongomirror instead of the Atlas CLI. To learn more about mongomirror, see https://www.mongodb.com/docs/atlas/reference/mongomirror/. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas liveMigrations create [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - --clusterName + - string + - true + - Human-readable label that identifies the Atlas destination cluster. + * - --drop + - + - false + - Flag that indicates whether this process should drop existing collections from the destination (Atlas) cluster given in --destinationClusterName before starting the migration of data from the source cluster. + * - --force + - + - false + - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. + * - -h, --help + - + - false + - help for create + * - --migrationHost + - strings + - true + - List of hosts running the MongoDB Agent that can transfer your MongoDB data from the source (Cloud Manager or Ops Manager) to destination (Atlas) deployments. Each live migration process uses its own dedicated migration host. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + * - --sourceCACertificatePath + - string + - false + - Path to the CA certificate that signed TLS certificates use to authenticate to the source Cloud Manager or Ops Manager cluster. Omit this value if --sourceSSL is not passed. + * - --sourceClusterName + - string + - true + - Human-readable label that identifies the source Cloud Manager or Ops Manager cluster. + * - --sourceManagedAuthentication + - + - false + - Flag that indicates whether MongoDB Automation manages authentication to the source Cloud Manager or Ops Manager cluster. If you set this to true, don't provide values for --sourceUsername and --sourcePassword. + + Mutually exclusive with --sourceUsername. + * - -p, --sourcePassword + - string + - false + - Password that authenticates the username to the source Cloud Manager or Ops Manager cluster. Omit this value if --sourceManagedAuthentication is passed. + * - --sourceProjectId + - string + - true + - Unique 24-hexadecimal digit string that identifies the source project. + * - --sourceSsl + - + - false + - Flag that indicates whether data source has TLS enabled. + * - -u, --sourceUsername + - string + - false + - Human-readable label that identifies the SCRAM-SHA user that connects to the source Cloud Manager or Ops Manager cluster. Omit this value if --sourceManagedAuthentication is set. + + Mutually exclusive with --sourceManagedAuthentication. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - 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:: + + ID LAGTIME READY FOR CUTOVER STATUS + + diff --git a/docs/command/atlas-liveMigrations-cutover.txt b/docs/command/atlas-liveMigrations-cutover.txt new file mode 100644 index 0000000..b52d4f9 --- /dev/null +++ b/docs/command/atlas-liveMigrations-cutover.txt @@ -0,0 +1,82 @@ +.. _atlas-liveMigrations-cutover: + +============================ +atlas liveMigrations cutover +============================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Start the cutover for a push live migration and confirm when the cutover completes. When the cutover completes, the application completes the live migration process and stops synchronizing with the source cluster. + +To migrate using scripts, use mongomirror instead of the Atlas CLI. To learn more about mongomirror, see https://www.mongodb.com/docs/atlas/reference/mongomirror/. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas liveMigrations cutover [options] + +.. Code end marker, please don't delete this comment + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for cutover + * - --liveMigrationId + - string + - true + - Unique 24-hexadecimal digit string that identifies the live migration job. + * - -o, --output + - string + - false + - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. + * - --projectId + - string + - false + - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - 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:: + + Cutover process successfully started. + + diff --git a/docs/command/atlas-liveMigrations.txt b/docs/command/atlas-liveMigrations.txt new file mode 100644 index 0000000..015e145 --- /dev/null +++ b/docs/command/atlas-liveMigrations.txt @@ -0,0 +1,67 @@ +.. _atlas-liveMigrations: + +==================== +atlas liveMigrations +==================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage a Live Migration to Atlas for your organization. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for liveMigrations + +Inherited Options +----------------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -P, --profile + - string + - 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. + +Related Commands +---------------- + +* :ref:`atlas-liveMigrations-create` - Create a new push live migration. +* :ref:`atlas-liveMigrations-cutover` - Start the cutover for a push live migration and confirm when the cutover completes. When the cutover completes, the application completes the live migration process and stops synchronizing with the source cluster. +* :ref:`atlas-liveMigrations-describe` - Return a push live migration job. +* :ref:`atlas-liveMigrations-link` - Manage the link-token for your organization. +* :ref:`atlas-liveMigrations-validation` - Manage a Live Migration validation job for your project. + + +.. toctree:: + :titlesonly: + + create + cutover + describe + link + validation +