Skip to content

Commit 5546a09

Browse files
denreadenrea
authored
Merge pull request #234439 from MikeRayMSFT/20230413-update-prerelease
Update pre-release content instructions (#49)
2 parents 096aeef + 23b736f commit 5546a09

File tree

2 files changed

+78
-58
lines changed

2 files changed

+78
-58
lines changed

‎articles/azure-arc/data/create-data-controller-using-kubernetes-native-tools.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -122,10 +122,6 @@ Edit the data controller configuration as needed:
122122
**OPTIONAL**
123123
- **name**: The default name of the data controller is `arc`, but you can change it if you want.
124124
- **displayName**: Set this to the same value as the name attribute at the top of the file.
125-
- **registry**: The Microsoft Container Registry is the default. If you are pulling the images from the Microsoft Container Registry and [pushing them to a private container registry](offline-deployment.md), enter the IP address or DNS name of your registry here.
126-
- **dockerRegistry**: The secret to use to pull the images from a private container registry if required.
127-
- **repository**: The default repository on the Microsoft Container Registry is `arcdata`. If you are using a private container registry, enter the path the folder/repository containing the Azure Arc-enabled data services container images.
128-
- **imageTag**: The current latest version tag is defaulted in the template, but you can change it if you want to use an older version.
129125
- **logsui-certificate-secret**: The name of the secret created on the Kubernetes cluster for the logs UI certificate.
130126
- **metricsui-certificate-secret**: The name of the secret created on the Kubernetes cluster for the metrics UI certificate.
131127

@@ -173,3 +169,4 @@ If you encounter any troubles with creation, please see the [troubleshooting gui
173169

174170
- [Create a SQL managed instance using Kubernetes-native tools](./create-sql-managed-instance-using-kubernetes-native-tools.md)
175171
- [Create a PostgreSQL server using Kubernetes-native tools](./create-postgresql-server-kubernetes-native-tools.md)
172+

‎articles/azure-arc/data/preview-testing.md

Lines changed: 77 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ ms.reviewer: mikeray
77
services: azure-arc
88
ms.service: azure-arc
99
ms.subservice: azure-arc-data
10-
ms.date: 09/07/2022
10+
ms.date: 04/14/2022
1111
ms.topic: conceptual
1212
ms.custom: references_regions, event-tier1-build-2022
1313
#Customer intent: As a data professional, I want to validate upcoming releases.
@@ -33,8 +33,8 @@ Normally, pre-release version binaries are available around 10:00 AM Pacific Tim
3333
Pre-release versions simultaneously release with artifacts, which are designed to work together:
3434

3535
- Container images hosted on the Microsoft Container Registry (MCR)
36-
- `mcr.microsoft.com/arcdata/preview` is the repository that hosts the **preview** pre-release builds
3736
- `mcr.microsoft.com/arcdata/test` is the repository that hosts the **test** pre-release builds
37+
- `mcr.microsoft.com/arcdata/preview` is the repository that hosts the **preview** pre-release builds
3838

3939
> [!NOTE]
4040
> `mcr.microsoft.com/arcdata/` will continue to be the repository that hosts the final release builds.
@@ -57,78 +57,95 @@ To install a pre-release version, follow these pre-requisite instructions:
5757

5858
If you use the Azure CLI extension:
5959

60-
- Uninstall the Azure CLI extension (`az extension remove -n arcdata`).
61-
- Download the latest pre-release Azure CLI extension `.whl` file from the link in the [Current preview release information](#Current preview release information)
62-
- Install the latest pre-release Azure CLI extension (`az extension add -s <location of downloaded .whl file>`).
60+
1. Uninstall the Azure CLI extension (`az extension remove -n arcdata`).
61+
1. Download the latest pre-release Azure CLI extension `.whl` file from the link in the [Current preview release information](#current-preview-release-information).
62+
1. Install the latest pre-release Azure CLI extension (`az extension add -s <location of downloaded .whl file>`).
6363

6464
If you use the Azure Data Studio extension to install:
6565

66-
- Uninstall the Azure Data Studio extension. Select the Extensions panel and select on the **Azure Arc** extension, select **Uninstall**.
67-
- Download the latest pre-release Azure Data Studio extension .vsix files from the links in the [Current preview release information](#Current preview release information)
68-
- Install the extensions by choosing File -> Install Extension from VSIX package and then browsing to the download location of the .vsix files. Install the `azcli` extension first and then `arc`.
66+
1. Uninstall the Azure Data Studio extension. Select the Extensions panel and select on the **Azure Arc** extension, select **Uninstall**.
67+
1. Download the latest pre-release Azure Data Studio extension .vsix files from the links in the [Current preview release information](#current-preview-release-information).
68+
1. Install the extensions. Choose **File** > **Install Extension from VSIX package**. Locate the download location of the .vsix files. Install the `azcli` extension first and then `arc`.
6969

7070
### Install using Azure CLI
7171

72-
> [!NOTE]
73-
> Deploying pre-release builds using direct connectivity mode from Azure CLI is not supported.
72+
To install with the Azure CLI, follow the steps for your connectivity mode:
73+
74+
- [Indirect connectivity mode](#indirect-connectivity-mode)
75+
- [Direct connectivity mode](#direct-connectivity-mode)
7476

7577
#### Indirect connectivity mode
7678

77-
If you install using the Azure CLI:
79+
1. Set environment variables. Set variables for:
80+
- Docker registry
81+
- Docker repository
82+
- Docker image tag
83+
- Docker image policy
7884

79-
1. Follow the instructions to [create a custom configuration profile](create-custom-configuration-template.md).
80-
1. Edit this custom configuration profile file. Enter the `docker` property values as required based on the information provided in the version history table on this page.
85+
Use the example script below to set environment variables for your respective platform.
86+
87+
# [Linux](#tab/linux)
8188

82-
For example:
89+
```console
90+
## variables for the docker registry, repository, and image
91+
export DOCKER_REGISTRY=<Docker registry>
92+
export DOCKER_REPOSITORY=<Docker repository>
93+
export DOCKER_IMAGE_TAG=<Docker image tag>
94+
export DOCKER_IMAGE_POLICY=<Docker image policy>
95+
```
8396

84-
```json
97+
# [Windows (PowerShell)](#tab/windows)
8598

86-
"docker": {
87-
"registry": "mcr.microsoft.com",
88-
"repository": "arcdata/test",
89-
"imageTag": "v1.8.0_2022-06-07_5ba6b837",
90-
"imagePullPolicy": "Always"
91-
},
99+
```PowerShell
100+
## variables for Metrics and Monitoring dashboard credentials
101+
$ENV:DOCKER_REGISTRY="<Docker registry>"
102+
$ENV:DOCKER_REPOSITORY="<Docker repository>"
103+
$ENV:DOCKER_IMAGE_TAG="<Docker image tag>"
104+
$ENV:DOCKER_IMAGE_POLICY="<Docker image policy>"
92105
```
106+
---
93107

108+
1. Follow the instructions to [create a custom configuration profile](create-custom-configuration-template.md).
94109
1. Use the command `az arcdata dc create` as explained in [create a custom configuration profile](create-custom-configuration-template.md).
95110

96111
#### Direct connectivity mode
97112

98113
If you install using the Azure CLI:
99114

100-
1. Follow the instructions to [create a custom configuration profile](create-custom-configuration-template.md).
101-
1. Edit this custom configuration profile file. Enter the `docker` property values as required based on the information provided in the version history table on this page.
102-
103-
For example:
115+
1. Set environment variables. Set variables for:
116+
- Docker registry
117+
- Docker repository
118+
- Docker image tag
119+
- Docker image policy
120+
- Arc data services extension version tag (`ARC_DATASERVICES_EXTENSION_VERSION_TAG`): Use the version of the **Arc enabled Kubernetes helm chart extension version** from the release details under [Current preview release information](#current-preview-release-information).
121+
- Arc data services release train: `ARC_DATASERVICES_EXTENSION_RELEASE_TRAIN`: `{ test | preview }`.
104122

105-
```json
106-
107-
"docker": {
108-
"registry": "mcr.microsoft.com",
109-
"repository": "arcdata/test",
110-
"imageTag": "v1.8.0_2022-06-07_5ba6b837",
111-
"imagePullPolicy": "Always"
112-
},
113-
```
114-
1. Set environment variables for:
123+
Use the example script below to set environment variables for your respective platform.
115124

116-
- `ARC_DATASERVICES_EXTENSION_VERSION_TAG`: Use the version of the **Arc enabled Kubernetes helm chart extension version** from the release details under [Current preview release information](#current-preview-release-information).
117-
- `ARC_DATASERVICES_EXTENSION_RELEASE_TRAIN`: `preview`
118-
119-
For example, the following command sets the environment variables on Linux.
125+
# [Linux](#tab/linux)
120126

121127
```console
122-
export ARC_DATASERVICES_EXTENSION_VERSION_TAG='1.2.20031002'
128+
## variables for the docker registry, repository, and image
129+
export DOCKER_REGISTRY=<Docker registry>
130+
export DOCKER_REPOSITORY=<Docker repository>
131+
export DOCKER_IMAGE_TAG=<Docker image tag>
132+
export DOCKER_IMAGE_POLICY=<Docker image policy>
133+
export ARC_DATASERVICES_EXTENSION_VERSION_TAG=<Version tag>
123134
export ARC_DATASERVICES_EXTENSION_RELEASE_TRAIN='preview'
124135
```
125136

126-
The following command sets the environment variables on PowerShell
137+
# [Windows (PowerShell)](#tab/windows)
127138

128-
```console
129-
$ENV:ARC_DATASERVICES_EXTENSION_VERSION_TAG="1.2.20031002"
139+
```PowerShell
140+
## variables for Metrics and Monitoring dashboard credentials
141+
$ENV:DOCKER_REGISTRY="<Docker registry>"
142+
$ENV:DOCKER_REPOSITORY="<Docker repository>"
143+
$ENV:DOCKER_IMAGE_TAG="<Docker image tag>"
144+
$ENV:DOCKER_IMAGE_POLICY="<Docker image policy>"
145+
$ENV:ARC_DATASERVICES_EXTENSION_VERSION_TAG="<Version tag>"
130146
$ENV:ARC_DATASERVICES_EXTENSION_RELEASE_TRAIN="preview"
131147
```
148+
---
132149

133150
1. Run `az arcdata dc create` as normal for the direct mode to:
134151

@@ -143,25 +160,31 @@ If you install using the Azure CLI:
143160
> [!NOTE]
144161
> Deploying pre-release builds using direct connectivity mode from Azure Data Studio is not supported.
145162
146-
#### Indirect connectivity mode
163+
You can install with Azure Data Studio (ADS) in indirect connectivity mode. To use Azure Data Studio to install:
147164

148-
If you use Azure Data Studio to install, complete the data controller deployment wizard as normal except click on **Script to notebook** at the end instead of **Deploy**. In the generated notebook, edit the `Set variables` cell to *add* the following lines:
165+
1. Complete the data controller deployment wizard as normal except click on **Script to notebook** at the end instead of **Deploy**.
166+
1. Update the following script. Replace `{ test | preview }` with the appropriate label.
167+
1. In the generated notebook, edit the `Set variables` cell to *add* the following lines:
149168

150-
```python
151-
# choose between arcdata/test or arcdata/preview as appropriate
152-
os.environ["AZDATA_DOCKER_REPOSITORY"] = "arcdata/test"
153-
os.environ["AZDATA_DOCKER_TAG"] = "v1.8.0_2022-06-07_5ba6b837"
154-
```
169+
```python
170+
# choose between arcdata/test or arcdata/preview as appropriate
171+
os.environ["AZDATA_DOCKER_REPOSITORY"] = "{ test | preview }"
172+
os.environ["AZDATA_DOCKER_TAG"] = "{ Current preview tag }
173+
```
155174

156-
Run the notebook by clicking **Run All**.
175+
1. Run the notebook, click **Run All**.
157176

158177
### Install using Azure portal
159178

160-
Follow the instructions to [Arc-enabled the Kubernetes cluster](create-data-controller-direct-prerequisites.md) as normal.
179+
1. Follow the instructions to [Arc-enabled the Kubernetes cluster](create-data-controller-direct-prerequisites.md) as normal.
180+
1. Open the Azure portal for the appropriate preview version:
161181

162-
Open the Azure portal by using this special URL: [https://portal.azure.com/?feature.canmodifystamps=true&Microsoft_Azure_HybridData_Platform=preview#home](https://portal.azure.com/?feature.canmodifystamps=true&Microsoft_Azure_HybridData_Platform=preview#home).
182+
- **Test**: [https://portal.azure.com/?feature.canmodifystamps=true&Microsoft_Azure_HybridData_Platform=test#home](https://portal.azure.com/?feature.canmodifystamps=true&Microsoft_Azure_HybridData_Platform=test#home)
183+
- **Preview**: [https://portal.azure.com/?feature.canmodifystamps=true&Microsoft_Azure_HybridData_Platform=preview#home](https://portal.azure.com/?feature.canmodifystamps=true&Microsoft_Azure_HybridData_Platform=preview#home).
163184

164-
Follow the instructions to [Create the Azure Arc data controller from Azure portal - Direct connectivity mode](create-data-controller-direct-azure-portal.md) except that when choosing a deployment profile, select **Custom template** in the **Kubernetes configuration template** drop-down. Set the repository to either `arcdata/test` or `arcdata/preview` as appropriate and enter the desired tag in the **Image tag** field. Fill out the rest of the custom cluster configuration template fields as normal.
185+
1. Follow the instructions to [Create the Azure Arc data controller from Azure portal - Direct connectivity mode](create-data-controller-direct-azure-portal.md) except that when choosing a deployment profile, select **Custom template** in the **Kubernetes configuration template** drop-down.
186+
1. Set the repository to either `arcdata/test` or `arcdata/preview` as appropriate. Enter the desired tag in the **Image tag** field.
187+
1. Fill out the rest of the custom cluster configuration template fields as normal.
165188

166189
Complete the rest of the wizard as normal.
167190

0 commit comments

Comments
 (0)