Repository navigation
Document gated plaintext PostgreSQL development demo - #2041
nellshamrell wants to merge 12 commits into
Conversation
Gate adoption on public compatible artifacts and synchronized edge samples; preserve password Secret delivery and generate the candidate TLS reference through the canonical producer. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Signed-off-by: Nell Shamrell-Harrington <nells@microsoft.com>
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Signed-off-by: Nell Shamrell-Harrington <nells@microsoft.com>
Classify BCP036 and BCP037 for the demo TLS property as failures even when Bicep exits successfully. Cover diagnostics and validation flow with standard-library fixtures in the existing CI job. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Signed-off-by: Nell Shamrell-Harrington <nells@microsoft.com>
Reject only diagnostics attributed to the approved demo path, preserving warnings from unrelated imported files. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Signed-off-by: Nell Shamrell-Harrington <nells@microsoft.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Signed-off-by: Nell Shamrell-Harrington <nells@microsoft.com>
Use the pushed DCO-equivalent candidate without changing generated reference content or claiming published adoption. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Signed-off-by: Nell Shamrell-Harrington <nells@microsoft.com>
Describe explicit Terraform delete semantics and Secret cleanup runtime prerequisites without claiming published support. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Signed-off-by: Nell Shamrell-Harrington <nells@microsoft.com>
This reverts commit 8cbaf90. Preserve the existing plaintext tutorial and adoption work while removing the out-of-scope candidate runtime contract documentation. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Signed-off-by: Nell Shamrell-Harrington <nells@microsoft.com>
|
That sentence covers the practical changes that make the tutorial match the PostgreSQL demo and make its results easier to verify:
The local candidate run verified the deployment, CRUD, actual plaintext connection and scoped deletion. It also found that three tutorial commands still use a retired |
Restore unrelated tutorial and validation changes for separate follow-up issues. Keep explicit server/client TLS settings, generated policy reference, compatibility requirements and Azure guard caveat. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Signed-off-by: Nell Shamrell-Harrington <nells@microsoft.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Signed-off-by: Nell Shamrell-Harrington <nells@microsoft.com>
Regenerate from resource-types-contrib 56d20315676cbee42a5939d105bb5e21096d0780 with Radius producer 59b3954f3af5702dc2a4057ac31292dbed40e35d and the existing docs importer. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Signed-off-by: Nell Shamrell-Harrington <nells@microsoft.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Signed-off-by: Nell Shamrell-Harrington <nells@microsoft.com>
Summary
Make the PostgreSQL tutorial explicitly choose the certificate-free development mode introduced by radius-project/resource-types-contrib#394: database
tls: 'disabled'and clientPGSSLMODE=disable.Document the resulting plaintext traffic, unchanged password authentication, certificate requirements for the other modes, and Azure's rejection of
disabled. Update the generated TLS reference and explain which compatible artifacts must be adopted before using the tutorial.Replace the direct PostgreSQL AVM example with Azure Blob Storage. The page still teaches how to reuse an existing module, without showing a PostgreSQL recipe that bypasses the TLS policy guard.
Reason for change
The corrected recipes enforce the default
requiredpolicy. A certificate-free demo must therefore selectdisabledexplicitly rather than rely on the recipe accepting plaintext despite its configuration. This mode is for private, disposable Kubernetes environments only.Keep this PR in draft. Compatible schema/extension/recipes must be published and adopted, and the final sample must match samples
edge. The reduced sample now contains only the two TLS settings; its image parameter and password-description changes were removed. It no longer matches the broader samples candidate until that source is reconciled.Issue closure: N/A.
Unrelated improvements were removed and tracked separately: password delivery, tutorial accuracy and deployment checks, storage and cleanup guidance, Bicep validation, and radius-project/samples#2697 for the image override and sample coordination.
How to test
Results after the scope reduction at
2bd16a3:npm --prefix docs run buildnpx --yes cspell lint --config .github/configs/.cspell.yml --no-progress --dot '**/*.md'python -B .github/scripts/validate_bicep.pytls. Compatible artifacts remain required. The validator is restored to its original behavior.git diff --check d67dc7d -- docs .githubAdditional checks for the storage example in
be36c5a0:npm --prefix docs run buildnpx --yes cspell lint --config .github\configs\.cspell.yml --no-progress docs\content\management\existing-recipes\_index.mdbicep.exe build recipe-pack.bicep --stdoutbicep.exe build module-contract.bicep --stdoutgit diff --check -- docs\content\management\existing-recipes\_index.mdThe generated reference is still based on the contrib candidate, not a released schema. Earlier live tests exercised the broader candidate with local artifacts and CLI adaptations; they do not establish acceptance of this reduced revision or the public tutorial.
File change summary
docs/static/samples/demo/app-postgresql.biceptls: 'disabled'andPGSSLMODE=disable.docs/content/getting-started/add-connection/_index.mddocs/content/getting-started/install-radius/_index.mddocs/content/reference/resources/radius.data/2025-08-01-preview/postgresqldatabases/index.mddocs/content/management/existing-recipes/_index.md