Deployments

Below projects in the ArangoGraph deployment hierarchy are deployments. A deployment contains an ArangoDB, configured as you choose. You can have any number of deployments under one project.

Organizations → Projects → Deployments

Each deployment can also be backed up manually or automatically by schedules you can define.

In essence, you can create whatever structure fits you for a given organization, its projects and deployments.

How to create a new deployment

1. If you do not have a project yet, create a project first.
2. In the main navigation, in the Projects section, click the project for which you want to create a new deployment.
3. In the Deployments tab, you will see an empty list or a list with your project’s existing deployments.
4. Click the New deployment button.

5. Set up your deployment. The configuration options are described below.

   The configuration options depend on the tier your organization belongs to. For more details about available resources and usage limits, refer to the ArangoGraph tiers section.

In the General section

• Enter the name and optionally a short description for the deployment.

In the Location section

1. Select the Provider and Region of the provider.

   Once a deployment has been created, it is not possible to change the provider and region anymore.

2. Select the DB Version. Note: If you don’t know which DB version to select, leave the version selected by default.
3. In the CA Certificate field
   • The default certificate created for your project will automatically be selected.
   • If you have no default certificate, or want to use a new certificate create a new certificate by typing the desired name for it and hitting enter or clicking the name when done.
   • Or, if you already have multiple certificates, select the desired one.
4. Optional but strongly recommended: In the IP allowlist field, select the desired one in case you want to limit access to your deployment to certain IP ranges. To create a allowlist, navigate to your project and select the IP allowlists tab.

In the Configuration section

Choose between a OneShard, Sharded or Developer deployment.

• OneShard deployments are suitable when your data set fits in a single node. They are ideal for graph use cases.

• Sharded deployments are suitable when your data set is larger than a single node. The data will be sharded across multiple nodes.

• Developer deployments are suitable when you want to try out ArangoDB without the need for high availability or scalability. The deployment will contain a single server only. Your data will not be replicated and your deployment can be restarted at any time.

OneShard

1. Select the memory size of your node.
2. Select the CPU size of your node.
3. Select the initial disk size of your node. The available ranges for the disk size depend on the selected memory size.
4. Select the upper limit for the disk size. It defaults to twice the initial disk size. You can set it to the same value as the initial disk size to disable automatic disk sizing.

Sharded

• In addition to memory and disk size as in the OneShard configuration, select the number of nodes for your deployment. The more nodes you have, the higher the replication factor can be.

Developer

• Like with OneShard and Sharded deployments, you choose memory and disk size. However note that the sizes you choose are for the entire deployment. For OneShard and Sharded deployments the chosen sizes are per node.

In the Summary section

1. Review the configuration, and if you’re ok with the setup press the Create button.
2. You will be taken to the deployment overview page. Note: Your deployment is at that point being bootstrapped, this process will take a few minutes. Once it is ready, you will receive a confirmation email.

How to access your deployment

1. In the main navigation, in the Projects section, click the project for which you created a deployment earlier.
2. Navigate to the Deployments tab.
3. For each deployment in your project, you see the status. While your new deployment is being set up, it will display the bootstrapping status.
4. Press the View button to show the deployment page.
5. When a deployment displays a status of OK, you can access it.

6. Click the copy icon next to the root password. This will copy the deployment root password to your clipboard. You can also click the view icon to unmask the root password to see it.

   Do not use the root username/password for everyday operations. It is recommended to use them only to create other user accounts with appropriate permissions.

7. You will also receive an email that the deployment is available, with a URL to open it up.
8. Click the Open endpoint button or on the endpoint URL property to open the dashboard of your new ArangoDB deployment.
9. In the username field type root, and in the password field paste the password that you copied earlier.
10. Press the Login button.
11. Press the Select DB: _system button

At this point your ArangoDB deployment is available for you to use — Have fun!

How to enable the root user password rotation

Password rotation refers to changing passwords regularly - a security best practice to reduce the vulnerability to password-based attacks and exploits by limiting for how long passwords are valid. The ArangoGraph Insights Platform can automatically change the root user password of an ArangoDB deployment periodically to improve security.

1. Navigate to the Deployment for which you want to enable an automatic password rotation for the root user.
2. On the Overview tab, click the button with the gear icon next to the ROOT PASSWORD.

3. In the Password Settings dialog, turn the password rotation on and click the Confirm button.

   

4. You can expand the Root password panel to see when the password was rotated last. The rotation takes place every three months.

How to edit a deployment

You can modify a deployment’s configuration, including the ArangoDB version that is being used, change the memory, CPU, and disk size, or even switch from a OneShard deployment to a Sharded one if your data set no longer fits in a single node.

1. Go to the Projects section and select an existing deployment from the list.
2. Open the deployment you want to change.
3. On the Overview tab, click the Edit button.
4. In the Version and Security section, you can do the following:
   • Upgrade the ArangoDB version that is currently being used. See also Upgrades and Versioning
   • Select a different CA certificate.
   • Add or remove an IP allowlist.
5. In the Configuration section, you can do the following:
   • Upgrade the memory size per node.
   • Modify the CPU per node from General to Low or vice-versa, if made available by the cloud provider.
   • Select a different disk size per node. The available ranges for the disk size depend on the selected memory size. To enable automatic disk size scaling, move the slider to a value higher than the current disk size.
   • Change OneShard deployments into Sharded deployments. To do so, click Sharded. In addition to the other configuration options, you can select the number of nodes for your deployment. This can also be modified later on.

   Notice that you cannot switch from Sharded back to OneShard.

   • AWS deployments have an additional option that allows you to select the Disk Performance either with general settings, or optimized for large and very large data sets. This option is dependent on the selected memory size. For example, larger deployments have optimized settings by default.

   When upgrading the memory size, disk size, and/or disk performance in AWS deployments, the value gets locked and cannot be changed until the cloud provider rate limit is reset.

6. All changes are reflected in the Summary section. Review the new configuration and click Save.

How to delete a deployment

1. In the main navigation, in the Projects section, click the project that holds the deployment you wish to delete.
2. On the Deployments tab, click the deployment you wish to delete.
3. Click the Danger zone tab.
4. Click the Delete deployment button.
5. 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. The deployment being deleted will display the Deleting status until it has been successfully removed.