Skip to content

Commit 0656ad2

Browse files
committed
Overhauling RDS DB section
1 parent e57bad5 commit 0656ad2

File tree

1 file changed

+25
-50
lines changed
  • src/connections/storage/catalog/postgres

1 file changed

+25
-50
lines changed

src/connections/storage/catalog/postgres/index.md

Lines changed: 25 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Segment supports the following Postgres database providers:
2121

2222
This guide explains how to set up a Postgres database with Heroku. Heroku is a cloud-based platform-as-a-service which simplifies the process of setting up and administering a Postgres database.
2323

24-
1. Signup for a Heroku account.
24+
1. Sign up for a Heroku account.
2525

2626
The first step to setting up Postgres on Heroku is to get a Heroku account. You can sign up for a free account [here](https://signup.heroku.com/identity).
2727

@@ -83,77 +83,52 @@ As a supplement to this guide, Amazon has created an official guide to [setting
8383

8484
3. Select the region you'd like to place the database in.
8585

86-
In the top right-hand corner of the console, you should see a drop-down with the available AWS regions. For best performance, put the database in the `US West` region.
86+
In the top right-hand corner of the console, you should see a drop-down with the available AWS regions. For best performance, put the database in one of the `US West` locations.
8787

8888
<img src="images/rds1.png" width="300">
8989

90-
4. Launch a DB Instance.
90+
4. Create a new database.
9191

92-
Go to the **Instances** tab on the left sidebar, and click **Launch DB Instance**.
92+
Select the **Databases** tab on the left sidebar, and click **Create database**.
9393

94-
![](images/rds2.png)
9594

9695
5. Select the PostgreSQL Engine.
9796

98-
Click on the PostgreSQL icon and then click **Next**.
97+
In the Engine options section, select **PostgreSQL**.
98+
<!-- Ask an engineer about what versions of PostgreSQL we support -->
9999

100-
![](images/rds3.png)
100+
6. Select a database template.
101101

102-
6. Select whether or not you'd like to use the database for production purposes.
102+
If you anticipate high utilization on your Postgres database, or if downtime is unacceptable, choose **Production**. If you don't plan to have high-utilization of your database or if periods of downtime are acceptable and you know how to recover from them, choose **Dev/Test**.
103+
<br/><br/>
104+
With the Free tier option, you have up to 750 hours of a Single-AZ db.t2.micro, db.t3.micro, or db.t4g.micro database running PostgreSQL. For more information about the AWS Free Tier with Amazon RDS, see Amazon's [Amazon RDS Free Tier documentation](https://aws.amazon.com/rds/free/).
105+
<!--Ask an engineer: will/can the free tier support a Segment integration?>
103106
104-
There are two differences between the production and non-production options on this screen.
107+
7. Specify the availability and durability of the database.
105108
106-
- **Multi-AZ Deployment** means that Amazon will maintain an additional database machine in a separate Availability Zone (AZ). An availability zone is a datacenter that is independent of other availability zones in the same geographic region. In the case of the failure of one of the database machines or availability zone loss, Amazon prevents downtime by automatically transitioning to the other database machine.
109+
The deployment options are:
110+
<!-- Ask an engineer which one of these options is recommended, or if there are any that aren't supported-->
107111

108-
**Provisioned IOPS** helps to guarantee the disk I/O performance of a database. Due to the fact that databases often cannot keep all of their data in RAM, they must store some data on disk. When running queries, the database may have to read data from the disk. With Provisioned IOPS, Amazon guarantees that disk will be able to perform a certain number of reads and writes a second.
112+
**Multi-AZ DB Cluster:** This option creates a cluster of databases with one primary database and two standby database instances, each in a different Availability Zone (AZ.) This option provides high availability and data redundancy, and increases capacity to serve read workloads.
109113

110-
If you anticipate high utilization on your Postgres database, or if downtime is unacceptable, choose **Production**. If you don't plan to have high-utilization of your database or periods of downtime are acceptable and you know how to recover from them, choose **Dev/Test**.
114+
**Multi-AZ DB instance:** This option creates two database instances located in different availability zones: one primary instance and once standby instance. This options provides high availability and data redundancy, but doesn't support read workloads.
111115

112-
After choosing, click **Next**.
116+
**Single DB instance:** This option creates a single database instance with no standby instances.
113117

114-
![](images/rds4.png)
118+
8. Configure the database settings.
115119

116-
7. Specify the DB Details.
120+
9. Select a DB instance class and class size.
121+
<!--Ask an engineer if a segment integration requires a minimum size here-->
117122

118-
Enter details about the database in the next screen. If you're not sure about an option, there are some details in this document below, and some tips provided in the sidebar when you edit an option.
119-
The instance options are:
123+
10. Configure the storage options for your database.
120124

121-
**License Model:** only has one option, so choose the default.
122-
123-
**DB Engine Version:** specifies the version of Postgres to use. If you aren't sure which version you'd like to use, the default is fine.
124-
125-
**DB Instance Class:** selects the machine your database will run on. If you're not sure what DB instance class is suitable for your database, check the [DB Instance Classes chart ](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html)and the [Pricing Page](http://aws.amazon.com/rds/pricing/).
126-
127-
**Multi-AZ Deployment:** whether or not you want a backup machine on standby. The pricing is equivalent to running two instances.
128-
129-
**Storage Type:** specifies the type of disk you'd like to use for the instance. From the sidebar information:
130-
131-
- General Purpose (SSD)storage is suitable for a broad range of database workloads. Provides baseline of 3 IOPS/GB and ability to burst to 3,000 IOPS.
132-
- Provisioned IOPS (SSD)storage is suitable for I/O-intensive database workloads. Provides flexibility to provision I/O ranging from 1,000 to 30,000 IOPS.
133-
- Magnetic storage may be used for small database workloads where data is accessed less frequently.
134-
135-
Provisioned IOPS allows you to specify what performance guarantees you'd like on disk I/O.
136-
137-
![](images/rds5.png)
138-
139-
The database settings are:
140-
141-
**DB Instance Identifier** is a unique identifier for the database. The ID must be unique for your account in a single region.
142-
143-
**Master Username** is the username you will use to log in to the instance.
144-
145-
**Master Password** is a password that is 8 to 128 ASCII characters long that doesn't contain the characters /, ", or @.
146-
147-
When you're done entering your settings, click **Next Step**.
148-
![](images/rds6.png)
149-
150-
8. Configure the advanced settings
125+
11. Set up the connectivity options for your database.
151126

152127
The options for Network & Security are:
153128

154-
- **VPC** specifies the Virtual Private Cloud you want the servers to reside in. If you have previously set up a VPC that you want the database in, select it here. If you aren't sure or don't have a VPC set up, select Create New VPC
155-
- **Subnet Group** specifies the subnets that the DB instances can use in the VPC. If you're not sure, select Create new DB Subnet Group
156-
- **Publicly Accessible** specifies whether your DB instances are internet-addressable. This option must be set to Yes.
129+
- **VPC** specifies the Virtual Private Cloud you want the servers to reside in. If you have previously set up a VPC that you want the database in, select it here. If you aren't sure or don't have a VPC set up, select **Create New VPC**. You cannot change the VPC after creating your database.
130+
- **Subnet group** specifies the subnets that the DB instances can use in the VPC. If you're not sure, select **Create new DB Subnet Group**.
131+
- **Publicly access** specifies whether your DB instances are internet-addressable. This option must be set to Yes.
157132
- **Availability Zone** specifies which availability zone you want the instances to reside in. If you have a preference, you can set it here, else leave it on the No Preference default.
158133
- **VPC Security Groups** specify traffic rules concerning what traffic can leave the instances and what traffic can arrive at the instance. Unless you've previously made a security group specifically for DB instances, it's best to create a new one.
159134

0 commit comments

Comments
 (0)