From 715ffabb54c3bce1b926bfe7ee92a6d34ff46f6f Mon Sep 17 00:00:00 2001 From: Jason Howell Date: Fri, 4 Aug 2017 19:34:27 -0700 Subject: [PATCH 1/3] Usability Study adjustments --- ...uickstart-create-server-database-portal.md | 94 +++++++++++-------- 1 file changed, 55 insertions(+), 39 deletions(-) diff --git a/articles/postgresql/quickstart-create-server-database-portal.md b/articles/postgresql/quickstart-create-server-database-portal.md index 61cee4ee28343..607223c1eb12b 100644 --- a/articles/postgresql/quickstart-create-server-database-portal.md +++ b/articles/postgresql/quickstart-create-server-database-portal.md @@ -42,20 +42,17 @@ Follow these steps to create an Azure Database for PostgreSQL server: Password |*Your choice* | Create a new password for the server admin account. Must contain from 8 to 128 characters. Your password must contain characters from three of the following categories – English uppercase letters, English lowercase letters, numbers (0-9), and non-alphanumeric characters (!, $, #, %, etc.). Location|*The region closest to your users*| Choose the location that's closest to your users. PostgreSQL Version|*Choose the latest version*| Choose the latest version unless you have specific requirements. - Pricing Tier | **Basic**, **50 Compute Units** **50 GB** | Click **Pricing tier** to specify the service tier and performance level for your new database. Choose Basic tier in the tab at the top. Click the left end of the Compute Units slider to adjust the value to the least amount available for this quickstart. See screenshot below. + Pricing Tier | **Basic**, **50 Compute Units** **50 GB** | Click **Pricing tier** to specify the service tier and performance level for your new database. Choose Basic tier in the tab at the top. Click the left end of the Compute Units slider to adjust the value to the least amount available for this quickstart. Click **Ok** to save the pricing tier selection. See the following screenshot. + | Pin to dashboard | Check | Check the **Pin to dashboard** option to allow easy tracking of your server on the front dashboard page of your Azure portal. > [!IMPORTANT] > The server admin login and password that you specify here are required to log in to the server and its databases later in this quick start. Remember or record this information for later use. ![Azure Database for PostgreSQL - pick the pricing tier](./media/quickstart-create-database-portal/2-service-tier.png) -5. Click **Ok**. -6. Click **Create** to provision the server. Provisioning takes a few minutes. +4. Click **Create** to provision the server. Provisioning takes a few minutes, up to 20 minutes maximum. - > [!TIP] - > Check the **Pin to dashboard** option to allow easy tracking of your deployments. - -7. On the toolbar, click **Notifications** to monitor the deployment process. +5. On the toolbar, click **Notifications** to monitor the deployment process. ![Azure Database for PostgreSQL - See notifications](./media/quickstart-create-database-portal/3-notifications.png) By default, **postgres** database gets created under your server. The [postgres](https://www.postgresql.org/docs/9.6/static/app-initdb.html) database is a default database meant for use by users, utilities, and third-party applications. @@ -64,64 +61,83 @@ Follow these steps to create an Azure Database for PostgreSQL server: The Azure Database for PostgreSQL service creates a firewall at the server-level. This firewall prevents external applications and tools from connecting to the server and any databases on the server unless a firewall rule is created to open the firewall for specific IP addresses. -1. After the deployment completes, click **All Resources** from the left-hand menu and type in the name **mypgserver-20170401** to search for your newly created server. Click the server name listed in the search result. The **Overview** page for your server opens and provides options for further configuration. +1. Locate your server after the deployment completes. For example, click **All Resources** from the left-hand menu and type in the your server name (such as the example mypgserver-20170401) to search for your newly created server. Click on your server name listed in the search result. The Overview page for your server opens and provides options for further configuration. - ![Azure Database for PostgreSQL - Search for server ](./media/quickstart-create-database-portal/4-locate.png) + ![Azure Database for PostgreSQL - Search for server ](./media/quickstart-create-database-portal/4-locate.png) -2. In the server blade, select **Connection Security**. -3. Click in the text box under **Rule Name,** and add a new firewall rule to whitelist the IP range for connectivity. For this quick start, let's allow all IPs by typing in **Rule Name = AllowAllIps**, **Start IP = 0.0.0.0** and **End IP = 255.255.255.255** and then click **Save**. You can set a firewall rule that covers an IP range to be able to connect from your network. +2. On the server page, select **Connection Security**. + ![Azure Database for PostgreSQL - Create Firewall Rule](./media/quickstart-create-database-portal/5-firewall-2.png) - ![Azure Database for PostgreSQL - Create Firewall Rule](./media/quickstart-create-database-portal/5-firewall-2.png) +3. Under the **Firewall Rules** heading, click in the blank text box in the **Rule Name** column to begin creating the firewall rule. -4. Click **Save** and then click the **X** to close the **Connections Security** page. + For this quick start, let's allow all IP addresses into the server by filling in the text box in each column with the following values: - > [!NOTE] - > Azure PostgreSQL server communicates over port 5432. If you are trying to connect from within a corporate network, outbound traffic over port 5432 may not be allowed by your network's firewall. If so, you will not be able to connect to your Azure SQL Database server unless your IT department opens port 5432. - > + Rule Name | Start IP | End IP + ---|---|--- + AllowAllIps | 0.0.0.0 | 255.255.255.255 -## Get the connection information +4. On the upper toolbar of the Connection Security page, click **Save**. Then click the **X** to close the Connection Security page. -When we created our Azure Database for PostgreSQL server, the default **postgres** database also gets created. To connect to your database server, you need to provide host information and access credentials. + > [!NOTE] + > Azure PostgreSQL server communicates over port 5432. If you are trying to connect from within a corporate network, outbound traffic over port 5432 may not be allowed by your network's firewall. If so, you will not be able to connect to your Azure SQL Database server unless your IT department opens port 5432. + > -1. From the left-hand menu in Azure portal, click **All resources** and search for the server you just created **mypgserver-20170401**. +## Get the connection information - ![Azure Database for PostgreSQL - Search for server ](./media/quickstart-create-database-portal/4-locate.png) +When we created our Azure Database for PostgreSQL server, a default database named **postgres** gets created. To connect to your database server, you need to recall the full server name and admin login credentials. You may have noted those values earlier in the quick start article. In case you did not, easily find the server name and login information from the server Overview page in the Azure portal. -2. Click the server name **mypgserver-20170401**. -3. Select the server's **Overview** page. Make a note of the **Server name** and **Server admin login name**. +1. Open your server's **Overview** page. Make a note of the **Server name** and **Server admin login name**. + Hover your cursor over each field, and the copy icon appears to the right of the text. Click the copy icon as needed to copy the values. ![Azure Database for PostgreSQL - Server Admin Login](./media/quickstart-create-database-portal/6-server-name.png) ## Connect to PostgreSQL database using psql in Cloud Shell -Let's now use the psql command-line utility to connect to the Azure Database for PostgreSQL server. +There are a number of applications you can use to connect to your Azure Database for PostgreSQL server. Let's first use the psql command-line utility to illustrate how to connect to the server. You can use a web browser and the Azure Cloud Shell as described here without the need to install any additional software. Also, you can connect from your own machine if you have psql installed locally. + 1. Launch the Azure Cloud Shell via the terminal icon on the top navigation pane. ![Azure Database for PostgreSQL - Azure Cloud Shell terminal icon](./media/quickstart-create-database-portal/7-cloud-console.png) -2. The Azure Cloud Shell opens in your browser, enabling you to type bash commands. +2. The Azure Cloud Shell opens in your browser, enabling you to type bash shell commands. ![Azure Database for PostgreSQL - Azure Shell Bash Prompt](./media/quickstart-create-database-portal/8-bash.png) -3. At the Cloud Shell prompt, connect to your Azure Database for PostgreSQL server by typing the psql command line at the prompt. The following format is used to connect to an Azure Database for PostgreSQL server with the [psql](https://www.postgresql.org/docs/9.6/static/app-psql.html) utility: - ```bash - psql --host= --port= --username= --dbname= - ``` +3. At the Cloud Shell prompt, connect to a database in your Azure Database for PostgreSQL server by typing the psql command line at the green prompt. - For example, the following command connects to the default database called **postgres** on your PostgreSQL server **mypgserver-20170401.postgres.database.azure.com** using access credentials. Always use port **5432** when connecting. Enter your server admin password when prompted. Please use spaces between the --switches in the command as shown, but do not use spaces between the equal signs and the parameter values. + The following format is used to connect to an Azure Database for PostgreSQL server with the [psql](https://www.postgresql.org/docs/9.6/static/app-psql.html) utility: + ```bash + psql --host= --port= --username= --dbname= + ``` + + For example, the following command connects to an example server + + ```bash + psql --host=mypgserver-20170401.postgres.database.azure.com --port=5432 --username=mylogin@mypgserver-20170401 --dbname=postgres + ``` + + psql parameter |Suggested value|Description + ---|---|--- + host | *server name* | Specify the server name value that was used when you created the Azure Database for PostgreSQL earlier. Our example server shown is mypgserver-20170401.postgres.database.azure.com. Use the fully qualified domain name (\*.postgres.database.azure.com) as shown in the example. Follow the previous section to get the connection information if you do not remember your server name. + port | **5432** | Always use port 5432 when connecting to Azure Database for PostgreSQL. + username | *server admin login name* |Type in the server admin login username supplied when you created the Azure Database for PostgreSQL earlier. Follow the previous section to get the connection information if you do not remember the username. The format is *username@servername*. + dbname | **postgres** | Use the default system generated database name *postgres* for the first connection. Later you will create your own database. + + After running the psql command, with your own parameter values, you will be prompted to type the server admin password. This will be the same password that you provided when you created the server. + + psql parameter |Suggested value|Description + ---|---|--- + password | *your admin password* | Note, the typed password characters will not be shown on the bash prompt. Press enter after you have typed all the characters to authenticate and connect. - ```bash - psql --host=mypgserver-20170401.postgres.database.azure.com --port=5432 --username=mylogin@mypgserver-20170401 --dbname=postgres - ``` -4. Once you're connected to the server, create a blank database at the prompt. -```bash -CREATE DATABASE mypgsqldb; -``` +4. Once you're connected to the server, create a blank database at the prompt by typing the following command: + ```bash + CREATE DATABASE mypgsqldb; + ``` 5. At the prompt, execute the following command to switch connection to the newly created database **mypgsqldb**. -```bash -\c mypgsqldb -``` + ```bash + \c mypgsqldb + ``` ## Connect to PostgreSQL database using pgAdmin From 0384ac5e8821adae0981d9a987469cda1915e417 Mon Sep 17 00:00:00 2001 From: Jason Howell Date: Fri, 4 Aug 2017 19:59:30 -0700 Subject: [PATCH 2/3] Usability Study adjustments --- .../quickstart-create-server-database-portal.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/articles/postgresql/quickstart-create-server-database-portal.md b/articles/postgresql/quickstart-create-server-database-portal.md index 607223c1eb12b..bd91d746aa74b 100644 --- a/articles/postgresql/quickstart-create-server-database-portal.md +++ b/articles/postgresql/quickstart-create-server-database-portal.md @@ -42,7 +42,7 @@ Follow these steps to create an Azure Database for PostgreSQL server: Password |*Your choice* | Create a new password for the server admin account. Must contain from 8 to 128 characters. Your password must contain characters from three of the following categories – English uppercase letters, English lowercase letters, numbers (0-9), and non-alphanumeric characters (!, $, #, %, etc.). Location|*The region closest to your users*| Choose the location that's closest to your users. PostgreSQL Version|*Choose the latest version*| Choose the latest version unless you have specific requirements. - Pricing Tier | **Basic**, **50 Compute Units** **50 GB** | Click **Pricing tier** to specify the service tier and performance level for your new database. Choose Basic tier in the tab at the top. Click the left end of the Compute Units slider to adjust the value to the least amount available for this quickstart. Click **Ok** to save the pricing tier selection. See the following screenshot. + Pricing Tier | **Basic**, **50 Compute Units** **50 GB** | Click **Pricing tier** to specify the service tier and performance level for your new database. Choose Basic tier in the tab at the top. Click the left end of the Compute Units slider to adjust the value to the least amount available for this quickstart. Click **Ok** to save the pricing tier selection. See the following screenshot. | Pin to dashboard | Check | Check the **Pin to dashboard** option to allow easy tracking of your server on the front dashboard page of your Azure portal. > [!IMPORTANT] @@ -61,7 +61,7 @@ Follow these steps to create an Azure Database for PostgreSQL server: The Azure Database for PostgreSQL service creates a firewall at the server-level. This firewall prevents external applications and tools from connecting to the server and any databases on the server unless a firewall rule is created to open the firewall for specific IP addresses. -1. Locate your server after the deployment completes. For example, click **All Resources** from the left-hand menu and type in the your server name (such as the example mypgserver-20170401) to search for your newly created server. Click on your server name listed in the search result. The Overview page for your server opens and provides options for further configuration. +1. Locate your server after the deployment completes. If needed you can search for it. For example, click **All Resources** from the left-hand menu and type in the server name (such as the example mypgserver-20170401) to search for your newly created server. Click on your server name listed in the search result. The Overview page for your server opens and provides options for further configuration. ![Azure Database for PostgreSQL - Search for server ](./media/quickstart-create-database-portal/4-locate.png) @@ -93,7 +93,7 @@ When we created our Azure Database for PostgreSQL server, a default database nam ## Connect to PostgreSQL database using psql in Cloud Shell -There are a number of applications you can use to connect to your Azure Database for PostgreSQL server. Let's first use the psql command-line utility to illustrate how to connect to the server. You can use a web browser and the Azure Cloud Shell as described here without the need to install any additional software. Also, you can connect from your own machine if you have psql installed locally. +There are a number of applications you can use to connect to your Azure Database for PostgreSQL server. Let's first use the psql command-line utility to illustrate how to connect to the server. You can use a web browser and the Azure Cloud Shell as described here without the need to install any additional software. If you have the psql utility installed locally on your own machine, you can connect from there as well. 1. Launch the Azure Cloud Shell via the terminal icon on the top navigation pane. @@ -123,7 +123,7 @@ There are a number of applications you can use to connect to your Azure Database username | *server admin login name* |Type in the server admin login username supplied when you created the Azure Database for PostgreSQL earlier. Follow the previous section to get the connection information if you do not remember the username. The format is *username@servername*. dbname | **postgres** | Use the default system generated database name *postgres* for the first connection. Later you will create your own database. - After running the psql command, with your own parameter values, you will be prompted to type the server admin password. This will be the same password that you provided when you created the server. + After running the psql command, with your own parameter values, you will be prompted to type the server admin password. This is the same password that you provided when you created the server. psql parameter |Suggested value|Description ---|---|--- From cd03ac9346df7c7bd5e9d0eefdb599f4f87033ca Mon Sep 17 00:00:00 2001 From: Jason Howell Date: Fri, 4 Aug 2017 23:55:16 -0700 Subject: [PATCH 3/3] Usability Study adjustments --- ...uickstart-create-server-database-portal.md | 62 ++++++++----------- 1 file changed, 25 insertions(+), 37 deletions(-) diff --git a/articles/postgresql/quickstart-create-server-database-portal.md b/articles/postgresql/quickstart-create-server-database-portal.md index bd91d746aa74b..b918ed2d1cec5 100644 --- a/articles/postgresql/quickstart-create-server-database-portal.md +++ b/articles/postgresql/quickstart-create-server-database-portal.md @@ -82,62 +82,50 @@ The Azure Database for PostgreSQL service creates a firewall at the server-level > Azure PostgreSQL server communicates over port 5432. If you are trying to connect from within a corporate network, outbound traffic over port 5432 may not be allowed by your network's firewall. If so, you will not be able to connect to your Azure SQL Database server unless your IT department opens port 5432. > + ## Get the connection information -When we created our Azure Database for PostgreSQL server, a default database named **postgres** gets created. To connect to your database server, you need to recall the full server name and admin login credentials. You may have noted those values earlier in the quick start article. In case you did not, easily find the server name and login information from the server Overview page in the Azure portal. +When we created our Azure Database for PostgreSQL server, the default **postgres** database also gets created. To connect to your database server, you need to provide host information and access credentials. + +1. From the left-hand menu in Azure portal, click **All resources** and search for the server you just created **mypgserver-20170401**. + + ![Azure Database for PostgreSQL - Search for server ](./media/quickstart-create-database-portal/4-locate.png) -1. Open your server's **Overview** page. Make a note of the **Server name** and **Server admin login name**. - Hover your cursor over each field, and the copy icon appears to the right of the text. Click the copy icon as needed to copy the values. +2. Click the server name **mypgserver-20170401**. +3. Select the server's **Overview** page. Make a note of the **Server name** and **Server admin login name**. ![Azure Database for PostgreSQL - Server Admin Login](./media/quickstart-create-database-portal/6-server-name.png) ## Connect to PostgreSQL database using psql in Cloud Shell -There are a number of applications you can use to connect to your Azure Database for PostgreSQL server. Let's first use the psql command-line utility to illustrate how to connect to the server. You can use a web browser and the Azure Cloud Shell as described here without the need to install any additional software. If you have the psql utility installed locally on your own machine, you can connect from there as well. - +Let's now use the psql command-line utility to connect to the Azure Database for PostgreSQL server. 1. Launch the Azure Cloud Shell via the terminal icon on the top navigation pane. ![Azure Database for PostgreSQL - Azure Cloud Shell terminal icon](./media/quickstart-create-database-portal/7-cloud-console.png) -2. The Azure Cloud Shell opens in your browser, enabling you to type bash shell commands. +2. The Azure Cloud Shell opens in your browser, enabling you to type bash commands. ![Azure Database for PostgreSQL - Azure Shell Bash Prompt](./media/quickstart-create-database-portal/8-bash.png) -3. At the Cloud Shell prompt, connect to a database in your Azure Database for PostgreSQL server by typing the psql command line at the green prompt. - - The following format is used to connect to an Azure Database for PostgreSQL server with the [psql](https://www.postgresql.org/docs/9.6/static/app-psql.html) utility: - ```bash - psql --host= --port= --username= --dbname= - ``` - - For example, the following command connects to an example server +3. At the Cloud Shell prompt, connect to your Azure Database for PostgreSQL server by typing the psql command line at the prompt. The following format is used to connect to an Azure Database for PostgreSQL server with the [psql](https://www.postgresql.org/docs/9.6/static/app-psql.html) utility: + ```bash + psql --host= --port= --username= --dbname= + ``` - ```bash - psql --host=mypgserver-20170401.postgres.database.azure.com --port=5432 --username=mylogin@mypgserver-20170401 --dbname=postgres - ``` - - psql parameter |Suggested value|Description - ---|---|--- - host | *server name* | Specify the server name value that was used when you created the Azure Database for PostgreSQL earlier. Our example server shown is mypgserver-20170401.postgres.database.azure.com. Use the fully qualified domain name (\*.postgres.database.azure.com) as shown in the example. Follow the previous section to get the connection information if you do not remember your server name. - port | **5432** | Always use port 5432 when connecting to Azure Database for PostgreSQL. - username | *server admin login name* |Type in the server admin login username supplied when you created the Azure Database for PostgreSQL earlier. Follow the previous section to get the connection information if you do not remember the username. The format is *username@servername*. - dbname | **postgres** | Use the default system generated database name *postgres* for the first connection. Later you will create your own database. - - After running the psql command, with your own parameter values, you will be prompted to type the server admin password. This is the same password that you provided when you created the server. - - psql parameter |Suggested value|Description - ---|---|--- - password | *your admin password* | Note, the typed password characters will not be shown on the bash prompt. Press enter after you have typed all the characters to authenticate and connect. + For example, the following command connects to the default database called **postgres** on your PostgreSQL server **mypgserver-20170401.postgres.database.azure.com** using access credentials. Always use port **5432** when connecting. Enter your server admin password when prompted. Please use spaces between the --switches in the command as shown, but do not use spaces between the equal signs and the parameter values. -4. Once you're connected to the server, create a blank database at the prompt by typing the following command: - ```bash - CREATE DATABASE mypgsqldb; - ``` + ```bash + psql --host=mypgserver-20170401.postgres.database.azure.com --port=5432 --username=mylogin@mypgserver-20170401 --dbname=postgres + ``` +4. Once you're connected to the server, create a blank database at the prompt. +```bash +CREATE DATABASE mypgsqldb; +``` 5. At the prompt, execute the following command to switch connection to the newly created database **mypgsqldb**. - ```bash - \c mypgsqldb - ``` +```bash +\c mypgsqldb +``` ## Connect to PostgreSQL database using pgAdmin