Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit 8a3c37d

Browse files
OAS-11485 | Add warning regarding single server upgrade to cluster in ArangoGraph (#798)
* add warning regarding single server upgrade to cluster * apply to 3.11 as well
1 parent a570281 commit 8a3c37d

File tree

3 files changed

+58
-15
lines changed

3 files changed

+58
-15
lines changed

‎site/content/3.11/arangograph/deployments/_index.md‎

Lines changed: 36 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -156,10 +156,10 @@ periodically to improve security.
156156

157157
1. Navigate to the __Deployment__ for which you want to enable an automatic
158158
password rotation for the root user.
159-
2. In the __Quick start__ section, click the button with the __gear__ icon next to the
159+
2. In the __Deployment details__ section, click the button with the __gear__ icon next to the
160160
__ROOT PASSWORD__.
161161
3. In the __Password Settings__ dialog, turn the automatic password rotation on
162-
and click the __Confirm__ button.
162+
and click the __Save__ button.
163163

164164
![ArangoGraph Deployment Password Rotation](../../../images/arangograph-deployment-password-rotation.png)
165165
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
175175
end-to-end audit traceability for a given user, as well as integration with
176176
ArangoGraph SSO.
177177

178-
You can enable this feature in the **Password Settings** dialog. Please note
178+
You can enable this feature in the **Deployment details** section by turning
179+
the **USE AUTO LOGIN FOR DATABASE UI** toggle on. Please note
179180
that it may take a few minutes to get activated.
180181
Once enabled, you no longer have to fill in the `root` user and password of
181182
your ArangoDB deployment.
@@ -201,7 +202,7 @@ the ArangoDB database web interface as all permissions are managed by the
201202
ArangoGraph platform.
202203
{{< /warning >}}
203204

204-
Before getting started, make sure you are signed into ArangoGraph as a user
205+
Before getting started, make sure you are signed in to ArangoGraph as a user
205206
with one of the following permissions in your project:
206207
- `data.deployment.full-access`
207208
- `data.deployment.read-only-access`
@@ -236,6 +237,11 @@ attached to your role. Read more about [roles and permissions](../security-and-a
236237
- Change the deployment name
237238
- Change the deployment description
238239
4. In the **Sizing** section, you can do the following:
240+
241+
{{< tip >}}
242+
Before changing deployment models, especially from **Single Server** to clustered configurations,
243+
consider creating a backup of your data.
244+
{{< /tip >}}
239245
- Change **OneShard** deployments into **Sharded** deployments. To do so,
240246
select **Sharded** in the **Model** dropdown list. You can select the
241247
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
244250
{{< /warning >}}
245251
- Change **Single Server** deployments into **OneShard** or **Sharded** deployments.
246252
{{< warning >}}
247-
You cannot switch from **Sharded** or **OneShard** back to **Single Server**.
253+
**Important considerations for Single Server upgrades:**
254+
- You cannot switch from **Sharded** or **OneShard** back to **Single Server**.
255+
- Changing **Single Server** deployments into **OneShard** or **Sharded** deployments
256+
will cause downtime and may take a considerable amount of time to complete. Plan this switch
257+
during a maintenance window when your application can tolerate service interruption.
258+
Your data remains safe throughout the process.
248259
{{< /warning >}}
249260
- Scale up or down the node size.
250261
{{< warning >}}
@@ -281,21 +292,33 @@ application has to handle connection failures by retrying operations if needed.
281292

282293
![ArangoGraph Connecting Drivers Example](../../../images/arangograph-connecting-drivers-example.png)
283294

295+
## How to pause a deployment
296+
297+
1. In the __Deployments__ page, click the deployment you wish to pause.
298+
2. Click the __Delete/Lock__ entry in the navigation.
299+
3. Click the __Pause deployment...__ button.
300+
4. To resume the deployment, go to the __Overview__ tab and click __Resume deployment__. The
301+
deployment being paused displays the __Hibernated__ status until it has been
302+
successfully resumed.
303+
284304
## How to delete a deployment
285305

286306
{{< danger >}}
287307
Deleting a deployment deletes all its data and backups.
288308
This operation is **irreversible**. Please proceed with caution.
289309
{{< /danger >}}
290310

291-
1. In the main navigation, in the __Projects__ section, click the project that
292-
holds the deployment you wish to delete.
293-
2. In the __Deployments__ page, click the deployment you wish to delete.
294-
3. Click the __Delete/Lock__ entry in the navigation.
295-
4. Click the __Delete deployment__ button.
296-
5. In the modal dialog, confirm the deletion by entering `Delete!` into the
311+
1. In the __Deployments__ page, click the deployment you wish to delete.
312+
2. Click the __Delete/Lock__ entry in the navigation.
313+
3. Click the __Delete deployment...__ button.
314+
4. In the modal dialog, confirm the deletion by entering `Delete!` into the
297315
designated text field.
298-
6. Confirm the deletion by pressing the __Yes__ button.
299-
7. You will be taken back to the deployments page of the project.
316+
5. Confirm the deletion by pressing the __Yes__ button.
317+
6. You will be taken back to the __Deployments__ page of the project.
300318
The deployment being deleted will display the __Deleting__ status until it has
301319
been successfully removed.
320+
321+
{{< info >}}
322+
Locked deployments cannot be deleted. Learn more about
323+
[locked resources](../security-and-access-control/_index.md#locked-resources) in ArangoGraph.
324+
{{< /info >}}

‎site/content/3.12/arangograph/deployments/_index.md‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -237,6 +237,11 @@ attached to your role. Read more about [roles and permissions](../security-and-a
237237
- Change the deployment name
238238
- Change the deployment description
239239
4. In the **Sizing** section, you can do the following:
240+
241+
{{< tip >}}
242+
Before changing deployment models, especially from **Single Server** to clustered configurations,
243+
consider creating a backup of your data.
244+
{{< /tip >}}
240245
- Change **OneShard** deployments into **Sharded** deployments. To do so,
241246
select **Sharded** in the **Model** dropdown list. You can select the
242247
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
245250
{{< /warning >}}
246251
- Change **Single Server** deployments into **OneShard** or **Sharded** deployments.
247252
{{< warning >}}
248-
You cannot switch from **Sharded** or **OneShard** back to **Single Server**.
253+
**Important considerations for Single Server upgrades:**
254+
- You cannot switch from **Sharded** or **OneShard** back to **Single Server**.
255+
- Changing **Single Server** deployments into **OneShard** or **Sharded** deployments
256+
will cause downtime and may take a considerable amount of time to complete. Plan this switch
257+
during a maintenance window when your application can tolerate service interruption.
258+
Your data remains safe throughout the process.
249259
{{< /warning >}}
250260
- Scale up or down the node size.
251261
{{< warning >}}

‎site/content/3.13/arangograph/deployments/_index.md‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -237,6 +237,11 @@ attached to your role. Read more about [roles and permissions](../security-and-a
237237
- Change the deployment name
238238
- Change the deployment description
239239
4. In the **Sizing** section, you can do the following:
240+
241+
{{< tip >}}
242+
Before changing deployment models, especially from **Single Server** to clustered configurations,
243+
consider creating a backup of your data.
244+
{{< /tip >}}
240245
- Change **OneShard** deployments into **Sharded** deployments. To do so,
241246
select **Sharded** in the **Model** dropdown list. You can select the
242247
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
245250
{{< /warning >}}
246251
- Change **Single Server** deployments into **OneShard** or **Sharded** deployments.
247252
{{< warning >}}
248-
You cannot switch from **Sharded** or **OneShard** back to **Single Server**.
253+
**Important considerations for Single Server upgrades:**
254+
- You cannot switch from **Sharded** or **OneShard** back to **Single Server**.
255+
- Changing **Single Server** deployments into **OneShard** or **Sharded** deployments
256+
will cause downtime and may take a considerable amount of time to complete. Plan this switch
257+
during a maintenance window when your application can tolerate service interruption.
258+
Your data remains safe throughout the process.
249259
{{< /warning >}}
250260
- Scale up or down the node size.
251261
{{< warning >}}

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /