-
Feature
-
Resolution: Unresolved
-
Critical
-
None
-
None
-
False
-
None
-
False
-
Not Selected
-
100% To Do, 0% In Progress, 0% Done
Feature Overview
Produce a metric on the managed cluster-side for our policy types (Config, Cert, Operator)
Goals
This Section: Provide high-level goal statement, providing user context
and expected user outcome(s) for this feature
- Close a gap between Policy-framework deployment and standalone deployment
- Policy framework on hub-side produces a policy metric that allows for an alerting rule to be created to get alerted on violated policies
Requirements
This Section: A list of specific needs or objectives that a Feature must
deliver to satisfy the Feature.. Some requirements will be flagged as MVP.
If an MVP gets shifted, the feature shifts. If a non MVP requirement slips,
it does not shift the feature.
| Requirement | Notes | isMvp? |
|---|---|---|
| CI - MUST be running successfully with test automation | This is a requirement for ALL features. |
YES |
| Release Technical Enablement | Provide necessary release enablement details and documents. |
YES |
(Optional) Use Cases
This Section:
- Produce a managed-cluster side metric for ConfigurationPolicy, CertificatePolicy, and OperatorPolicy comparable to the hub-side metric that includes the violation status
- Update RHACM observability to automatically allowlist and collect these metrics to the hub when MCO is enabled.
- Allow for alerting rules to be created for policies deployed in the standalone mode
- Allow for global hub to discover and know about policies deployed in standalone mode
- Update "Policy deployment comparison table" doc
- Feature: Policy compliance metric on the hub cluster for alerts
- Deployed with external tools
- Change "No" to "Yes"
Questions to answer
- What fields are needed to be included?
- Name (policy name)
- Namespace (? - two different namespaces are possible)
- Kind (ConfigurationPolicy, CertificatePolicy, OperatorPolicy)
- Severity
- Response action
- (Result - same as policy_governance_info)
- 0 if policy has no violations
- 1 if policy has violations
- -1 if policy is unknown or pending
Out of Scope
- …
Background, and strategic fit
This Section: What does the person writing code, testing, documenting
need to know? What context can be provided to frame this feature?
Assumptions
- ...
Customer Considerations
- ...
Documentation Considerations
Questions to be addressed:
- What educational or reference material (docs) is required to support this
product feature? For users/admins? Other functions (security officers, etc)? - Does this feature have a doc impact?
- New Content, Updates to existing content, Release Note, or No Doc Impact
- If unsure and no Technical Writer is available, please contact Content
Strategy. - What concepts do customers need to understand to be successful in
[action]? - How do we expect customers will use the feature? For what purpose(s)?
- What reference material might a customer want/need to complete [action]?
- Is there source material that can be used as reference for the Technical
Writer in writing the content? If yes, please link if available. - What is the doc impact (New Content, Updates to existing content, or
Release Note)?