@@ -5,118 +5,95 @@ weight: 20
5
5
description : >-
6
6
How to create and manage deployments in ArangoGraph
7
7
---
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.
11
10
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.
16
13
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 >**
19
15
20
16
![ ArangoGraph Deployments] ( ../../../images/arangograph-deployments-page.png )
21
17
22
18
## How to create a new deployment
23
19
24
20
1 . If you do not have a project yet,
25
21
[ 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.
31
25
5 . Set up your deployment. The configuration options are described below.
32
26
33
- ![ ArangoGraph New Deployment] ( ../../../images/arangograph-new-deployment1.png )
34
-
35
27
{{< info >}}
36
28
Deployments contain exactly ** one policy** . Within that policy, you can define
37
29
role bindings to regulate access control on a deployment level.
38
30
{{< /info >}}
39
31
40
32
### In the ** General** section
41
33
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 >}}
90
40
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 )
93
42
94
- ![ ArangoGraph Deployment OneShard ] ( ../../../images/arangograph-new-deployment-oneshard.png )
43
+ ### In the ** Sizing ** section
95
44
96
- #### Sharded
45
+ - Choose a __ Model __ for the deployment:
97
46
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.
102
49
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.
104
54
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.
106
59
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.
110
62
111
- ![ ArangoGraph Deployment Single Server ] ( ../../../images/arangograph-new-deployment-singleserver .png )
63
+ ![ ArangoGraph New Deployment Sizing ] ( ../../../images/arangograph-new-deployment-sizing .png )
112
64
113
- ### In the ** Summary ** section
65
+ ### In the ** Advanced ** section
114
66
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.
120
97
121
98
## How to access your deployment
122
99
@@ -125,11 +102,12 @@ provider and region in the Location section.
125
102
which you created a deployment earlier.
126
103
3 . Alternatively, you can access your deployment by clicking __ Deployments__ in the
127
104
dashboard navigation. This page shows all deployments from all projects.
105
+ Click the name of the deployment you want to view.
128
106
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.
130
108
5 . Press the __ View__ button to show the deployment page.
131
109
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
133
111
the dashboard of your new ArangoDB deployment.
134
112
135
113
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
138
116
database web interface, you need to follow the additional steps outlined below
139
117
to access your deployment:
140
118
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
142
120
root password to your clipboard. You can also click the view icon to unmask
143
121
the root password to see it.
144
-
145
122
{{< security >}}
146
123
Do not use the root username/password for everyday operations. It is recommended
147
124
to use them only to create other user accounts with appropriate permissions.
148
125
{{< /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
151
127
the dashboard of your new ArangoDB deployment.
152
128
3 . In the __ username__ field type ` root ` , and in the __ password__ field paste the
153
129
password that you copied earlier.
@@ -242,7 +218,7 @@ This feature is available on `443` port only.
242
218
243
219
## How to edit a deployment
244
220
245
- You can modify a deployment’ s configuration, including the ArangoDB version
221
+ You can modify a deployment' s configuration, including the ArangoDB version
246
222
that is being used, change the memory size, or even switch from
247
223
a OneShard deployment to a Sharded one if your data set no longer fits in a
248
224
single node.
@@ -252,34 +228,37 @@ To edit an existing deployment, you must have the necessary set of permissions
252
228
attached to your role. Read more about [ roles and permissions] ( ../security-and-access-control/_index.md#roles ) .
253
229
{{< /tip >}}
254
230
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:
271
239
- 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.
274
242
{{< warning >}}
275
243
You cannot switch from ** Sharded** back to ** OneShard** .
276
244
{{< /warning >}}
277
245
- Change ** Single Server** deployments into ** OneShard** or ** Sharded** deployments.
278
246
{{< warning >}}
279
247
You cannot switch from ** Sharded** or ** OneShard** back to ** Single Server** .
280
248
{{< /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** .
283
262
284
263
## How to connect a driver to your deployment
285
264
@@ -305,7 +284,7 @@ application has to handle connection failures by retrying operations if needed.
305
284
## How to delete a deployment
306
285
307
286
{{< danger >}}
308
- Deleting a deployment will delete all its data and backups.
287
+ Deleting a deployment deletes all its data and backups.
309
288
This operation is ** irreversible** . Please proceed with caution.
310
289
{{< /danger >}}
311
290
0 commit comments