Deployments

Below projects in the Oasis 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.

Oasis Deployments

Also see the video Create a Deployment on ArangoDB Oasis.

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 on 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.

Oasis New Deployment

Also see the video Create a Deployment on ArangoDB Oasis.

Deployments contain exactly one policy. Within that policy, you can define role bindings to regulate access control on a deployment level.

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.
  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 on 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 (also see the video IP allowlists with ArangoDB Oasis).

For any kind of production deployment we strongly advise to use an IP allowlist.

Oasis New Deployment

In the Configuration section

Choose between a OneShard and Sharded 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.

OneShard

  1. Select the memory size of your node.
  2. Select the CPU size of your node.
  3. Select the disk size of your node. The available ranges for the disk size depend on the selected memory size.

Oasis Deployment OneShard

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.

Oasis Deployment Sharded

  • If you’re unsure about the sharded setup, you can go through our wizard. Click on Help me decide to open the recommendation process.

Oasis Deployment Sharded

  • The wizard will guide you through a set of questions and display a recommendation.
  • Click Use recommendation to apply it to your sharded configuration.

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 on 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.
  7. You will also receive an email that the deployment is available, with a URL to open it up.
  8. Click on 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!

Each deployment is accessible on two ports:

  • Port 8529 is the standard port recommended for use by web-browsers.
  • Port 18529 is the alternate port that is recommended for use by automated services.

The difference between these ports is the certificate used. If you enable Use well known certificate, the certificates used on port 8529 is well known and automatically accepted by most web browsers. The certificate used on port 18529 is a self-signed certificate. For securing automated services, the use of a self-signed certificate is recommended.

How to delete a deployment

Deleting a deployment will delete all its data and backups. This operation is irreversible. Please proceed with caution.

  1. In the main navigation, in the Projects section, click on the project that holds the deployment you wish to delete.
  2. On the Deployments tab, click on the deployment you wish to delete.
  3. Click on to 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.