Skip to content

Commit f8f06a4

Browse files
authored
Merge pull request #178495 from MicrosoftDocs/release-arc-data
November, 2021 Arc Data release
2 parents a52e3d3 + de97cb2 commit f8f06a4

File tree

46 files changed

+1945
-1320
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+1945
-1320
lines changed

.openpublishing.publish.config.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,12 @@
4545
"branch": "master",
4646
"branch_mapping": {}
4747
},
48+
{
49+
"path_to_root": "azure_arc_sample",
50+
"url": "https://github.com/microsoft/azure_arc",
51+
"branch": "main",
52+
"branch_mapping": {}
53+
},
4854
{
4955
"path_to_root": "resourcemanager-templates",
5056
"url": "https://github.com/Azure/azure-docs-json-samples",

articles/azure-arc/data/azure-data-studio-dashboards.md

Lines changed: 7 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ ms.subservice: azure-arc-data
77
author: twright-msft
88
ms.author: twright
99
ms.reviewer: mikeray
10-
ms.date: 07/30/2021
10+
ms.date: 11/03/2021
1111
ms.topic: how-to
1212
---
1313

@@ -23,52 +23,18 @@ ms.topic: how-to
2323
- Download [Azure Data Studio](/sql/azure-data-studio/download-azure-data-studio)
2424
- Azure Arc extension is installed
2525

26-
### Determine the data controller server API endpoint URL
2726

28-
First, you'll need to connect Azure Data Studio to your data controller service API endpoint URL.
29-
30-
To get this endpoint you can run the following command:
31-
32-
```console
33-
kubectl get svc/controller-svc-external -n <namespace name>
34-
35-
#Example:
36-
kubectl get svc/controller-svc-external -n arc
37-
```
38-
39-
You'll see output that looks like this:
40-
41-
```console
42-
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
43-
controller-svc-external LoadBalancer 10.0.175.137 52.154.152.24 30080:32192/TCP 22h
44-
```
45-
46-
If you are using a LoadBalancer type, you'll want to copy the external IP address and port number. If you are using NodePort, you'll want to use the IP address of your Kubernetes API server and the port number listed under the PORT(S) column.
47-
48-
Now, you'll want to construct a URL to your endpoint by combining this information like so:
49-
50-
```console
51-
https://<ip address>:<port>
52-
53-
Example:
54-
https://52.154.152.24:30080
55-
```
56-
57-
Take note of your IP address as you will use it in the next step.
5827

5928
### Connect
6029

6130
1. Open Azure Data Studio
31+
2. Select the **Connections** tab on the left
32+
3. Expand the panel called **Azure Arc Controllers**
33+
4. Click the **Connect Controller** button. This will open a blade on the right side
34+
5. By default, Azure Data Studio will try to read from the kube.config file in your default directory and list the available kubernetes cluster contexts and pre-select the current cluster context. If this is the right cluster to connect to, enter the namespace where the Azure Arc data controller is deployed in the input for **Namespace**. If you need to retrieve the namespace where the Azure Arc data controller is deployed, you can run ```kubectl get datacontrollers -A``` on your kubernetes cluster.
35+
6. Optionally add a display name for the Azure Arc data controller in the input for **Name**
36+
7. Select **Connect**
6237

63-
1. Select the **Connections** tab on the left
64-
65-
Towards the bottom, expand the panel called **Azure Arc Controllers**.
66-
67-
Click the + icon to add a new data controller connection.
68-
69-
At the top of the screen in the command palette, enter the URL you constructed in Step 1, click enter.
70-
Enter the username for the data controller. This was the username value that you passed during the deployment of the data controller. Click enter.
71-
Enter the password for the data controller. This was the password value that you passed during the deployment of the data controller. Click enter.
7238

7339
Now that you are connected to a data controller, you can view the dashboards for the data controller and any SQL managed instances or PostgreSQL Hyperscale server group resources that you have.
7440

articles/azure-arc/data/backup-restore-postgresql-hyperscale.md

Lines changed: 2 additions & 204 deletions
Original file line numberDiff line numberDiff line change
@@ -7,215 +7,13 @@ ms.subservice: azure-arc-data
77
author: TheJY
88
ms.author: jeanyd
99
ms.reviewer: mikeray
10-
ms.date: 07/30/2021
10+
ms.date: 11/03/2021
1111
ms.topic: how-to
1212
---
1313

1414
# Back up and restore Azure Arc-enabled PostgreSQL Hyperscale server groups
1515

16-
> [!IMPORTANT]
17-
> Backup and restore of Azure Arc-enabled PostgreSQL Hyperscale server is not supported in the current preview release.
16+
Backup and restore of Azure Arc-enabled PostgreSQL Hyperscale server is not supported in the current preview release.
1817

19-
[!INCLUDE [azure-arc-common-prerequisites](../../../includes/azure-arc-common-prerequisites.md)]
20-
21-
[!INCLUDE [azure-arc-data-preview](../../../includes/azure-arc-data-preview.md)]
22-
23-
When you back up or restore your Azure Arc-enabled PostgreSQL Hyperscale server group, the entire set of databases on all the PostgreSQL nodes of your server group is backed-up and/or restored.
24-
25-
## Take a manual full backup
26-
27-
To take a full backup of the entire data and log folders of your server group, run the following command:
28-
```console
29-
azdata arc postgres backup create [--name <backup name>] --server-name <server group name> [--no-wait] 
30-
```
31-
Where:
32-
- __name__ indicates the name of a backup
33-
- __server-name__ indicates a server group
34-
- __no-wait__ indicates that the command line will not wait for the backup to complete for you to be able to continue to use this command-line window
35-
36-
This command will coordinate a distributed full backup across all the nodes that constitute your Azure Arc-enabled PostgreSQL Hyperscale server group. In other words, it will backup all data in your Coordinator and Worker nodes.
37-
38-
For example:
39-
40-
```console
41-
azdata arc postgres backup create --name backup12082020-0250pm --server-name postgres01
42-
```
43-
44-
When the backup completes, the ID, name, size, state and timestamp of the backup will be returned. For example:
45-
```console
46-
{
47-
"ID": "8085723fcbae4aafb24798c1458f4bb7",
48-
"name": "backup12082020-0250pm",
49-
"size": "9.04 MiB",
50-
"state": "Done",
51-
"timestamp": "2020-12-08 22:50:22+00:00"
52-
}
53-
```
54-
`+xx:yy` indicates the timezone for the time at which the backup was taken. In this example, "+00:00" means UTC time (UTC + 00 hour 00 minutes).
55-
56-
> [!NOTE]
57-
> It is not yet possible to:
58-
> - Schedule automatic backups
59-
> - Show the progress of a backup while it is being taken
60-
61-
## List backups
62-
63-
To list the backups that are available to restore, run the following command:
64-
65-
```console
66-
azdata arc postgres backup list --server-name <servergroup name>
67-
```
68-
69-
For example:
70-
71-
```console
72-
azdata arc postgres backup list --server-name postgres01
73-
```
74-
75-
Returns an output like:
76-
77-
```output
78-
ID Name Size State Timestamp
79-
-------------------------------- --------------------- --------- ------- -------------------------
80-
d744303b1b224ef48be9cba4f58c7cb9 backup12072020-0731pm 13.83 MiB Done 2020-12-08 03:32:09+00:00
81-
c4f964d28da34318a420e6d14374bd36 backup12072020-0819pm 9.04 MiB Done 2020-12-08 04:19:49+00:00
82-
a304c6ef99694645a2a90ce339e94714 backup12072020-0822pm 9.1 MiB Done 2020-12-08 04:22:26+00:00
83-
47d1f57ec9014328abb0d8fe56020760 backup12072020-0827pm 9.06 MiB Done 2020-12-08 04:27:22+00:00
84-
8085723fcbae4aafb24798c1458f4bb7 backup12082020-0250pm 9.04 MiB Done 2020-12-08 22:50:22+00:00
85-
```
86-
87-
The Timestamp column indicates the point in time UTC at which the backup was taken.
88-
89-
## Restore a backup
90-
In this section we are showing you how to do a full restore or a point in time restore. When you restore a full backup, you restore the entire content of the backup. When you do a point in time restore, you restore up to the point in time you indicate. Any transaction that was done later than this point in time is not restored.
91-
92-
> [!CAUTION]
93-
> You can only restore to a server group that has the same number of worker nodes that it had when the backup was taken. If you increased or reduced the number of worker nodes since the backup was taken, before you restore, you need to increase/reduce the number of worker nodes - or create a new server group - to match the content of the backup. The restore will fail when the number of worker nodes do not match.
94-
95-
### Restore a full backup
96-
To restore the entire content of a backup run the command:
97-
```console
98-
azdata arc postgres backup restore --server-name <target server group name> [--source-server-name <source server group name> --backup-id <backup id>]
99-
or
100-
azdata arc postgres backup restore -sn <target server group name> [-ssn <source server group name> --backup-id <backup id>]
101-
```
102-
<!--To read the general format of restore command, run: azdata arc postgres backup restore --help -->
103-
104-
Where:
105-
- __backup-id__ is the ID of the backup shown in the list backup command shown above.
106-
This will coordinate a distributed full restore across all the nodes that constitute your Azure Arc-enabled PostgreSQL Hyperscale server group. In other words, it will restore all data in your Coordinator and Worker nodes.
107-
108-
#### Examples:
109-
110-
__Restore the server group postgres01 onto itself:__
111-
112-
```console
113-
azdata arc postgres backup restore -sn postgres01 --backup-id d134f51aa87f4044b5fb07cf95cf797f
114-
```
115-
116-
This operation is only supported for PostgreSQL version 12 and higher.
117-
118-
__Restore the server group postgres01 to a different server group postgres02:__
119-
120-
```console
121-
azdata arc postgres backup restore -sn postgres02 -ssn postgres01 --backup-id d134f51aa87f4044b5fb07cf95cf797f
122-
```
123-
This operation is supported for any version of PostgreSQL starting version 11. The target server group must be created before the restore operation, must be of the same configuration and must be using the same backup PVC as the source server group.
124-
125-
When the restore operation is complete, it will return an output like this to the command line:
126-
127-
```json
128-
{
129-
"ID": "d134f51aa87f4044b5fb07cf95cf797f",
130-
"state": "Done"
131-
}
132-
```
133-
134-
> [!NOTE]
135-
> It is not yet possible to:
136-
> - Restore a backup by indicating its name
137-
> - Show the progress of a restore operation
138-
139-
140-
### Do a point in time restore
141-
142-
To restore a server group up to a specific point time, run the command:
143-
```console
144-
azdata arc postgres backup restore --server-name <target server group name> --source-server-name <source server group name> --time <point in time to restore to>
145-
or
146-
azdata arc postgres backup restore -sn <target server group name> -ssn <source server group name> -t <point in time to restore to>
147-
```
148-
149-
To read the general format of restore command, run: `azdata arc postgres backup restore --help`.
150-
151-
Where `time` is the point in time to restore to. Provide either a timestamp or a number and suffix (`m` for minutes, `h` for hours, `d` for days, or `w` for weeks). For example `1.5h` goes back 90 minutes.
152-
153-
#### Examples:
154-
__Do a point in time restore of the server group postgres01 onto itself:__
155-
156-
It is not yet possible to do point in time restore of a server group onto itself.
157-
158-
__Do a point in time restore of the server group postgres01 to a different server group postgres02 to a specific timestamp:__
159-
```console
160-
azdata arc postgres backup restore -sn postgres02 -ssn postgres01 -t "2020-12-08 04:23:48.751326+00"
161-
```
162-
163-
This example restores into server group postgres02 the state at which server group postgres01 was on December 8th 2020 at 04:23:48.75 UTC. Note that "+00" indicates the timezone of the point in time you indicate. If you do not indicate a timezone, the timezone of the client from which you run the restore operation will be used.
164-
165-
For example:
166-
- `2020-12-08 04:23:48.751326+00` is interpreted as `2020-12-08 04:23:48.751326` UTC
167-
- if you are in the Pacific Standard Time zone (PST = UTC+08), `2020-12-08 04:23:48.751326` is interpreted as `2020-12-08 12:23:48.751326` UTC
168-
This operation is supported for any version of PostgreSQL starting version 11. The target server group must be created before the restore operation and must be using the same backup PVC as the source server group.
169-
170-
171-
__Do a point in time restore of the server group postgres01 to a different server group postgres02 to a specific amount of time in the past:__
172-
```console
173-
azdata arc postgres backup restore -sn postgres02 -ssn postgres01 -t "22m"
174-
```
175-
176-
This example restores into server group postgres02 the state at which server group postgres01 was 22 minutes ago.
177-
This operation is supported for any version of PostgreSQL starting version 11. The target server group must be created before the restore operation and must be using the same backup PVC as the source server group.
178-
179-
> [!NOTE]
180-
> It is not yet possible to:
181-
> - Show the progress of a restore operation
182-
183-
## Delete backups
184-
185-
Backup retention cannot be set in Preview. However you can manually delete backups that you do not need.
186-
The general command to delete backups is:
187-
188-
```console
189-
azdata arc postgres backup delete [--server-name, -sn] {[--name, -n], -id}
190-
```
191-
192-
where:
193-
- `--server-name` is the name of the server group from which the user wants to delete a backup
194-
- `--name` is the name of the backup to delete
195-
- `-id`is the ID of the backup to delete
196-
197-
> [!NOTE]
198-
> `--name` and `-id` are mutually exclusive.
199-
200-
For example:
201-
202-
```console
203-
azdata arc postgres backup delete -sn postgres01 -n MyBackup091720200110am
204-
{
205-
"ID": "5b0481dfc1c94b4cac79dd56a1bb21f4",
206-
"name": "MyBackup091720200110am",
207-
"state": "Done"
208-
}
209-
```
210-
211-
You can retrieve the name and the ID of your backups by running the list backup command as explained in the previous paragraph.
212-
213-
For more details about the delete command, run:
214-
215-
```console
216-
azdata arc postgres backup delete --help
217-
```
218-
219-
## Next steps
22018
- Read about [scaling out (adding worker nodes)](scale-out-in-postgresql-hyperscale-server-group.md) your server group
22119
- Read about [scaling up or down (increasing/decreasing memory/vcores)](scale-up-down-postgresql-hyperscale-server-group-using-cli.md) your server group

articles/azure-arc/data/change-postgresql-port.md

Lines changed: 26 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -7,57 +7,60 @@ ms.subservice: azure-arc-data
77
author: TheJY
88
ms.author: jeanyd
99
ms.reviewer: mikeray
10-
ms.date: 07/30/2021
10+
ms.date: 11/03/2021
1111
ms.topic: how-to
1212
---
1313

1414

1515
# Change the port on which the server group is listening
1616

17-
Changing the port is a standard edit operation of the server group. In order to change the port, run the following command:
17+
To change the port, edit the server group. For example, run the following command:
18+
1819
```azurecli
1920
az postgres arc-server edit -n <server group name> --port <desired port number> --k8s-namespace <namespace> --use-k8s
2021
```
2122

22-
For example, let's assume the name of your server group is _postgres01_ and you would like it to listen on port _866_. You would run the following command:
23+
If the name of your server group is _postgres01_ and you would like it to listen on port _866_. Run the following command:
24+
2325
```azurecli
24-
az postgres arc-server edit -n postgres01 --port 866 --k8s-namespace <namespace> --use-k8s
26+
az postgres arc-server edit -n postgres01 --port 866 --k8s-namespace arc --use-k8s
2527
```
2628

2729
## Verify that the port was changed
2830

2931
To verify that the port was changed, run the following command to show the configuration of your server group:
32+
3033
```azurecli
3134
az postgres arc-server show -n <server group name> --k8s-namespace <namespace> --use-k8s
3235
```
3336

3437
In the output of that command, look at the port number displayed for the item "port" in the "service" section of the specifications of your server group.
35-
Alternatively, you can verify in the item externalEndpoint of the status section of the specifications of your server group that the IP address is followed by the port number you configured.
3638

37-
As an illustration, if we continue the example above, you would run the command:
39+
Alternatively, you can verify in the item `externalEndpoint` of the status section of the specifications of your server group that the IP address is followed by the port number you configured.
40+
41+
As an illustration, to continue the example above, run the command:
42+
3843
```azurecli
39-
az postgres arc-server show -n postgres01 --k8s-namespace <namespace> --use-k8s
44+
az postgres arc-server show -n postgres01 --k8s-namespace arc --use-k8s
4045
```
4146

42-
and you would see port 866 referred to here:
47+
The command return port 866:
4348

44-
```console
45-
"service": {
46-
"port": 866,
47-
"type": "LoadBalancer"
48-
},
49+
```output
50+
"services": {
51+
"primary": {
52+
"port": 866,
53+
"type": "LoadBalancer"
54+
}
55+
}
4956
```
50-
and here
51-
52-
```console
53-
"status": {
54-
"externalEndpoint": "12.678.345.09:866",
55-
"logSearchDashboard": "https://12.345.678.90:30777/kibana/app/kibana#/discover?_a=(query:(language:kuery,query:'custom_resource_name:postgres01'))",
56-
"metricsDashboard": "https://12.345.678.90:30777/grafana/d/postgres-metrics?var-Namespace=arc&var-Name=postgres01",
57-
"readyPods": "3/3",
58-
"state": "Ready"
59-
}
57+
58+
In addition, note the value for `primaryEndpoint`.
59+
60+
```output
61+
"primaryEndpoint": "12.345.67.890:866",
6062
```
63+
6164
## Next steps
6265
- Read about [how to connect to your server group](get-connection-endpoints-and-connection-strings-postgres-hyperscale.md).
6366
- Read about how you can configure other aspects of your server group in the section How-to\Manage\Configure & scale section of the documentation.

0 commit comments

Comments
 (0)