Skip to content

CSPL-3867: SHC and CM Error Message Visibility #1548

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.

Sign up for GitHub

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

Jump to bottom
Merged
rlieberman-splunk merged 5 commits into from
Jul 30, 2025
Merged

CSPL-3867: SHC and CM Error Message Visibility #1548

rlieberman-splunk merged 5 commits into from
Jul 30, 2025

Conversation

@rlieberman-splunk
Copy link
Collaborator

@rlieberman-splunk rlieberman-splunk commented Jul 23, 2025

Description

This PR fixes the handling of error scenarios for search head cluster and cluster manager CRs. SearchHeadCluster CRs were not showing error messages due to an invalid DeployerPhase value. ClusterManager CRs were not showing events due to an incorrect Kind value. Logs and unit tests were added to verify this issue is fixed and help debug in the future.

Key Changes

  • Corrected the Kind field value in ClusterManager events from "Clustermanager" to "ClusterManager" to ensure proper object references. (api/v4/clustermanager_types.go)
  • Added a new DeployerPhase field initial value of PhaseError during the cluster's initialization. This is required for shc with validation errors to be retrieved by the operator. (pkg/splunk/enterprise/searchheadcluster.go)

Testing and Verification

  • Unit test added
  • Deployed a ClusterManager and SearchHeadCluster CR with an invalid spec, and verified that errors show in the following outputs:
    • kubectl get shc
    • kubectl describe shc
    • kubectl get clustermanager
    • kubectl describe clustermanager

Related Issues

PR Checklist

  • Code changes adhere to the project's coding standards.
  • Relevant unit and integration tests are included.
  • Documentation has been updated accordingly.
  • All tests pass locally.
  • The PR description follows the project's guidelines.

@coveralls
Copy link
Collaborator

coveralls commented Jul 23, 2025

Pull Request Test Coverage Report for Build 16476345705

Details

  • 1 of 3 (33.33%) changed or added relevant lines in 2 files are covered.
  • 1 unchanged line in 1 file lost coverage.
  • Overall coverage increased (+0.01%) to 86.724%
Changes Missing Coverage Covered Lines Changed/Added Lines %
pkg/splunk/enterprise/util.go 0 2 0.0%
Files with Coverage Reduction New Missed Lines %
pkg/splunk/enterprise/util.go 1 90.49%
Totals Coverage Status
Change from base Build 16468948002: 0.01%
Covered Lines: 10635
Relevant Lines: 12263
💛 - Coveralls

@coveralls
Copy link
Collaborator

coveralls commented Jul 23, 2025 •
edited
Loading

Pull Request Test Coverage Report for Build 16497369954

Details

  • 1 of 3 (33.33%) changed or added relevant lines in 2 files are covered.
  • 1 unchanged line in 1 file lost coverage.
  • Overall coverage increased (+0.02%) to 86.732%
Changes Missing Coverage Covered Lines Changed/Added Lines %
pkg/splunk/enterprise/util.go 0 2 0.0%
Files with Coverage Reduction New Missed Lines %
pkg/splunk/enterprise/util.go 1 90.49%
Totals Coverage Status
Change from base Build 16468948002: 0.02%
Covered Lines: 10636
Relevant Lines: 12263
💛 - Coveralls

kasiakoziol
kasiakoziol approved these changes Jul 24, 2025
View reviewed changes
patrykw-splunk
patrykw-splunk approved these changes Jul 30, 2025
View reviewed changes
Copy link
Collaborator

@patrykw-splunk patrykw-splunk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@rlieberman-splunk rlieberman-splunk merged commit 7a4bd21 into develop Jul 30, 2025
27 checks passed
@rlieberman-splunk rlieberman-splunk deleted the CSPL_3867_errors branch July 30, 2025 13:15
rlieberman-splunk added a commit that referenced this pull request Sep 15, 2025
@github-actions @kasiakoziol
@patrykw-splunk @rlieberman-splunk @Igor-splunk
Promote Develop to main for Splunk Operator Release 3.0.0 (#1573)
9c31567 
* CSPL-3704 SmartStore ownerReferences removed

* CSPL-3704 Integration tests enabled to check the PR

* CSPL-3704 Fix failing tests

* CSPL-3704 Remove branch from int tests

* test

* CSPL-3705 Ignoring an error if decommisioning already enabled

* CSPL-3705 Removing branch from integ tests

* CSPL-3705 Addressing a comment

* clean-up deprecated dirs - .circleci & .devcontainer (#1499)

Co-authored-by: Patryk Wasielewski <[email protected]>

* set imagePullPolicy default in helm chart (#1513)

* CSPL-3186: Upgrade Enterprise Security Version 8.0.2 (#1425)

* Updates for integration tests and documentation with latest ES version

* Update enterprise security versions and app files

* remove branch from inte test workflow

* CSPL-3688: Update Prerelease Workflow (#1502)

* add more automation to pre-release workflow

* update version and replaced version in bundle files

* update dockerfile sok version, not enterprise version

* fix typo

* CSPL-3584: Split run-tests.sh into multiple files (#1507)

* split run-tests.sh into multiple files

* trigger integration tests on branch

* use scriptdir to run sh files

* remove trigger int test workflow

* test azure, gcp, and namespace scoped workflows

* cleanup workflows

* feature: add support for pre-created PVs - admin-managed-pv annotation (#1509)

* add support for admin-managed-pv annotation

---------

Co-authored-by: Patryk Wasielewski <[email protected]>

* Removing App Framework tests for C3 and M4 on ARM builds

* CSPL-3702 Replacing () with {} in script variables

* Ginkgo upgrade

* CSPL-3768 Adding inputs to Graviton pipelines and tests

* CSPL-3768 Not disclosing ECR secret value

* CSPL-3678 Introducing pipeline for Graviton and some fixes

* CSPL-3768 Fixes

* CSPL-3768 Fixes

* CSPL-3768 Addressing Copilot suggestions

* CSPL-3768 Addressing comments

* CSPL-3759 Addressing soon to be deprecated

* CSPL-3784: Update base image to latest ubi8-minimal version (#1525)

* update base image to latest ubi8-minimal version

* trigger integration test cases for branch

* trigger tests

* cleanup

* update Dockerfile comment

* CSPL-3675 Update Operator-SDK to v1.39 (#1488)


* v.1.39.0 migration

---------

Co-authored-by: igor.grzankowski <@splunk.com>
Co-authored-by: Vivek Reddy <[email protected]>
Co-authored-by: rlieberman-splunk <[email protected]>
Co-authored-by: kasiakoziol <[email protected]>
Co-authored-by: Patryk Wasielewski <[email protected]>

* CSPL_3759 Ginkgo types to v2

* Add DeepWiki badge (#1529)

Co-authored-by: igor.grzankowski <@splunk.com>

* Upgrade golang.org/x/net version to v0.38.0 (#1530)

* upgrade golang.org/x/net version to v0.38.0

* trigger integration test cases on branch

* remove integration test trigger

* CSPL-3783: Update AppFramework docs with troubleshooting information (#1527)

* Add more logs around invalid phase and downloadPending (#1528)

* Remove kube rbac proxy from helm charts (#1531)

Co-authored-by: igor.grzankowski <@splunk.com>

* CSPL-3851 Adding info to docs about session stickiness for ingress

* Remove in progress phase

* Revert "Remove in progress phase"

This reverts commit 3c919d6.

* update SmartStore documentation for gcp and azure (#1541)

* Backport main to develop for Splunk Operator Release 2.8.1 (#1542) (#1543)

*  release 2.8.1 chnages - backported

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Patryk Wasielewski <[email protected]>
Co-authored-by: patrykw-splunk <[email protected]>

* CSPL-3898 Fixing int-helm tests failing after SDK upgrade (#1544)

* CSPL-3867: SHC and CM Error Message Visibility (#1548)

* print error for update status failed

* add deployerPhase initial value

* set correct Kind in ClusterManager events

* cleanup

* use v4 in test

* CSPL-3905: Security and dependency updates (#1551)

* initial changes for aws-sdk-go-v2

* code compiles and unit tests pass

* trigger smoke and integration tests, update context

* set correct path for downloading from s3 bucket for tests

* update ENTERPRISE_LICENSE_LOCATION

* security updates, uncomment test suites

* cleanup

* [CSPL-3912] Allow Custom Probe Scripts (#1549)

* Promote Develop to main for Splunk Operator Release 2.8.1 (#1542)

* release preparation - release 2.8.1

---------

Co-authored-by: Patryk Wasielewski <[email protected]>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: patrykw-splunk <[email protected]>

* check for existing configmap before creating a new one

* update error handling

* fix unit tests

* cleanup and documentation updates

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Patryk Wasielewski <[email protected]>
Co-authored-by: patrykw-splunk <[email protected]>

* CSPL-3913: Pass dynamic environment variables in Splunk StatefulSet for Ansible-based config generation (#1555)

* add new environment variables for config generation

* unit test updates

* add api version to env var

* Promote Develop to main for Splunk Operator Release 2.8.1 (#1542) (#1553)

* release 2.8.1

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Patryk Wasielewski <[email protected]>
Co-authored-by: patrykw-splunk <[email protected]>

* Document skipping apply cluster-bundle on cluster managers (#1556)

* Update of shc upgrade process (#1547)

Update of shc upgrade process

---------

Co-authored-by: Patryk Wasielewski <[email protected]>

* Update Helm.md (#1563)

Co-authored-by: Patryk Wasielewski <[email protected]>

* Merge Splunk10 feature changes into develop (#1559)

* CSPL-3707: Update documentation around minimum number of indexer cluster peers (#1558)

* document minimum number of CR replicas

* update examples documentation

* Default Build to multi-platform amd64 and arm64 (#1557)

* add linux/arm64 as a platform to build the operator by default

* set platforms in dockerfile

* use tag instead of sha

* update tag version

* update base image to latest

* Remove kube-rbac-proxy references and implement upgrade-sdk 1.38 changes (#1565)

* remove kube-rbac-proxy references and implement upgrade-sdk 1.38 changes

* fix kustomize references

* fix container number for debug

* cleanup

* fix service for metrics

---------

Co-authored-by: Patryk Wasielewski <[email protected]>

* helm changes for 3.0.0 release (#1566)

Co-authored-by: Patryk Wasielewski <[email protected]>

* Fix kustomization templates after removing kube-rbac-proxy (#1570)

* fix kustomization templates

---------

Co-authored-by: Patryk Wasielewski <[email protected]>

* Splunk Operator 3.0.0 release (#1572)

* Update changelog

---------

Co-authored-by: Igor-splunk <[email protected]>
Co-authored-by: igor.grzankowski <@splunk.com>

* remove old helm charts from splunk-enterprise/charts folder

---------

Co-authored-by: kasiakoziol <[email protected]>
Co-authored-by: patrykw-splunk <[email protected]>
Co-authored-by: Patryk Wasielewski <[email protected]>
Co-authored-by: rlieberman-splunk <[email protected]>
Co-authored-by: Igor Grzankowski <[email protected]>
Co-authored-by: Vivek Reddy <[email protected]>
Co-authored-by: igor.grzankowski <@splunk.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: patrykw-splunk <[email protected]>
Co-authored-by: Igor-splunk <[email protected]>
rlieberman-splunk added a commit that referenced this pull request Sep 26, 2025
@rlieberman-splunk @github-actions
@kasiakoziol @patrykw-splunk @Igor-splunk @vivekr-splunk
Merge main to develop 3.0.0 (#1586)
a3737ba 
* Promote Develop to main for Splunk Operator Release 3.0.0 (#1573)

* CSPL-3704 SmartStore ownerReferences removed

* CSPL-3704 Integration tests enabled to check the PR

* CSPL-3704 Fix failing tests

* CSPL-3704 Remove branch from int tests

* test

* CSPL-3705 Ignoring an error if decommisioning already enabled

* CSPL-3705 Removing branch from integ tests

* CSPL-3705 Addressing a comment

* clean-up deprecated dirs - .circleci & .devcontainer (#1499)

Co-authored-by: Patryk Wasielewski <[email protected]>

* set imagePullPolicy default in helm chart (#1513)

* CSPL-3186: Upgrade Enterprise Security Version 8.0.2 (#1425)

* Updates for integration tests and documentation with latest ES version

* Update enterprise security versions and app files

* remove branch from inte test workflow

* CSPL-3688: Update Prerelease Workflow (#1502)

* add more automation to pre-release workflow

* update version and replaced version in bundle files

* update dockerfile sok version, not enterprise version

* fix typo

* CSPL-3584: Split run-tests.sh into multiple files (#1507)

* split run-tests.sh into multiple files

* trigger integration tests on branch

* use scriptdir to run sh files

* remove trigger int test workflow

* test azure, gcp, and namespace scoped workflows

* cleanup workflows

* feature: add support for pre-created PVs - admin-managed-pv annotation (#1509)

* add support for admin-managed-pv annotation

---------

Co-authored-by: Patryk Wasielewski <[email protected]>

* Removing App Framework tests for C3 and M4 on ARM builds

* CSPL-3702 Replacing () with {} in script variables

* Ginkgo upgrade

* CSPL-3768 Adding inputs to Graviton pipelines and tests

* CSPL-3768 Not disclosing ECR secret value

* CSPL-3678 Introducing pipeline for Graviton and some fixes

* CSPL-3768 Fixes

* CSPL-3768 Fixes

* CSPL-3768 Addressing Copilot suggestions

* CSPL-3768 Addressing comments

* CSPL-3759 Addressing soon to be deprecated

* CSPL-3784: Update base image to latest ubi8-minimal version (#1525)

* update base image to latest ubi8-minimal version

* trigger integration test cases for branch

* trigger tests

* cleanup

* update Dockerfile comment

* CSPL-3675 Update Operator-SDK to v1.39 (#1488)


* v.1.39.0 migration

---------

Co-authored-by: igor.grzankowski <@splunk.com>
Co-authored-by: Vivek Reddy <[email protected]>
Co-authored-by: rlieberman-splunk <[email protected]>
Co-authored-by: kasiakoziol <[email protected]>
Co-authored-by: Patryk Wasielewski <[email protected]>

* CSPL_3759 Ginkgo types to v2

* Add DeepWiki badge (#1529)

Co-authored-by: igor.grzankowski <@splunk.com>

* Upgrade golang.org/x/net version to v0.38.0 (#1530)

* upgrade golang.org/x/net version to v0.38.0

* trigger integration test cases on branch

* remove integration test trigger

* CSPL-3783: Update AppFramework docs with troubleshooting information (#1527)

* Add more logs around invalid phase and downloadPending (#1528)

* Remove kube rbac proxy from helm charts (#1531)

Co-authored-by: igor.grzankowski <@splunk.com>

* CSPL-3851 Adding info to docs about session stickiness for ingress

* Remove in progress phase

* Revert "Remove in progress phase"

This reverts commit 3c919d6.

* update SmartStore documentation for gcp and azure (#1541)

* Backport main to develop for Splunk Operator Release 2.8.1 (#1542) (#1543)

*  release 2.8.1 chnages - backported

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Patryk Wasielewski <[email protected]>
Co-authored-by: patrykw-splunk <[email protected]>

* CSPL-3898 Fixing int-helm tests failing after SDK upgrade (#1544)

* CSPL-3867: SHC and CM Error Message Visibility (#1548)

* print error for update status failed

* add deployerPhase initial value

* set correct Kind in ClusterManager events

* cleanup

* use v4 in test

* CSPL-3905: Security and dependency updates (#1551)

* initial changes for aws-sdk-go-v2

* code compiles and unit tests pass

* trigger smoke and integration tests, update context

* set correct path for downloading from s3 bucket for tests

* update ENTERPRISE_LICENSE_LOCATION

* security updates, uncomment test suites

* cleanup

* [CSPL-3912] Allow Custom Probe Scripts (#1549)

* Promote Develop to main for Splunk Operator Release 2.8.1 (#1542)

* release preparation - release 2.8.1

---------

Co-authored-by: Patryk Wasielewski <[email protected]>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: patrykw-splunk <[email protected]>

* check for existing configmap before creating a new one

* update error handling

* fix unit tests

* cleanup and documentation updates

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Patryk Wasielewski <[email protected]>
Co-authored-by: patrykw-splunk <[email protected]>

* CSPL-3913: Pass dynamic environment variables in Splunk StatefulSet for Ansible-based config generation (#1555)

* add new environment variables for config generation

* unit test updates

* add api version to env var

* Promote Develop to main for Splunk Operator Release 2.8.1 (#1542) (#1553)

* release 2.8.1

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Patryk Wasielewski <[email protected]>
Co-authored-by: patrykw-splunk <[email protected]>

* Document skipping apply cluster-bundle on cluster managers (#1556)

* Update of shc upgrade process (#1547)

Update of shc upgrade process

---------

Co-authored-by: Patryk Wasielewski <[email protected]>

* Update Helm.md (#1563)

Co-authored-by: Patryk Wasielewski <[email protected]>

* Merge Splunk10 feature changes into develop (#1559)

* CSPL-3707: Update documentation around minimum number of indexer cluster peers (#1558)

* document minimum number of CR replicas

* update examples documentation

* Default Build to multi-platform amd64 and arm64 (#1557)

* add linux/arm64 as a platform to build the operator by default

* set platforms in dockerfile

* use tag instead of sha

* update tag version

* update base image to latest

* Remove kube-rbac-proxy references and implement upgrade-sdk 1.38 changes (#1565)

* remove kube-rbac-proxy references and implement upgrade-sdk 1.38 changes

* fix kustomize references

* fix container number for debug

* cleanup

* fix service for metrics

---------

Co-authored-by: Patryk Wasielewski <[email protected]>

* helm changes for 3.0.0 release (#1566)

Co-authored-by: Patryk Wasielewski <[email protected]>

* Fix kustomization templates after removing kube-rbac-proxy (#1570)

* fix kustomization templates

---------

Co-authored-by: Patryk Wasielewski <[email protected]>

* Splunk Operator 3.0.0 release (#1572)

* Update changelog

---------

Co-authored-by: Igor-splunk <[email protected]>
Co-authored-by: igor.grzankowski <@splunk.com>

* remove old helm charts from splunk-enterprise/charts folder

---------

Co-authored-by: kasiakoziol <[email protected]>
Co-authored-by: patrykw-splunk <[email protected]>
Co-authored-by: Patryk Wasielewski <[email protected]>
Co-authored-by: rlieberman-splunk <[email protected]>
Co-authored-by: Igor Grzankowski <[email protected]>
Co-authored-by: Vivek Reddy <[email protected]>
Co-authored-by: igor.grzankowski <@splunk.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: patrykw-splunk <[email protected]>
Co-authored-by: Igor-splunk <[email protected]>

* CSPL-4005: Remove CRDs from splunk/splunk-operator helm chart (#1579)

* remove crds from helm chart, needs documentation

* add documentation about adding CRDs before helm chart installation

* repackage helm charts

* cleanup helm test workflow

* Helm package: helm package changes 3.0.0 (#1582)

* helm test case

* .env changes with spulnk 10.0.0

* updated splunk default version to 10

* removed helm test from branch

---------

Co-authored-by: Vivek Reddy <[email protected]>

* Vendor only Splunk Operator 3.0.0 in Splunk Enterprise chart to prevent fallback to older operator (#1583)

* removing old splunk operator helm chart

* generate helm packages

---------

Co-authored-by: Vivek Reddy <[email protected]>

* resolve merge conflict

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: kasiakoziol <[email protected]>
Co-authored-by: patrykw-splunk <[email protected]>
Co-authored-by: Patryk Wasielewski <[email protected]>
Co-authored-by: Igor Grzankowski <[email protected]>
Co-authored-by: Vivek Reddy <[email protected]>
Co-authored-by: patrykw-splunk <[email protected]>
Co-authored-by: Igor-splunk <[email protected]>
Co-authored-by: vivekr-splunk <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@patrykw-splunk patrykw-splunk patrykw-splunk approved these changes

@kasiakoziol kasiakoziol kasiakoziol approved these changes

@vivekr-splunk vivekr-splunk Awaiting requested review from vivekr-splunk

@Igor-splunk Igor-splunk Awaiting requested review from Igor-splunk

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@rlieberman-splunk @coveralls @patrykw-splunk @kasiakoziol