README
¶
ArangoDB Cloud API's
This repository contains the interface definition of the API for ArangoDB Oasis, the ArangoDB Cloud.
The entire interface is specified in protocol buffers and uses GRPC underlying as protocol. A full list of API methods and their arguments is available here.
Maintainers
This provider plugin is maintained by the team at ArangoDB.
More information
More information and a getting started guide about the Oasis API is available at arangodb.com/docs/stable/oasis.
Examples
The following projects make use of the ArangoDB Oasis API and are good examples of how to use it:
- oasisctl Commandline utility for ArangoDB Oasis
- terraform-provider-oasis Terraform plugin for ArangoDB Oasis
Building
Building the APIs involves the compilation of the protocol buffers and the generation of a Go client for it.
Note that it is not needed to go through this build process in order to use the API.
The build process requires a github personal access token with the following scopes.
- repo
- repo:status
- repo_deployment
- public_repo
- repo:invite
The token must be placed in a file called ${HOME}/.arangodb/ms/github-readonly-code-acces.token.
To compile the protobuffer specifications and build Go wrappers for them, run:
make build-image
make
Building clients for other languages
Since GRPC is available for many languages (Java, NodeJS, C#, Python...) it is fairly straightforward to create clients for these languages.
To do so, follow language specific instructions on grpc.io.
Note that we do not support clients other than the Go client that already included in this repository.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
api
|
|
|
audit
|
|
|
v1
Package v1 is a reverse proxy.
|
Package v1 is a reverse proxy. |
|
backup
|
|
|
v1
Package v1 is a reverse proxy.
|
Package v1 is a reverse proxy. |
|
billing
|
|
|
v1
Package v1 is a reverse proxy.
|
Package v1 is a reverse proxy. |
|
common
|
|
|
v1
Package common/v1 contains the common types used in API of ArangoDB Managed Service
|
Package common/v1 contains the common types used in API of ArangoDB Managed Service |
|
crypto
|
|
|
v1
Package v1 is a reverse proxy.
|
Package v1 is a reverse proxy. |
|
currency
|
|
|
v1
Package v1 is a reverse proxy.
|
Package v1 is a reverse proxy. |
|
data
|
|
|
v1
Package v1 is a reverse proxy.
|
Package v1 is a reverse proxy. |
|
example
|
|
|
v1
Package example/v1 contains the API of Example services.
|
Package example/v1 contains the API of Example services. |
|
iam
|
|
|
v1
Package iam/v1 contains the API of Identity & Access Management services.
|
Package iam/v1 contains the API of Identity & Access Management services. |
|
internal
|
|
|
metrics
|
|
|
v1
Package metrics/v1 contains the API of Metrics services.
|
Package metrics/v1 contains the API of Metrics services. |
|
monitoring
|
|
|
v1
Package monitoring/v1 contains the API used to monitor deployments.
|
Package monitoring/v1 contains the API used to monitor deployments. |
|
network
|
|
|
v1
Package network/v1 contains the API of network services.
|
Package network/v1 contains the API of network services. |
|
notification
|
|
|
v1
Package notification/v1 contains the API of notifications.
|
Package notification/v1 contains the API of notifications. |
|
platform
|
|
|
v1
Package provider/v1 contains the API used to fetch provider & region information.
|
Package provider/v1 contains the API used to fetch provider & region information. |
|
prepaid
|
|
|
v1
Package prepaid/v1 contains the API of prepaid deployments.
|
Package prepaid/v1 contains the API of prepaid deployments. |
|
replication
|
|
|
v1
Package replication/v1 contains the API of replication services.
|
Package replication/v1 contains the API of replication services. |
|
resourcemanager
|
|
|
v1
Package resourcemanager/v1 contains the API of ResourceManager services.
|
Package resourcemanager/v1 contains the API of ResourceManager services. |
|
security
|
|
|
v1
Package security/v1 contains the API used to fetch security information.
|
Package security/v1 contains the API used to fetch security information. |
|
support
|
|
|
v1
Package support/v1 contains the API used to fetch support information.
|
Package support/v1 contains the API used to fetch support information. |
|
tools
|
|
|
v1
Package tools/v1 contains the API of Tools services.
|
Package tools/v1 contains the API of Tools services. |
|
usage
|
|
|
v1
Package usage/v1 contains the API of Usage services.
|
Package usage/v1 contains the API of Usage services. |