self_managed_options.yml 1.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  1. columns:
  2. - column: "Option"
  3. - column: "Description"
  4. rows:
  5. - Option: "`--dump-k8s`"
  6. Description: |
  7. <a name="dump-k8s"></a>
  8. If `true`, dump debug information from the Kubernetes cluster.
  9. Defaults to `true`.
  10. - Option: "`--k8s-namespace <NAMESPACE>`"
  11. Description: |
  12. <a name="k8s-namespace"></a> The namespaces to dump. Specify multiple
  13. times to dump multiple namespaces.
  14. Required if [`--dump-k8s`](#dump-k8s) is true.
  15. - Option: "`--k8s-context <CONTEXT>`"
  16. Description: |
  17. <a name="k8s-context"></a> The Kubernetes context to use.
  18. Defaults to the `KUBERNETES_CONTEXT` environment variable.
  19. - Option: "`--k8s-dump-secret-values`"
  20. Description: |
  21. <a name="k8s-dump-secret-values"></a> If `true`, include unredacted secrets in the
  22. dump. Use with caution.
  23. Defaults to `false`.
  24. - Option: "`--auto-port-forward`"
  25. Description: |
  26. <a name="auto-port-forward"></a>If `true`, automatically port-forward the
  27. external SQL port.
  28. Defaults to `true`.
  29. - Option: "`--port-forward-local-address <IP address>`"
  30. Description: |
  31. <a name="port-forward-local-address"></a> The address to listen on for
  32. port-forwarding.
  33. Defaults to `127.0.0.1`.
  34. - Option: "`--port-forward-local-port <PORT>`"
  35. Description: |
  36. <a name="port-forward-local-port"></a> The port to listen on for
  37. port-forwarding.
  38. Defaults to `6875`.
  39. - Option: "`-h`, `--help`"
  40. Description: |
  41. <a name="help"></a> Print help information.