diff --git a/advocacy_docs/edb-postgres-ai/cloud-service/using_cluster/cli/managing_clusters.mdx b/advocacy_docs/edb-postgres-ai/cloud-service/using_cluster/cli/managing_clusters.mdx index 9f9076f5ed0..dda5253484c 100644 --- a/advocacy_docs/edb-postgres-ai/cloud-service/using_cluster/cli/managing_clusters.mdx +++ b/advocacy_docs/edb-postgres-ai/cloud-service/using_cluster/cli/managing_clusters.mdx @@ -33,7 +33,7 @@ Enable read-only workloads: No Provider: Azure Cloud Provider Subscription ID: "111,222" Service Account IDs, (leave empty to stop adding): "id1@iam.gcp" -Cluster Name: my-biganimal-cluster +Cluster Name: my-cloud-service-cluster Password: **************** PostgreSQL type: EDB Postgres Advanced Server PostgreSQL version: 14 @@ -71,7 +71,7 @@ __OUTPUT__ ├──────────────┬──────────────────────┬──────────┬──────────────┬──────────────────────────┬─────────────┬───────────────┬───────────────────────────────┬────────────────────┬────────────┤ │ ID │ Name │ Provider │ Architecture │ Status │ Region │ Instance Type │ Postgres Details │ Maintenance Window │ FAReplicas │ ├──────────────┼──────────────────────┼──────────┼──────────────┼──────────────────────────┼─────────────┼───────────────┼───────────────────────────────┼────────────────────┼────────────┤ -│ p-gxhkfww1fe │ my-biganimal-cluster │ Azure │ ha │ Cluster in healthy state │ East US │ E2s v3 │ EDB Postgres Advanced Server │ Disabled │ N/A │ +│ p-gxhkfww1fe │ my-cloud-service-cluster │ Azure │ ha │ Cluster in healthy state │ East US │ E2s v3 │ EDB Postgres Advanced Server │ Disabled │ N/A │ │ │ │ │ │ │ │ │ │ │ │ └──────────────┴──────────────────────┴──────────┴──────────────┴──────────────────────────┴─────────────┴───────────────┴───────────────────────────────┴────────────────────┴────────────┘ ``` @@ -87,21 +87,21 @@ Here's a sample configuration file in YAML format with Azure specified as the pr --- clusterArchitecture: ha # haStandbyReplicas: 2 # -provider: azure # -cspSubscriptionIDs: # +provider: azure # +cspSubscriptionIDs: # - 123123123 # - 456456456 # -serviceAccountIds: # +serviceAccountIds: # - service-account-1234567b@development-data-123456.iam.gserviceaccount.com# - service-account-1234567b@development-data-123456.iam.gserviceaccount.com# -clusterName: biganimal_cluster # +clusterName: cloud_service_cluster # password: ************ # tags: # - name: tag1 # color: "#c5eae7" # - name: tag2 # color: "#0b6ff4" # -# refer following link for steps to setup IAM: https://www.enterprisedb.com/docs/biganimal/latest/using_cluster/01_postgres_access/iam-authentication-for-postgres +# refer following link for steps to setup IAM: https://www.enterprisedb.com/docs/edb-postgres-ai/cloud-service/using_cluster/postgres_access/database_authentication/#iam-authentication-for-postgres iamAuthentication: true # postgresType: epas # postgresVersion: 14 # @@ -124,9 +124,9 @@ pgConfigMap: # customMaintenanceWindow: # isEnabled: true # - maintenanceStartDay: Monday # + maintenanceStartDay: Monday # maintenanceStartTime: 02:00 # -superuserAccess: true # +superuserAccess: true # pgvector: true # postgis: true # pgBouncer: true # @@ -179,7 +179,7 @@ To use your Cloud Service cluster, you first need to get your cluster's connecti ```shell biganimal cluster show-connection \ - --name "my-biganimal-cluster" \ + --name "my-cloud-service-cluster" \ --provider "azure" \ --region "eastus" __OUTPUT__ @@ -198,7 +198,7 @@ You can query the complete connection information with other output formats, lik ```shell biganimal cluster show-connection \ - --name "my-biganimal-cluster" \ + --name "my-cloud-service-cluster" \ --provider "azure" \ --region "eastus" \ --output "json" @@ -229,7 +229,7 @@ After the cluster is created, you can update attributes of the cluster, includin For example, to set the public allowed IP range list, use the `--cidr-blocks` flag: ```shell -./biganimal cluster update --name "my-biganimal-cluster" --provider "azure" \ +./biganimal cluster update --name "my-cloud-service-cluster" --provider "azure" \ --region "eastus" \ --cidr-blocks "9.9.9.9/28=Traffic from App A" ``` @@ -237,7 +237,7 @@ For example, to set the public allowed IP range list, use the `--cidr-blocks` fl To check whether the setting took effect, use the `cluster show` command, and view the detailed cluster information output in JSON format. For example: ```shell -biganimal cluster show --name "my-biganimal-cluster" --provider "azure" \ +biganimal cluster show --name "my-cloud-service-cluster" --provider "azure" \ --region "eastus" \ --output "json" \ | jq '.[0].allowIpRangeMap' @@ -273,7 +273,7 @@ To delete a cluster you no longer need, use the `cluster delete` command. For ex ```shell biganimal cluster delete \ - --name "my-biganimal-cluster" \ + --name "my-cloud-service-cluster" \ --provider "azure" \ --region "eastus" ``` @@ -286,11 +286,11 @@ Cloud Service continuously backs up your PostgreSQL clusters. Using the CLI, you ```shell biganimal cluster restore\ - --name "my-biganimal-cluster" \ + --name "my-cloud-service-cluster" \ --provider "azure" \ --region "eastus" \ --password "mypassword@123" \ - --new-name "my-biganimal-cluster-restored" \ + --new-name "my-cloud-service-cluster-restored" \ --new-region="eastus2" \ --cluster-architecture "single" \ --instance-type "azure:Standard_E2s_v3" \ @@ -430,11 +430,11 @@ Where `` is a valid path to a YAML configuration file. #### Azure example ``` -clusterName: biganimal_cluster # +clusterName: cloud_service_cluster # password: ************ # postgresType: epas # (only epas is supported in pgd preview) postgresVersion: 14 # -provider: azure # +provider: azure # dataNodes: 3 # tags: # - name: tag1 # @@ -451,7 +451,7 @@ dataGroups: # : Not Applicable to Azure Premium Storage and GCP:[pd-ssd], volume Input/Output Operations Per Second> customMaintenanceWindow: # maintenanceStartTime: 15:00 # - maintenanceStartDay: monday # + maintenanceStartDay: Monday # networking: public # allowIpRangeMap: # - cidr: 9.9.9.9/28 # @@ -471,7 +471,7 @@ dataGroups: # : Not Applicable to Azure Premium Storage and GCP:[pd-ssd], volume Input/Output Operations Per Second> customMaintenanceWindow: # maintenanceStartTime: 17:00 # - maintenanceStartDay: tuesday # + maintenanceStartDay: tuesday # networking: public # allowIpRangeMap: # - cidr: 9.9.9.9/28 # @@ -482,24 +482,24 @@ dataGroups: # array_nulls: true # backupRetentionPeriod: 30d # -# cspSubscriptionIds: # +# cspSubscriptionIds: # # - 123123123 # # - 456456456 # -# serviceAccountIds: # +# serviceAccountIds: # # - service-account-1234567b@development-data-123456.iam.gserviceaccount.com# # - service-account-1234567b@development-data-123456.iam.gserviceaccount.com# witnessGroups: # + - provider: azure # region: uksouth # customMaintenanceWindow: # maintenanceStartTime: 18:00 # - maintenanceStartDay: monday # + maintenanceStartDay: Monday # ``` #### AWS example ``` -clusterName: biganimal-aws-pgd-cluster # +clusterName: cloud-service-aws-pgd-cluster # password: Meredith Palmer Memorial # postgresType: pgextended # (only epas is supported in pgd preview) postgresVersion: 16 # @@ -520,7 +520,7 @@ dataGroups: # : Not Applicable to Azure Premium Storage and GCP:[pd-ssd], volume Input/Output Operations Per Second> customMaintenanceWindow: # maintenanceStartTime: 15:00 # - maintenanceStartDay: monday # + maintenanceStartDay: Monday # networking: public # allowIpRangeMap: # - cidr: 9.9.9.9/28 # @@ -541,7 +541,7 @@ dataGroups: # : Not Applicable to Azure Premium Storage and GCP:[pd-ssd], volume Input/Output Operations Per Second> customMaintenanceWindow: # maintenanceStartTime: 17:00 # - maintenanceStartDay: tuesday # + maintenanceStartDay: tuesday # networking: public # allowIpRangeMap: # - cidr: 9.9.9.9/28 # @@ -564,13 +564,13 @@ witnessGroups: # customMaintenanceWindow: # maintenanceStartTime: 18:00 # - maintenanceStartDay: monday # + maintenanceStartDay: Monday # ``` #### Google Cloud example ``` -clusterName: biganimal-gcp-pgd-cluster # +clusterName: cloud-service-gcp-pgd-cluster # password: Meredith Palmer Memorial # postgresType: epas # (only epas is supported in pgd preview) postgresVersion: 16 # @@ -591,7 +591,7 @@ dataGroups: # : Not Applicable to Azure Premium Storage and GCP:[pd-ssd], volume Input/Output Operations Per Second> customMaintenanceWindow: # maintenanceStartTime: 15:00 # - maintenanceStartDay: monday # + maintenanceStartDay: Monday # networking: public # allowIpRangeMap: # - cidr: 9.9.9.9/28 # @@ -612,7 +612,7 @@ dataGroups: # : Not Applicable to Azure Premium Storage and GCP:[pd-ssd], volume Input/Output Operations Per Second> customMaintenanceWindow: # maintenanceStartTime: 18:00 # - maintenanceStartDay: monday # + maintenanceStartDay: Monday # networking: public # allowIpRangeMap: # - cidr: 9.9.9.9/28 # @@ -631,11 +631,11 @@ dataGroups: # witnessGroups: # + - provider: azure # region: australiaeast # customMaintenanceWindow: # maintenanceStartTime: 21:00 # - maintenanceStartDay: monday # + maintenanceStartDay: Monday # ``` ### Add a data group @@ -661,7 +661,7 @@ dataGroups: volumeProperties: P2 customMaintenanceWindow: maintenanceStartTime: 18:00 - maintenanceStartDay: monday + maintenanceStartDay: Monday networking: public allowIpRangeMap: - cidr: 9.9.9.9/28 @@ -694,7 +694,7 @@ Where `` is a valid path to a YAML configuration file. For updating ``` clusterId: p-***** # -clusterName: biganimal_cluster # +clusterName: cloud_service_cluster # password: ************ # tags: # - name: tag1 # @@ -712,7 +712,7 @@ dataGroups: # : Not Applicable to Azure Premium Storage and GCP:[pd-ssd], volume Input/Output Operations Per Second> customMaintenanceWindow: # maintenanceStartTime: 15:00 # - maintenanceStartDay: monday # + maintenanceStartDay: Monday # networking: public # allowIpRangeMap: # - cidr: 9.9.9.9/28 # @@ -723,17 +723,17 @@ dataGroups: # array_nulls: true # backupRetentionPeriod: 30d # -# cspSubscriptionIds: # +# cspSubscriptionIds: # # - 123123123 # # - 456456456 # -# serviceAccountIds: # +# serviceAccountIds: # # - service-account-1234567b@development-data-123456.iam.gserviceaccount.com# # - service-account-1234567b@development-data-123456.iam.gserviceaccount.com# witnessGroups: # customMaintenanceWindow: # maintenanceStartTime: 18:00 # - maintenanceStartDay: monday # + maintenanceStartDay: Monday # ``` ### Show distributed high-availability clusters @@ -763,7 +763,7 @@ You can either restore an active or a deleted distributed high-availability clus To restore a distributed high-availability cluster, clusterId, sourceGroupId and password are mandatory fields. All other fields are optional. Removing the optional fields will use the corresponding source group field instead. ``` -clusterName: biganimal_cluster # +clusterName: cloud_service_cluster # password: ************ # dataNodes: 3 # clusterId: p-***** # @@ -783,7 +783,7 @@ dataGroups: # : Not Applicable to Azure Premium Storage and GCP:[pd-ssd], volume Input/Output Operations Per Second> customMaintenanceWindow: # maintenanceStartTime: 15:00 # - maintenanceStartDay: monday # + maintenanceStartDay: Monday # allowIpRangeMap: # - cidr: 9.9.9.9/28 # description: Allow traffic from App A #