Use 'PLACEHOLDER' to represent secrets in docs and GH workflows (#227)

Co-authored-by: Chris Gillum <cgillum@microsoft.com>
microsoft · Jun 4, 2024 · 213d57d · 213d57d
1 parent 5dbe623
commit 213d57d
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 5 deletions.
diff --git a/.github/workflows/build-and-test.yml b/.github/workflows/build-and-test.yml
@@ -15,7 +15,7 @@ jobs:
 
     runs-on: ubuntu-latest
     env:
-      SA_PASSWORD: NotASecret!12
+      SA_PASSWORD: NotASecret!12 # ([SuppressMessage\("Microsoft.Security", "CS001:SecretInline", Justification="This isn't a real prod secret, it is a local DB instance instantiated on demand."\)]
 
     steps:
     - uses: actions/checkout@v4

diff --git a/docs/kubernetes.md b/docs/kubernetes.md
@@ -38,7 +38,7 @@ spec:
         - name: ACCEPT_EULA
           value: "Y"
         - name: SA_PASSWORD
-          value: "Pass@word1"
+          value: "PLACEHOLDER" # replace PLACEHOLDER With a password
 ---
 apiVersion: v1
 kind: Service
@@ -72,8 +72,9 @@ Once the container starts up, use the following PowerShell commands to create a
 # Get the name of the Pod running SQL Server
 $mssqlPod = kubectl get pods -n mssql -o jsonpath='{.items[0].metadata.name}'
 
-# Use sqlcmd.exe to create a database named "DurableDB"
-kubectl exec -n mssql $mssqlPod -- /opt/mssql-tools/bin/sqlcmd -S . -U sa -P "Pass@word1" -Q "CREATE DATABASE [DurableDB] COLLATE Latin1_General_100_BIN2_UTF8"
+# Use sqlcmd.exe to create a database named "DurableDB".
+# Replace 'PLACEHOLDER' with the password you used earlier
+kubectl exec -n mssql $mssqlPod -- /opt/mssql-tools/bin/sqlcmd -S . -U sa -P "PLACEHOLDER" -Q "CREATE DATABASE [DurableDB] COLLATE Latin1_General_100_BIN2_UTF8"
 ```
 
 ?> If you have an old version of the database already deployed, you may want to first delete that one using `DROP DATABASE [DurableDB]` SQL command. This should only be necessary when using alpha builds of the Durable Task SQL provider. Newer builds will take care of database schema upgrades automatically.
@@ -114,7 +115,8 @@ metadata:
   name: mssql-secrets
 type: Opaque
 stringData:
-  SQLDB_Connection: "Server=mssqlinst.mssql.svc.cluster.local;Database=DurableDB;User ID=sa;Password=Pass@word1;Persist Security Info=False;TrustServerCertificate=True;Encrypt=True;"
+  # Replace PLACEHOLDER with the password you chose earlier
+  SQLDB_Connection: "Server=mssqlinst.mssql.svc.cluster.local;Database=DurableDB;User ID=sa;Password=PLACEHOLDER;Persist Security Info=False;TrustServerCertificate=True;Encrypt=True;"
 ```
 
 Name the yaml file **mssql-secrets.yml** and deploy it to your cluster.