Skip to content

Commit 641c944

Browse files
authored
Merge pull request #2074 from EnterpriseDB/release/2021-11-30
Release 2021-11-30
2 parents 5276700 + 0f789ea commit 641c944

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+532
-440
lines changed

product_docs/docs/bart/2.6/bart_inst/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ This guide provides information about how to install and configure the EDB Backu
2222
- To view a complete list of supported platforms, see [Platform Compatibility](https://www.enterprisedb.com/platform-compatibility).
2323

2424

25-
!!! Note
26-
BART 2.6 is no longer supported on CentOS/RHEL/OL 6.x platforms. It is strongly recommended that EDB products running on these platforms be migrated to a supported platform.
25+
!!! Note
26+
BART is not supported by EDB Postgres Advanced Server or PostgreSQL version 14 and later. EDB strongly recommends you move to Barman or pgBackRest as your backup recovery tool. See [Moving to a New Backup Tool](../bart_migration) for more information.
2727

2828
- BART supports the following database versions:
2929

product_docs/docs/biganimal/release/administering_cluster/01_portal_access.mdx

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -4,35 +4,36 @@ redirects:
44
- 01_user_access
55
---
66

7-
BigAnimal uses Azure Active Directory (AD) to authenticate users and role based access controls to grant users access to different parts of the application.
7+
BigAnimal uses Azure Active Directory (AD) to authenticate users and role-based access controls to grant users access to different parts of the application.
88

99
## Organizations
1010

11-
Each subscribed customer has a unique *organization*. Each organization’s database clusters are deployed and managed in the customer's cloud account. This ensures complete segregation of customer data between organizations.
11+
Each subscribed customer has a unique *organization*. Each organization’s database clusters are deployed and managed in the customer's cloud account. This approach ensures complete segregation of customer data between organizations.
1212

13-
Each BigAnimal organization is associated with an Azure AD tenant. Azure AD establishes the identity of users that belong to an organization. After Azure AD is linked during subscription, users that belong to that AD can login with minimum access privileges.
13+
Each BigAnimal organization is associated with an Azure AD tenant. Azure AD establishes the identity of users that belong to an organization. After Azure AD is linked during subscription, users that belong to that AD can log in with minimum access privileges.
1414

15-
BigAnimal supports role based access control policies. A user with the owner role may assign roles to other users in the same organization.
15+
BigAnimal supports role-based access control policies. A user with the owner role can assign roles to other users in the same organization.
1616

1717
## Roles
1818
Access to BigAnimal is controlled by roles. Roles are sets of permissions. You use roles to manage permissions assigned to users.
1919

20-
* Each organization will have three default roles available:
20+
Each organization has three default roles available:
2121
* owner
2222
* reader
2323
* contributor
24-
* These roles can be edited by changing their name or description.
24+
25+
You can edit these roles by changing their name or description.
2526

2627
### Permissions
2728

28-
Permissions are generally represented in the format *action*:*object* where *action* represents an operation that can be performed and *object* represents a category of portal functionality.
29+
Permissions are generally represented in the format *action*:*object* where *action* represents an operation to perform and *object* represents a category of portal functionality.
2930

30-
The available *actions* are: create, read, update, delete
31+
* The available actions are: create, read, update, and delete.
3132

32-
The available *objects* are: backups, billing, clusters, events, permissions, roles, users, versions
33+
* The available objects are: backups, billing, clusters, events, permissions, roles, users, and versions.
3334

3435
!!! Note
35-
Not every object supports all the actions. A typical example is *versions* object is always *read* only.
36+
Not every object supports all the actions. For example, versions objects are always read-only.
3637

3738
### Permissions by role
3839

@@ -54,63 +55,62 @@ The following are the default permission by role:
5455
| | delete | | | | | | | | |
5556

5657

57-
### Editing roles
58+
### Edit roles
5859

59-
To edit roles:
6060
1. Navigate to **Admin > Roles**.
6161

6262
3. Select the edit icon for the role in the list.
6363

64-
#### Changing role name
64+
#### Change role name
6565

66-
To change the name or description of the role:
6766
1. Select the **Settings** tab.
6867

6968
2. Edit **Name** or **Description**.
70-
3. Press **Save**.
69+
3. Select **Save**.
70+
71+
#### Change role permissions
7172

72-
#### Changing role permissions
73+
You can change permissions associated with the role.
7374

74-
To change permissions associated with the role:
7575
1. Select the **Permissions** tab.
7676

77-
2. Select the **Change Permissions** button on the top right.
78-
3. Select the list of permissions you want to be associated with the role.
79-
4. Press **Submit**
77+
2. Select **Change Permissions** in the top right.
78+
3. Select the list of permissions you want to associate with the role.
79+
4. Select **Submit**.
8080

8181
!!! Note
82-
Changing role permissions will affect every user who is assigned the same role.
82+
Changing role permissions affects every user who is assigned that role.
8383

8484
## Users
8585

86-
When you configured your Azure subscription, you also enabled BigAnimal to authenticate users from your organization using Azure AD. Before users become visible in the BigAnimal **Users** screen they need to sign in using Azure AD after receiving special emails sent by your organization. New users signed in to BigAnimal have a minimum set of permissions until you assign them a role.
86+
When you configured your Azure subscription, you also enabled BigAnimal to authenticate users from your organization using Azure AD. Before users become visible in the BigAnimal **Users** screen, they need to sign in using Azure AD after receiving special emails from your organization. New users signed in to BigAnimal have a minimum set of permissions until you assign them a role.
87+
88+
### Assign roles to users
8789

88-
### Assigning roles to users
89-
To assign appropriate roles to users:
9090
1. Navigate to **Admin > Users**.
9191

9292
2. Select the edit icon for the user.
9393
3. Select **Assign Roles**.
94-
4. Select or deselect roles for the user.
94+
4. Select or clear roles for the user.
9595
5. Select **Submit**.
9696

9797
!!! Note
98-
For a user's role assignment to take effect, the user needs to log out from BigAnimal and log in again.
98+
For a user's role assignment to take effect, the user must log out from BigAnimal and log in again.
9999

100-
### Viewing users
100+
### View users
101101

102-
To view all users from your organization that have logged in at least once:
102+
You can view all users from your organization who have logged in at least once.
103103

104104
1. Navigate to **Admin > Users**.
105105

106-
2. View the list of users sorted by most recent log in.
106+
2. View the list of users sorted by most recent login.
107107

108108
## Example scenario
109109

110110
1. The BigAnimal organization is created, and Tom logs in and is granted the owner role.
111111

112-
2. Tom asks Jerry to log in, using his Azure AD account; Jerry's account in BigAnimal is created.
113-
3. Tom grants Sally the contributor role. Sally logs out and back in, and she can now create BigAnimal clusters.
114-
4. Sally asks Jerry to log in, and grants him the reader role.
115-
5. Jerry logs out and back in, and he can now see the clusters that Sally has created.
112+
2. Tom asks Jerry to log in, using his Azure AD account. Jerry's account in BigAnimal is created.
113+
3. Tom grants Sally the contributor role. Sally logs out and back in. She can now create BigAnimal clusters.
114+
4. Sally asks Jerry to log in and grants him the reader role.
115+
5. Jerry logs out and back in. He can now see the clusters that Sally created.
116116

product_docs/docs/biganimal/release/administering_cluster/03_account_activity.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Reviewing account activity"
33
---
4-
The activity log collects BigAnimal events based on user activity within the portal. It can be used to audit activities performed by users from your organizations or research activities that may have affected your account.
4+
The activity log collects BigAnimal events based on user activity in the portal. You can use the log to audit activities performed by users from your organizations or research activities that might have affected your account.
55

66
## Events
77

@@ -20,17 +20,17 @@ Events are related to the following resource types:
2020
* organization
2121

2222
!!! Note
23-
Database events are **not** logging activity on the Postgres server. They are logging the use of the portal to create or modify database clusters.
23+
Database events are not logging activity on the Postgres server. They are logging the use of the portal to create or modify database clusters.
2424

25-
## Viewing and searching the activity log
25+
## View and search the activity log
2626

27-
To view events, navigate to the [**Activity Log**](https://portal.biganimal.com/activityLog) page on the [BigAnimal](https://portal.biganimal.com) portal. To search events, use the filters at the top of the page.
27+
To view events, navigate to the [Activity Log](https://portal.biganimal.com/activityLog) page on the [BigAnimal](https://portal.biganimal.com) portal. To search events, use the filters at the top of the page.
2828

2929
The following fields are in the activity log:
3030

3131
| Field | Description |
3232
| ---------------------| ---------------------------------------------------------------------------- |
33-
| **Activity Name** | Name of an event in the format _Action Resource-Type, Resource-name_ |
33+
| **Activity Name** | Name of an event in the format _Action Resource-Type, Resource-name_ |
3434
| **User** | User responsible for the event |
3535
| **Date** | Date when the action was performed |
3636
| **Resource** | Resource type of the resource |

product_docs/docs/biganimal/release/administering_cluster/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22
title: "Administering your account"
33
---
44

5-
In this section, account owners can find information on administrative activities for the BigAnimal account including portal and database user access management as well as account activity reviews.
5+
Administrative activities for the BigAnimal account include portal and database user access management as well as account activity reviews.

product_docs/docs/biganimal/release/getting_started/01_check_resource_limits.mdx

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,35 +4,35 @@ title: Raising Azure resource limits
44

55
By default, Azure sets a very low limit on the number of virtual machines and cores per region and on the number of Public IP Addresses per region that are available in a given subscription.
66

7-
The default number of total cores per subscription per region is 20. See [Virtual Machines limits - Azure Resource Manager](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/azure-subscription-service-limits#virtual-machines-limits---azure-resource-manager) for more information. You need to increase the total cores to account for the total number of cores you expect to use in each region and reserve these cores to be used by EDB. See the next section [Virtual Machine Quota Requirements](#virtual-machine-quota-requirements)for more information.
7+
The default number of total cores per subscription per region is 20. See [Virtual Machines limits - Azure Resource Manager](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/azure-subscription-service-limits#virtual-machines-limits---azure-resource-manager) for more information. You need to increase the total cores to account for the total number of cores you expect to use in each region and reserve these cores to be used by EDB. See [Virtual Machine Quota Requirements](#virtual-machine-quota-requirements) for more information.
88

9-
The default Public IP address limits for Public IP Addresses Basic and Public IP Addresses Standards is set to 10. See [Public IP address limits](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/azure-subscription-service-limits#publicip-address) for more information. You need to increase the limit of `Public IP Addresses - Basic` and `Public IP Addresses - Standard` for the regions where you plan to deploy your EDB clusters with the total number of EDB clusters you plan to use.
9+
The default Public IP address limits for Public IP Addresses Basic and Public IP Addresses Standards is set to 10. See [Public IP address limits](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/azure-subscription-service-limits#publicip-address) for more information. You need to increase the limit of `Public IP Addresses - Basic` and `Public IP Addresses - Standard` to the total number of clusters you plan to deploy in a particular region.
1010

1111

1212
## Virtual machine quota requirements
13-
In each region, BigAnimal uses eight Dv4 virtual machine cores to manage your BigAnimal infrastructure. Your Postgres clusters deployed in the region use separate ESv3 virtual machine cores. The number of cores depends on the Instance Type and High Availability options of the clusters you provision. You can calculate the number of ESv3 cores required for your cluster based on the following:
13+
In each region, BigAnimal uses eight Dv4 virtual machine cores to manage your BigAnimal infrastructure. Your Postgres clusters deployed in the region use separate ESv3 virtual machine cores. The number of cores depends on the **Instance Type** and **High Availability** options of the clusters you provision. You can calculate the number of ESv3 cores required for your cluster based on the following:
1414

1515
* Virtual machine instance of type E{N}Sv3 uses {N} cores. For example, an instance of type E64Sv3 uses 64 ESv3 cores.
1616
* Cluster running on an E{N}Sv3 instance with high availability not enabled uses exactly {N} ESv3 cores.
1717
* Cluster running on an E{N}Sv3 instance with high availability enabled uses 3 * {N} ESv3 cores.
1818

1919
As an example, if you provision the largest virtual machine E64Sv3 with high availability enabled, it requires (3 * 64)=192 ESv3 cores per region. BigAnimal infrastructure requires an additional eight Dv4 virtual machine cores per region.
2020

21-
## Checking current utilization
21+
## Check current utilization
2222

23-
To check if you have adequate Azure resources to provision new clusters:
23+
You can check whether you have adequate Azure resources to provision new clusters.
2424

2525
1. In the [Azure portal](https://portal.azure.com/), select **Subscription**.
2626
2. Select your specific subscription.
27-
3. Select **Usage + quotas** in the **Settings** section.
28-
4. Search for "Total Regional vCPUs" and select the **Location** to check the regional vCPUs limits.
29-
5. Search for "DSv2" and "ESv3" to view virtual machines limits.
27+
3. In the **Settings** section, select **Usage + quotas**.
28+
4. Search for _Total Regional vCPUs_ and select the location to check the regional vCPUs limits.
29+
5. Search for _DSv2_ and _ESv3_ to view virtual machines limits.
3030
6. Search for Public IP to view networks limits.
3131

3232

3333
## Increasing network quota
3434

35-
You can increase the number of public IP addresses for your account either by using Azure's portal if you have appropriate privileges or by submitting a support request. See:
35+
You can increase the number of public IP addresses for your account either by using Azure's portal, if you have appropriate privileges, or by submitting a support request. See:
3636

3737
- [Request Networking quota increase at subscription level using Help + support](https://docs.microsoft.com/en-us/azure/azure-portal/supportability/networking-quota-requests#request-networking-quota-increase-at-subscription-level-using-help--support)
3838

@@ -41,11 +41,11 @@ You can increase the number of public IP addresses for your account either by us
4141

4242
## Increasing virtual machine quota
4343

44-
You can increase the number of ESv3 Series virtual machines per region for your account either by using Azure's portal if you have appropriate privileges or by submitting a support request. See:
44+
You can increase the number of ESv3 Series virtual machines per region for your account either by using Azure's portal, if you have appropriate privileges, or by submitting a support request. See:
4545

46-
- [Request a quota increase by region from Help + support](https://docs.microsoft.com/en-us/azure/azure-portal/supportability/regional-quota-requests#request-a-quota-increase-by-region-from-help--support)
46+
- [Request a quota increase by region from Help + support](https://docs.microsoft.com/en-us/azure/azure-portal/supportability/regional-quota-requests#increase-a-regional-quota-from-help--support)
4747

48-
- [Request a quota increase by region from subscriptions](https://docs.microsoft.com/en-us/azure/azure-portal/supportability/regional-quota-requests#request-a-quota-increase-by-region-from-subscriptions)
48+
- [Request a quota increase by region from subscriptions](https://docs.microsoft.com/en-us/azure/azure-portal/supportability/regional-quota-requests#increase-a-regional-vcpu-quota)
4949

5050

5151

0 commit comments

Comments
 (0)