diff --git a/build/ci/copy.bara.sky.template b/build/ci/copy.bara.sky.template index f20d057..328e725 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/**", "!source/command/atlas-kubernetes**"]), authoring = authoring.pass_thru(author), transformations = [ - core.move("docs/command", "source/command"), + core.move( + "docs/command/", + "source/command/", + ), ], ) diff --git a/docs/command/atlas-kubernetes-config-apply.txt b/docs/command/atlas-kubernetes-config-apply.txt deleted file mode 100644 index cd8e51b..0000000 --- a/docs/command/atlas-kubernetes-config-apply.txt +++ /dev/null @@ -1,119 +0,0 @@ -.. _atlas-kubernetes-config-apply: - -============================= -atlas kubernetes config apply -============================= - -!!A CHANGE!! - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Generate and apply Kubernetes configuration resources for use with Atlas Kubernetes Operator. - -This command exports configurations for Atlas objects including projects, deployments, and users directly into Kubernetes, allowing you to manage these resources using the Atlas Kubernetes Operator. For more information, see https://www.mongodb.com/docs/atlas/atlas-operator/. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas kubernetes config apply [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 - - strings - - false - - One or more comma separated cluster names to import - * - -h, --help - - - - false - - help for apply - * - --kubeContext - - string - - false - - Name of the kubeconfig context to use. - * - --kubeconfig - - string - - false - - Path to the kubeconfig file to use for CLI requests. - * - --operatorVersion - - string - - false - - Version of Atlas Kubernetes Operator to generate resources for. - * - --orgId - - string - - false - - Organization ID to use. This option overrides the settings in the configuration file or environment variable. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --targetNamespace - - string - - false - - Namespaces to use for generated kubernetes entities - -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. - -Examples --------- - -.. code-block:: - :copyable: false - - # Export and apply all supported resources of a specific project: - atlas kubernetes config apply --projectId= - - -.. code-block:: - :copyable: false - - # Export and apply all supported resources of a specific project and to a specific namespace: - atlas kubernetes config apply --projectId= --targetNamespace= - - -.. code-block:: - :copyable: false - - # Export and apply all supported Project resource, and only the described Deployment resources of a specific project to a specific namespace: - atlas kubernetes config apply --projectId= --clusterName= --targetNamespace= - - -.. code-block:: - :copyable: false - - # Export and apply all supported resources of a specific project to a specific namespace restricting the version of the Atlas Kubernetes Operator: - atlas kubernetes config apply --projectId= --targetNamespace= --operatorVersion=1.5.1 diff --git a/docs/command/atlas-kubernetes-config-generate.txt b/docs/command/atlas-kubernetes-config-generate.txt deleted file mode 100644 index b51afc6..0000000 --- a/docs/command/atlas-kubernetes-config-generate.txt +++ /dev/null @@ -1,142 +0,0 @@ -.. _atlas-kubernetes-config-generate: - -================================ -atlas kubernetes config generate -================================ - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Generate Kubernetes configuration resources for use with Atlas Kubernetes Operator. - -This command exports configurations for Atlas objects including projects, deployments, and users in a Kubernetes-compatible format, allowing you to manage these resources using the Atlas Kubernetes Operator. For more information, see https://www.mongodb.com/docs/atlas/atlas-operator/ - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas kubernetes config generate [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 - - strings - - false - - One or more comma separated cluster names to import - * - --dataFederationName - - strings - - false - - One or more comma separated data federation names to import - * - -h, --help - - - - false - - help for generate - * - --includeSecrets - - - - false - - Flag that generates kubernetes secrets with data for projects, users, deployments entities. - * - --independentResources - - - - false - - Flag that makes the generated resources that support independent usage, to use external IDs rather than Kubernetes references. - * - --operatorVersion - - string - - false - - Version of Atlas Kubernetes Operator to generate resources for. This value defaults to "2.5.0". - * - --orgId - - string - - false - - Organization ID to use. This option overrides the settings in the configuration file or environment variable. - * - --projectId - - string - - false - - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. - * - --targetNamespace - - string - - false - - Namespaces to use for generated kubernetes entities - -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. - -Examples --------- - -.. code-block:: - :copyable: false - - # Export Project, DatabaseUsers, Deployments resources for a specific project without connection and integration secrets: - atlas kubernetes config generate --projectId= - - -.. code-block:: - :copyable: false - - # Export Project, DatabaseUsers, Deployments resources for a specific project, but use external IDs where supported: - atlas kubernetes config generate --projectId= --independentResources - - -.. code-block:: - :copyable: false - - # Export Project, DatabaseUsers, Deployments resources for a specific project including connection and integration secrets: - atlas kubernetes config generate --projectId= --includeSecrets - - -.. code-block:: - :copyable: false - - # Export Project, DatabaseUsers, Deployments resources for a specific project including connection and integration secrets to a specific namespace: - atlas kubernetes config generate --projectId= --includeSecrets --targetNamespace= - - -.. code-block:: - :copyable: false - - # Export Project, DatabaseUsers, DataFederations and specific Deployment resources for a specific project including connection and integration secrets to a specific namespace: - atlas kubernetes config generate --projectId= --clusterName= --includeSecrets --targetNamespace= - - -.. code-block:: - :copyable: false - - # Export resources for a specific version of the Atlas Kubernetes Operator: - atlas kubernetes config generate --projectId= --targetNamespace= --operatorVersion=1.5.1 - - -.. code-block:: - :copyable: false - - # Export Project, DatabaseUsers, Clusters and specific DataFederation resources for a specific project to a specific namespace: - atlas kubernetes config generate --projectId= --dataFederationName= --targetNamespace= diff --git a/docs/command/atlas-kubernetes-config.txt b/docs/command/atlas-kubernetes-config.txt deleted file mode 100644 index 78d1adf..0000000 --- a/docs/command/atlas-kubernetes-config.txt +++ /dev/null @@ -1,63 +0,0 @@ -.. _atlas-kubernetes-config: - -======================= -atlas kubernetes config -======================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Manage Kubernetes configuration resources. - -This command provides your Kubernetes configuration access to Atlas. - -Options -------- - -.. list-table:: - :header-rows: 1 - :widths: 20 10 10 60 - - * - Name - - Type - - Required - - Description - * - -h, --help - - - - false - - help for config - -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-apply` - Generate and apply Kubernetes configuration resources for use with Atlas Kubernetes Operator. -* :ref:`atlas-kubernetes-config-generate` - Generate Kubernetes configuration resources for use with Atlas Kubernetes Operator. - - -.. toctree:: - :titlesonly: - - apply - generate - diff --git a/docs/command/atlas-kubernetes-operator-install.txt b/docs/command/atlas-kubernetes-operator-install.txt deleted file mode 100644 index 881f335..0000000 --- a/docs/command/atlas-kubernetes-operator-install.txt +++ /dev/null @@ -1,164 +0,0 @@ -.. _atlas-kubernetes-operator-install: - -================================= -atlas kubernetes operator install -================================= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Install Atlas Kubernetes Operator to a cluster. - -This command installs a supported version of Atlas Kubernetes Operator to an existing cluster, and optionally imports Atlas resources that are managed by the operator. - -This command creates an API key for the Operator and adds it to Kubernetes as a secret, which the Operator then uses to make Atlas Admin API calls. -The key is scoped to the project when you specify the --projectName option and to the organization when you omit the --projectName option. - -Syntax ------- - -.. code-block:: - :caption: Command Syntax - - atlas kubernetes operator install [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 - * - --atlasGov - - - - false - - Flag that indicates whether to configure Atlas for Government as a target of the operator. - * - -h, --help - - - - false - - help for install - * - --import - - - - false - - Flag that indicates whether to import existing Atlas resources into the cluster for the operator to manage. - * - --kubeContext - - string - - false - - Name of the kubeconfig context to use. - * - --kubeconfig - - string - - false - - Path to the kubeconfig file to use for CLI requests. - * - --operatorVersion - - string - - false - - Version of the operator to install. - * - --orgId - - string - - false - - Organization ID to use. This option overrides the settings in the configuration file or environment variable. - * - --projectName - - string - - false - - Name of the project to create or use with the installed operator. - * - --resourceDeletionProtection - - - - false - - Toggle atlas operator deletion protection for resources like Projects, Deployments, etc. Read more: https://dochub.mongodb.org/core/ako-deletion-protection This value defaults to true. - * - --subresourceDeletionProtection - - - - false - - Toggle atlas operator deletion protection for subresources like Alerts, Integrations, etc. Read more: https://dochub.mongodb.org/core/ako-deletion-protection This value defaults to true. - * - --targetNamespace - - string - - false - - Namespace where to install the operator. - * - --watchNamespace - - strings - - false - - List that contains namespaces that the operator will listen to. - -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. - -Examples --------- - -.. code-block:: - :copyable: false - - # Install latest version of the operator into the default namespace: - atlas kubernetes operator install - - -.. code-block:: - :copyable: false - - # Install the latest version of the operator targeting Atlas for Government instead of regular commercial Atlas: - atlas kubernetes operator install --atlasGov - - -.. code-block:: - :copyable: false - - # Install a specific version of the operator: - atlas kubernetes operator install --operatorVersion=1.7.0 - - -.. code-block:: - :copyable: false - - # Install a specific version of the operator to a namespace and watch only this namespace and a second one: - atlas kubernetes operator install --operatorVersion=1.7.0 --targetNamespace= --watchNamespace=, - - -.. code-block:: - :copyable: false - - # Install and import all objects from an organization: - atlas kubernetes operator install --targetNamespace= --orgID --import - - -.. code-block:: - :copyable: false - - # Install and import objects from a specific project: - atlas kubernetes operator install --targetNamespace= --orgID --projectName --import - - -.. code-block:: - :copyable: false - - # Install the operator and disable deletion protection: - atlas kubernetes operator install --resourceDeletionProtection=false - - -.. code-block:: - :copyable: false - - # Install the operator and disable deletion protection for sub-resources (Atlas project integrations, private endpoints, etc.): - atlas kubernetes operator install --subresourceDeletionProtection=false 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..17f3eb5 --- /dev/null +++ b/docs/command/atlas-liveMigrations-create.txt @@ -0,0 +1,128 @@ +.. _atlas-liveMigrations-create: + +=========================== +atlas liveMigrations create +=========================== + +CONTAINS SOME CHANGE!! + +.. 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 +