-
Notifications
You must be signed in to change notification settings - Fork 5
K8SPS-583 Fixed monitoring and TLS docs, added hidden draft for monitor kubernetes doc #159
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
nastena1606
commented
Nov 7, 2025
ixed monitoring and TLS docs, added hidden draft for monitor kubernetes doc
modified: docs/ReleaseNotes/Kubernetes-Operator-for-PS-RN0.1.0.md
modified: docs/ReleaseNotes/Kubernetes-Operator-for-PS-RN0.10.0.md
modified: docs/ReleaseNotes/Kubernetes-Operator-for-PS-RN0.11.0.md
modified: docs/ReleaseNotes/Kubernetes-Operator-for-PS-RN0.12.0.md
modified: docs/ReleaseNotes/Kubernetes-Operator-for-PS-RN0.2.0.md
modified: docs/ReleaseNotes/Kubernetes-Operator-for-PS-RN0.3.0.md
modified: docs/ReleaseNotes/Kubernetes-Operator-for-PS-RN0.4.0.md
modified: docs/ReleaseNotes/Kubernetes-Operator-for-PS-RN0.5.0.md
modified: docs/ReleaseNotes/Kubernetes-Operator-for-PS-RN0.6.0.md
modified: docs/ReleaseNotes/Kubernetes-Operator-for-PS-RN0.7.0.md
modified: docs/ReleaseNotes/Kubernetes-Operator-for-PS-RN0.8.0.md
modified: docs/ReleaseNotes/Kubernetes-Operator-for-PS-RN0.9.0.md
modified: docs/System-Requirements.md
modified: docs/TLS.md
modified: docs/architecture.md
modified: docs/assets/fragments/monitor-db.txt
new file: docs/assets/images/cadvisor.svg
new file: docs/assets/images/certificates.svg
new file: docs/assets/images/kubelet.svg
modified: docs/cluster-wide.md
modified: docs/data-insert.md
modified: docs/index.md
new file: docs/monitor-kubernetes.md
modified: docs/operator.md
new file: docs/tls-update.md
modified: mkdocs-base.yml
deleted: snippets/monitor-db.md
modified: variables.yml
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR consolidates and improves TLS and monitoring documentation. The main changes restructure the monitoring documentation by moving content from a snippet file to a reusable fragment, add a new draft document for Kubernetes monitoring, and enhance TLS documentation with clearer instructions for certificate management and updates.
Key changes:
- Restructured monitoring documentation by converting snippets to fragments and adding a new Kubernetes monitoring guide
- Enhanced TLS documentation with improved certificate generation instructions and a new certificate update guide
- Fixed formatting inconsistencies and typos across multiple documentation files
Reviewed Changes
Copilot reviewed 16 out of 19 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| variables.yml | Added monitoring tag variable for Kubernetes monitoring stack version |
| snippets/monitor-db.md | Removed - content migrated to fragments |
| mkdocs-base.yml | Fixed commented navigation entry for Kubernetes monitoring page |
| docs/tls-update.md | New guide for certificate expiration checking and updates |
| docs/monitor-kubernetes.md | New comprehensive guide for Kubernetes cluster monitoring with PMM |
| docs/TLS.md | Restructured with improved certificate generation workflow and prerequisites |
| docs/assets/fragments/monitor-db.txt | Updated with clearer PMM setup instructions and token format |
| docs/encryption-setup.md | Fixed formatting inconsistencies in code blocks |
| docs/data-insert.md | Fixed broken internal link |
| docs/System-Requirements.md | Added OpenShift installation option |
| docs/cluster-wide.md | Added external link indicators |
| docs/ReleaseNotes/* | Removed external link indicators from internal GitHub links |
| docs/*-tutorial.md | Fixed heading formatting |
Comments suppressed due to low confidence (1)
docs/tls-update.md:1
- Broken internal link anchor - the reference '#' points nowhere and should link to the 'Check your certificates for expiration' section.
## Update certificates
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
docs/encryption-setup.md
Outdated
| Since this is a running cluster, we will apply a patch: | ||
| ``` {.bash data-prompt="$" } | ||
| $ kubectl patch ps ps-cluster1 \ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
in this case the command will be wrong and didn't apply, since in NAMESPACE variable we store vault, not operator ns.
docs/encryption-setup.md
Outdated
| Now create a Secret object: | ||
| ``` {.bash data-prompt="$" } | ||
| $ kubectl apply -f deploy/vault-secret.yaml -n $NAMESPACE |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the same here. this command create secret in vault ns, not in operator ns.
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
…-encryption-monitoring
…-monitoring' into K8SPS-583-Hackathon-encryption-monitoring
b084dad to
23ab63d
Compare
…m:percona/k8sps-docs into K8SPS-583-Hackathon-encryption-monitoring
docs/tls-update.md
Outdated
| --type=kubernetes.io/tls -o yaml --dry-run=client | kubectl apply -f - | ||
| ``` | ||
| 8. The cluster will go through a rolling reconciliation, but it will do it |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| 8. The cluster will go through a rolling reconciliation, but it will do it | |
| 8. The cluster will go through a rolling restart, but it will do it |
docs/tls-update.md
Outdated
| --type=kubernetes.io/tls -o yaml --dry-run=client | kubectl apply -f - | ||
| ``` | ||
| 10. The cluster will go through a rolling reconciliation, but it will do it |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| 10. The cluster will go through a rolling reconciliation, but it will do it | |
| 10. The cluster will go through a rolling restart, but it will do it |
Co-authored-by: Ege Güneş <[email protected]>
docs/tls-update.md
Outdated
| ``` | ||
| 5. The cluster will go through a rolling reconciliation, but it will do it | ||
| without problems, as every node has old TLS certificate/key, and both new |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
reconciliation -> restart (from Ege's suggestion)
Split the page into subtopics Modified TOC