Skip to content

Commit 8fc959b

Browse files
authored
Merge pull request #201941 from MikeRayMSFT/20220616-deploy-arc
Restructure Deploy from ADS and update TOC
2 parents d5df1b7 + e4ea5f6 commit 8fc959b

File tree

4 files changed

+161
-141
lines changed

4 files changed

+161
-141
lines changed

articles/azure-arc/data/create-sql-managed-instance-azure-data-studio.md

Lines changed: 72 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,75 +1,92 @@
11
---
2-
title: Create Azure SQL Managed Instance using Azure Data Studio
3-
description: Create Azure SQL Managed Instance using Azure Data Studio
2+
title: Create Azure Arc-enabled SQL Managed Instance using Azure Data Studio
3+
description: Create Azure Arc-enabled SQL Managed Instance using Azure Data Studio
44
services: azure-arc
55
ms.service: azure-arc
66
ms.subservice: azure-arc-data
77
author: dnethi
88
ms.author: dinethi
99
ms.reviewer: mikeray
10-
ms.date: 07/30/2021
10+
ms.date: 06/16/2021
1111
ms.topic: how-to
1212
---
1313

14-
# Create SQL Managed Instance - Azure Arc using Azure Data Studio
14+
# Create Azure Arc-enabled SQL Managed Instance using Azure Data Studio
1515

16-
This document walks you through the steps for installing Azure SQL Managed Instance - Azure Arc using Azure Data Studio
16+
This document demonstrates how to install Azure SQL Managed Instance - Azure Arc using Azure Data Studio.
1717

1818
[!INCLUDE [azure-arc-common-prerequisites](../../../includes/azure-arc-common-prerequisites.md)]
1919

20-
[!INCLUDE [use-insider-azure-data-studio](includes/use-insider-azure-data-studio.md)]
20+
## Create Azure Arc-enabled SQL Managed Instance
2121

22-
## Create Azure SQL Managed Instance on Azure Arc
23-
24-
- Launch Azure Data Studio
25-
- On the Connections tab, Click on the three dots on the top left and choose "New Deployment"
26-
- From the deployment options, select **Azure SQL Managed Instance - Azure Arc**
22+
1. Launch Azure Data Studio
23+
2. On the Connections tab, select on the three dots on the top left and choose **New Deployment...**.
24+
3. From the deployment options, select **Azure SQL managed instance**.
2725
> [!NOTE]
2826
> You may be prompted to install the appropriate CLI here if it is not currently installed.
29-
- Accept the Privacy and license terms and click **Select** at the bottom
30-
31-
- In the Deploy Azure SQL Managed Instance - Azure Arc blade, enter the following information:
32-
- Enter a name for the SQL Server instance
33-
- Enter and confirm a password for the SQL Server instance
34-
- Select the storage class as appropriate for data
35-
- Select the storage class as appropriate for logs
36-
- Select the storage class as appropriate for backups
37-
38-
> [!NOTE]
39-
>Note: Starting with the February release, a ReadWriteMany (RWX) capable storage class needs to be specified for backups. Learn more about [access modes](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#access-modes)
40-
If no storage class is specified for backups, the default storage class in kubernetes is used and if this is not RWX capable, the Arc SQL Managed Instance installation may not succeed.
41-
42-
- Click the **Deploy** button
43-
44-
- This should initiate the creation of the Azure SQL Managed Instance - Azure Arc on the data controller.
45-
46-
- In a few minutes, your creation should successfully complete
47-
48-
## Connect to Azure SQL Managed Instance - Azure Arc from Azure Data Studio
49-
50-
- View all the Azure SQL Managed Instances provisioned, using the following commands:
51-
52-
```azurecli
53-
az sql mi-arc list --k8s-namespace <namespace> --use-k8s
54-
```
55-
56-
Output should look like this, copy the ServerEndpoint (including the port number) from here.
57-
58-
```console
59-
60-
Name Replicas ServerEndpoint State
61-
------------ ---------- ----------------- -------
62-
sqlinstance1 1/1 25.51.65.109:1433 Ready
63-
```
64-
65-
- In Azure Data Studio, under **Connections** tab, click on the **New Connection** on the **Servers** view
66-
- In the **Connection** blade, paste the ServerEndpoint into the Server textbox
67-
- Select **SQL Login** as the Authentication type
68-
- Enter *sa* as the user name
69-
- Enter the password for the `sa` account
70-
- Optionally, enter the specific database name to connect to
71-
- Optionally, select/Add New Server Group as appropriate
72-
- Select **Connect** to connect to the Azure SQL Managed Instance - Azure Arc
27+
28+
4. Select **Select**.
29+
30+
Azure Data Studio opens **Azure SQL managed instance**.
31+
32+
5. For **Resource Type**, choose **Azure SQL managed instance - Azure Arc**.
33+
6. Accept the privacy statement and license terms
34+
1. Review the required tools. Follow instructions to update tools before you proceed.
35+
1. Select **Next**.
36+
37+
Azure Data Studio allows you to set your specifications for the managed instance. The following table describes the fields:
38+
39+
|Setting | Description | Required or optional
40+
|-------|-------|-------|
41+
|**Target Azure Controller** | Name of the Azure Arc data controller. | Required |
42+
|**Instance name** | Managed instance name. | Required |
43+
|**Username** | System administrator user name. | Required |
44+
|**System administrator password** | SQL authentication password for the managed instance. The passwords must be at least eight characters long and contain characters from three of the following four categories: Latin uppercase letters, Latin lowercase letters, numbers, and non-alphanumeric characters.<br/></br> Confirm the password. | Required |
45+
|**Service tier** | Specify the appropriate service tier: Business Critical or General Purpose. | Required |
46+
|**I already have a SQL Server License** | Select if this managed instance will use a license from your organization. | Optional |
47+
|**Storage Class (Data)** | Select from the list. | Required |
48+
|**Volume Size in Gi (Data)** | The amount of space in gibibytes to allocate for data. | Required |
49+
|**Storage Class (Database logs)** | Select from the list. | Required |
50+
|**Volume Size in Gi (Database logs)** | The amount of space in gibibytes to allocate for database transaction logs. | Required |
51+
|**Storage Class (Logs)** | Select from the list. | Required |
52+
|**Volume Size in Gi (Logs)** | The amount of space in gibibytes to allocate for logs. | Required |
53+
|**Storage Class (Backups)** | Select from the list. Specify a ReadWriteMany (RWX) capable storage class for backups. Learn more about [access modes](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#access-modes). If this storage class isn't RWX capable, the deployment may not succeed. | Required |
54+
|**Volume Size in Gi (Backups)** | The size of the storage volume to be used for database backups in gibibytes. | Required |
55+
|**Cores Request** | The number of cores to request for the managed instance. Integer. | Optional |
56+
|**Cores Limit** | The request for the capacity for the managed instance in gigabytes. Integer. | Optional |
57+
|**Memory Request** | Select from the list. | Required |
58+
|**Point in time retention (days)** | The number of days to keep your point in time backups. | Optional |
59+
60+
After you've set all of the required values, Azure Data Studio enables the **Deploy** button. If this control is disabled, verify that you have all required settings configured.
61+
62+
1. Select the **Deploy** button to create the managed instance.
63+
64+
After you select the deploy button, the Azure Arc data controller initiates the deployment. The deployment creates the managed instance. The deployment process takes a few minutes to create the data controller.
65+
66+
## Connect to Azure Arc-enabled SQL Managed Instance from Azure Data Studio
67+
68+
View all the Azure SQL Managed Instances provisioned to this data controller. Use the following command:
69+
70+
```azurecli
71+
az sql mi-arc list --k8s-namespace <namespace> --use-k8s
72+
```
73+
74+
Output should look like this, copy the ServerEndpoint (including the port number) from here.
75+
76+
```console
77+
Name Replicas ServerEndpoint State
78+
------------ ---------- ----------------- -------
79+
sqlinstance1 1/1 25.51.65.109:1433 Ready
80+
```
81+
82+
1. In Azure Data Studio, under **Connections** tab, select the **New Connection** on the **Servers** view
83+
1. Under **Connection**>**Server**, paste the ServerEndpoint
84+
1. Select **SQL Login** as the Authentication type
85+
1. Enter *sa* as the user name
86+
1. Enter the password for the `sa` account
87+
1. Optionally, enter the specific database name to connect to
88+
1. Optionally, select/Add New Server Group as appropriate
89+
1. Select **Connect** to connect to the Azure SQL Managed Instance - Azure Arc
7390

7491
## Next Steps
7592

articles/azure-arc/data/storage-configuration.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ Some services in Azure Arc for data services depend upon being configured to use
147147

148148
At the time the data controller is provisioned, the storage class to be used for each of these persistent volumes is specified by either passing the --storage-class | -sc parameter to the `az arcdata dc create` command or by setting the storage classes in the control.json deployment template file that is used. If you are using the Azure portal to create the data controller in the directly connected mode, the deployment template that you choose will either have the storage class predefined in the template or if you select a template which does not have a predefined storage class then you will be prompted for one. If you use a custom deployment template, then you can specify the storage class.
149149

150-
The deployment templates that are provided out of the box have a default storage class specified that is appropriate for the target environment, but it can be overridden during deployment. See the detailed steps to [create custom configuration temmplates](create-custom-configuration-template.md) to change the storage class configuration for the data controller pods at deployment time.
150+
The deployment templates that are provided out of the box have a default storage class specified that is appropriate for the target environment, but it can be overridden during deployment. See the detailed steps to [create custom configuration templates](create-custom-configuration-template.md) to change the storage class configuration for the data controller pods at deployment time.
151151

152152
If you set the storage class using the --storage-class | -sc parameter the storage class will be used for both log and data storage classes. If you set the storage classes in the deployment template file, you can specify different storage classes for logs and data.
153153

@@ -172,7 +172,10 @@ When creating an instance using either `az sql mi-arc create` or `az postgres ar
172172
|`--storage-class-data`, `-d`|Used to specify the storage class for all data files including transaction log files|
173173
|`--storage-class-logs`, `-g`|Used to specify the storage class for all log files|
174174
|`--storage-class-data-logs`|Used to specify the storage class for the database transaction log files.|
175-
|`--storage-class-backups`|Used to specify the storage class for all backup files.|
175+
|`--storage-class-backups`|Used to specify the storage class for all backup files. Use a ReadWriteMany (RWX) capable storage class for backups. Learn more about [access modes](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#access-modes). |
176+
177+
> [!WARNING]
178+
> If you don't specify a storage class for backups, the deployment uses the default storage class in Kubernetes. If this storage class isn't RWX capable, the deployment may not succeed.
176179
177180
The table below lists the paths inside the Azure SQL Managed Instance container that is mapped to the persistent volume for data and logs:
178181

articles/azure-arc/data/toc.yml

Lines changed: 76 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -110,72 +110,6 @@ items:
110110
href: troubleshoot-guide.md
111111
- name: Get logs
112112
href: troubleshooting-get-logs.md
113-
- name: Azure Arc-enabled PostgreSQL Hyperscale (preview)
114-
items:
115-
- name: Overview
116-
items:
117-
- name: What is Azure Arc-enabled PostgreSQL Hyperscale
118-
href: what-is-azure-arc-enabled-postgres-hyperscale.md
119-
- name: Limitations
120-
href: limitations-postgresql-hyperscale.md
121-
- name: Quickstarts
122-
items:
123-
- name: Supported versions
124-
href: supported-versions-postgres-hyperscale.md
125-
- name: Create Postgres Hyperscale server group (CLI)
126-
href: create-postgresql-hyperscale-server-group.md
127-
- name: Create Postgres Hyperscale server group (portal)
128-
href: create-postgresql-hyperscale-server-group-azure-portal.md
129-
- name: Create Postgres Hyperscale server group (Azure Data Studio)
130-
href: create-postgresql-hyperscale-server-group-azure-data-studio.md
131-
- name: Create Postgres Hyperscale server group - Kubernetes native tools
132-
href: create-postgresql-hyperscale-server-group-kubernetes-native-tools.md
133-
- name: Connect
134-
href: get-connection-endpoints-and-connection-strings-postgres-hyperscale.md
135-
- name: Concepts
136-
items:
137-
- name: Distribute data
138-
href: concepts-distributed-postgres-hyperscale.md
139-
- name: Server group placement
140-
href: postgresql-hyperscale-server-group-placement-on-kubernetes-cluster-nodes.md
141-
- name: How-to
142-
items:
143-
- name: Manage
144-
items:
145-
- name: Backup & restore
146-
href: backup-restore-postgresql-hyperscale.md
147-
- name: Change PostgreSQL port
148-
href: change-postgresql-port.md
149-
- name: Configure & scale
150-
items:
151-
- name: Show configuration
152-
href: show-configuration-postgresql-hyperscale-server-group.md
153-
- name: Scale out|in worker nodes
154-
href: scale-out-in-postgresql-hyperscale-server-group.md
155-
- name: Scale up|down memory & vCores
156-
href: scale-up-down-postgresql-hyperscale-server-group-using-cli.md
157-
- name: Configure server parameters
158-
href: configure-server-parameters-postgresql-hyperscale.md
159-
- name: Delete
160-
href: delete-postgresql-hyperscale-server-group.md
161-
- name: List server groups
162-
href: list-server-groups-postgres-hyperscale.md
163-
- name: Monitoring, log analytics, billing information (portal)
164-
href: monitoring-log-analytics-azure-portal-postgresql.md
165-
- name: Secure
166-
href: configure-security-postgres-hyperscale.md
167-
- name: Manage server group (Azure Data Studio)
168-
href: manage-postgresql-hyperscale-server-group-with-azure-data-studio.md
169-
- name: Use Postgres extensions
170-
href: using-extensions-in-postgresql-hyperscale-server-group.md
171-
- name: Migrate
172-
items:
173-
- name: Migrate PostgreSQL data into a PostgreSQL Hyperscale server group
174-
href: migrate-postgresql-data-into-postgresql-hyperscale-server-group.md
175-
- name: Import the sample database AdventureWorks
176-
href: restore-adventureworks-sample-db-into-postgresql-hyperscale-server-group.md
177-
- name: Troubleshoot
178-
href: troubleshoot-postgresql-hyperscale-server-group.md
179113
- name: Azure Arc-enabled SQL Managed Instance
180114
items:
181115
- name: Overview
@@ -188,18 +122,18 @@ items:
188122
href: limitations-managed-instance.md
189123
- name: Service tiers
190124
href: service-tiers.md
191-
- name: Quickstarts
192-
items:
193-
- name: Create SQL Managed Instance
194-
href: create-sql-managed-instance.md
195-
- name: Create SQL Managed Instance (Azure Data Studio)
196-
href: create-sql-managed-instance-azure-data-studio.md
197-
- name: Create using Kubernetes tools
198-
href: create-sql-managed-instance-using-kubernetes-native-tools.md
199-
- name: Connect
200-
href: connect-managed-instance.md
201125
- name: How-to
202126
items:
127+
- name: Create & connect
128+
items:
129+
- name: Create with CLI
130+
href: create-sql-managed-instance.md
131+
- name: Create with Azure Data Studio
132+
href: create-sql-managed-instance-azure-data-studio.md
133+
- name: Create using Kubernetes tools
134+
href: create-sql-managed-instance-using-kubernetes-native-tools.md
135+
- name: Connect
136+
href: connect-managed-instance.md
203137
- name: Manage
204138
items:
205139
- name: Configure
@@ -270,6 +204,72 @@ items:
270204
href: managed-instance-high-availability.md
271205
- name: Disaster recovery
272206
href: managed-instance-disaster-recovery.md
207+
- name: Azure Arc-enabled PostgreSQL Hyperscale (preview)
208+
items:
209+
- name: Overview
210+
items:
211+
- name: What is Azure Arc-enabled PostgreSQL Hyperscale
212+
href: what-is-azure-arc-enabled-postgres-hyperscale.md
213+
- name: Limitations
214+
href: limitations-postgresql-hyperscale.md
215+
- name: Quickstarts
216+
items:
217+
- name: Supported versions
218+
href: supported-versions-postgres-hyperscale.md
219+
- name: Create Postgres Hyperscale server group (CLI)
220+
href: create-postgresql-hyperscale-server-group.md
221+
- name: Create Postgres Hyperscale server group (portal)
222+
href: create-postgresql-hyperscale-server-group-azure-portal.md
223+
- name: Create Postgres Hyperscale server group (Azure Data Studio)
224+
href: create-postgresql-hyperscale-server-group-azure-data-studio.md
225+
- name: Create Postgres Hyperscale server group - Kubernetes native tools
226+
href: create-postgresql-hyperscale-server-group-kubernetes-native-tools.md
227+
- name: Connect
228+
href: get-connection-endpoints-and-connection-strings-postgres-hyperscale.md
229+
- name: Concepts
230+
items:
231+
- name: Distribute data
232+
href: concepts-distributed-postgres-hyperscale.md
233+
- name: Server group placement
234+
href: postgresql-hyperscale-server-group-placement-on-kubernetes-cluster-nodes.md
235+
- name: How-to
236+
items:
237+
- name: Manage
238+
items:
239+
- name: Backup & restore
240+
href: backup-restore-postgresql-hyperscale.md
241+
- name: Change PostgreSQL port
242+
href: change-postgresql-port.md
243+
- name: Configure & scale
244+
items:
245+
- name: Show configuration
246+
href: show-configuration-postgresql-hyperscale-server-group.md
247+
- name: Scale out|in worker nodes
248+
href: scale-out-in-postgresql-hyperscale-server-group.md
249+
- name: Scale up|down memory & vCores
250+
href: scale-up-down-postgresql-hyperscale-server-group-using-cli.md
251+
- name: Configure server parameters
252+
href: configure-server-parameters-postgresql-hyperscale.md
253+
- name: Delete
254+
href: delete-postgresql-hyperscale-server-group.md
255+
- name: List server groups
256+
href: list-server-groups-postgres-hyperscale.md
257+
- name: Monitoring, log analytics, billing information (portal)
258+
href: monitoring-log-analytics-azure-portal-postgresql.md
259+
- name: Secure
260+
href: configure-security-postgres-hyperscale.md
261+
- name: Manage server group (Azure Data Studio)
262+
href: manage-postgresql-hyperscale-server-group-with-azure-data-studio.md
263+
- name: Use Postgres extensions
264+
href: using-extensions-in-postgresql-hyperscale-server-group.md
265+
- name: Migrate
266+
items:
267+
- name: Migrate PostgreSQL data into a PostgreSQL Hyperscale server group
268+
href: migrate-postgresql-data-into-postgresql-hyperscale-server-group.md
269+
- name: Import the sample database AdventureWorks
270+
href: restore-adventureworks-sample-db-into-postgresql-hyperscale-server-group.md
271+
- name: Troubleshoot
272+
href: troubleshoot-postgresql-hyperscale-server-group.md
273273
- name: Reference
274274
items:
275275
- name: Release version log

0 commit comments

Comments
 (0)