Skip to content

Commit 77e8a1c

Browse files
rwestMSFTrwestMSFT
committed
[Bulk] Rename SA_PASSWORD to MSSQL_SA_PASSWORD
1 parent 9ef79c5 commit 77e8a1c

9 files changed

Lines changed: 55 additions & 55 deletions

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

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ Before starting the following steps, make sure that you've selected your preferr
112112

113113
::: zone pivot="cs1-bash"
114114
```bash
115-
sudo docker run -e "ACCEPT_EULA=Y" -e "SA_PASSWORD=<YourStrong@Passw0rd>" \
115+
sudo docker run -e "ACCEPT_EULA=Y" -e "MSSQL_SA_PASSWORD=<YourStrong@Passw0rd>" \
116116
-p 1433:1433 --name sql1 --hostname sql1 \
117117
-d \
118118
mcr.microsoft.com/mssql/server:2017-latest
@@ -125,7 +125,7 @@ Before starting the following steps, make sure that you've selected your preferr
125125
> If you are using PowerShell Core, replace the double quotes with single quotes.
126126
127127
```PowerShell
128-
docker run -e "ACCEPT_EULA=Y" -e "SA_PASSWORD=<YourStrong@Passw0rd>" `
128+
docker run -e "ACCEPT_EULA=Y" -e "MSSQL_SA_PASSWORD=<YourStrong@Passw0rd>" `
129129
-p 1433:1433 --name sql1 --hostname sql1 `
130130
-d `
131131
mcr.microsoft.com/mssql/server:2017-latest
@@ -134,7 +134,7 @@ Before starting the following steps, make sure that you've selected your preferr
134134

135135
::: zone pivot="cs1-cmd"
136136
```cmd
137-
docker run -e "ACCEPT_EULA=Y" -e "SA_PASSWORD=<YourStrong@Passw0rd>" `
137+
docker run -e "ACCEPT_EULA=Y" -e "MSSQL_SA_PASSWORD=<YourStrong@Passw0rd>" `
138138
-p 1433:1433 --name sql1 --hostname sql1 `
139139
-d `
140140
mcr.microsoft.com/mssql/server:2017-latest
@@ -150,7 +150,7 @@ Before starting the following steps, make sure that you've selected your preferr
150150
| Parameter | Description |
151151
|-----|-----|
152152
| **-e "ACCEPT_EULA=Y"** | Set the `ACCEPT_EULA` variable to any value to confirm your acceptance of the End-User Licensing Agreement. Required setting for the [!INCLUDE [ssnoversion-md](../includes/ssnoversion-md.md)] image. |
153-
| **-e "SA_PASSWORD=\<YourStrong@Passw0rd\>"** | Specify your own strong password that is at least eight characters and meets the [SQL Server password requirements](../relational-databases/security/password-policy.md). Required setting for the [!INCLUDE [ssnoversion-md](../includes/ssnoversion-md.md)] image. |
153+
| **-e "MSSQL_SA_PASSWORD=\<YourStrong@Passw0rd\>"** | Specify your own strong password that is at least eight characters and meets the [SQL Server password requirements](../relational-databases/security/password-policy.md). Required setting for the [!INCLUDE [ssnoversion-md](../includes/ssnoversion-md.md)] image. |
154154
| **-p 1433:1433** | Map a TCP port on the host environment (first value) with a TCP port in the container (second value). In this example, [!INCLUDE [ssnoversion-md](../includes/ssnoversion-md.md)] is listening on TCP 1433 in the container and this container port is then exposed to TCP port 1433 on the host. |
155155
| **--name sql1** | Specify a custom name for the container rather than a randomly generated one. If you run more than one container, you can't reuse this same name. |
156156
| **--hostname sql1** | Used to explicitly set the container hostname. If you don't specify the hostname, it defaults to the container ID, which is a randomly generated system GUID. |
@@ -201,7 +201,7 @@ Before starting the following steps, make sure that you've selected your preferr
201201

202202
Setting `--hostname` and `--name` to the same value is a good way to easily identify the target container.
203203

204-
1. As a final step, change your SA password because the `SA_PASSWORD` is visible in `ps -eax` output and stored in the environment variable of the same name. See steps below.
204+
1. As a final step, change your SA password because the `MSSQL_SA_PASSWORD` is visible in `ps -eax` output and stored in the environment variable of the same name. See steps below.
205205

206206
::: moniker-end
207207
<!--SQL Server 2019 on Linux-->
@@ -244,7 +244,7 @@ Before starting the following steps, make sure that you've selected your preferr
244244

245245
::: zone pivot="cs1-bash"
246246
```bash
247-
sudo docker run -e "ACCEPT_EULA=Y" -e "SA_PASSWORD=<YourStrong@Passw0rd>" \
247+
sudo docker run -e "ACCEPT_EULA=Y" -e "MSSQL_SA_PASSWORD=<YourStrong@Passw0rd>" \
248248
-p 1433:1433 --name sql1 --hostname sql1 \
249249
-d \
250250
mcr.microsoft.com/mssql/server:2019-latest
@@ -257,7 +257,7 @@ Before starting the following steps, make sure that you've selected your preferr
257257
> If you are using PowerShell Core, replace the double quotes with single quotes.
258258
259259
```PowerShell
260-
docker run -e "ACCEPT_EULA=Y" -e "SA_PASSWORD=<YourStrong@Passw0rd>" `
260+
docker run -e "ACCEPT_EULA=Y" -e "MSSQL_SA_PASSWORD=<YourStrong@Passw0rd>" `
261261
-p 1433:1433 --name sql1 --hostname sql1 `
262262
-d `
263263
mcr.microsoft.com/mssql/server:2019-latest
@@ -266,7 +266,7 @@ Before starting the following steps, make sure that you've selected your preferr
266266

267267
::: zone pivot="cs1-cmd"
268268
```cmd
269-
docker run -e "ACCEPT_EULA=Y" -e "SA_PASSWORD=<YourStrong@Passw0rd>" `
269+
docker run -e "ACCEPT_EULA=Y" -e "MSSQL_SA_PASSWORD=<YourStrong@Passw0rd>" `
270270
-p 1433:1433 --name sql1 --hostname sql1 `
271271
-d `
272272
mcr.microsoft.com/mssql/server:2019-latest
@@ -282,7 +282,7 @@ Before starting the following steps, make sure that you've selected your preferr
282282
| Parameter | Description |
283283
|-----|-----|
284284
| **-e "ACCEPT_EULA=Y"** | Set the `ACCEPT_EULA` variable to any value to confirm your acceptance of the End-User Licensing Agreement. Required setting for the [!INCLUDE [ssnoversion-md](../includes/ssnoversion-md.md)] image. |
285-
| **-e "SA_PASSWORD=\<YourStrong@Passw0rd\>"** | Specify your own strong password that is at least eight characters and meets the [SQL Server password requirements](../relational-databases/security/password-policy.md). Required setting for the [!INCLUDE [ssnoversion-md](../includes/ssnoversion-md.md)] image. |
285+
| **-e "MSSQL_SA_PASSWORD=\<YourStrong@Passw0rd\>"** | Specify your own strong password that is at least eight characters and meets the [SQL Server password requirements](../relational-databases/security/password-policy.md). Required setting for the [!INCLUDE [ssnoversion-md](../includes/ssnoversion-md.md)] image. |
286286
| **-p 1433:1433** | Map a TCP port on the host environment (first value) with a TCP port in the container (second value). In this example, [!INCLUDE [ssnoversion-md](../includes/ssnoversion-md.md)] is listening on TCP 1433 in the container and this container port is then exposed to TCP port 1433 on the host. |
287287
| **--name sql1** | Specify a custom name for the container rather than a randomly generated one. If you run more than one container, you can't reuse this same name. |
288288
| **--hostname sql1** | Used to explicitly set the container hostname. If you don't specify the hostname, it defaults to the container ID, which is a randomly generated system GUID. |
@@ -333,7 +333,7 @@ Before starting the following steps, make sure that you've selected your preferr
333333

334334
Setting `--hostname` and `--name` to the same value is a good way to easily identify the target container.
335335

336-
1. As a final step, change your SA password because the `SA_PASSWORD` is visible in `ps -eax` output and stored in the environment variable of the same name. See steps below.
336+
1. As a final step, change your SA password because the `MSSQL_SA_PASSWORD` is visible in `ps -eax` output and stored in the environment variable of the same name. See steps below.
337337

338338
::: moniker-end
339339
<!--SQL Server 2022 on Linux-->
@@ -376,7 +376,7 @@ Before starting the following steps, make sure that you've selected your preferr
376376

377377
::: zone pivot="cs1-bash"
378378
```bash
379-
sudo docker run -e "ACCEPT_EULA=Y" -e "SA_PASSWORD=<YourStrong@Passw0rd>" \
379+
sudo docker run -e "ACCEPT_EULA=Y" -e "MSSQL_SA_PASSWORD=<YourStrong@Passw0rd>" \
380380
-p 1433:1433 --name sql1 --hostname sql1 \
381381
-d \
382382
mcr.microsoft.com/mssql/server:2022-latest
@@ -389,7 +389,7 @@ Before starting the following steps, make sure that you've selected your preferr
389389
> If you are using PowerShell Core, replace the double quotes with single quotes.
390390
391391
```PowerShell
392-
docker run -e "ACCEPT_EULA=Y" -e "SA_PASSWORD=<YourStrong@Passw0rd>" `
392+
docker run -e "ACCEPT_EULA=Y" -e "MSSQL_SA_PASSWORD=<YourStrong@Passw0rd>" `
393393
-p 1433:1433 --name sql1 --hostname sql1 `
394394
-d `
395395
mcr.microsoft.com/mssql/server:2022-latest
@@ -398,7 +398,7 @@ Before starting the following steps, make sure that you've selected your preferr
398398

399399
::: zone pivot="cs1-cmd"
400400
```cmd
401-
docker run -e "ACCEPT_EULA=Y" -e "SA_PASSWORD=<YourStrong@Passw0rd>" `
401+
docker run -e "ACCEPT_EULA=Y" -e "MSSQL_SA_PASSWORD=<YourStrong@Passw0rd>" `
402402
-p 1433:1433 --name sql1 --hostname sql1 `
403403
-d `
404404
mcr.microsoft.com/mssql/server:2022-latest
@@ -414,7 +414,7 @@ Before starting the following steps, make sure that you've selected your preferr
414414
| Parameter | Description |
415415
|-----|-----|
416416
| **-e "ACCEPT_EULA=Y"** | Set the `ACCEPT_EULA` variable to any value to confirm your acceptance of the End-User Licensing Agreement. Required setting for the [!INCLUDE [ssnoversion-md](../includes/ssnoversion-md.md)] image. |
417-
| **-e "SA_PASSWORD=\<YourStrong@Passw0rd\>"** | Specify your own strong password that is at least eight characters and meets the [SQL Server password requirements](../relational-databases/security/password-policy.md). Required setting for the [!INCLUDE [ssnoversion-md](../includes/ssnoversion-md.md)] image. |
417+
| **-e "MSSQL_SA_PASSWORD=\<YourStrong@Passw0rd\>"** | Specify your own strong password that is at least eight characters and meets the [SQL Server password requirements](../relational-databases/security/password-policy.md). Required setting for the [!INCLUDE [ssnoversion-md](../includes/ssnoversion-md.md)] image. |
418418
| **-p 1433:1433** | Map a TCP port on the host environment (first value) with a TCP port in the container (second value). In this example, [!INCLUDE [ssnoversion-md](../includes/ssnoversion-md.md)] is listening on TCP 1433 in the container and this container port is then exposed to TCP port 1433 on the host. |
419419
| **--name sql1** | Specify a custom name for the container rather than a randomly generated one. If you run more than one container, you can't reuse this same name. |
420420
| **--hostname sql1** | Used to explicitly set the container hostname. If you don't specify the hostname, it defaults to the container ID, which is a randomly generated system GUID. |
@@ -465,14 +465,14 @@ Before starting the following steps, make sure that you've selected your preferr
465465

466466
Setting `--hostname` and `--name` to the same value is a good way to easily identify the target container.
467467

468-
1. As a final step, change your SA password because the `SA_PASSWORD` is visible in `ps -eax` output and stored in the environment variable of the same name. See steps below.
468+
1. As a final step, change your SA password because the `MSSQL_SA_PASSWORD` is visible in `ps -eax` output and stored in the environment variable of the same name. See steps below.
469469

470470
::: moniker-end
471471

472472
<!-- This section was pasted in from includes/sql-server-linux-change-docker-password.md, to better support zone pivots. 2019/02/11 -->
473473
## <a id="sapassword"></a> Change the system administrator password
474474

475-
The **SA** account is a system administrator on the [!INCLUDE [ssnoversion-md](../includes/ssnoversion-md.md)] instance that gets created during setup. After you create your [!INCLUDE [ssnoversion-md](../includes/ssnoversion-md.md)] container, the `SA_PASSWORD` environment variable you specified is discoverable by running `echo $SA_PASSWORD` in the container. For security purposes, change your SA password.
475+
The **SA** account is a system administrator on the [!INCLUDE [ssnoversion-md](../includes/ssnoversion-md.md)] instance that gets created during setup. After you create your [!INCLUDE [ssnoversion-md](../includes/ssnoversion-md.md)] container, the `MSSQL_SA_PASSWORD` environment variable you specified is discoverable by running `echo $MSSQL_SA_PASSWORD` in the container. For security purposes, change your SA password.
476476

477477
::: zone pivot="cs1-bash"
478478
1. Choose a strong password to use for the SA user.

‎docs/linux/quickstart-sql-server-containers-kubernetes.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,10 @@ This quickstart uses [kubectl](https://kubernetes.io/docs/user-guide/kubectl/) t
3535

3636
1. Create an SA password in the Kubernetes cluster. Kubernetes can manage sensitive configuration information, like passwords as [secrets](https://kubernetes.io/docs/concepts/configuration/secret/).
3737

38-
2. To create a secret in Kubernetes named `mssql` that holds the value `MyC0m9l&xP@ssw0rd` for the `SA_PASSWORD`, run the following command. Remember to pick your own complex password:
38+
2. To create a secret in Kubernetes named `mssql` that holds the value `MyC0m9l&xP@ssw0rd` for the `MSSQL_SA_PASSWORD`, run the following command. Remember to pick your own complex password:
3939

4040
```console
41-
kubectl create secret generic mssql --from-literal=SA_PASSWORD="MyC0m9l&xP@ssw0rd"
41+
kubectl create secret generic mssql --from-literal=MSSQL_SA_PASSWORD="MyC0m9l&xP@ssw0rd"
4242
```
4343

4444
## Create storage
@@ -153,11 +153,11 @@ You will create a manifest to describe the container, based on the SQL Server [m
153153
value: "Developer"
154154
- name: ACCEPT_EULA
155155
value: "Y"
156-
- name: SA_PASSWORD
156+
- name: MSSQL_SA_PASSWORD
157157
valueFrom:
158158
secretKeyRef:
159159
name: mssql
160-
key: SA_PASSWORD
160+
key: MSSQL_SA_PASSWORD
161161
volumeMounts:
162162
- name: mssqldb
163163
mountPath: /var/opt/mssql
@@ -186,13 +186,13 @@ You will create a manifest to describe the container, based on the SQL Server [m
186186

187187
- `persistentVolumeClaim`: This value requires an entry for `claimName:` that maps to the name used for the persistent volume claim. This tutorial uses `mssql-data`.
188188

189-
- `name: SA_PASSWORD`: Configures the container image to set the SA password, as defined in this section.
189+
- `name: MSSQL_SA_PASSWORD`: Configures the container image to set the SA password, as defined in this section.
190190

191191
```yaml
192192
valueFrom:
193193
secretKeyRef:
194194
name: mssql
195-
key: SA_PASSWORD
195+
key: MSSQL_SA_PASSWORD
196196
```
197197

198198
When Kubernetes deploys the container, it refers to the secret named `mssql` to get the value for the password.

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -38,15 +38,15 @@ The following example shows how to use these environment variables to pull and r
3838

3939
```bash
4040
docker run \
41-
-e 'ACCEPT_EULA=Y' -e 'SA_PASSWORD=<YourStrong!Passw0rd>' \
41+
-e 'ACCEPT_EULA=Y' -e 'MSSQL_SA_PASSWORD=<YourStrong!Passw0rd>' \
4242
-e 'MSSQL_RPC_PORT=135' -e 'MSSQL_DTC_TCP_PORT=51000' \
4343
-p 51433:1433 -p 135:135 -p 51000:51000 \
4444
-d mcr.microsoft.com/mssql/server:2017-latest
4545
```
4646

4747
```PowerShell
4848
docker run `
49-
-e "ACCEPT_EULA=Y" -e "SA_PASSWORD=<YourStrong!Passw0rd>" `
49+
-e "ACCEPT_EULA=Y" -e "MSSQL_SA_PASSWORD=<YourStrong!Passw0rd>" `
5050
-e "MSSQL_RPC_PORT=135" -e "MSSQL_DTC_TCP_PORT=51000" `
5151
-p 51433:1433 -p 135:135 -p 51000:51000 `
5252
-d mcr.microsoft.com/mssql/server:2017-latest
@@ -60,15 +60,15 @@ The following example shows how to use these environment variables to pull and r
6060

6161
```bash
6262
docker run \
63-
-e 'ACCEPT_EULA=Y' -e 'SA_PASSWORD=<YourStrong!Passw0rd>' \
63+
-e 'ACCEPT_EULA=Y' -e 'MSSQL_SA_PASSWORD=<YourStrong!Passw0rd>' \
6464
-e 'MSSQL_RPC_PORT=135' -e 'MSSQL_DTC_TCP_PORT=51000' \
6565
-p 51433:1433 -p 135:135 -p 51000:51000 \
6666
-d mcr.microsoft.com/mssql/server:2019-GA-ubuntu-20.04
6767
```
6868

6969
```PowerShell
7070
docker run `
71-
-e "ACCEPT_EULA=Y" -e "SA_PASSWORD=<YourStrong!Passw0rd>" `
71+
-e "ACCEPT_EULA=Y" -e "MSSQL_SA_PASSWORD=<YourStrong!Passw0rd>" `
7272
-e "MSSQL_RPC_PORT=135" -e "MSSQL_DTC_TCP_PORT=51000" `
7373
-p 51433:1433 -p 135:135 -p 51000:51000 `
7474
-d mcr.microsoft.com/mssql/server:2019-GA-ubuntu-20.04
@@ -114,7 +114,7 @@ For more information about routing ports, see [Configure port routing](sql-serve
114114
If you're deploying SQL Server containers on a Kubernetes platform, see the example YAML deployment manifest below. In this example, the Kubernetes platform is Azure Kubernetes Service (AKS). Before running the sample deployment YAML script, create the necessary secret to store the `sa` password. A typical command is as shown below:
115115

116116
```bash
117-
kubectl create secret generic mssql --from-literal=SA_PASSWORD="MyC0m9l&xP@ssw0rd"
117+
kubectl create secret generic mssql --from-literal=MSSQL_SA_PASSWORD="MyC0m9l&xP@ssw0rd"
118118
```
119119

120120
You'll notice the following points in the manifest file:
@@ -177,11 +177,11 @@ spec:
177177
value: "13500"
178178
- name: MSSQL_DTC_TCP_PORT
179179
value: "51000"
180-
- name: SA_PASSWORD
180+
- name: MSSQL_SA_PASSWORD
181181
valueFrom:
182182
secretKeyRef:
183183
name: mssql
184-
key: SA_PASSWORD
184+
key: MSSQL_SA_PASSWORD
185185
volumeMounts:
186186
- name: mssql
187187
mountPath: "/var/opt/mssql"

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ chmod 440 /container/sql1/secrets/mssql.keytab
208208
Run your SQL Server container, and mount the correct AD configuration files that were previously created as shown below:
209209
210210
```bash
211-
sudo docker run -e "ACCEPT_EULA=Y" -e "SA_PASSWORD=\<YourStrong@Passw0rd\>" \
211+
sudo docker run -e "ACCEPT_EULA=Y" -e "MSSQL_SA_PASSWORD=\<YourStrong@Passw0rd\>" \
212212
-p 5433:1433 --name sql1 \
213213
-v /container/sql1:/var/opt/mssql \
214214
-v /container/sql1/krb5.conf:/etc/krb5.conf \
@@ -221,7 +221,7 @@ sudo docker run -e "ACCEPT_EULA=Y" -e "SA_PASSWORD=\<YourStrong@Passw0rd\>" \
221221
Our example would contain the following commands:
222222
223223
```bash
224-
sudo docker run -e "ACCEPT_EULA=Y" -e "SA_PASSWORD=P@ssw0rd" -p 5433:1433 --name sql1 \
224+
sudo docker run -e "ACCEPT_EULA=Y" -e "MSSQL_SA_PASSWORD=P@ssw0rd" -p 5433:1433 --name sql1 \
225225
-v /container/sql1:/var/opt/mssql/ \
226226
-v /container/sql1/krb5.conf:/etc/krb5.conf \
227227
--dns-search contoso.com \

0 commit comments

Comments
 (0)