8000 DOC-510 | ArangoGraph Packaging Changes (#1453) · arangodb/docs@bcb8c45 · GitHub
[go: up one dir, main page]
Skip to content
This repository was archived by the owner on Dec 13, 2023. It is now read-only.

Commit bcb8c45

Browse files
nerpaulanerpaula
authored
DOC-510 | ArangoGraph Packaging Changes (#1453)
* packaging changes * remove note and fix link * remove two more mentions of enterprise * changed heading
1 parent 0a30d19 commit bcb8c45

15 files changed

+86
-129
lines changed

‎3.10/quick-start-in-the-cloud.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -138,14 +138,16 @@ Alternatively, follow the steps of the linked guides:
138138
- [Access your deployment](arangograph/deployments.html#how-to-access-your-deployment)
139139
- [Delete your deployment](arangograph/deployments.html#how-to-delete-a-deployment)
140140

141-
## Free-to-Try vs. Professional Service
141+
## Free-to-Try vs. Paid
142142

143-
The ArangoGraph Insights Platform comes with a free-to-try tier that lets you test our ArangoDB
144-
Cloud for free for 14 days. It includes one project and one deployment.
145-
After the trial period, your deployments are automatically deleted.
143+
The ArangoGraph Insights Platform comes with a free-to-try tier that lets you test
144+
the ArangoDB Cloud for free for 14 days. It includes one project and one small
145+
deployment of 4GB, local backups, and one notebook for learning and data science.
146+
After the trial period, your deployment is automatically deleted.
146147

147-
You can convert to the professional service model at any time by adding
148+
You can unlock all features in ArangoGraph at any time by adding
148149
your billing details and at least one payment method. See:
150+
- [ArangoGraph Packages](arangograph/organizations.html#arangograph-packages)
149151
- [How to add billing details to organizations](arangograph/billing.html#how-to-add-billing-details)
150152
- [How to add a payment method to an organization](arangograph/billing.html#how-to-add-a-payment-method)
151153

‎3.11/quick-start-in-the-cloud.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -138,14 +138,16 @@ Alternatively, follow the steps of the linked guides:
138138
- [Access your deployment](arangograph/deployments.html#how-to-access-your-deployment)
139139
- [Delete your deployment](arangograph/deployments.html#how-to-delete-a-deployment)
140140

141-
## Free-to-Try vs. Professional Service
141+
## Free-to-Try vs. Paid
142142

143-
The ArangoGraph Insights Platform comes with a free-to-try tier that lets you test our ArangoDB
144-
Cloud for free for 14 days. It includes one project and one deployment.
145-
After the trial period, your deployments are automatically deleted.
143+
The ArangoGraph Insights Platform comes with a free-to-try tier that lets you test
144+
the ArangoDB Cloud for free for 14 days. It includes one project and one small
145+
deployment of 4GB, local backups, and one notebook for learning and data science.
146+
After the trial period, your deployment is automatically deleted.
146147

147-
You can convert to the professional service model at any time by adding
148+
You can unlock all features in ArangoGraph at any time by adding
148149
your billing details and at least one payment method. See:
150+
- [ArangoGraph Packages](arangograph/organizations.html#arangograph-packages)
149151
- [How to add billing details to organizations](arangograph/billing.html#how-to-add-billing-details)
150152
- [How to add a payment method to an organization](arangograph/billing.html#how-to-add-a-payment-method)
151153

‎3.12/quick-start-in-the-cloud.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -138,14 +138,16 @@ Alternatively, follow the steps of the linked guides:
138138
- [Access your deployment](arangograph/deployments.html#how-to-access-your-deployment)
139139
- [Delete your deployment](arangograph/deployments.html#how-to-delete-a-deployment)
140140

141-
## Free-to-Try vs. Professional Service
141+
## Free-to-Try vs. Paid
142142

143-
The ArangoGraph Insights Platform comes with a free-to-try tier that lets you test our ArangoDB
144-
Cloud for free for 14 days. It includes one project and one deployment.
145-
After the trial period, your deployments are automatically deleted.
143+
The ArangoGraph Insights Platform comes with a free-to-try tier that lets you test
144+
the ArangoDB Cloud for free for 14 days. It includes one project and one small
145+
deployment of 4GB, local backups, and one notebook for learning and data science.
146+
After the trial period, your deployment is automatically deleted.
146147

147-
You can convert to the professional service model at any time by adding
148+
You can unlock all features in ArangoGraph at any time by adding
148149
your billing details and at least one payment method. See:
150+
- [ArangoGraph Packages](arangograph/organizations.html#arangograph-packages)
149151
- [How to add billing details to organizations](arangograph/billing.html#how-to-add-billing-details)
150152
- [How to add a payment method to an organization](arangograph/billing.html#how-to-add-a-payment-method)
151153

‎arangograph/backups.md

Lines changed: 4 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ To backup data in ArangoGraph for an ArangoDB installation, navigate to the
1515
There are two ways to create backups. Create periodic backups using a
1616
**Backup policy**, or create a backup manually.
1717
Both ways allow you to create [backups in multiple regions](#multi-region-backups)
18-
as well, if your organization belongs to the Enterprise tier.
18+
as well.
1919

2020
### Periodic backups
2121

@@ -34,8 +34,7 @@ These backups are not automatically uploaded. To enable this, use the
3434
**Upload backup to storage** option and choose a retention period that
3535
specifies how long backups are retained after creation.
3636

37-
If your organization belongs to the Enterprise tier and the
38-
**Upload backup to storage** option is enabled for a backup policy,
37+
If the **Upload backup to storage** option is enabled for a backup policy,
3938
you can then create backups in different regions than the default one.
4039
The regions where the default backup is copied are shown in the
4140
**Additional regions** column in the **Policies** section.
@@ -48,8 +47,7 @@ It's also possible to create a backup on demand. To do this, click **Back up now
4847

4948
![Back up Now Dialog](images/arangograph-back-up-now-dialog.png)
5049

51-
If your organization belongs to the Enterprise tier and you want to manually
52-
copy a backup to a different region than the default
50+
If you want to manually copy a backup to a different region than the default
5351
one, first ensure that the **Upload backup to storage** option is enabled.
5452
Then, highlight the backup row and use the
5553
**Copy backup to a different region** button from the **Actions** column.
@@ -103,13 +101,6 @@ alternatives such as having hourly backups with a retention period of a year.
103101

104102
## Multi-region backups
105103

106-
{% hint 'info' %}
107-
The multi-region backup feature is only available for the ArangoGraph
108-
Enterprise tier. To upgrade to the Enterprise tier,
109-
[get in touch](https://www.arangodb.com/contact/){:target="_blank"}
110-
with the ArangoDB team.
111-
{% endhint %}
112-
113104
Using the multi-region backup feature, you can store backups in multiple regions
114105
simultaneously either manually or automatically as part of a **Backup policy**.
115106
If a backup created in one region goes down, it is still available in other
@@ -145,8 +136,7 @@ During restore, the deployment is temporarily not available.
145136
{% hint 'info' %}
146137
The cloned deployment will have the exact same features as the previous
147138
deployment including node size, model, and cloud provider. The region
148-
can stay the same or you can select a different one if your organization belongs
149-
to the Enterprise tier.
139+
can stay the same or you can select a different one.
150140
For restoring a deployment as quick as possible, it is recommended to create a
151141
deployment in the same region as where the backup resides to avoid cross-region
152142
data transfer.

‎arangograph/deployments.md

Lines changed: 11 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,6 @@ its projects and deployments.
3030
4. Click the __New deployment__ button.
3131
5. Set up your deployment. The configuration options are described below.
3232

33-
{% hint 'info' %}
34-
The configuration options depend on the tier your organization belongs to.
35-
For more details about available resources and usage limits, refer to the
36-
[ArangoGraph tiers](organizations.html#arangograph-tiers) section.
37-
{% endhint %}
38-
3933
![ArangoGraph New Deployment](images/arangograph-new-deployment1.png)
4034

4135
{% hint 'info' %}
@@ -94,13 +88,8 @@ provider and region in the Location section.
9488

9589
#### OneShard
9690

97-
1. Select the memory size of your node.
98-
2. Select the CPU size of your node.
99-
3. Select the initial disk size of your node. The available ranges for the disk size
100-
depend on the selected memory size.
101-
4. Select the upper limit for the disk size. It defaults to twice the initial
102-
disk size. You can set it to the same value as the initial disk size to
103-
disable automatic disk sizing.
91+
- Select the memory size of your node. The disk size is automatically set for you
92+
based on the selected memory size.
10493

10594
{% hint 'info' %}
10695
A deployment's node disk size is automatically increased by 25% when the maximal
@@ -114,16 +103,17 @@ the upper disk size limit already.
114103

115104
#### Sharded
116105

117-
- In addition to memory and disk size as in the OneShard configuration, select
106+
- In addition to the memory size as in the OneShard configuration, select
118107
the number of nodes for your deployment. The more nodes you have, the higher
119-
the replication factor can be.
108+
the replication factor can be. Same as in OneShard, the disk size is automatically
109+
set for you.
120110

121111
![ArangoGraph Deployment Sharded](images/arangograph-new-deployment-sharded.png)
122112

123113
#### Single Server
124114

125-
- Like with OneShard and Sharded deployments, you choose memory and disk size.
126-
However note that the sizes you choose are for the entire deployment.
115+
- Like with OneShard and Sharded deployments, you can choose the memory size.
116+
Note, however, that the size you choose is for the entire deployment.
127117
For OneShard and Sharded deployments the chosen sizes are per node.
128118

129119
![ArangoGraph Deployment Single Server](images/arangograph-new-deployment-singleserver.png)
@@ -250,7 +240,7 @@ are using the `18529` port to avoid breaking changes.
250240
## How to edit a deployment
251241

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

@@ -259,12 +249,6 @@ To edit an existing deployment, you must have the necessary set of permissions
259249
attached to your role. Read more about [roles and permissions](access-control.html#roles).
260250
{% endhint %}
261251

262-
{% hint 'info' %}
263-
The configuration options depend on the tier your organization belongs to.
264-
For more details about available resources and usage limits, refer to the
265-
[ArangoGraph tiers](organizations.html#arangograph-tiers) section.
266-
{% endhint %}
267-
268252
1. Go to the **Projects** section and select an existing deployment from the list.
269253
2. Open the deployment you want to change.
270254
3. On the **Overview** tab, click the **Edit** button.
@@ -274,28 +258,18 @@ For more details about available resources and usage limits, refer to the
274258
- Select a different CA certificate.
275259
- Add or remove an IP allowlist.
276260
5. In the **Configuration** section, you can do the following:
277-
- Upgrade the memory size per node.
278-
- Modify the CPU per node from General to Low or vice-versa, if made available
279-
by the cloud provider.
280-
- Select a different disk size per node. The available ranges for the disk size
281-
depend on the selected memory size. To enable automatic disk size scaling, move
282-
the slider to a value higher than the current disk size.
261+
- Upgrade the memory size per node. The disk size is automatically set for you.
283262
- Change **OneShard** deployments into **Sharded** deployments. To do so,
284263
click **Sharded**. In addition to the other configuration options, you can
285264
select the number of nodes for your deployment. This can also be modified later on.
286265

287266
{% hint 'warning' %}
288267
Notice that you cannot switch from **Sharded** back to **OneShard**.
289268
{% endhint %}
290-
291-
- AWS deployments have an additional option that allows you to select the
292-
**Disk Performance** either with general settings, or optimized for large
293-
and very large data sets. This option is dependent on the selected memory
294-
size. For example, larger deployments have optimized settings by default.
295269

296270
{% hint 'warning' %}
297-
When upgrading the memory size, disk size, and/or disk performance in AWS deployments,
298-
the value gets locked and cannot be changed until the cloud provider rate limit is reset.
271+
When upgrading the memory size in AWS deployments, the value gets locked and
272+
cannot be changed until the cloud provider rate limit is reset.
299273
{% endhint %}
300274

301275
6. All changes are reflected in the **Summary** section. Review the new

‎arangograph/images/arangograph-billing.png

238 KB
Loading

‎arangograph/images/arangograph-new-deployment-oneshard.png

64.2 KB
Loading

‎arangograph/images/arangograph-new-deployment-sharded.png

78.4 KB
Loading

‎arangograph/images/arangograph-new-deployment-singleserver.png

65.7 KB
Loading

‎arangograph/notebooks.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,8 @@ favorite GraphML libraries with GPUs.
5858

5959
{% hint 'info' %}
6060
Depending on the tier your organization belongs to, different limitations apply:
61-
- Professional and Enterprise tiers: you can create up to three notebooks per deployment.
62-
- Free-to-try tier: you can only create one notebook per deployment.
61+
- On-Demand and Committed: you can create up to three notebooks per deployment.
62+
- Free-to-try: you can only create one notebook per deployment.
6363
{% endhint %}
6464

6565
![Notebooks](images/arangograph-notebooks.png)

‎arangograph/organizations.md

Lines changed: 43 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -29,51 +29,58 @@ member of one _Free-to-try_ tier organization at a time.
2929

3030
![ArangoGraph Organization Overview](images/arangograph-organization-overview.png)
3131

32-
## ArangoGraph tiers
33-
34-
With the ArangoGraph Insights Platform, your organization can belong to one of the following three tiers:
35-
36-
- **Free-to-try tier**: ArangoGraph comes with a free-to-try tier that lets
37-
you test ArangoGraph for free for 14 days. After the trial period,
38-
your deployments will be deleted automatically. Includes the Basic Support plan,
39-
which covers the availability and connectivity of the ArangoGraph Insights Platform, and general questions.
40-
- **Professional tier**: Allows you to create additional organizations and
41-
projects, and have more and larger deployments. Includes the Standard support for
42-
professional deployments, which covers everything from the Basic support plan
43-
with explicit response times.
44-
- **Enterprise tier**: Get unlimited access to all functionalities and resources,
45-
with the best available support and response times. Includes the Premium Standard
46-
support plan.
47-
48-
|  | Free-to-try | Professional | Enterprise |
49-
|-------|:--------------:|:---------------:|:-------------:|
50-
| **Organizations per user** | 1 | Unlimited | Unlimited |
51-
| **Projects per organization** | 1 | 3 | Unlimited |
52-
| **Deployments per project** | 1 | 5 | Unlimited |
53-
| **Upload backup** | Not included | Included | Included |
54-
| **Private endpoint deployment** | Not included | Not included | Included |
55-
| **Support plan** | Basic | Standard | Premium Standard |
32+
## ArangoGraph Packages
5633

57-
{% hint 'info' %}
58-
Based on the type of tier your organization belongs to, different usage
59-
limits apply for memory and storage.
60-
{% endhint %}
34+
With the ArangoGraph Insights Platform, your organization can choose one of the
35+
following packages.
6136

62-
## How to upgrade to Professional tier
37+
### Free Trial
6338

64-
You can upgrade to the professional service model at any time by adding
65-
your billing details and at least one payment method. You can then create
66-
additional organizations and projects and have more and larger deployments.
39+
ArangoGraph comes with a free-to-try tier that lets you test ArangoGraph for
40+
free for 14 days. You can get started quickly, without needing to enter a
41+
credit card.
6742

68-
See [Billing: How to add billing details / payment methods](billing.html)
43+
The free trial gives you access to:
44+
- One small deployment (4GB) in a region of your choice for 14 days
45+
- Local backups
46+
- One ArangoGraph Notebook for learning and data science
6947

70-
![ArangoGraph Billing](images/arangograph-billing.png)
48+
After the trial period, your deployment will be deleted automatically.
49+
50+
### On-Demand
51+
52+
Add a payment payment method to gain access to ArangoGraph's full feature set.
53+
Pay monthly via a credit card for what you actually use.
54+
55+
This package unlocks all ArangoGraph functionality, including:
56+
- Multiple and larger deployments
57+
- Backups to cloud storage, with multi-region support
58+
- Enhanced security features such as Private Endpoints
59+
60+
### Committed
7161

72-
## How to upgrade to Enterprise tier
62+
Commit up-front for a year and pay via the Sales team. This package provides
63+
the same flexibility of On-Demand, but at a lower price.
7364

74-
To upgrade to the Enterprise tier, you need to get in touch with the ArangoDB
65+
In addition, you gain access to:
66+
- 24/7 Premium Support
67+
- ArangoDB Professional Services Engagements
68+
- Ability to transact via the AWS and GCP marketplaces
69+
70+
To take advantage of this, you need to get in touch with the ArangoDB
7571
team. [Contact us](https://www.arangodb.com/contact/){:target="_blank"} for more details.
7672

73+
## How to unlock all features
74+
75+
You can unlock all features in ArangoGraph at any time by adding your billing
76+
details and a payment method. As soon as you have added a payment method, all
77+
ArangoGraph functionalities are immediately unlocked. From that point on, your
78+
deployments will no longer expire and you can create more and larger deployments.
79+
80+
See [Billing: How to add billing details / payment methods](billing.html)
81+
82+
![ArangoGraph Billing](images/arangograph-billing.png)
83+
7784
## How to create a new organization
7885

7986
See [My Account: How to create a new organization](my-account.html#how-to-create-a-new-organization)

‎arangograph/private-endpoints.md

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,6 @@ securely deploy to various cloud providers such as Google Cloud Platform (GCP),
1111
Microsoft Azure, and Amazon Web Services (AWS). Follow the steps outlined below
1212
to get started.
1313

14-
{% hint 'info' %}
15-
The private endpoint feature is only available on the
16-
[Enterprise tier](organizations.html#arangograph-tiers) of ArangoGraph.
17-
{% endhint %}
18-
1914
{% hint 'tip' %}
2015
Private endpoints on Microsoft Azure can be cross region; in AWS they should be
2116
located in the same region.
@@ -52,9 +47,7 @@ service attachment that you need during the creation of your private endpoint(s)
5247

5348
1. Open the deployment you want to change.
5449
2. On the **Overview** tab, click the **Edit** button with an ellipsis (`…`)
55-
icon. If you see a pencil icon and no menu opens, then you are on the
56-
Free-to-try or Professional tier. The private endpoint service is only available
57-
if your organization belongs to the Enterprise tier.
50+
icon.
5851
3. Click **Change to private endpoint** in the menu.
5952
![ArangoGraph Deployment Private Endpoint Menu](images/arangograph-gcp-change.png)
6053
4. In the configuration wizard, click **Next** to enter your configuration details.
@@ -98,9 +91,7 @@ please contact support via **Request help** in the help menu.
9891

9992
1. Open the deployment you want to change.
10093
2. On the **Overview** tab, click the **Edit** button with an ellipsis (`…`)
101-
icon. If you see a pencil icon and no menu opens, then you are on the
102-
Free-to-try or Professional tier. The private endpoint service is only available
103-
if your organization belongs to the Enterprise tier.
94+
icon.
10495
3. Click **Change to private endpoint** in the menu.
10596
![ArangoGraph Deployment Private Endpoint Menu](images/arangograph-deployment-private-endpoint-menu.png)
10697
4. In the configuration wizard, click **Next** to enter your configuration details.
@@ -155,9 +146,7 @@ that automatically connects to private endpoints that are created in those princ
155146

156147
1. Open the deployment you want to change.
157148
2. In the **Overview** tab, click the **Edit** button with an ellipsis (`…`)
158-
icon. If you see a pencil icon and no menu opens, then you are on the
159-
Free-to-try or Professional tier. The private endpoint service is only available
160-
if your organization belongs to the Enterprise tier.
149+
icon.
161150
3. Click **Change to private endpoint** in the menu.
162151
![ArangoGraph Deployment AWS Change to Private Endpoint](images/arangograph-aws-change-to-private-endpoint.png)
163152
4. In the configuration wizard, click **Next** to enter your configuration details.

‎arangograph/scim.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,6 @@ title: SCIM Provisioning
55
---
66
# SCIM Provisioning
77

8-
{% hint 'info' %}
9-
This feature is only available in ArangoGraph Enterprise.
10-
{% endhint %}
11-
128
ArangoGraph provides support to control and manage members access in
139
ArangoGraph organizations with the
1410
**System for Cross-domain Identity Management** (SCIM) provisioning.

‎arangograph/single-sign-on.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,6 @@ title: Single Sign-On (SSO)
55
---
66
# Single Sign-On (SSO)
77

8-
{% hint 'info' %}
9-
This feature is only available in ArangoGraph Enterprise.
10-
{% endhint %}
11-
128
ArangoGraph provides support to enable **Single Sign-On** (SSO) authentication
139
using **Security Assertion Markup language 2.0** (SAML 2.0).
1410

0 commit comments

Comments
 (0)
0