Skip to content

Commit 826e242

Browse files
drothery-edbdrothery-edb
authored
Merge pull request #1933 from EnterpriseDB/2021-10-13
Production branch: 2021 10 13
2 parents 71784dc + cf9a0bf commit 826e242

31 files changed

+2338
-76
lines changed

‎product_docs/docs/edbcloud/beta/administering_cluster/01_portal_access.mdx

Lines changed: 22 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -27,26 +27,29 @@ Permissions are generally represented in the format *action*:*object* where *act
2727

2828
The available *actions* are: create, read, update, delete
2929

30-
The available *objects* are: backups, billing, clusters, events, permissions, roles, tickets, users, versions
30+
The available *objects* are: backups, billing, clusters, events, permissions, roles, users, versions
31+
32+
!!! Note
33+
Not every object supports all the actions. A typical example is *versions* object is always *read* only.
3134

3235
### Permissions by Role
3336

3437
The following are the default permission by role:
3538

36-
| Role | Action |backups | billing | clusters | events | roles | permissions | tickets | users | versions |
37-
|-------------|--------|--------|---------|-----------|--------|-------|-------------|---------|-------|----------|
38-
| owner | create | x | | x | | x | x | x | x | x |
39-
| | read | x | x | x | x | x | x | x | x | x |
40-
| | update | x | | x | | x | x | x | x | x |
41-
| | delete | x | | x | | x | x | x | x | x |
42-
| contributor | create | x | | x | | | | x | | |
43-
| | read | x | x | x | x | x | x | x | x | x |
44-
| | update | x | | x | | | | x | | |
45-
| | delete | x | | x | | | | x | | |
46-
| reader | create | | | | | | | | | |
47-
| | read | x | x | x | x | x | x | x | x | x |
48-
| | update | | | | | | | | | |
49-
| | delete | | | | | | | | | |
39+
| Role | Action |backups | billing | clusters | events | roles | permissions | users | versions |
40+
|-------------|--------|--------|---------|-----------|--------|-------|-------------|--------|----------|
41+
| owner | create | x | | x | | | | | |
42+
| | read | x | x | x | x | x | x | x | x |
43+
| | update | x | | x | | | | x | |
44+
| | delete | x | | x | | | | | |
45+
| contributor | create | x | | x | | | | | |
46+
| | read | x | x | x | x | x | x | x | x |
47+
| | update | x | | x | | | | | |
48+
| | delete | x | | x | | | | | |
49+
| reader | create | | | | | | | | |
50+
| | read | x | x | x | x | x | x | x | x |
51+
| | update | | | | | | | | |
52+
| | delete | | | | | | | | |
5053

5154

5255
### Editing Roles
@@ -104,8 +107,8 @@ To view all users from your organization that have logged in at least once:
104107

105108
1. The EDB Cloud organization is created, and Tom logs in and is granted the owner role.
106109

107-
1. Tom asks Jerry to log in, using his Azure AD account; Jerry's account in EDB Cloud is created.
108-
1. Tom grants Sally the contributor role. Sally logs out and back in, and she can now create EDB Cloud clusters.
109-
1. Sally asks Jerry to log in, and grants him the reader role.
110-
1. Jerry logs out and back in, and he can now see the clusters that Sally has created.
110+
2. Tom asks Jerry to log in, using his Azure AD account; Jerry's account in EDB Cloud is created.
111+
3. Tom grants Sally the contributor role. Sally logs out and back in, and she can now create EDB Cloud clusters.
112+
4. Sally asks Jerry to log in, and grants him the reader role.
113+
5. Jerry logs out and back in, and he can now see the clusters that Sally has created.
111114

‎product_docs/docs/edbcloud/beta/getting_started/03_create_cluster.mdx

Lines changed: 44 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -5,35 +5,61 @@ title: "Creating a Cluster"
55
Prior to creating your cluster, make sure you have adequate Azure resources or your request to create a cluster will fail. See [Raising Your Azure Resource Limits](01_check_resource_limits).
66
!!!
77

8-
98
To create a cluster:
109

1110
1. Sign in to the [EDB Cloud](https://portal.edbcloud.com) portal.
1211

13-
3. Select **Create New Cluster** in the top right of the **Overview** page or **Clusters** page.
14-
4. Enter the name for your cluster in the **Cluster Name** field.
15-
5. Enter a password for your cluster in the **Password** field. This will be the password for the user edb_admin.
16-
6. In the **Database Type** section,
12+
3. Select **Create New Cluster** in the top right of the **Overview** page or **Clusters** page. The **Create Cluster** page opens.
13+
4. Specify the cluster settings on the following tabs of the **Create Cluster** page:
14+
- [**Cluster Info**](#cluster-info)
15+
16+
- [**Operational Settings**](#operational-settings)
17+
- [**DB Configuration** ](#db-configuation) (optional)
18+
- [ **Availibility** ](#availibility) (optional)
19+
20+
8. Select **Create Cluster**. It might take a few minutes to deploy.
21+
22+
!!! Note
23+
When you elect not to configure settings on optional tabs, the default values are used.
24+
25+
## Cluster Info
26+
1. Enter the name for your cluster in the **Cluster Name** field.
27+
28+
2. Enter a password for your cluster in the **Password** field. This will be the password for the user edb_admin.
29+
3. Select **Next: Operational Settings**.
30+
31+
## Operational Settings
32+
1. In the **Database Type** section,
1733
1. Select the type of Postgres you want to use in the **Postgres Type** field:
1834
- [*PostgreSQL*](../../../supported-open-source/postgresql/) is an open-source object-relational database management system.
19-
35+
2036
- [*EDB Postgres Advanced Server*](../../../epas/latest/) is EDB’s secure, Oracle-compatible PostgreSQL.
21-
22-
6. Select the version of Postgres that you want to use in the **Version** field. See [Database Version Policy](../overview/05_database_version_policy) for more information.
23-
7. Select the cloud provider for your cluster in the **Provider** field.
37+
38+
2. Select the version of Postgres that you want to use in the **Version** field. See [Database Version Policy](../overview/05_database_version_policy) for more information.
39+
2. Select the cloud provider for your cluster in the **Provider** field.
2440
!!! Note
2541
Microsoft Azure is the only option for the Preview.
26-
8. Select the region where you want your cluster to be deployed in the **Region** field. For the best performance, EDB typically recommends that this region should be the same as other resources you have that communicate with your cluster.
27-
9. Enable or disable high availablity using the **High Availability** slide button. High availability is enabled by default. When high availability is enabled, clusters are configured with one primary and two replicas with synchronous streaming replication. Clusters are configured across availability zones in regions with availability zones. When high availability is disabled, only one instance is provisioned. See [Supported Architectures](../overview/02_high_availibility) for more information.
28-
10. In the the **Instance Type** section, select the number of vCPUs and amount of memory you desire.
29-
11. In the **Storage** field, select the type and amount of storage needed for your cluster.
42+
3. Select the region where you want your cluster to be deployed in the **Region** field. For the best performance, EDB typically recommends that this region should be the same as other resources you have that communicate with your cluster.
43+
4. In the the **Instance Type** section, select the number of vCPUs and amount of memory you desire.
44+
5. In the **Storage** section, select **Volume Type**, and in **Volume Properties** the type and amount of storage needed for your cluster.
3045
!!! Note
3146
EDB Cloud currently supports Azure Premium SSD storage types. See [the Azure documentation](https://docs.microsoft.com/en-us/azure/virtual-machines/disks-types#premium-ssd) for more information.
32-
12. (Optional) Expand the **Advanced Customization** section, to specify:
33-
1. The desired amount of connections your cluster allows for other applications. You can either enter the amount or use the arrows. The default is 100.
34-
35-
1. Whether to use private or public networking using the **Networking** slide button. Networking is set to Private by default. Private networking allows only IP addresses within your private network to connect to your cluster. Public means that any client can connect to your cluster’s public IP address over the internet.
36-
17. Select **Create Cluster**. It might take a few minutes to deploy.
47+
6. In the **Networking** section, Whether to use private or public networking using the **Networking** slide button. Networking is set to Public by default. Public means that any client can connect to your cluster’s public IP address over the internet.
48+
Private networking allows only IP addresses within your private network to connect to your cluster.
49+
7. To optionally make updates to your database configuration parameters, select **Next: DB Configuration**.
50+
51+
## DB Configuration
52+
In the **Parameters** section, you can update the value of the database configuration parameters, as needed.
53+
54+
To update the parameter values, see [Modifying Your Database Configuration Parameters](../using_cluster/03_modifying_your_cluster/05_db_configuration_parameters)
55+
56+
57+
58+
## Availability
59+
Enable or disable high availability using the **High Availability** slide button. High availability is enabled by default.
60+
When high availability is enabled, clusters are configured with one primary and two replicas with synchronous streaming replication.
61+
Clusters are configured across availability zones in regions with availability zones. When high availability is disabled, only one instance is provisioned.
62+
See [Supported Architectures](../overview/02_high_availibility) for more information.
3763

3864
## What’s Next
3965

‎product_docs/docs/edbcloud/beta/getting_started/index.mdx

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,8 @@
11
---
22
title: "Getting Started"
33
indexCards: simple
4-
navigation:
5-
- 02_connect_cloud_account
6-
- 01_check_resource_limits
7-
- 03_create_cluster
8-
94
---
105

116
In this section, Azure subscription administrators can learn how to initially set up their EDB Cloud account, invite others to join them in exploring what EDB has to offer, and create initial clusters as an account owner so that development can begin.
127

13-
<div class="toctree" maxdepth="5">
14-
15-
connect_cloud_account configure_access create_cluster
168

17-
</div>

‎product_docs/docs/edbcloud/beta/using_cluster/03_modify_and_scale_cluster.mdx

Lines changed: 0 additions & 28 deletions
This file was deleted.

‎product_docs/docs/edbcloud/beta/using_cluster/03_modifying_your_cluster/05_db_configuration_parameters.mdx

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
title: Modifying Database Configuration Parameters
3+
---
4+
5+
The database parameters listed on the DB Configuration tab are also referred to as Grand Unified Configuration (GUC) variables. See [What Is a GUC Variable?](https://www.enterprisedb.com/blog/what-guc-variable) for more information.
6+
7+
The list of parameters is populated based on the type of database you selected on the **Operational Settings** tab when you created your cluster. For more information about the parameters for your database type:
8+
9+
- For Postgres parameters, see [Setting Parameters](https://www.postgresql.org/docs/current/config-setting.html) and [Server Configuration](https://www.postgresql.org/docs/current/runtime-config.html) in the Postgres documentation.
10+
11+
- For EDB Postgres Advanced Server, see [Summary of Configuration Parameters](https://www.enterprisedb.com/docs/epas/latest/epas_guide/03_database_administration/01_configuration_parameters/02_summary_of_configuration_parameters/#summary_of_configuration_parameters) and [Configuration Parameters](https://www.enterprisedb.com/docs/epas/latest/epas_guide/03_database_administration/01_configuration_parameters/).
12+
13+
- For additional information on parameters, see [postgresqlco.nf](https://postgresqlco.nf/).
14+
15+
!!!note
16+
Not all database configuration parameters are supported by EDB Cloud. Some parameters, such as `wal_level` and `restore_command`, are reserved for EDB to provide the managed database features of EDB Cloud.
17+
!!!
18+
19+
To modify a parameter,
20+
21+
1. Go to the parameter you want to modify using these methods:
22+
- To search for a specific parameter, use the search field.
23+
- To filter what parameters show, select one of the following in the **Show only** drop-down list:
24+
- Custom Values - shows only parameters that are changed from the default values, either in this session or modified in a previous session and already applied to the cluster.
25+
- Currently Edited Values - shows only parameters that have been changed during this edit session.
26+
27+
1. Enter the new value in the parameter value field.
28+
29+
1. Save your changes.

‎product_docs/docs/edbcloud/beta/using_cluster/03_modifying_your_cluster/index.mdx

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
title: Modifying Your Cluster
3+
# Added this redirect because we removed the Modify and Scale topic
4+
redirects:
5+
- 03_modify_and_scale_cluster
6+
---
7+
1. Sign in to the [EDB Cloud](https://portal.edbcloud.com) portal.
8+
9+
1. From the [**Clusters**](https://portal.edbcloud.com/clusters) page, select the name of the cluster you want to edit.
10+
11+
2. Select **Edit Cluster** from the top right corner of the **Cluster Info** panel.
12+
13+
1. You can modify the following settings on the corresponding tab of the Edit Cluster page:
14+
15+
| Settings | Tab |
16+
| ------- | ----------- |
17+
| Cluster name and password | [Cluster Info](../../getting_started/03_create_cluster/#cluster_info) |
18+
| Instance type (vCPUs and memory)* | [Operational Settings](../../getting_started/03_create_cluster/#operational_settings) |
19+
| Networking type (public or private) | [Operational Settings](../../getting_started/03_create_cluster/#operational_settings) |
20+
| Database configuration parameters | [Database Configuration Parameters](05_db_configuration_parameters)
21+
| High availability (on or off) | [Availability](../../getting_started/03_create_cluster/#availability) |
22+
23+
*Changing the instance type could incur higher cloud infrastructure charges.
24+
25+
!!! Note
26+
Saving changes may require a database restart.
27+
28+
1. Save your changes.

0 commit comments

Comments
 (0)