OAS-11485 | Add warning regarding single server upgrade to cluster in ArangoGraph (#798)

nerpaula · web-flow · commit 8a3c37dd3e84 · 2025-10-07T16:06:14.000+02:00
* add warning regarding single server upgrade to cluster

* apply to 3.11 as well
diff --git a/site/content/3.11/arangograph/deployments/_index.md b/site/content/3.11/arangograph/deployments/_index.md
@@ -156,10 +156,10 @@ periodically to improve security.
 
 1. Navigate to the __Deployment__ for which you want to enable an automatic
    password rotation for the root user.
-2. In the __Quick start__ section, click the button with the __gear__ icon next to the
+2. In the __Deployment details__ section, click the button with the __gear__ icon next to the
    __ROOT PASSWORD__.
 3. In the __Password Settings__ dialog, turn the automatic password rotation on
-   and click the __Confirm__ button.
+   and click the __Save__ button.
 
    ![ArangoGraph Deployment Password Rotation](../../../images/arangograph-deployment-password-rotation.png)
 4. You can expand the __Root password__ panel to see when the password was
@@ -175,7 +175,8 @@ are shared between ArangoGraph and your database, you can benefit from
 end-to-end audit traceability for a given user, as well as integration with
 ArangoGraph SSO.
 
-You can enable this feature in the **Password Settings** dialog. Please note
+You can enable this feature in the **Deployment details** section by turning
+the **USE AUTO LOGIN FOR DATABASE UI** toggle on. Please note
 that it may take a few minutes to get activated.
 Once enabled, you no longer have to fill in the `root` user and password of
 your ArangoDB deployment.
@@ -201,7 +202,7 @@ the ArangoDB database web interface as all permissions are managed by the
 ArangoGraph platform.
 {{< /warning >}}
 
-Before getting started, make sure you are signed into ArangoGraph as a user
+Before getting started, make sure you are signed in to ArangoGraph as a user
 with one of the following permissions in your project:
 - `data.deployment.full-access`
 - `data.deployment.read-only-access`
@@ -236,6 +237,11 @@ attached to your role. Read more about [roles and permissions](../security-and-a
    - Change the deployment name
    - Change the deployment description
 4. In the **Sizing** section, you can do the following:
+   
+   {{< tip >}}
+   Before changing deployment models, especially from **Single Server** to clustered configurations,
+   consider creating a backup of your data.
+   {{< /tip >}}
    - Change **OneShard** deployments into **Sharded** deployments. To do so,
      select **Sharded** in the **Model** dropdown list. You can select the
      number of nodes for your deployment. This can also be modified later on.
@@ -244,7 +250,12 @@ attached to your role. Read more about [roles and permissions](../security-and-a
      {{< /warning >}}
    - Change **Single Server** deployments into **OneShard** or **Sharded** deployments.
      {{< warning >}}
-     You cannot switch from **Sharded** or **OneShard** back to **Single Server**.
+     **Important considerations for Single Server upgrades:**
+     - You cannot switch from **Sharded** or **OneShard** back to **Single Server**.
+     - Changing **Single Server** deployments into **OneShard** or **Sharded** deployments
+       will cause downtime and may take a considerable amount of time to complete. Plan this switch
+       during a maintenance window when your application can tolerate service interruption.
+       Your data remains safe throughout the process.
      {{< /warning >}}
    - Scale up or down the node size.
      {{< warning >}}
@@ -281,21 +292,33 @@ application has to handle connection failures by retrying operations if needed.
 
 ![ArangoGraph Connecting Drivers Example](../../../images/arangograph-connecting-drivers-example.png)
 
+## How to pause a deployment
+
+1. In the __Deployments__ page, click the deployment you wish to pause.
+2. Click the __Delete/Lock__ entry in the navigation.
+3. Click the __Pause deployment...__ button.
+4. To resume the deployment, go to the __Overview__ tab and click __Resume deployment__. The
+   deployment being paused displays the __Hibernated__ status until it has been
+   successfully resumed.
+
 ## How to delete a deployment
 
 {{< danger >}}
 Deleting a deployment deletes all its data and backups.
 This operation is **irreversible**. Please proceed with caution.
 {{< /danger >}}
 
-1. In the main navigation, in the __Projects__ section, click the project that
-   holds the deployment you wish to delete.
-2. In the __Deployments__ page, click the deployment you wish to delete.
-3. Click the __Delete/Lock__ entry in the navigation.
-4. Click the __Delete deployment__ button.
-5. In the modal dialog, confirm the deletion by entering `Delete!` into the
+1. In the __Deployments__ page, click the deployment you wish to delete.
+2. Click the __Delete/Lock__ entry in the navigation.
+3. Click the __Delete deployment...__ button.
+4. In the modal dialog, confirm the deletion by entering `Delete!` into the
    designated text field.
-6. Confirm the deletion by pressing the __Yes__ button.
-7. You will be taken back to the deployments page of the project.
+5. Confirm the deletion by pressing the __Yes__ button.
+6. You will be taken back to the __Deployments__ page of the project.
    The deployment being deleted will display the __Deleting__ status until it has
    been successfully removed.
+
+{{< info >}}
+Locked deployments cannot be deleted. Learn more about
+[locked resources](../security-and-access-control/_index.md#locked-resources) in ArangoGraph.
+{{< /info >}}
diff --git a/site/content/3.12/arangograph/deployments/_index.md b/site/content/3.12/arangograph/deployments/_index.md
@@ -237,6 +237,11 @@ attached to your role. Read more about [roles and permissions](../security-and-a
    - Change the deployment name
    - Change the deployment description
 4. In the **Sizing** section, you can do the following:
+   
+   {{< tip >}}
+   Before changing deployment models, especially from **Single Server** to clustered configurations,
+   consider creating a backup of your data.
+   {{< /tip >}}
    - Change **OneShard** deployments into **Sharded** deployments. To do so,
      select **Sharded** in the **Model** dropdown list. You can select the
      number of nodes for your deployment. This can also be modified later on.
@@ -245,7 +250,12 @@ attached to your role. Read more about [roles and permissions](../security-and-a
      {{< /warning >}}
    - Change **Single Server** deployments into **OneShard** or **Sharded** deployments.
      {{< warning >}}
-     You cannot switch from **Sharded** or **OneShard** back to **Single Server**.
+     **Important considerations for Single Server upgrades:**
+     - You cannot switch from **Sharded** or **OneShard** back to **Single Server**.
+     - Changing **Single Server** deployments into **OneShard** or **Sharded** deployments
+       will cause downtime and may take a considerable amount of time to complete. Plan this switch
+       during a maintenance window when your application can tolerate service interruption.
+       Your data remains safe throughout the process.
      {{< /warning >}}
    - Scale up or down the node size.
      {{< warning >}}
diff --git a/site/content/3.13/arangograph/deployments/_index.md b/site/content/3.13/arangograph/deployments/_index.md
@@ -237,6 +237,11 @@ attached to your role. Read more about [roles and permissions](../security-and-a
    - Change the deployment name
    - Change the deployment description
 4. In the **Sizing** section, you can do the following:
+   
+   {{< tip >}}
+   Before changing deployment models, especially from **Single Server** to clustered configurations,
+   consider creating a backup of your data.
+   {{< /tip >}}
    - Change **OneShard** deployments into **Sharded** deployments. To do so,
      select **Sharded** in the **Model** dropdown list. You can select the
      number of nodes for your deployment. This can also be modified later on.
@@ -245,7 +250,12 @@ attached to your role. Read more about [roles and permissions](../security-and-a
      {{< /warning >}}
    - Change **Single Server** deployments into **OneShard** or **Sharded** deployments.
      {{< warning >}}
-     You cannot switch from **Sharded** or **OneShard** back to **Single Server**.
+     **Important considerations for Single Server upgrades:**
+     - You cannot switch from **Sharded** or **OneShard** back to **Single Server**.
+     - Changing **Single Server** deployments into **OneShard** or **Sharded** deployments
+       will cause downtime and may take a considerable amount of time to complete. Plan this switch
+       during a maintenance window when your application can tolerate service interruption.
+       Your data remains safe throughout the process.
      {{< /warning >}}
    - Scale up or down the node size.
      {{< warning >}}
