Skip to content

docs(e2e): warn on ziti diagnostics secret - #180

Merged
rowan-stein merged 1 commit into
mainfrom
noa/issue-170-diagnostics-safety
May 29, 2026
Merged

docs(e2e): warn on ziti diagnostics secret#180
rowan-stein merged 1 commit into
mainfrom
noa/issue-170-diagnostics-safety

Conversation

@casey-brooks

Copy link
Copy Markdown
Contributor

Summary

  • Adds explicit DEV/E2E-only warnings around the ziti-management-diagnostics secret used by expose diagnostics tests.
  • Documents that the matching OpenZiti identity and Kubernetes secret must not exist in production.
  • Notes that bootstrap must keep enable_ziti_management_diagnostics defaulted to false and only enable it for E2E/dev runs.

Related

Follow-up to merged PR #172. Complements agynio/bootstrap#544.

Fixes #170

Test & Lint Summary

  • buf generate: passed; generated files were restored because the committed branch already contains generated sources.
  • CGO_ENABLED=0 go test -run 'TestZitiManagementEndpoint|TestZitiDiagnosticsSecret' -tags 'e2e svc_agents_orchestrator' ./tests/...: 3 passed / 0 failed / 0 skipped; tracecanary had no test files.
  • gofmt -w tests/expose_test.go: passed with no formatting errors.
  • test -z "$(gofmt -l tests/expose_test.go)": passed; lint/format check reported no errors.

@casey-brooks

Copy link
Copy Markdown
Contributor Author

Update

Created follow-up PR #180 because PR #172 is already merged and must not be changed. This follow-up adds explicit DEV/E2E-only warnings in code and docs for ziti-management-diagnostics, and references the bootstrap guard flag requirement.

Test & Lint Summary

  • buf generate: passed; generated files were restored because the committed branch already contains generated sources.
  • CGO_ENABLED=0 go test -run 'TestZitiManagementEndpoint|TestZitiDiagnosticsSecret' -tags 'e2e svc_agents_orchestrator' ./tests/...: 3 passed / 0 failed / 0 skipped; tracecanary had no test files.
  • gofmt -w tests/expose_test.go: passed with no formatting errors.
  • test -z "$(gofmt -l tests/expose_test.go)": passed; lint/format check reported no errors.

@casey-brooks
casey-brooks requested a review from noa-lucent May 29, 2026 07:52

@noa-lucent noa-lucent left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review in progress.

@noa-lucent noa-lucent left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review complete. The follow-up adds clear DEV/E2E-only warnings in the root and BDD docs, and the code-level constant now documents the production safety invariant without changing runtime behavior. No further changes requested.

@rowan-stein
rowan-stein merged commit 19346bd into main May 29, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Expose lifecycle diagnostics can't query Ziti controller (RBAC forbids reading ziti-controller-admin-secret)

3 participants