Skip to content

Commit 802580a

Browse files
Peter-MsftPeter-Msft
committed
BDC install azdata refresh and additions
1 parent 6c4c4d9 commit 802580a

6 files changed

Lines changed: 131 additions & 122 deletions

‎docs/azdata/install/deploy-install-azdata-installer.md‎

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Learn how to install the azdata tool for installing and managing SQ
55
author: MikeRayMSFT
66
ms.author: mikeray
77
ms.reviewer: mihaelab
8-
ms.date: 11/04/2019
8+
ms.date: 09/30/2020
99
ms.topic: conceptual
1010
ms.prod: sql
1111
ms.technology: big-data-cluster
@@ -15,11 +15,7 @@ ms.technology: big-data-cluster
1515

1616
[!INCLUDE[SQL Server 2019](../../includes/applies-to-version/sqlserver2019.md)]
1717

18-
This article describes how to install `azdata` for SQL Server 2019 Big Data Clusters on Windows. Before the Windows Installation was available, the installation of `azdata` required `pip`.
19-
20-
>For Linux (Ubuntu), see [install `azdata` with installer](./deploy-install-azdata-linux-package.md).
21-
22-
At this time, there are no package managers to install `azdata` on other operating systems or distributions. For these platforms, see [install `azdata` without package manager](./deploy-install-azdata.md).
18+
This article describes how to install `azdata` for SQL Server 2019 Big Data Clusters on Windows. Before the Microsoft Windows Installer for `azdata` was available, the installation of`azdata` required `pip`.
2319

2420
## Install `azdata` with the Microsoft Windows Installer
2521

@@ -32,7 +28,7 @@ To install `azdata` on with the Microsoft Windows Installer,
3228

3329
If you have any previous releases of `azdata` installed, it is important to uninstall it first before installing the latest version.
3430

35-
To remove the release candidate version of `azdata`, run the following command.
31+
For example, to remove the release candidate version of `azdata`, run the following command:
3632

3733
```bash
3834
pip3 uninstall -r https://azdatacli.blob.core.windows.net/python/azdata/2019-rc1/requirements.txt

‎docs/azdata/install/deploy-install-azdata-linux-package.md‎

Lines changed: 58 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
title: Install azdata with installer on Linux
2+
title: Install azdata with apt
33
titleSuffix: SQL Server big data clusters
4-
description: Learn how to install the azdata tool for installing and managing SQL Server Big Data Clusters with the installer (Linux).
4+
description: Learn how to install the azdata tool for installing and managing SQL Server Big Data Clusters with apt.
55
author: MikeRayMSFT
66
ms.author: mikeray
77
ms.reviewer: mihaelab
8-
ms.date: 01/07/2020
8+
ms.date: 09/30/2020
99
ms.topic: conceptual
1010
ms.prod: sql
1111
ms.technology: big-data-cluster
@@ -15,95 +15,93 @@ ms.technology: big-data-cluster
1515

1616
[!INCLUDE[SQL Server 2019](../../includes/applies-to-version/sqlserver2019.md)]
1717

18-
This article describes how to install `azdata` for SQL Server 2019 Big Data Clusters on Linux. Before these package managers were available, the installation of `azdata` required `pip`.
18+
For Linux distributions with `apt` there is a package for the `azdata-cli`. The CLI package has been tested on Linux versions which use `apt`:
1919

20-
[!INCLUDE [azdata-package-installation-remove-pip-install](../../includes/azdata-package-installation-remove-pip-install.md)]
21-
22-
## <a id="linux"></a>Install `azdata` for Linux
20+
- Ubuntu 16.04, Ubuntu 18.04
2321

24-
`azdata` installation package is available for Ubuntu with `apt`.
22+
[!INCLUDE [azdata-package-installation-remove-pip-install](../../includes/azdata-package-installation-remove-pip-install.md)]
2523

26-
### <a id="azdata-apt"></a>Install `azdata` with apt (Ubuntu)
24+
## Install with apt
2725

28-
>[!NOTE]
29-
>The `azdata` package does not use the system Python, rather installs its own Python interpreter.
26+
>[!IMPORTANT]
27+
> The RPM package of the `azdata-cli` depends on the python3 package. On your system, this may be a Python version which predates the requirement of *Python 3.6.x*. If this poses an issue for you, find a replacement python3 package or follow the manual install instructions that use [`pip`](../install/deploy-install-azdata-pip.md).
3028
31-
1. Get packages needed for the install process:
29+
1. Install dependencies necessary to install `azdata-cli`.
3230

33-
```bash
34-
sudo apt-get update
35-
sudo apt-get install gnupg ca-certificates curl wget software-properties-common apt-transport-https lsb-release -y
36-
```
31+
```bash
32+
sudo apt-get update
33+
sudo apt-get install gnupg ca-certificates curl wget software-properties-common apt-transport-https lsb-release -y
34+
```
3735

38-
2. Download and install the signing key:
36+
2. Import the Microsoft repository key.
3937

40-
```bash
41-
curl -sL https://packages.microsoft.com/keys/microsoft.asc |
42-
gpg --dearmor |
43-
sudo tee /etc/apt/trusted.gpg.d/microsoft.asc.gpg > /dev/null
44-
```
38+
```bash
39+
curl -sL https://packages.microsoft.com/keys/microsoft.asc |
40+
gpg --dearmor |
41+
sudo tee /etc/apt/trusted.gpg.d/microsoft.asc.gpg > /dev/null
42+
```
4543

46-
3. Add the `azdata` repository information.
44+
3. Create local repository information.
4745

4846
For Ubuntu 16.04 client run:
49-
```bash
50-
sudo add-apt-repository "$(wget -qO- https://packages.microsoft.com/config/ubuntu/16.04/mssql-server-2019.list)"
51-
```
47+
48+
```bash
49+
sudo add-apt-repository "$(wget -qO- https://packages.microsoft.com/config/ubuntu/16.04/mssql-server-2019.list)"
50+
```
5251

5352
For Ubuntu 18.04 client run:
54-
```bash
55-
sudo add-apt-repository "$(wget -qO- https://packages.microsoft.com/config/ubuntu/18.04/mssql-server-2019.list)"
56-
```
5753

58-
4. Update repository information and install `azdata`:
54+
```bash
55+
sudo add-apt-repository "$(wget -qO- https://packages.microsoft.com/config/ubuntu/18.04/mssql-server-2019.list)"
56+
```
5957

60-
```bash
61-
sudo apt-get update
62-
sudo apt-get install -y azdata-cli
63-
```
58+
4. Install `azdata-cli`.
6459

65-
5. Verify installation:
60+
```bash
61+
sudo apt-get update
62+
sudo apt-get install -y azdata-cli
63+
```
6664

67-
```bash
68-
azdata --version
69-
```
65+
## Verify install
7066

71-
### Update
67+
```bash
68+
azdata
69+
azdata --version
70+
```
7271

73-
Upgrade `azdata` only:
72+
## Update
73+
74+
Update the `azdata-cli` with the `apt-get update` and `apt-get install` commands.
7475

7576
```bash
7677
sudo apt-get update && sudo apt-get install --only-upgrade -y azdata-cli
7778
```
7879

79-
### Uninstall
80-
81-
1. Uninstall with apt-get remove:
80+
## Uninstall
8281

83-
```bash
84-
sudo apt-get remove -y azdata-cli
85-
```
82+
1. Remove the package from your system.
8683

87-
2. Remove the `azdata` repository information:
84+
```bash
85+
sudo apt-get remove -y azdata-cli
86+
```
8887

89-
>[!NOTE]
90-
>This step is not needed if you plan on installing `azdata` in the future
88+
2. Remove the repository information if you do not plan to reinstall `azdata-cli`.
9189

92-
```bash
93-
sudo rm /etc/apt/sources.list.d/azdata-cli.list
94-
```
90+
```bash
91+
sudo rm /etc/apt/sources.list.d/azdata-cli.list
92+
```
9593

96-
3. Remove the signing key:
94+
3. Remove the repository key.
9795

98-
```bash
99-
sudo rm /etc/apt/trusted.gpg.d/dpgswdist.v1.asc.gpg
100-
```
96+
```bash
97+
sudo rm /etc/apt/trusted.gpg.d/dpgswdist.v1.asc.gpg
98+
```
10199

102-
4. Remove any unneeded dependencies that were installed with Azdata CLI:
100+
4. Remove dependencies no longer required.
103101

104-
```bash
105-
sudo apt autoremove
106-
```
102+
```bash
103+
sudo apt autoremove
104+
```
107105

108106
## Next steps
109107

‎docs/azdata/install/deploy-install-azdata-macos.md‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,19 @@ description: Learn how to install the azdata tool for installing and managing Bi
55
author: MikeRayMSFT
66
ms.author: mikeray
77
ms.reviewer: mihaelab
8-
ms.date: 01/07/2020
8+
ms.date: 09/30/2020
99
ms.topic: conceptual
1010
ms.prod: sql
1111
ms.technology: big-data-cluster
1212
---
1313

1414
# Install `azdata` on macOS
1515

16-
For the macOS platform, you can install the `azdata-cli` with homebrew package manager. The CLI package has been tested on macOS versions:
17-
* 10.13 High Sierra
18-
* 10.14 Mojave
19-
* 10.15 Catalina
16+
For the macOS platform, you can install the `azdata-cli` with Homebrew package manager. The CLI package has been tested on macOS versions:
17+
18+
- 10.13 High Sierra
19+
- 10.14 Mojave
20+
- 10.15 Catalina
2021

2122
## Install with Homebrew
2223

@@ -48,7 +49,7 @@ brew upgrade azdata-cli
4849

4950
## Uninstall
5051

51-
Use homebrew to uninstall the `azdata-cli` package.
52+
Use Homebrew to uninstall the `azdata-cli` package.
5253

5354
```bash
5455
brew uninstall azdata-cli

‎docs/azdata/install/deploy-install-azdata-pip.md‎

Lines changed: 29 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Learn how to install the azdata tool for installing and managing Bi
55
author: MikeRayMSFT
66
ms.author: mikeray
77
ms.reviewer: mihaelab
8-
ms.date: 01/07/2020
8+
ms.date: 09/30/2020
99
ms.topic: conceptual
1010
ms.prod: sql
1111
ms.technology: big-data-cluster
@@ -15,44 +15,46 @@ ms.technology: big-data-cluster
1515

1616
[!INCLUDE[SQL Server 2019](../../includes/applies-to-version/sqlserver2019.md)]
1717

18-
This article describes how to install the `azdata` tool Windows or Linux using `pip`.
18+
This article describes how to install the `azdata` tool on Windows, Linux or macOS/OS X using `pip`.
1919

20-
For Windows and Linux (Ubuntu distribution), you can install with a [package manager](./deploy-install-azdata-installer.md) for a simpler experience.
20+
> [!TIP]
21+
> For a simpler experience, `azdata` can be installed with a [package manager](./deploy-install-azdata.md/) for Windows, Linux (Ubuntu, Debian, RHEL, CentOS, openSUSE and SLE distributions) and macOS.
2122
2223
## <a id="prerequisites"></a> Prerequisites
2324

24-
`azdata` is a command-line utility written in Python that enables cluster administrators to bootstrap and manage the big data cluster via REST APIs. The minimum Python version required is v3.5. `pip` is required to download and install `azdata` tool. The instructions below provide examples for Windows and Ubuntu. For installing Python on other platforms, see the [Python documentation](https://wiki.python.org/moin/BeginnersGuide/Download).
25-
In addition, install and update the latest version of `requests` Python package:
25+
`azdata` is a command-line utility written in Python that enables cluster administrators to bootstrap and manage SQL Server 2019 Big Data Clusters (BDC) via REST APIs. The minimum Python version required is v3.5. `pip` is required to download and install the `azdata` tool. The instructions below provide examples for Windows, Linux (Ubuntu) and macOS/OS X. For installing Python on other platforms, see the [Python documentation](https://wiki.python.org/moin/BeginnersGuide/Download). In addition, install and update the latest version of `requests` Python package:
2626

2727
```bash
2828
pip3 install -U requests
2929
```
3030

3131
> [!IMPORTANT]
32-
> If you are installing a newer version of big data clusters, back up your data and delete the old cluster upgrading `azdata` and installing the new release. For more information, see [Upgrading to a new release](../../big-data-cluster/deployment-upgrade.md).
32+
> If your current version of Big Data Cluster is customer technology preview (CTP) or release candidate version (RC) and you are installing a newer version of Big Data Clusters, back up your data and delete the old cluster, upgrade `azdata` and install the new release. Upgrading from a supported release, including general distribution release (GDR), cumulative update (CU), or quick fix engineering (QFE), can be performed in place and therefore deletion of the cluster is not required. For more information, see [Upgrading to a new release](../../big-data-cluster/deployment-upgrade.md).
3333
3434
## <a id="windows"></a> Windows `azdata` installation
3535

36-
1. On a Windows client, download the necessary Python package from [https://www.python.org/downloads/](https://www.python.org/downloads/). For python3.5.3 and later, pip3 is also installed when you install Python.
36+
1. On a Windows client, download the necessary Python package from [https://www.python.org/downloads/](https://www.python.org/downloads/). For python 3.5.3 and later, pip3 is also installed when you install Python.
3737

38-
> [!TIP]
38+
> [!TIP]
3939
> When installing Python3, select to add Python to your `PATH`. If you do not, you can later find where pip3 is located and manually add it to your `PATH`.
4040
4141
1. Open a new Windows PowerShell session so that it gets the latest path with Python in it.
4242

43-
1. If you have any previous releases of `azdata` installed, it is important to uninstall it first before installing the latest version.
43+
1. Starting with SQL Server 2019 CU5 release, azdata has an independent semantic version from the server. If you have any previous releases of `azdata` installed prior to this, it is important to first uninstall them before installing the latest version.
4444

45-
For CTP 3.2 or RC1, run the following command.
45+
For example, for CTP 3.2 or RC1, run the following command:
4646

47-
```bash
47+
```powershell
4848
pip3 uninstall -r https://azdatacli.blob.core.windows.net/python/azdata/2019-ctp3.2/requirements.txt
4949
```
50+
5051
or
51-
```bash
52+
53+
```powershell
5254
pip3 uninstall -r https://azdatacli.blob.core.windows.net/python/azdata/2019-rc1/requirements.txt
5355
```
5456

55-
1. Install `azdata` with the following command:
57+
1. Install `azdata`.
5658

5759
```powershell
5860
pip3 install -r https://aka.ms/azdata
@@ -73,25 +75,27 @@ On Linux, you must install Python 3.5 and then upgrade pip. The following exampl
7375
sudo apt-get install -y unixodbc-dev
7476
```
7577

76-
1. Upgrade pip3:
78+
1. Upgrade pip3.
7779

7880
```bash
7981
sudo -H pip3 install --upgrade pip
8082
```
8183

82-
1. If you have any previous releases of `azdata` installed, it is important to uninstall it first before installing the latest version.
84+
1. Starting with SQL Server 2019 CU5 release, azdata has an independent semantic version from the server. If you have any previous releases of `azdata` installed prior to this, it is important to first uninstall them before installing the latest version.
8385

84-
For CTP 3.2 or RC1, run the following command.
86+
For example, for CTP 3.2 or RC1, run the following command:
8587

8688
```bash
8789
pip3 uninstall -r https://azdatacli.blob.core.windows.net/python/azdata/2019-ctp3.2/requirements.txt
8890
```
91+
8992
or
93+
9094
```bash
9195
pip3 uninstall -r https://azdatacli.blob.core.windows.net/python/azdata/2019-rc1/requirements.txt
9296
```
9397

94-
1. Install `azdata` with the following command:
98+
1. Install `azdata`.
9599

96100
```bash
97101
pip3 install -r https://aka.ms/azdata --user
@@ -106,35 +110,35 @@ To install `azdata` on macOS or OS X complete these steps. For each step, run th
106110

107111
1. On a macOS client, install [Homebrew](https://brew.sh) if you don't have it already:
108112

109-
```
113+
```bash
110114
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
111115
```
112116

113117
1. Install Python and pip, minimum version 3.0:
114118

115-
```
119+
```bash
116120
brew install python3
117121
```
118122

119123
1. Install dependencies:
120124

121-
```
125+
```bash
122126
pip3 install -U requests
123127
brew install freetds
124128
```
125129

126-
1. If you have any previous releases of the tool installed, it is important to uninstall it first before installing the latest version of `azdata`. The following command removes the version of `azdata`.
130+
1. Starting with SQL Server 2019 CU5 release, azdata has an independent semantic version from the server. If you have any previous releases of `azdata` installed prior to this, it is important to first uninstall them before installing the latest version. For example, the following command removes the RC1 version of `azdata`:
127131

128-
```
132+
```bash
129133
pip3 uninstall -r https://azdatacli.blob.core.windows.net/python/azdata/2019-rc1/requirements.txt
130134
```
131135

132-
1. Install `azdata` with the following command:
136+
1. Install `azdata`.
133137

134-
```
138+
```bash
135139
pip3 install -r https://aka.ms/azdata
136140
```
137141

138142
## Next steps
139143

140-
For more information about big data clusters, see [What are [!INCLUDE[big-data-clusters-2019](../../includes/ssbigdataclusters-ver15.md)]?](../../big-data-cluster/big-data-cluster-overview.md).
144+
For more information about Big Data Clusters, see [What are [!INCLUDE[big-data-clusters-2019](../../includes/ssbigdataclusters-ver15.md)]?](../../big-data-cluster/big-data-cluster-overview.md).

0 commit comments

Comments
 (0)