Skip to content

Commit d3edd16

Browse files
authored
DOC-691 | ArangoGraph: Adjust for deployment UI changes (#547)
1 parent 33b29e4 commit d3edd16

30 files changed

+428
-537
lines changed

Diff for: site/content/3.10/arangograph/deployments/_index.md

+91-112
Original file line numberDiff line numberDiff line change
@@ -5,118 +5,95 @@ weight: 20
55
description: >-
66
How to create and manage deployments in ArangoGraph
77
---
8-
Below projects in the ArangoGraph deployment hierarchy are deployments. A deployment
9-
contains an ArangoDB, configured as you choose. You can have any number of
10-
deployments under one project.
8+
An ArangoGraph deployment is an ArangoDB cluster or single server, configured
9+
as you choose.
1110

12-
**Organizations → Projects → <u>Deployments</u>**
13-
14-
Each deployment can also be backed up manually or automatically by schedules
15-
you can define.
11+
Each deployment belongs to a project, which belongs to an organization in turn.
12+
You can have any number of deployments under one project.
1613

17-
In essence, you can create whatever structure fits you for a given organization,
18-
its projects and deployments.
14+
**Organizations → Projects → <u>Deployments</u>**
1915

2016
![ArangoGraph Deployments](../../../images/arangograph-deployments-page.png)
2117

2218
## How to create a new deployment
2319

2420
1. If you do not have a project yet,
2521
[create a project](../projects.md#how-to-create-a-new-project) first.
26-
2. In the main navigation, in the __Projects__ section, click the project for
27-
which you want to create a new deployment.
28-
3. In the __Deployments__ page, you will see an empty list or a list with
29-
your project's existing deployments.
30-
4. Click the __New deployment__ button.
22+
2. In the main navigation, click __Deployments__.
23+
3. Click the __New deployment__ button.
24+
4. Select the project you want to create the deployment for.
3125
5. Set up your deployment. The configuration options are described below.
3226

33-
![ArangoGraph New Deployment](../../../images/arangograph-new-deployment1.png)
34-
3527
{{< info >}}
3628
Deployments contain exactly **one policy**. Within that policy, you can define
3729
role bindings to regulate access control on a deployment level.
3830
{{< /info >}}
3931

4032
### In the **General** section
4133

42-
- Enter the name and optionally a short description for the deployment.
43-
44-
### In the **Location** section
45-
46-
1. Select the __Provider__ and __Region__ of the provider.
47-
{{< warning >}}
48-
Once a deployment has been created, it is not possible to change the
49-
provider and region anymore.
50-
{{< /warning >}}
51-
2. Select the __DB Version__.
52-
**Note**: If you don't know which DB version to select, leave the version
53-
selected by default.
54-
3. In the __CA Certificate__ field
55-
- The default certificate created for your project will automatically be selected.
56-
- If you have no default certificate, or want to use a new certificate
57-
create a new certificate by typing the desired name for it and hitting
58-
enter or clicking the name when done.
59-
- Or, if you already have multiple certificates, select the desired one.
60-
4. _Optional but strongly recommended:_ In the __IP allowlist__ field, select the
61-
desired one in case you want to limit access to your deployment to certain
62-
IP ranges. To create a allowlist, navigate to your project and select the
63-
__IP allowlists__ tab.
64-
65-
{{< security >}}
66-
For any kind of production deployment we strongly advise to use an IP allowlist.
67-
{{< /security >}}
68-
69-
### In the **Configuration** section
70-
71-
Choose between a **OneShard**, **Sharded** or **Single Server** deployment.
72-
73-
- OneShard deployments are suitable when your data set fits in a single node.
74-
They are ideal for graph use cases.
75-
76-
- Sharded deployments are suitable when your data set is larger than a single
77-
node. The data will be sharded across multiple nodes.
78-
79-
- Single Server deployments are suitable when you want to try out ArangoDB without
80-
the need for high availability or scalability. The deployment will contain a
81-
single server only. Your data will not be replicated and your deployment can
82-
be restarted at any time.
83-
84-
{{< info >}}
85-
Before you begin configuring your deployment, you first need to select the
86-
provider and region in the Location section.
87-
{{< /info >}}
88-
89-
#### OneShard
34+
- Enter the __Name__ and optionally a __Short description__ for the deployment.
35+
- Select the __Provider__ and __Region__ of the provider.
36+
{{< warning >}}
37+
Once a deployment has been created, it is not possible to change the
38+
provider and region anymore.
39+
{{< /warning >}}
9040

91-
- Select the memory size of your node. The disk size is automatically set for you
92-
based on the selected memory size.
41+
![ArangoGraph New Deployment General](../../../images/arangograph-new-deployment-general.png)
9342

94-
![ArangoGraph Deployment OneShard](../../../images/arangograph-new-deployment-oneshard.png)
43+
### In the **Sizing** section
9544

96-
#### Sharded
45+
- Choose a __Model__ for the deployment:
9746

98-
- In addition to the memory size as in the OneShard configuration, select
99-
the number of nodes for your deployment. The more nodes you have, the higher
100-
the replication factor can be. Same as in OneShard, the disk size is automatically
101-
set for you.
47+
- __OneShard__ deployments are suitable when your data set fits in a single node.
48+
They are ideal for graph use cases. This model has a fixed number of 3 nodes.
10249

103-
![ArangoGraph Deployment Sharded](../../../images/arangograph-new-deployment-sharded.png)
50+
- __Sharded__ deployments are suitable when your data set is larger than a single
51+
node. The data will be sharded across multiple nodes. You can select the
52+
__Number of nodes__ for this deployment model. The more nodes you have, the
53+
higher the replication factor can be.
10454

105-
#### Single Server
55+
- __Single Server__ deployments are suitable when you want to try out ArangoDB without
56+
the need for high availability or scalability. The deployment will contain a
57+
single server only. Your data will not be replicated and your deployment can
58+
be restarted at any time.
10659

107-
- Like with OneShard and Sharded deployments, you can choose the memory size.
108-
Note, however, that the size you choose is for the entire deployment.
109-
For OneShard and Sharded deployments the chosen sizes are per node.
60+
- Select a __NODE SIZE__ from the list of available options. Each option is a
61+
combination of vCPUs, memory, and disk space per node.
11062

111-
![ArangoGraph Deployment Single Server](../../../images/arangograph-new-deployment-singleserver.png)
63+
![ArangoGraph New Deployment Sizing](../../../images/arangograph-new-deployment-sizing.png)
11264

113-
### In the **Summary** section
65+
### In the **Advanced** section
11466

115-
1. Review the configuration, and if you're ok with the setup press the
116-
__Create__ button.
117-
2. You will be taken to the deployment overview page.
118-
**Note:** Your deployment is at that point being bootstrapped, this process
119-
will take a few minutes. Once it is ready, you will receive a confirmation email.
67+
- Select the __DB Version__.
68+
If you don't know which DB version to select, use the version selected by default.
69+
- Select the desired __Support Plan__. Click the link below the field to get
70+
more information about the different support plans.
71+
- In the __Certificate__ field:
72+
- The default certificate created for your project is selected automatically.
73+
- If you have no default certificate, or want to use a new certificate,
74+
create a new certificate by typing the desired name for it and hitting
75+
enter or clicking __Create "\<name\>"__ when done.
76+
- Or, if you already have multiple certificates, select the desired one.
77+
- _Optional but strongly recommended:_ In the __IP allowlist__ field, select the
78+
desired one in case you want to limit access to your deployment to certain
79+
IP ranges. To create a allowlist, navigate to your project and select the
80+
__IP allowlists__ tab. See [How to manage IP allowlists](../projects.md#how-to-manage-ip-allowlists)
81+
for details.
82+
{{< security >}}
83+
For any kind of production deployment it is strongly advise to use an IP allowlist.
84+
{{< /security >}}
85+
- Select a __Deployment Profile__. Profile options are only available on request.
86+
87+
![ArangoGraph New Deployment Advanced](../../../images/arangograph-new-deployment-advanced.png)
88+
89+
### In the **Summary** panel
90+
91+
1. Review the configuration, and if you're okay with the setup, press the
92+
__Create deployment__ button.
93+
2. You are taken to the deployment overview page.
94+
**Note:** Your deployment is being bootstrapped at that point. This process
95+
takes a few minutes. Once the deployment is ready, you receive a confirmation
96+
email.
12097

12198
## How to access your deployment
12299

@@ -125,11 +102,12 @@ provider and region in the Location section.
125102
which you created a deployment earlier.
126103
3. Alternatively, you can access your deployment by clicking __Deployments__ in the
127104
dashboard navigation. This page shows all deployments from all projects.
105+
Click the name of the deployment you want to view.
128106
4. For each deployment in your project, you see the status. While your new
129-
deployment is being set up, it will display the __bootstrapping__ status.
107+
deployment is being set up, it displays the __bootstrapping__ status.
130108
5. Press the __View__ button to show the deployment page.
131109
6. When a deployment displays a status of __OK__, you can access it.
132-
7. Click the __Open web console__ button or on the endpoint URL property to open
110+
7. Click the __Open database UI__ button or on the database UI link to open
133111
the dashboard of your new ArangoDB deployment.
134112

135113
At this point your ArangoDB deployment is available for you to use — **Have fun!**
@@ -138,16 +116,14 @@ If you have disabled the [auto-login option](#auto-login-to-database-ui) to the
138116
database web interface, you need to follow the additional steps outlined below
139117
to access your deployment:
140118

141-
1. Click the copy icon next to the root password. This will copy the deployment
119+
1. Click the copy icon next to the root password. This copies the deployment
142120
root password to your clipboard. You can also click the view icon to unmask
143121
the root password to see it.
144-
145122
{{< security >}}
146123
Do not use the root username/password for everyday operations. It is recommended
147124
to use them only to create other user accounts with appropriate permissions.
148125
{{< /security >}}
149-
150-
2. Click the __Open web console__ button or on the endpoint URL property to open
126+
2. Click the __Open database UI__ button or on the database UI link to open
151127
the dashboard of your new ArangoDB deployment.
152128
3. In the __username__ field type `root`, and in the __password__ field paste the
153129
password that you copied earlier.
@@ -242,7 +218,7 @@ This feature is available on `443` port only.
242218

243219
## How to edit a deployment
244220

245-
You can modify a deployments configuration, including the ArangoDB version
221+
You can modify a deployment's configuration, including the ArangoDB version
246222
that is being used, change the memory size, or even switch from
247223
a OneShard deployment to a Sharded one if your data set no longer fits in a
248224
single node.
@@ -252,34 +228,37 @@ To edit an existing deployment, you must have the necessary set of permissions
252228
attached to your role. Read more about [roles and permissions](../security-and-access-control/_index.md#roles).
253229
{{< /tip >}}
254230

255-
1. Go to the **Projects** section and select an existing deployment from the list.
256-
2. Open the deployment you want to change.
257-
3. In the **Quick start** section, click the **Edit** button.
258-
4. In the **Version and Security** section, you can do the following:
259-
- Upgrade the ArangoDB version that is currently being used. See also
260-
[Upgrades and Versioning](upgrades-and-versioning.md)
261-
- Select a different CA certificate.
262-
- Add or remove an IP allowlist.
263-
5. In the **Configuration** section, you can do the following:
264-
- Scale up or down the memory size per node. The disk size is
265-
automatically set for you.
266-
{{< warning >}}
267-
When scaling up or down the memory size in AWS deployments, the new
268-
value gets locked and cannot be changed again until the cloud provider rate
269-
limit is reset.
270-
{{< /warning >}}
231+
1. In the main navigation, click **Deployments** and select an existing
232+
deployment from the list, or click **Projects**, select a project, and then
233+
select a deployment.
234+
2. In the **Quick start** section, click the **Edit** button.
235+
3. In the **General** section, you can do the following:
236+
- Change the deployment name
237+
- Change the deployment description
238+
4. In the **Sizing** section, you can do the following:
271239
- Change **OneShard** deployments into **Sharded** deployments. To do so,
272-
click **Sharded**. In addition to the other configuration options, you can
273-
select the number of nodes for your deployment. This can also be modified later on.
240+
select **Sharded** in the **Model** dropdown list. You can select the
241+
number of nodes for your deployment. This can also be modified later on.
274242
{{< warning >}}
275243
You cannot switch from **Sharded** back to **OneShard**.
276244
{{< /warning >}}
277245
- Change **Single Server** deployments into **OneShard** or **Sharded** deployments.
278246
{{< warning >}}
279247
You cannot switch from **Sharded** or **OneShard** back to **Single Server**.
280248
{{< /warning >}}
281-
6. All changes are reflected in the **Summary** section. Review the new
282-
configuration and click **Save**.
249+
- Scale up or down the node size.
250+
{{< warning >}}
251+
When scaling up or down the size in AWS deployments, the new value gets locked
252+
and cannot be changed again until the cloud provider rate limit is reset.
253+
{{< /warning >}}
254+
5. In the **Advanced** section, you can do the following:
255+
- Upgrade the ArangoDB version that is currently being used. See also
256+
[Upgrades and Versioning](upgrades-and-versioning.md)
257+
- Select a different certificate.
258+
- Add or remove an IP allowlist.
259+
- Select a deployment profile.
260+
6. All changes are reflected in the **Summary** panel. Review the new
261+
configuration and click **Save changes**.
283262

284263
## How to connect a driver to your deployment
285264

@@ -305,7 +284,7 @@ application has to handle connection failures by retrying operations if needed.
305284
## How to delete a deployment
306285

307286
{{< danger >}}
308-
Deleting a deployment will delete all its data and backups.
287+
Deleting a deployment deletes all its data and backups.
309288
This operation is **irreversible**. Please proceed with caution.
310289
{{< /danger >}}
311290

Diff for: site/content/3.10/arangograph/organizations/_index.md

+3-5
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,12 @@ weight: 10
55
description: >-
66
How to manage organizations and what type of packages ArangoGraph offers
77
---
8-
At the highest level of the ArangoGraph deployment hierarchy are organizations.
9-
Organizations are a container for projects.
8+
An ArangoGraph organizations is a container for projects. An organization
9+
typically represents a (commercial) entity such as a company, a company division,
10+
an institution, or a non-profit organization.
1011

1112
**<u>Organizations</u> → Projects → Deployments**
1213

13-
An organization typically represents a (commercial) entity such as a company,
14-
a company division, an institution or a non-profit organization.
15-
1614
Users can be members of one or more organizations. However, you can only be a
1715
member of one _Free-to-try_ tier organization at a time.
1816

Diff for: site/content/3.10/arangograph/projects.md

+3-7
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,16 @@ weight: 15
55
description: >-
66
How to manage projects and IP allowlists in ArangoGraph
77
---
8-
Below organizations in the ArangoGraph deployment hierarchy are projects. They can
9-
represent organizational units such as teams, product groups, environments
10-
(e.g. staging vs. production). You can have any number of projects under one
11-
organization.
8+
ArangoGraph projects can represent organizational units such as teams,
9+
product groups, environments (e.g. staging vs. production). You can have any
10+
number of projects under one organization.
1211

1312
**Organizations → <u>Projects</u> → Deployments**
1413

1514
Projects are a container for related deployments, certificates & IP allowlists.
1615
Projects also come with their own policy for access control. You can have any
1716
number of deployment under one project.
1817

19-
In essence, you can create whatever structure fits you for a given organization,
20-
its projects and deployments.
21-
2218
![ArangoGraph Projects Overview](../../images/arangograph-projects-overview.png)
2319

2420
## How to create a new project

Diff for: site/content/3.10/arangograph/security-and-access-control/_index.md

+7-6
Original file line numberDiff line numberDiff line change
@@ -65,12 +65,13 @@ viewed on the **Policy** page of an organization within the ArangoGraph dashboar
6565
Decide whether you want to edit the policy for an organization, a project,
6666
or a deployment:
6767

68-
- **Organization**: In the main navigation menu, click **Access Control**, then
69-
open the **Policy** tab.
70-
- **Project**: In the main navigation menu, click the name of the required project, then
71-
open the **Policy** tab.
72-
- **Deployment**: In the main navigation menu, click the name of the required project, then click either
73-
the deployment name or the **View** button, and finally open the **Policy** tab.
68+
- **Organization**: In the main navigation, click the __Organization__ icon and
69+
then click __Policy__.
70+
- **Project**: In the main navigation, click the __Dashboard__ icon, then click
71+
__Projects__, click the name of the desired project, and finally click __Policy__.
72+
- **Deployment**: In the main navigation, click the __Dashboard__ icon, then
73+
click __Deployments__, click the name of the desired deployment, and finally
74+
click __Policy__.
7475

7576
To delete a role binding, click the **Recycle Bin** icon in the **Actions** column.
7677

Diff for: site/content/3.10/get-started/set-up-a-cloud-instance.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -82,13 +82,12 @@ used for multiple accounts.
8282

8383
{{< icon src="../../images/arangograph-deployment-ready-email.png" alt="ArangoGraph Deployment Ready Email" style="max-height: 50vh">}}
8484

85-
3. Click the name or the **View** button of the deployment card (or the
86-
__Open deployment details__ link in the email) to view the deployment
87-
details.
85+
3. Click the name of the deployment (or the __Open deployment details__ link in
86+
the email) to view the deployment details.
8887

8988
![ArangoGraph Deployment Ready](../../images/arangograph-deployment-ready.png)
9089

91-
4. Click the __Open web console__ button to open the ArangoDB web interface.
90+
4. Click the __Open database UI__ button to open the ArangoDB web interface.
9291

9392
5. You can install example datasets and follow the accompanying guides to get
9493
started with ArangoDB and its query language. In the ArangoGraph dashboard, click

0 commit comments

Comments
 (0)