Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cloud/cloud-scaling.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ default one.

### Data disks

**Data Disks** are dedicated storage volumes used exclusively for RavenDB data. They are available on **Azure** for instances running in the *Production Tier*. These disks are entirely separate from the operating system disk, which remains isolated to ensure system stability and optimal performance.
**Data Disks** are dedicated storage volumes used exclusively for RavenDB data. They are available for instances running in the *Production Tier*. These disks are entirely separate from the operating system disk, which remains isolated to ensure system stability and optimal performance.

The use of a data disk is mandatory for deployments requiring more than 1TB of storage.

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified cloud/portal/assets/portal-product-create-billing-section.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified cloud/portal/assets/portal-product-create-customize-section.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified cloud/portal/assets/portal-product-create-summary-section.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified cloud/portal/assets/portal-product-details-allowed-ips.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified cloud/portal/assets/portal-product-details-maintenance-zone.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified cloud/portal/assets/portal-product-details-metrics.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified cloud/portal/assets/portal-product-list-add-product-button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified cloud/portal/assets/portal-product-list-product-active.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified cloud/portal/assets/portal-product-list-product-creating.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified cloud/portal/assets/portal-support-activation-request-form.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified cloud/portal/assets/portal-support-tab.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified cloud/portal/assets/provider-region-tier-selection.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
99 changes: 58 additions & 41 deletions cloud/portal/cloud-portal-products-tab.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,113 +35,129 @@ and [Production](../../cloud/cloud-overview.mdx#the-production-tier).
</Admonition>

## Provisioning a New Product

To provision a new product, open your Portal's Products tab and click **Add Product**.

!["Figure 1 - Add Product"](./assets/portal-product-list-add-product-button.png)

The New Product wizard will open and walk you through the following simple stages:

A. [Plan](../../cloud/portal/cloud-portal-products-tab.mdx#a-new-product-plan)
B. [Billing](../../cloud/portal/cloud-portal-products-tab.mdx#b-new-product-billing)
C. [Customize](../../cloud/portal/cloud-portal-products-tab.mdx#c-new-product-customize)
D. [Summary](../../cloud/portal/cloud-portal-products-tab.mdx#d-new-product-summary)
B. [Account](../../cloud/portal/cloud-portal-products-tab.mdx#b-new-product-account)
C. [Billing](../../cloud/portal/cloud-portal-products-tab.mdx#c-new-product-billing)
D. [Customize](../../cloud/portal/cloud-portal-products-tab.mdx#d-new-product-customize)
E. [Summary](../../cloud/portal/cloud-portal-products-tab.mdx#e-new-product-summary)

#### A. New Product: Plan
Use the Plan page to choose your product's cloud **Provider**, **Region** and **Tier**.
Use the Plan page to choose your product's cloud **Provider**, **Region**, **Tier**, **Instance**, **Storage** and **Payment model**.

!["Figure 2 - Plan Provider Region & Tier"](./assets/provider-region-tier-selection.png)



1. **Cloud Provider**
Choose your cloud host. It can currently be one of three providers:
Amazon AWS, Microsoft Azure, and Google Cloud Platform.
**Amazon Web Services**, **Microsoft Azure**, and **Google Cloud Platform**.

2. **Region**
Select where your equipment would be physically located.


3. **Tier**
You can raise a [Free node](../../cloud/cloud-instances.mdx#a-free-cloud-node),
a [Development node](../../cloud/cloud-instances.mdx#a-development-cloud-server) or a
[Production cluster](../../cloud/cloud-instances.mdx#a-production-cloud-cluster).
Learn more about them in the [Tiers and Instances](../../cloud/cloud-instances.mdx) page.
#### B. New Product: Billing
Enter your billing details and click Next,
or click **Skip Billing Information** to evaluate the cloud service using a basic free product.

4. **Instance**
Choose the instance type that best suits your requirements.
Learn more about them in the [Tiers and Instance](../../cloud/cloud-instances.mdx) page.

5. **Storage**
Select disk type and size.
Learn more about them in the [Scaling](../../cloud/cloud-scaling#scaling---change-storage) page.

6. **Payment model**
Choose your payment model and commitment.
Learn more about them in the [Pricing, Payment and Billing](../../cloud/cloud-pricing-payment-billing) page.

#### B. New Product: Account
Enter your account information and click **Next**.

!["Figure 3 - New Product: Account"](./assets/portal-product-create-account-section.png)

#### C. New Product: Billing
Enter your billing details and click **Next**.

!["Figure 4 - New Product: Billing"](./assets/portal-product-create-billing-section.png)

!["Figure 3 - New Product: Billing"](./assets/portal-product-create-billing-section.png)
#### C. New Product: Customize
#### D. New Product: Customize
Choose your product's display name, release channel and allowed IP addresses.

!["Figure 4 - New Product: Customize"](./assets/portal-product-create-customize-section.png)
!["Figure 5 - New Product: Customize"](./assets/portal-product-create-customize-section.png)

The **Display Name** is simply the name that would appear in your Cloud Products tab.
<Admonition type="note" title="Important " id="important" href="#important">
The **Allowed IPs** section determines which addresses would be allowed to manage your database.
This adds an important layer to your database security on the network level.
You can read more about it in the [Security](../cloud-security.mdx#access-your-product) page.
</Admonition>
#### D. New Product: Summary

#### E. New Product: Summary
The Summary stage shows you your choices and lets you edit them if you wish.

!["Figure 5 - New Product: Summary"](./assets/portal-product-create-summary-section.png)
!["Figure 6 - New Product: Summary"](./assets/portal-product-create-summary-section.png)
When you finish defining your product, the cloud provisioning routine will show you
your new product's status until it's ready to go.

!["Figure 6 - New Product: Provisioning"](./assets/portal-product-list-product-creating.png)

!["Figure 7 - New Product: Active"](./assets/portal-product-list-product-active.png)
!["Figure 7 - New Product: Provisioning"](./assets/portal-product-list-product-creating.png)

!["Figure 8 - New Product: Active"](./assets/portal-product-list-product-active.png)

## View the Product Metrics

!["Figure 8 - Product Metrics: General View"](./assets/portal-product-details-metrics.png)
!["Figure 9 - Product Metrics: General View"](./assets/portal-product-details-metrics.png)

This allows you to analyse your machine resources for a selected time period and cluster node.
It's useful for analysing usage, instance overload and traffic.


## View the Cluster Health

!["Figure 9 - Cluster Health: General View"](./assets/portal-product-details-cluster-health.png)
!["Figure 10 - Cluster Health: General View"](./assets/portal-product-details-cluster-health.png)

This allows you to analyse your cluster incidents for a selected *time period*, *cluster node*, *severity*, *category* and *event status*.
In addition, **Cluster Health** generates suggestions for a selected *cluster node* based on incident trends that can help resolve cluster stability issues.
It's useful for analysing usage, instance overload and traffic.

More details can be found [here](../cloud-maintenance-troubleshooting.mdx#cluster-health).


## Managing an Existing Product

To modify an existing product, find it in the Products tab and click its Manage button.

!["Figure 10 - Manage Product: Manage Button"](./assets/portal-product-list-manage-button.png)
!["Figure 11 - Manage Product: Manage Button"](./assets/portal-product-list-manage-button.png)

This is a general view of the product details page:

!["Figure 11 - Product Details"](./assets/portal-product-details.png "Figure 11 - Manage Product: Product Details")
!["Figure 12 - Product Details"](./assets/portal-product-details.png "Figure 11 - Manage Product: Product Details")

### Change Instance Type and Storage
You can view your configuration and change your product's instance type and storage size here.

!["Figure 12 - Manage Product tab"](./assets/portal-product-details-instance-parameters.png)
!["Figure 13 - Manage Product tab"](./assets/portal-product-details-instance-parameters.png)
* **Change Instance Type**
Use sliders to set your desired configuration. This can be changed later as you need to scale to changing data processing needs.

!["Figure 13 - Manage Product: Scale"](./assets/portal-product-details-edit-tier.png)
!["Figure 14 - Manage Product: Scale"](./assets/portal-product-details-edit-tier.png)

More details can be found [here](../cloud-scaling.mdx#change-instance-type).
* **Change Storage**
Use this slider to modify your product's storage.

!["Figure 14 - Manage Product: Change Storage"](./assets/portal-product-details-edit-storage.png)
!["Figure 15 - Manage Product: Change Storage"](./assets/portal-product-details-edit-storage.png)

On **Azure** disk can be migrated to **Data Disk** using *Migrate disk* button.
Disk can be migrated to **Data Disk** using *Migrate disk* button.

!["Figure 15 - Manage Product: Storage"](./assets/portal-product-details-storage.png)
!["Figure 16 - Manage Product: Storage"](./assets/portal-product-details-storage.png)

More details can be found [here](../cloud-scaling.mdx#change-storage).

### Instance Access

* **Open Studio**
Expand All @@ -151,7 +167,7 @@ You can view your configuration and change your product's instance type and stor
Use the security tab to download your [certificate](../../cloud/cloud-security.mdx) or determine which addresses are
allowed to connect your database instance.

!["Figure 16 - Manage Product: Manage access"](./assets/portal-product-details-manage-access.png)
!["Figure 17 - Manage Product: Manage access"](./assets/portal-product-details-manage-access.png)

* **Download Certificate**
Click this button to download your certificate.
Expand All @@ -170,18 +186,19 @@ allowed to connect your database instance.
* **See audit logs**
Click this button to view audit logs. A popup will show where you have to select a year and month.
You can download audit logs from there.
!["Figure 17 - See audit logs"](./assets/portal-product-details-audit-logs.png)
!["Figure 18 - See audit logs"](./assets/portal-product-details-audit-logs.png)

* **Edit**
Click this button to edit your product's list of Allowed IPs.

!["Figure 18 - Manage Product: Edit IPs"](./assets/portal-product-details-allowed-ips.png)
!["Figure 19 - Manage Product: Edit IPs"](./assets/portal-product-details-allowed-ips.png)

<Admonition type="info" title="We recommend fortifying your security by allowing access only to specific IPs" id="we-recommend-fortifying-your-security-by-allowing-access-only-to-specific-ips" href="#we-recommend-fortifying-your-security-by-allowing-access-only-to-specific-ips">
You can increase your system's security further using this in-depth security measure and restrict access to
trusted sources, e.g. your application servers.
More details can be found in the [Security](../cloud-security.mdx#access-your-product) page.
</Admonition>

### Manage features

You can view features available for your product, enable, disable and configure them here.
Expand All @@ -190,31 +207,31 @@ You can view features available for your product, enable, disable and configure
After enabling features some of them must be configured to work properly.
</Admonition>

!["Figure 19 - Manage Features: Configure or disable features"](./assets/portal-product-features-enabled.png)
!["Figure 20 - Manage Features: Configure or disable features"](./assets/portal-product-features-enabled.png)

Available features are described on [Product Features](../cloud-features.mdx) page.

### Nodes: Additional product nodes

You can expand your cluster by adding *more product nodes* to your cluster. This helps improve *High Availability* and *task/load balancing*.

!["Figure 20 - Nodes: Manage additional nodes"](./assets/portal-product-nodes-additional-nodes.png)
!["Figure 21 - Nodes: Manage additional nodes"](./assets/portal-product-nodes-additional-nodes.png)

More details can be found [here](../cloud-scaling.mdx#additional-product-nodes---general).

### Maintenance and Danger Zones: Terminate and Restart your Instance
You can restart your product nodes, deploy additional tools and terminate your product here.

!["Figure 21 - Manage Product: Maintenance and Termination"](./assets/portal-product-details-maintenance-and-termination.png)
!["Figure 22 - Manage Product: Maintenance and Termination"](./assets/portal-product-details-maintenance-and-termination.png)
* **Maintenance Zone**
Use this tab to restart selected node and deploy RavenDB tools.

!["Figure 22 - Manage Product: Storage"](./assets/portal-product-details-maintenance-zone.png)
!["Figure 23 - Manage Product: Storage"](./assets/portal-product-details-maintenance-zone.png)
* **Danger Zone**
Use this tab's **Terminate** button to eliminate your cluster.

!["Figure 23 - Manage Product: Terminate"](./assets/portal-product-details-terminate-product.png)
!["Figure 24 - Manage Product: Terminate"](./assets/portal-product-details-terminate-product.png)

<Admonition type="danger" title="">
Terminating your instance is **irreversible**. Your data and cluster properties will be permanently lost.
</Admonition>


Loading