Merge pull request #5011 from EnterpriseDB/release/2023-11-15

Release: 2023-11-15

install_template/config.yaml

@@ -162,55 +162,55 @@ products:
     platforms:
       - name: CentOS 7
         arch: x86_64
-        supported versions: [13]
+        supported versions: [13, 16]
       - name: RHEL 8
         arch: ppc64le
-        supported versions: [13]
+        supported versions: [13, 16]
       - name: RHEL 9
         arch: ppc64le
-        supported versions: [13]
+        supported versions: [13, 16]
       - name: AlmaLinux 8 or Rocky Linux 8
         arch: x86_64
-        supported versions: [13]
+        supported versions: [13, 16]
       - name: AlmaLinux 9 or Rocky Linux 9
         arch: x86_64
-        supported versions: [13]      
+        supported versions: [13, 16]      
       - name: RHEL 7 or OL 7
         arch: x86_64
-        supported versions: [13]
+        supported versions: [13, 16]
       - name: RHEL 8 or OL 8
         arch: x86_64
-        supported versions: [13]
+        supported versions: [13, 16]
       - name: RHEL 9 or OL 9
         arch: x86_64
-        supported versions: [13]
+        supported versions: [13, 16]
       - name: Debian 10
         arch: x86_64
-        supported versions: [13]
+        supported versions: [13, 16]
       - name: Debian 11
         arch: x86_64
-        supported versions: [13]
+        supported versions: [13, 16]
       - name: Ubuntu 18.04
         arch: x86_64
-        supported versions: [13]
+        supported versions: [13, 16]
       - name: Ubuntu 20.04
         arch: x86_64
-        supported versions: [13]
+        supported versions: [13, 16]
       - name: Ubuntu 22.04
         arch: x86_64
-        supported versions: [13]
+        supported versions: [13, 16]
       - name: SLES 12
         arch: x86_64
-        supported versions: [13]
+        supported versions: [13, 16]
       - name: SLES 12
         arch: ppc64le
-        supported versions: [13]
+        supported versions: [13, 16]
       - name: SLES 15
         arch: x86_64
-        supported versions: [13]
+        supported versions: [13, 16]
       - name: SLES 15
         arch: ppc64le
-        supported versions: [13]
+        supported versions: [13, 16]
   - name: EDB pgBouncer
     platforms:
       - name: CentOS 7

product_docs/docs/biganimal/release/reference/cli/managing_clusters.mdx

@@ -4,7 +4,9 @@ navTitle: Managing clusters
 deepToC: true
 ---
 
-These examples show Azure as the cloud provider unless indicated otherwise. The functionality is the same when using AWS or Google Cloud.
+These examples show Azure as the cloud provider unless indicated otherwise. 
+
+Although the functionality is the same when using AWS or Google Cloud, there may be additional input flags based on the cloud provider type. Use the `-h` or `--help` flags for more information on the CLI commands.  
 
 ## Managing single-node and primary/standby high-availability clusters
 
@@ -27,6 +29,8 @@ Cluster architecture: Primary/Standby High Availability
 Number of standby replicas: 2 Replicas
 Enable read-only workloads: No
 Provider: Azure
+Cloud Provider Subscription ID: "111,222"
+Service Account IDs, (leave empty to stop adding): "[email protected]"
 Cluster Name: my-biganimal-cluster
 Password: ****************
 PostgreSQL type: EDB Postgres Advanced Server
@@ -77,34 +81,41 @@ You can use the `create --config-file` command to create one or more clusters wi
 Here's a sample configuration file in YAML format with Azure specified as the provider:
 
 ```yaml
-  # config_file.yaml
-  ---
-  clusterArchitecture: ha                     # <string:  cluster architecture, valid values ["single" | "ha" | "eha"]>
-  haStandbyReplicas: 2                        # <number:  Number of standby replicas. Field must be specified if user has selected primary/standby high availability cluster type. Default value is 2, valid values [1, 2].>
-  provider: azure                             # <string:  cloud provider id>
-  clusterName: my-biganimal-cluster           # <string:  cluster name>
-  password: ************                      # <string:  cluster password (must be at least 12 characters)>
-  iamAuthentication: false                    # <bool:    Identity and Access Management, enabling IAM authentication will allow database users to authenticate to Postgres using your cloud provider's IAM(currently supported only for AWS). You can set up IAM authentication after your cluster is provisioned.>
-  postgresType: epas                          # <string:  postgresType id, valid values ["postgres" | "epas" | "pgextended"]>
-  postgresVersion: "14"                       # <string:  postgres version>
-  region: eastus                              # <string:  provider region id>
-  instanceType: azure:Standard_E2s_v3         # <string:  instance type id>
-  volumeType: azurepremiumstorage             # <string:  volume type id>
-  volumeProperties: P1                        # <string:  Applicable to Azure only, volume properties id>
-  volumePropertySize: "4Gi"                   # <string:  Applicable to AWS gp3 only and Azure Ultradisk, volume size in Byte, you may append unit suffix 'Gi' or 'G'.>
-  volumePropertyIOPS: 3000                    # <number>: Applicable to AWS gp3 and Azure Ultradisk, volume Input/Output Operations Per Second> 
-  networking: public                          # <string:  input "private" or "public" network>
-  allowIpRangeMap:                            # <list:    IP Range to allow network traffic to your cluster from the public Internet>
-    - cidr: 9.9.9.9/28                        # <string:  CIDR of allowed source IP range>
-      description: Allow traffic from App A   # <string:  The description of this allowed ip range>
-    - cidr: 10.10.10.10/27                    # <string:  CIDR of allowed source IP range>
-      description: Allow traffic from App B   # <string:  The description of this allowed ip range>
-  pgConfigMap:                                # <Object:  Postgres configuration>
-    application_name: test_app                # <string:  set the database "application_name" property to "test_app">
-    array_nulls: true                         # <bool:    set the database "array_nulls" property to True>
-  backupRetentionPeriod: 30d                  # <string:  Use strings like “7d“ or “2w“ or “3m” to specify days (1-180), weeks (1-25) or months (1-6) to set retention period>
-  readOnlyWorkloads:                          # <bool:    Set True to enable read-only connection and route all read-only queries to standby replicas and reduce the workload on primary>
-  ---
+# config_file.yaml
+---
+clusterArchitecture: ha                                               # <string:  cluster architecture, valid values ["single" | "ha" ]>
+haStandbyReplicas: 2                                                  # <number:  Number of standby replicas. Field must be specified if user has selected Primary/Standby High Availability cluster type. Default value is 2, valid values [1, 2].>
+provider: azure                                                       # <string:  cloud provider id, valid values ["azure", "aws", "gcp"]>
+cspSubscriptionIDs:                                                   # <list:  cloud provider subscription/account ID, required when cluster is BigAnimal hosted>
+  - 123123123                                                         # <string>
+  - 456456456                                                         # <string>
+serviceAccountIds:                                                    # <list: A Google Cloud Service Account is used for logs. If you leave this blank, then you will be unable to access log details for this cluster. Required when cluster is BigAnimal hosted>
+  - service-account-1234567b@development-data-123456.iam.gserviceaccount.com# <string>
+  - service-account-1234567b@development-data-123456.iam.gserviceaccount.com# <string>
+clusterName: biganimal_cluster                                        # <string:  cluster name>
+password: ************                                                # <string:  cluster password (must be at least 12 characters)>
+# refer following link for steps to setup IAM:  https://www.enterprisedb.com/docs/biganimal/latest/using_cluster/01_postgres_access/iam-authentication-for-postgres
+iamAuthentication: true                                               # <bool:  Identity and Access Management, enabling IAM authentication will allow database users to authenticate to Postgres using your cloud provider's IAM(currently supported only for AWS). You can set up IAM authentication after your cluster is provisioned.>
+postgresType: epas                                                    # <string:  postgresType id, valid values ["postgres" | "epas" | "pgextended"]>
+postgresVersion: 14                                                   # <string:  postgres version>
+region: eastus                                                        # <string:  provider region id>
+instanceType: azure:Standard_E2s_v3                                   # <string:  instance type id>
+volumeType: azurepremiumstorage                                       # <string:  volume type id>
+volumeProperties: P1                                                  # <string:  Applicable to Azure Premium Storage only, volume properties id>
+volumePropertySize: 4Gi                                               # <string:  Not Applicable to Azure Premium Storage, volume size in Gibibytes or Tebibytes, you may append unit suffix Ti,Gi(the default unit).>
+volumePropertyIOPS: 1000                                              # <number>: Not Applicable to Azure Premium Storage and GCP:[pd-ssd], volume Input/Output Operations Per Second>
+networking: public                                                    # <string:  input "private" or "public" network>
+allowIpRangeMap:                                                      # <list: IP Range to allow network traffic to your cluster from the public Internet>
+  - cidr: 9.9.9.9/28                                                  # <string: CIDR of allowed source IP range>
+    description: Allow traffic from App A                             # <string: The description of this allowed ip range>
+  - cidr: 10.10.10.10/27                                              # <string: CIDR of allowed source IP range>
+    description: Allow traffic from App B                             # <string: The description of this allowed ip range>
+readOnlyWorkloads: true                                               # <bool: Set True to enable read-only connection and route all read-only queries to standby replicas and reduce the workload on primary>
+pgConfigMap:                                                          # <Object: Postgres configuration>
+  application_name: test_app                                          # <string: set the database "application_name" property to "test_app">
+  array_nulls: true                                                   # <bool: set the database "array_nulls" property to True>
+backupRetentionPeriod: 30d                                            # <string: Retention period must be between 1-180 days or 1-25 weeks or 1-6 months. Using strings like "7d" or "2w" or "3m" to specify days, weeks and months respectively.>
+---
 ```
 
 !!! Note
@@ -126,15 +137,15 @@ To enable you to view valid values to use in the configuration file for BigAnima
 ```shell
 biganimal cluster show-architectures
 __OUTPUT__
-┌────────────────────────────────────────────────────────┐
-│ Architecture                                           │
-├────────┬────────────────────────────────────┬──────────┤
-│ ID     │ Name                               │ Status   │
-├────────┼────────────────────────────────────┼──────────┤
-│ ha     │ Primary/Standby High Availability  │ enabled  │
-│ pgd    │ Extreme High Availability          │ disabled │
-│ single │ Single Node                        │ enabled  │
-└────────┴────────────────────────────────────┴──────────┘
+┌───────────────────────────────────────────────────────────────┐
+│ Architecture                                                  │
+├────────┬───────────────────────────────────────────┬──────────┤
+│ ID     │ Name                                      │ Status   │
+├────────┼───────────────────────────────────────────┼──────────┤
+│ ha     │ Primary/Standby High Availability         │ enabled  │
+│ pgd    │ Extreme High Availability                 │ disabled │
+│ single │ Single Node                               │ enabled  │
+└────────┴───────────────────────────────────────────┴──────────┘
 ```
 
 !!!Tip
@@ -151,12 +162,14 @@ biganimal cluster show-connection \
   --provider "azure" \
   --region "eastus"
 __OUTPUT__
-┌─────────────┬──────────────────────────────────────────────────────────────────────────────────────────┐
-│ Access Type │ Connection String                                                                        │
-├─────────────┼──────────────────────────────────────────────────────────────────────────────────────────┤
-│ read-write  │ postgresql://[email protected]:5432/edb_admin │
-│ read-only   │ Disabled                                                                                 │
-└─────────────┴──────────────────────────────────────────────────────────────────────────────────────────┘
+┌───────────────-----------──┬──────────────────────────────────────────────────────────────────────────────────────────┐
+│ Name                       │ Details                                                                                  │
+├────────────────-----------─┼──────────────────────────────────────────────────────────────────────────────────────────┤
+│ read-write-connection      │ postgresql://[email protected]:5432/edb_admin │
+│ rw-service-name            │ postgresql://[email protected]:5432/edb_admin │
+│ read-only-connection       │ Disabled                                                                                 │
+│ ro-service-name            │ Disabled                                                                                 │
+└─────────────────-----------┴──────────────────────────────────────────────────────────────────────────────────────────┘
 ```
 
 !!!tip
@@ -188,6 +201,8 @@ After the cluster is created, you can update attributes of the cluster, includin
 -   Retention period
 -   Read-only workloads
 -   IAM authentication
+-   Cloud service provider subscription IDs
+-   Service account IDs
 
 For example, to set the public allowed IP range list, use the `--cidr-blocks` flag:
 
@@ -264,6 +279,10 @@ biganimal cluster restore\
   --restore-point "2022-01-26T15:04:05+0800" \
   --backup-retention-period "2w" \
   --read-only-workloads: "true"
+  --csp-subscription-ids "123123123,456456456"
+  --service-account-ids "service-account-1234567b@development-data-123456.iam.gserviceaccount.com,
+service-account-1234567b@development-data-123456.iam.gserviceaccount.com"
+  --credential "my_credential"
 ```
 
 The password for the restored cluster is mandatory. The other parameters, if not specified, inherit the source database's settings. 

product_docs/docs/biganimal/release/reference/cli/using_features.mdx

@@ -24,6 +24,8 @@ __OUTPUT__
 ? Volume type: Azure Premium Storage
 ? Volume properties: P1 (4 Gi, 120 Provisioned IOPS, 25 Provisioned MB/s)
 ? Networking: Public
+? Cloud Provider Subscription ID: "111,222"
+? Service Account IDs, (leave empty to stop adding): "[email protected]"
 ? By default your cluster allows all inbound communications, add IP allowed list to restrict the access: No
 ? Add database config in the format "application_name=sample_app&array_nulls=true", Leave empty for default configuration: 
 ? Backup Retention Period, note backups will incur storage charges from the cloud provider directly. e.g. "7d", "2w" or "3m": 3m
@@ -70,6 +72,8 @@ __OUTPUT__
 ? Volume properties: P1 (4 Gi, 120 Provisioned IOPS, 25 Provisioned MB/s)
 ? Networking: Public
 ? By default your cluster allows all inbound communications, add IP allowed list to restrict the access: No
+? Cloud Provider Subscription ID: "111,222"
+? Service Account IDs, (leave empty to stop adding): "[email protected]"
 ? Add database config in format "application_name=sample_app&array_nulls=true": autovacuum_max_workers=5&autovacuum_vacuum_cost_limit=3000&checkpoint_completion_target=0.9&checkpoint_timeout=15min&cpu_tuple_cost=0.03&effective_cache_size=0.75 * ram&maintenance_work_mem=(0.15 * (ram - shared_buffers) / autovacuum_max_workers) > 1GB ? 1GB : (0.15 * (ram - shared_buffers) / autovacuum_max_workers)&random_page_cost=1.1&shared_buffers=((0.25 * ram) > 80GB) ? 80GB : (0.25 * ram)&tcp_keepalives_idle=120&tcp_keepalives_interval=30&wal_buffers=64MB&wal_compression=on
 ? Backup Retention Period, use strings like '7d' or '2w' or '3m' to specify days, weeks and months respectively.: 3m
 ```
@@ -120,4 +124,4 @@ biganimal cluster [set|get]-maintenance-window
                                      {--enable} [--start-day --start-time]
 ```
 
-For more information on maintenance windows, see [Periodic maintenance](/biganimal/release/overview/updates).
+For more information on maintenance windows, see [Periodic maintenance](/biganimal/release/overview/updates).