Feature Overview

This feature focuses on enhancing the search operator's capabilities to provide ACM administrators with better insights into its health, configuration, and operational status. It aims to improve debuggability, user experience, and automate configurations for large-scale environments.

Goals

This Section: Provide high-level goal statement, providing user context
and expected user outcome(s) for this feature

• This feature aims to enhance the search operator by providing greater visibility into its health, configuration, and operational status, leading to easier debugging and improved user experience for ACM administrators.

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.

(Optional) Use Cases

This Section:

• Main success scenarios - high-level user stories
  • An ACM admin can view metrics from the search PostgreSQL instance to monitor its health and utilization.
  • An ACM admin is immediately notified of search operator configuration errors.
  • An ACM admin receives a message from the search operator when advanced PostgreSQL configuration is necessary.
  • An ACM admin can check the search CR status to understand the current state of Search and identify any issues.
  • An ACM admin can successfully set up Search in High Availability (HA) mode.
  • The search operator automatically configures deployments (Postgres, indexer, API) in large-scale environments.
• Alternate flow/scenarios - high-level user stories
  • If invalid hugepages resource requests are provided, the search operator logs the error, and the user gains visibility into this error without parsing logs

Questions to answer

• ...

Out of Scope

• Automation of the action to update the PostgreSQL configuration is excluded from the story "As ACM admin, I want the search operator to show a message when advanced PostgreSQL config".
• Changing the log level on the collector in a managed cluster (ACM-7610) is out of scope for this feature, as it is listed as a separate story

Background, and strategic fit

This feature provides essential context for anyone involved in coding, testing, or documenting the search operator. It aims to make the search operator more robust and user-friendly by offering better insights into its operations and configurations. This aligns with a broader strategy of improving the debuggability and reliability of Search Postgres and the overall ACM search experience.

Assumptions

• The necessary hooks and APIs are available within Kubernetes/OpenShift for the search operator to gather required metrics and report configuration errors.
• The thresholds for "large scale environments" needing automated PostgreSQL configuration can be clearly defined.

Customer Considerations

• Customers will benefit from increased transparency into the search operator's status and health.
• Easier debugging of search-related issues will reduce downtime and improve overall system stability.
• Automated configuration for large environments will simplify deployment and management for large-scale ACM users.

Documentation Considerations

Questions to be addressed:

• What educational or reference material (docs) is required to support this product feature?
  • Yes, for users/admins.
• Does this feature have a doc impact?
  • Yes.
• What concepts do customers need to understand to be successful in monitoring search operator health and configuring advanced PostgreSQL settings?
• How do we expect customers will use the feature? For what purpose(s)?
  • To monitor search health, debug issues, and ensure optimal performance in various environments.
• What reference material might a customer want/need to complete search operator configuration or troubleshooting?
• Is there source material that can be used as reference for the Technical Writer in writing the content?
  • Yes, the detailed descriptions within the Jira stories themselves, especially for metrics and error reporting. Links to relevant technical design documents or architectural diagrams if available.

What is the doc impact (New Content, Updates to existing content, or Release Note)?

• New Content: Documentation on new metrics exposed by the search operator, details on configuration error reporting, and guidance on automated large-scale environment configuration.
• Updates to existing content: Updates to search operator installation and configuration guides to include advanced PostgreSQL settings and HA mode setup.
• Release Note: A release note detailing the search operator enhancements.