Skip to content

Commit

Permalink
Fix more references to old doc location
Browse files Browse the repository at this point in the history
  • Loading branch information
SuperSandro2000 committed May 8, 2023
1 parent a9e7cd0 commit bb47a34
Show file tree
Hide file tree
Showing 10 changed files with 14 additions and 16 deletions.
1 change: 0 additions & 1 deletion .dockerignore
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,5 @@ README.md
report.html
shell.nix
/testing/
doc/
PROJECT
RELEASE.md
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Deprecated

- Support for determining `tier` label [heuristically](./doc/playbook.md) has been
- Support for determining `tier` label [heuristically](./docs/playbook.md) has been
deprecated and will be removed in a later version.

## 0.8.0 - 2022-04-12
Expand Down
1 change: 0 additions & 1 deletion Makefile.maker.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ coverageTest:
dockerfile:
enabled: true
extraIgnores:
- doc/
- PROJECT
- RELEASE.md

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ absent-metrics-operator --help
```

In case of a false positive, the operator can be disabled for a specific alert rule or the
entire `PrometheusRule` resource. Refer to the [playbook for operators](./doc/playbook.md#disable-the-operator)
entire `PrometheusRule` resource. Refer to the [playbook for operators](./docs/playbook.md#disable-the-operator)
for instructions.

### Metrics
Expand Down
2 changes: 1 addition & 1 deletion controllers/alert_rule.go
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,7 @@ func parseAlertRule(logger logr.Logger, in monitoringv1.Rule, opts LabelOpts) ([
"summary": fmt.Sprintf("missing %s", m),
"description": fmt.Sprintf(
"The metric '%s' is missing. '%s' alert using it may not fire as intended. "+
"See <https://github.com/sapcc/absent-metrics-operator/blob/master/doc/playbook.md|the operator playbook>.",
"See <https://github.com/sapcc/absent-metrics-operator/blob/master/docs/playbook.md|the operator playbook>.",
m, in.Alert,
),
}
Expand Down
2 changes: 1 addition & 1 deletion docs/absence-alert-rule-definition.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ _absence alert rule_ would be `AbsentContainersLimesSuccessfulScrapesRate5m`.
The values of `support_group` and `service` labels are only included in the name if the
labels are specified in the `--keep-labels` flag.

The description also includes a [link](./doc/playbook.md) to the playbook for operators
The description also includes a [link](./docs/playbook.md) to the playbook for operators
that can be referenced on how to deal with _absence alert rules_.

## Labels
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ spec:
description:
The metric 'keppel_container_memory_usage_percent' is missing.
'OpenstackKeppelPodOOMExceedingLimits' alert using it may not fire as intended.
See <https://github.com/sapcc/absent-metrics-operator/blob/master/doc/playbook.md|the
See <https://github.com/sapcc/absent-metrics-operator/blob/master/docs/playbook.md|the
operator playbook>.
summary: missing keppel_container_memory_usage_percent

Expand All @@ -43,6 +43,6 @@ spec:
description:
The metric 'kube_pod_failed_scheduling_memory_total' is missing.
'OpenstackKeppelPodSchedulingInsufficientMemory' alert using it may not
fire as intended. See <https://github.com/sapcc/absent-metrics-operator/blob/master/doc/playbook.md|the
fire as intended. See <https://github.com/sapcc/absent-metrics-operator/blob/master/docs/playbook.md|the
operator playbook>.
summary: missing kube_pod_failed_scheduling_memory_total
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ spec:
annotations:
description:
The metric 'http_requests_total' is missing. 'OpenstackLimesHttpErrors'
alert using it may not fire as intended. See <https://github.com/sapcc/absent-metrics-operator/blob/master/doc/playbook.md|the
alert using it may not fire as intended. See <https://github.com/sapcc/absent-metrics-operator/blob/master/docs/playbook.md|the
operator playbook>.
summary: missing http_requests_total

Expand All @@ -41,7 +41,7 @@ spec:
annotations:
description:
The metric 'limes_suspended_scrapes' is missing. 'OpenstackLimesSuspendedScrapes'
alert using it may not fire as intended. See <https://github.com/sapcc/absent-metrics-operator/blob/master/doc/playbook.md|the
alert using it may not fire as intended. See <https://github.com/sapcc/absent-metrics-operator/blob/master/docs/playbook.md|the
operator playbook>.
summary: missing limes_suspended_scrapes

Expand All @@ -58,6 +58,6 @@ spec:
annotations:
description:
The metric 'openstack_assignments_per_role' is missing. 'OpenstackLimesUnexpectedCloudViewerRoleAssignments'
alert using it may not fire as intended. See <https://github.com/sapcc/absent-metrics-operator/blob/master/doc/playbook.md|the
alert using it may not fire as intended. See <https://github.com/sapcc/absent-metrics-operator/blob/master/docs/playbook.md|the
operator playbook>.
summary: missing openstack_assignments_per_role
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,6 @@ spec:
annotations:
description:
The metric 'openstack_assignments_per_role' is missing. 'OpenstackLimesUnexpectedCloudViewerRoleAssignments'
alert using it may not fire as intended. See <https://github.com/sapcc/absent-metrics-operator/blob/master/doc/playbook.md|the
alert using it may not fire as intended. See <https://github.com/sapcc/absent-metrics-operator/blob/master/docs/playbook.md|the
operator playbook>.
summary: missing openstack_assignments_per_role
8 changes: 4 additions & 4 deletions test/fixtures/swift_openstack_absent_metric_alert_rules.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ spec:
annotations:
description:
The metric 'swift_cluster_md5_not_matched' is missing. 'OpenstackSwiftMismatchedConfig'
alert using it may not fire as intended. See <https://github.com/sapcc/absent-metrics-operator/blob/master/doc/playbook.md|the
alert using it may not fire as intended. See <https://github.com/sapcc/absent-metrics-operator/blob/master/docs/playbook.md|the
operator playbook>.
summary: missing swift_cluster_md5_not_matched

Expand All @@ -44,7 +44,7 @@ spec:
annotations:
description:
The metric 'swift_dispersion_task_exit_code' is missing. 'OpenstackSwiftHealthCheck'
alert using it may not fire as intended. See <https://github.com/sapcc/absent-metrics-operator/blob/master/doc/playbook.md|the
alert using it may not fire as intended. See <https://github.com/sapcc/absent-metrics-operator/blob/master/docs/playbook.md|the
operator playbook>.
summary: missing swift_dispersion_task_exit_code

Expand All @@ -61,7 +61,7 @@ spec:
description:
The metric 'global:swift_cluster_storage_used_percent_average'
is missing. 'OpenstackSwiftUsedSpace' alert using it may not fire as intended.
See <https://github.com/sapcc/absent-metrics-operator/blob/master/doc/playbook.md|the
See <https://github.com/sapcc/absent-metrics-operator/blob/master/docs/playbook.md|the
operator playbook>.
summary: missing global:swift_cluster_storage_used_percent_average

Expand All @@ -77,6 +77,6 @@ spec:
annotations:
description:
The metric 'swift_recon_task_exit_code' is missing. 'OpenstackSwiftHealthCheck'
alert using it may not fire as intended. See <https://github.com/sapcc/absent-metrics-operator/blob/master/doc/playbook.md|the
alert using it may not fire as intended. See <https://github.com/sapcc/absent-metrics-operator/blob/master/docs/playbook.md|the
operator playbook>.
summary: missing swift_recon_task_exit_code

0 comments on commit bb47a34

Please sign in to comment.