ArangoDB v3.5 reached End of Life (EOL) and is no longer supported.

This documentation is outdated. Please see the most recent version here: Latest Docs

Projects

Below organizations in the Oasis deployment hierarchy are projects. They can represent organizational units such as teams, product groups, environments (e.g. staging vs. production). You can have any number of projects under one organization.

Organizations → Projects → Deployments

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

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

Oasis Projects Overview

How to create a new project

  1. Click on Overview in the Projects section of the main navigation.
  2. Click the New project button.
  3. Enter a name and optionally a description for your new project.
  4. Click the Create button.
  5. You will be taken to the project page.
  6. To change the name or description, click on either at the top of the page.

Oasis New Project

Oasis Project Summary

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

How to create a new deployment

See Deployments: How to create a new deployment

How to delete a project

Deleting a project will delete contained deployments, certificates & IP allowlists. This operation is irreversible.

  1. Click on Overview in the Projects section of the main navigation.
  2. Click on a trash can icon in the Actions column.
  3. Enter Delete! to confirm and click Yes.

Alternatively, you can also delete a project via the project page:

  1. Click on a project name in the Projects section of the main navigation.
  2. Click on the Danger zone tab.
  3. Click the Delete project… button.
  4. Enter Delete! to confirm and click Yes.

How to manage IP allowlists

IP allowlists let you limit access to your deployment to certain IP ranges. It is optional, but strongly recommended to do so.

You can create an allowlist as part of

  1. Click on a project name in the Projects section of the main navigation.
  2. Click on the Security tab.
  3. In the IP allowlists section, click on:
    • The New IP allowlist button to create a new allowlist.
    • A name or the eye icon in the Actions column to view the allowlist.
    • The pencil icon to edit the allowlist. You can also view the allowlist and click the Edit button.
    • The trash can icon to delete the allowlist.

How to manage certificates

Certificates are utilized for encrypted remote administration.

Certificates that do have the Use well known certificate option enabled do not need any installation and will be supported by almost all web-browsers automatically.

Each certificate you create in ArangoDB Oasis that has the Use well known certificate option disabled, you will also need to install on your local machine. This operation will slightly vary between operating systems.

  1. Click on a project name in the Projects section of the main navigation.
  2. Click on the Security tab.
  3. In the Certificates section, click on:
    • The New certificate button to create a new certificate.
    • A name or the eye icon in the Actions column to view a certificate. The dialog that opens provides commands for installing and uninstalling the certificate through a console.
    • The pencil icon to edit a certificate. You can also view a certificate and click on the Edit button.
    • The tag icon to make the certificate the new default.
    • The trash can icon to delete a certificate.

Oasis Certificates

Oasis Certificate Install Instructions

How to manage role bindings

See: