Skip to content

Commit bd55390

Browse files
rwestMSFTrwestMSFT
committed
Add deprecation note for SA_PASSWORD
1 parent 8cde286 commit bd55390

11 files changed

Lines changed: 42 additions & 3 deletions

‎docs/linux/quickstart-install-connect-docker.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,9 @@ Before starting the following steps, make sure that you've selected your preferr
110110

111111
1. To run the Linux container image with Docker, you can use the following command from a bash shell or elevated PowerShell command prompt.
112112

113+
> [!IMPORTANT]
114+
> The `SA_PASSWORD` environment variable is deprecated. Please use `MSSQL_SA_PASSWORD` instead.
115+
113116
::: zone pivot="cs1-bash"
114117
```bash
115118
sudo docker run -e "ACCEPT_EULA=Y" -e "MSSQL_SA_PASSWORD=<YourStrong@Passw0rd>" \
@@ -242,6 +245,9 @@ Before starting the following steps, make sure that you've selected your preferr
242245

243246
1. To run the Linux container image with Docker, you can use the following command from a bash shell or elevated PowerShell command prompt.
244247

248+
> [!IMPORTANT]
249+
> The `SA_PASSWORD` environment variable is deprecated. Please use `MSSQL_SA_PASSWORD` instead.
250+
245251
::: zone pivot="cs1-bash"
246252
```bash
247253
sudo docker run -e "ACCEPT_EULA=Y" -e "MSSQL_SA_PASSWORD=<YourStrong@Passw0rd>" \
@@ -374,6 +380,9 @@ Before starting the following steps, make sure that you've selected your preferr
374380

375381
1. To run the Linux container image with Docker, you can use the following command from a bash shell or elevated PowerShell command prompt.
376382

383+
> [!IMPORTANT]
384+
> The `SA_PASSWORD` environment variable is deprecated. Please use `MSSQL_SA_PASSWORD` instead.
385+
377386
::: zone pivot="cs1-bash"
378387
```bash
379388
sudo docker run -e "ACCEPT_EULA=Y" -e "MSSQL_SA_PASSWORD=<YourStrong@Passw0rd>" \

‎docs/linux/sample-unattended-install-redhat.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,9 @@ This example installs [!INCLUDE [sssql19-md](../includes/sssql19-md.md)] on RHEL
3232

3333
Save the sample script to a file and then to customize it. You'll need to replace the variable values in the script. You can also set any of the scripting variables as environment variables, as long as you remove them from the script file.
3434

35+
> [!IMPORTANT]
36+
> The `SA_PASSWORD` environment variable is deprecated. Please use `MSSQL_SA_PASSWORD` instead.
37+
3538
```bash
3639
#!/bin/bash -e
3740

‎docs/linux/sample-unattended-install-ubuntu.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,9 @@ Save the sample script to a file and then to customize it. You'll need to replac
3333

3434
The script might fail if SQL Server is slow to start. That's because the script will exit with a non-zero status. Removing the `-e` switch on the first line may resolve this issue.
3535

36+
> [!IMPORTANT]
37+
> The `SA_PASSWORD` environment variable is deprecated. Please use `MSSQL_SA_PASSWORD` instead.
38+
3639
```bash
3740
#!/bin/bash -e
3841

‎docs/linux/sql-server-linux-configure-environment-variables.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ You can use several different environment variables to configure SQL Server 2019
4141
| Environment variable | Description |
4242
|-----|-----|
4343
| **ACCEPT_EULA** | Set the **ACCEPT_EULA** variable to any value to confirm your acceptance of the [End-User Licensing Agreement](https://go.microsoft.com/fwlink/?LinkId=746388). Required setting for the SQL Server image. |
44-
| **MSSQL_SA_PASSWORD** | Configure the SA user password. |
44+
| **MSSQL_SA_PASSWORD** | Configure the SA user password.<br /><br /> The `SA_PASSWORD` environment variable is deprecated. Please use `MSSQL_SA_PASSWORD` instead. |
4545
| **MSSQL_PID** | Set the SQL Server edition or product key. Possible values include: </br></br>**Evaluation**</br>**Developer**</br>**Express**</br>**Web**</br>**Standard**</br>**Enterprise**</br>**A product key**</br></br>If specifying a product key, it must be in the form of #####-#####-#####-#####-#####, where '#' is a number or a letter.|
4646
| **MSSQL_LCID** | Sets the language ID to use for SQL Server. For example 1036 is French. |
4747
| **MSSQL_COLLATION** | Sets the default collation for SQL Server. This overrides the default mapping of language ID (LCID) to collation. |
@@ -65,7 +65,7 @@ You can use several different environment variables to configure SQL Server 2019
6565
| Environment variable | Description |
6666
|-----|-----|
6767
| **ACCEPT_EULA** | Set the **ACCEPT_EULA** variable to any value to confirm your acceptance of the [End-User Licensing Agreement](https://go.microsoft.com/fwlink/?LinkId=746388). Required setting for the SQL Server image. |
68-
| **MSSQL_SA_PASSWORD** | Configure the SA user password. |
68+
| **MSSQL_SA_PASSWORD** | Configure the SA user password.<br /><br /> The `SA_PASSWORD` environment variable is deprecated. Please use `MSSQL_SA_PASSWORD` instead. |
6969
| **MSSQL_PID** | Set the SQL Server edition or product key. Possible values include: </br></br>**Evaluation**</br>**Developer**</br>**Express**</br>**Web**</br>**Standard**</br>**Enterprise**</br>**A product key**</br></br>If specifying a product key, it must be in the form of #####-#####-#####-#####-#####, where '#' is a number or a letter.|
7070
| **MSSQL_LCID** | Sets the language ID to use for SQL Server. For example 1036 is French. |
7171
| **MSSQL_COLLATION** | Sets the default collation for SQL Server. This overrides the default mapping of language ID (LCID) to collation. |

‎docs/linux/sql-server-linux-configure-msdtc-docker.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,9 @@ To enable MSDTC transaction in SQL Server containers, you must set two new envir
3636

3737
The following example shows how to use these environment variables to pull and run a single SQL Server 2017 container configured for MSDTC. This allows it to communicate with any application on any hosts.
3838

39+
> [!IMPORTANT]
40+
> The `SA_PASSWORD` environment variable is deprecated. Please use `MSSQL_SA_PASSWORD` instead.
41+
3942
```bash
4043
docker run \
4144
-e 'ACCEPT_EULA=Y' -e 'MSSQL_SA_PASSWORD=<YourStrong!Passw0rd>' \
@@ -58,6 +61,9 @@ docker run `
5861

5962
The following example shows how to use these environment variables to pull and run a single SQL Server 2019 container configured for MSDTC. This allows it to communicate with any application on any hosts.
6063

64+
> [!IMPORTANT]
65+
> The `SA_PASSWORD` environment variable is deprecated. Please use `MSSQL_SA_PASSWORD` instead.
66+
6167
```bash
6268
docker run \
6369
-e 'ACCEPT_EULA=Y' -e 'MSSQL_SA_PASSWORD=<YourStrong!Passw0rd>' \

‎docs/linux/sql-server-linux-containers-ad-auth-adutil-tutorial.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -207,6 +207,9 @@ chmod 440 /container/sql1/secrets/mssql.keytab
207207
208208
Run your SQL Server container, and mount the correct AD configuration files that were previously created as shown below:
209209
210+
> [!IMPORTANT]
211+
> The `SA_PASSWORD` environment variable is deprecated. Please use `MSSQL_SA_PASSWORD` instead.
212+
210213
```bash
211214
sudo docker run -e "ACCEPT_EULA=Y" -e "MSSQL_SA_PASSWORD=\<YourStrong@Passw0rd\>" \
212215
-p 5433:1433 --name sql1 \

‎docs/linux/sql-server-linux-docker-container-configure.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,9 @@ The first option is to mount a directory on your host as a data volume in your c
4242
> [!NOTE]
4343
> SQL Server 2019 containers automatically start up as non-root, while SQL Server 2017 containers start as root by default. For more information on running SQL Server containers as non-root, see [Configure security](sql-server-linux-docker-container-security.md).
4444
45+
> [!IMPORTANT]
46+
> The `SA_PASSWORD` environment variable is deprecated. Please use `MSSQL_SA_PASSWORD` instead.
47+
4548
<!--SQL Server 2017 on Linux -->
4649
::: moniker range="= sql-server-linux-2017 || = sql-server-2017"
4750

‎docs/linux/sql-server-linux-docker-container-deployment.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -223,6 +223,9 @@ There are scenarios where you might not want to use the latest SQL Server contai
223223
224224
3. To run a new container with that image, specify the tag name in the `docker run` command. In the following command, replace `<image_tag>` with the version you want to run.
225225
226+
> [!IMPORTANT]
227+
> The `SA_PASSWORD` environment variable is deprecated. Please use `MSSQL_SA_PASSWORD` instead.
228+
226229
::: zone pivot="cs1-bash"
227230
```bash
228231
docker run -e 'ACCEPT_EULA=Y' -e 'MSSQL_SA_PASSWORD=<YourStrong!Passw0rd>' -p 1401:1433 -d mcr.microsoft.com/mssql/server:<image_tag>

‎docs/linux/sql-server-linux-docker-container-security.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,9 @@ Follow the steps below to build a SQL Server 2017 container that starts up as th
3636

3737
3. Start the container.
3838

39+
> [!IMPORTANT]
40+
> The `SA_PASSWORD` environment variable is deprecated. Please use `MSSQL_SA_PASSWORD` instead.
41+
3942
```bash
4043
docker run -e "ACCEPT_EULA=Y" -e "MSSQL_SA_PASSWORD=MyStrongPassword@" --cap-add SYS_PTRACE --name sql1 -p 1433:1433 -d 2017-latest-non-root
4144
```

‎docs/linux/sql-server-linux-setup-2022.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,9 @@ You can perform an unattended installation in the following way:
157157

158158
The following example configures the Developer edition of SQL Server with the **MSSQL_PID** environment variable. It also accepts the EULA (**ACCEPT_EULA**) and sets the SA user password (**MSSQL_SA_PASSWORD**). The `-n` parameter performs an unprompted installation where the configuration values are pulled from the environment variables.
159159

160+
> [!IMPORTANT]
161+
> The `SA_PASSWORD` environment variable is deprecated. Please use `MSSQL_SA_PASSWORD` instead.
162+
160163
```bash
161164
sudo MSSQL_PID=Developer ACCEPT_EULA=Y MSSQL_SA_PASSWORD='<YourStrong!Passw0rd>' /opt/mssql/bin/mssql-conf -n setup
162165
```

0 commit comments

Comments
 (0)