forked from rook/rook
Blaine Gardner
c9d99e01a0
mkdocs uses a markdown renderer that is hardcoded to 4 spaces per tab
for detecting indentation levels, including ordered- and
unordered-lists. Since we cannot easily change the renderer, begin using
a markdown linter in CI that will fail if official docs do not adhere to
the spacing rules.
As a starting point, the markdownlint config does not begin with the
default set of checks, which might overwhelm attempts to fix them.
Instead, focus on list-tab-spacing rules and a few other highly useful
checks.
markdownlint also has some gaps in its abilities that allow common Rook
doc issues to pass acceptance. However, it allows creating custom
linting plugins. Create 2 such linting plugins to check 2 things:
- all doc lines (except code blocks) must be aligned to a 4-space
boundary, without exception. This ensures that markdown will render
correctly with mkdocs. This unfortunately makes it possible to create
lists that are internally aligned strangely.
- admonitions must all follow the same format of
```
!!! header
body
```
For the strange lists, this is allowed and renders correctly, but it
looks strange:
```md
- first bullet
- second bullet
still second bullet
- third bullet
has a paragraph
of text inside
- last bullet
Signed-off-by: Blaine Gardner <blaine.gardner@ibm.com>
58 lines
1.7 KiB
Markdown
58 lines
1.7 KiB
Markdown
---
|
|
title: OpenShift Common Issues
|
|
---
|
|
|
|
## Enable Monitoring in the Storage Dashboard
|
|
|
|
OpenShift Console uses OpenShift Prometheus for monitoring and populating data in Storage Dashboard. Additional configuration is required to monitor the Ceph Cluster from the storage dashboard.
|
|
|
|
1. Change the monitoring namespace to `openshift-monitoring`
|
|
|
|
Change the namespace of the RoleBinding `rook-ceph-metrics` from `rook-ceph` to `openshift-monitoring` for the `prometheus-k8s` ServiceAccount in [rbac.yaml](https://github.com/rook/rook/blob/master/deploy/examples/monitoring/rbac.yaml#L70).
|
|
|
|
```yaml
|
|
subjects:
|
|
- kind: ServiceAccount
|
|
name: prometheus-k8s
|
|
namespace: openshift-monitoring
|
|
```
|
|
|
|
2. Enable Ceph Cluster monitoring
|
|
|
|
Follow [ceph-monitoring/prometheus-alerts](../Storage-Configuration/Monitoring/ceph-monitoring.md#prometheus-alerts).
|
|
|
|
3. Set the required label on the namespace
|
|
|
|
```console
|
|
oc label namespace rook-ceph "openshift.io/cluster-monitoring=true"
|
|
```
|
|
|
|
## Troubleshoot Monitoring Issues
|
|
|
|
!!! attention
|
|
Switch to `rook-ceph` namespace using `oc project rook-ceph`.
|
|
|
|
1. Ensure ceph-mgr pod is Running
|
|
|
|
```console
|
|
$ oc get pods -l app=rook-ceph-mgr
|
|
NAME READY STATUS RESTARTS AGE
|
|
rook-ceph-mgr 1/1 Running 0 14h
|
|
```
|
|
|
|
2. Ensure service monitor is present
|
|
|
|
```console
|
|
$ oc get servicemonitor rook-ceph-mgr
|
|
NAME AGE
|
|
rook-ceph-mgr 14h
|
|
```
|
|
|
|
3. Ensure the prometheus rules object has been created
|
|
|
|
```console
|
|
$ oc get prometheusrules -l prometheus=rook-prometheus
|
|
NAME AGE
|
|
prometheus-ceph-rules 14h
|
|
```
|