Skip to content

Commit

Permalink
Merge pull request #6240 from dimagi/gh/data-migration/doc-updates
Browse files Browse the repository at this point in the history
Various documentation updates for data migration
  • Loading branch information
gherceg authored Mar 8, 2024
2 parents d5a3e9b + 09b510f commit 9284d07
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 9 deletions.
2 changes: 2 additions & 0 deletions docs/source/installation/migration/1-migrating-project.rst
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,8 @@ will be unable to submit forms or sync with the server.
* Proceed to step 4.


.. _import-data-into-environment:

4. Import the data to the new environment
-----------------------------------------

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Migrating an entire CommCare HQ instance

This document describes high level steps to migrate an entire CommCare HQ instance from one set of servers
to another set of servers. If you are looking to migrate just a single project to a new environment
please see :ref:`migrate-instance`. You can also use that method if you care about
please see :ref:`migrate-project`. You can also use that method if you care about
only a single project in your environment and don't need other projects.

There are database and application services in a CommCare HQ instance. Only the data for database services need to be
Expand Down
24 changes: 16 additions & 8 deletions docs/source/reference/howto/wipe_persistent_data.rst
Original file line number Diff line number Diff line change
Expand Up @@ -101,22 +101,30 @@ Rebuilding environment
$ cchq <env_name> django-manage create_kafka_topics
.. note::
.. warning::

If you are migrating a project to a new environment, you can return to the steps outlined in
`Import the data to the new environment <installation/migration/1-migrating-project.html#import-the-data-to-the-new-environment>`_.
Otherwise, you can continue with the following steps.
If you are migrating a project to a new environment, return to the steps outlined in
:ref:`import-data-into-environment`. Do not start services back up until you have finished loading
data into your new environment.

#. Run a code deploy to start CommCare back up.

Start new environment
---------------------

.. note::

The following steps should only be run if you are **not** planning to migrate a project from an existing environment.


#. End downtime (you will encounter a prompt that says no record of downtime was found, continue anyway as this starts services up).

.. code-block::
$ cchq <env_name> deploy
$ cchq <env_name> downtime end
#. Recreate a superuser (where you substitute your address in place of
"you@your.domain"). This is optional and should not be performed if
you are planning to migrate domain from other environment.
"you@your.domain").

.. code-block::
Expand Down

0 comments on commit 9284d07

Please sign in to comment.