CSPL-2966: Feature: Manual App Updates per Custom Resource (CR) in Splunk Operator #1395

vivekr-splunk · 2024-10-28T23:34:50Z

Description

This PR introduces a feature allowing for manual app deployment updates on a per-custom-resource (CR) basis for the Splunk Operator. With this enhancement, admins can initiate app deployments for each splunk custom resource instance independently, without impacting other instances. This capability enables more flexible and frequent app deployment schedules, addressing customer requirements for controlled and isolated updates.

Customer Requirement:

Need: Separate app deployment processes for each custom resource to allow independent deployment at any time during the day, rather than a unified deployment after hours.
Solution: A unique ConfigMap per CR instance, allowing isolated manual app deployments through a status field update in the ConfigMap.

Key Changes

Auto-generation of ConfigMaps per CR:
- Each Custom Resource instance now has a dedicated ConfigMap and field for manual app management.
- ConfigMap is named based on the associated CR type and instance, ensuring clarity and association.
- ConfigMap is automatically deleted when the corresponding CR is deleted.
Manual Trigger for App Deployment:
- Admins can set the manualUpdate to "on" in the ConfigMap to initiate app deployment for a specific CR instance.
- The Splunk Operator detects this change, executes the app deployment, and resets the manualUpdate to "off" upon completion.
Fallback Mechanism for Missing CR-Specific ConfigMaps:
- If a CR-specific ConfigMap do not have entry for manual app management manualUpdate is missing, the Splunk Operator falls back to the default ConfigMap for manual updates.
- Logging has been added to indicate whether a specific or default ConfigMap was used for deployment.
Enable/Disable Automatic Polling:
- Automatic polling for app updates can be enabled or disabled by adjusting the appsRepoPollIntervalSeconds in each CR.
- Documentation updates provide examples of enabling/disabling polling and manually updating the ConfigMap.
Comprehensive Testing:
- Unit tests validate ConfigMap handling and fallback scenarios.
- Integration tests ensure app deployments function independently across multiple CRs.
- Customer-specific scenarios simulate multiple CR deployments and isolated app updates.
Documentation:
- Updated configuration guide to reflect new ConfigMap-based manual app deployment for each CR instance.
- Added examples for enabling/disabling automatic polling and triggering manual updates.

Testing and Verification

Unit Tests: Added unit tests for handling ConfigMap updates, fallback logic, and status monitoring.
Integration Tests: Validated app deployment functionality per instance using dedicated ConfigMaps.
Customer Scenario Testing: Simulated scenarios based on Schwarz's environment to verify independent app deployments without interference.

Next Steps

Migration Considerations: Documentation includes instructions for transitioning existing installations to the new ConfigMap model.
Additional Observability: Log outputs confirm whether specific or fallback ConfigMaps are used, providing insights for troubleshooting.

Related Issues

Closes: CSPL-2966

Signed-off-by: Vivek Reddy <vivekr@splunk.com>

Signed-off-by: Vivek Reddy <vivekrsplunk@github.com>

pkg/splunk/enterprise/configuration.go

test/appframework_aws/s1/appframework_aws_test.go

Signed-off-by: Vivek Reddy <vivekrsplunk@github.com>

akondur

Small comment but looks good

pkg/splunk/enterprise/configuration.go

Signed-off-by: Vivek Reddy <vivekrsplunk@github.com>

* Use docker-buildx and make smoke tests run * Add a '.' * Test again * Change env variable value * Trigger int testing * Minimize changes only to smoke tests to start with * Initial changes for graviton smoke tests * Try this * Add the argument again * Try passing build arguments * Add a default value * Hardcode * Change tag * Pull locally * Don't push for graviton * Display operator image * Change eks instance type * Dump version * Describe * Don't need to tag for graviton * Re-run change kust * Avoid describe * Enable everything and try again * Remove push-latest, re-run pipelines * Re-run tests * Enable int tests * Update error logs * Further enhance * Don't use platform in FROM in dockerfile, remove TARGETOSIMAGE, ignore int tests for now * Trigger int and smoke as well * Pull image fix - int tests * Set graviton to true int tests * Re-trigger * Trigger * Re-trigger * Disable int tests for now. * Avoid vul testing for graviton for now * Add support for Ubuntu * Pass as build arg * Echo BASE_OS * Address review comments * Fix docker builds * Change logic for Ubuntu * Test package version * Run without package versions * Fix unattended-upgrades * Build for amd64 as well for pipelines * Remove space * Change to AS * Trigger for 9.2.4 AL2023 ARM * Try installing certificates on SOK container * Trigger both arm and ubuntu. Add cert for ubuntu * Trigger workflows for 9.2.4 AL2023 ARM64 * trigger AL2023 build for splunk 9.2.4 * trigger AL2023 build for splunk 9.3.2 * trigger Ubuntu build for splunk 9.2.4 * trigger Ubuntu build for splunk 9.3.2 * trigger AL2023 build for splunk 9.2.4 * use new label to test app framework tests that hang during teardown * use shorter label for testing tag * trigger integration test for PR * trigger rebuild of sok images for arm64 architectures * trigger rebuild for sok container on linux arm64 * remove build and test workflow for now * trigger rebuild for sok container on ubuntu arm64 * separate suite tag for failing test * get correct standalone for readiness checks * get correct standalone for readiness checks * add sleep for managermc1 failing test case * dump splunk version during consistently check for search head cluster * clean up new workflows * merge commit for pulling splunk enterprise image * re-enable test case, correct merge conflict * feat: [CSPL-3253]: Change default storageClassName value in PVC * add back feature branch for integration test workflow trigger * Initial changes to support deployer spec in SHC CRD * Integration testing enabled * Remove SHC updating phase check * Remove change splunk operator name step in integration test workflow * Trigger int testing again * Fix int test bug * remove specific branch to run integration tests * Add a comment, rename TC. * Add UT and return error if not deployer sts * Add node affinity as well. * [CSPL-3269] Change error log for clarification (#1422) * Change error log to info for clarification * update log statement * change log back to error, keep new contents * lowercase error message * Restore int-test workflow * CSPL-3156: Add kubectl-splunk Plugin for Executing Splunk Commands within Kubernetes Pods (#1407) * adding kubectl splunk plugin Signed-off-by: Vivek Reddy <vivekrsplunk@github.com> * Fix code scanning alert no. 32: Clear-text logging of sensitive information Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com> * added auto credentials Signed-off-by: Vivek Reddy <vivekrsplunk@github.com> * Fix code scanning alert no. 34: Clear-text logging of sensitive information Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com> * modularized code with test Signed-off-by: Vivek Reddy <vivekrsplunk@github.com> * adding workflow for this Signed-off-by: Vivek Reddy <vivekrsplunk@github.com> * adding workflow for this Signed-off-by: Vivek Reddy <vivekrsplunk@github.com> * adding name to workflow Signed-off-by: Vivek Reddy <vivekrsplunk@github.com> * adding name to workflow Signed-off-by: Vivek Reddy <vivekrsplunk@github.com> * adding name to workflow Signed-off-by: Vivek Reddy <vivekrsplunk@github.com> * adding branch for test Signed-off-by: Vivek Reddy <vivekrsplunk@github.com> --------- Signed-off-by: Vivek Reddy <vivekrsplunk@github.com> Co-authored-by: Vivek Reddy <vivekrsplunk@github.com> Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com> Co-authored-by: Arjun Kondur <69369319+akondur@users.noreply.github.com> * CSPL-2966: Feature: Manual App Updates per Custom Resource (CR) in Splunk Operator (#1395) * adding cr specific configmap Signed-off-by: Vivek Reddy <vivekr@splunk.com> * formatting changes * fallback * adding logic for manual update Signed-off-by: Vivek Reddy <vivekr@splunk.com> * working logic * commenting unit test for now * comment unit test for now * comment unit test in makefile * fixed field manualUpdate in per Cr config Signed-off-by: Vivek Reddy <vivekr@splunk.com> * add ownership to config * order changed for config creation * fix manualUpdate per CR * unit test cases fixed * CSPL-2983: doc changes Signed-off-by: Vivek Reddy <vivekr@splunk.com> * fixed unit test cases Signed-off-by: Vivek Reddy <vivekr@splunk.com> * uncomment unit test Signed-off-by: Vivek Reddy <vivekr@splunk.com> * adding go mod changes Signed-off-by: Vivek Reddy <vivekr@splunk.com> * some more changes to go sum * fixed mc list test case * fixed searchhead for dev merge Signed-off-by: Vivek Reddy <vivekr@splunk.com> * adding per cr changes Signed-off-by: Vivek Reddy <vivekrsplunk@github.com> * replaced test label Signed-off-by: Vivek Reddy <vivekrsplunk@github.com> * added few doc and code changes Signed-off-by: Vivek Reddy <vivekrsplunk@github.com> --------- Signed-off-by: Vivek Reddy <vivekr@splunk.com> Signed-off-by: Vivek Reddy <vivekrsplunk@github.com> Co-authored-by: Vivek Reddy <vivekrsplunk@github.com> * CSPL-3064: Support for Distroless Image Creation in Splunk Operator for Kubernetes (#1421) * adding support for distoless Signed-off-by: Vivek Reddy <vivekrsplunk@github.com> * adding document changes for distroless Signed-off-by: Vivek Reddy <vivekrsplunk@github.com> * adding github workflow for distroless Signed-off-by: Vivek Reddy <vivekrsplunk@github.com> * adding github workflow for distroless Signed-off-by: Vivek Reddy <vivekrsplunk@github.com> * adding github workflow for distroless Signed-off-by: Vivek Reddy <vivekrsplunk@github.com> * adding github workflow for distroless Signed-off-by: Vivek Reddy <vivekrsplunk@github.com> * Add workflow to push distroless image. * Add - CSPL-3064 branch to triggers for Arm Distroless Smoke Test WorkFlow * Add - CSPL-3064 branch to triggers for Arm Distroless Smoke Test WorkFlow * Add - CSPL-3064 branch to triggers for Arm Distroless Smoke Test WorkFlow * Remove stuttering from name * Use correct distroless image name * Use correct distroless image name * Comment out vurneability-scan * Comment out vurneability-scan * Use correct naming convention in merge develop to main * Use sidecar in distroless int workflow. * Update manifest path * Update sidecar manifest * Add kustomize patch to deploy sidecar-debug * Fix kustomize * Fix command * Fix sidecar name * supporting debug pod in pipeline Signed-off-by: Vivek Reddy <vivekrsplunk@github.com> * renamed sidecar name * Fix distroless-build-test-push-workflow.yml to not build for amd * Fix distroless build test push workflow * fix * comment vurn scan out * Update build push distro workflow * Update distorless-int-test-worfklow * Review suggestions * Remove empty lines from install.md * Remove running on CSPL-3064 --------- Signed-off-by: Vivek Reddy <vivekrsplunk@github.com> Co-authored-by: Vivek Reddy <vivekrsplunk@github.com> Co-authored-by: igor.grzankowski <igor.grzankowski@splunk.com> Co-authored-by: Igor Grzankowski <igorg@splunk.com> * Splunk Operator 2.7.1 release (#1426) * [create-pull-request] automated change * additional changes * use consistent formatting in ChangeLog.md * bundle clusterserviceversion updates --------- Co-authored-by: rlieberman-splunk <rlieberman-splunk@users.noreply.github.com> Co-authored-by: rlieberman-splunk <rlieberman@splunk.com> * Update distroless RC and release tags (#1433) * update distroless docker image tag * publish distroless image on releas --------- Signed-off-by: Vivek Reddy <vivekrsplunk@github.com> Signed-off-by: Vivek Reddy <vivekr@splunk.com> Co-authored-by: Arjun Kondur <akondur@splunk.com> Co-authored-by: Arjun Kondur <69369319+akondur@users.noreply.github.com> Co-authored-by: rlieberman-splunk <rlieberman@splunk.com> Co-authored-by: Patryk Wasielewski <pwasiele@splunk.com> Co-authored-by: patrykw-splunk <patrykw@splunk.com> Co-authored-by: vivekr-splunk <94569031+vivekr-splunk@users.noreply.github.com> Co-authored-by: Vivek Reddy <vivekrsplunk@github.com> Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com> Co-authored-by: igor.grzankowski <igor.grzankowski@splunk.com> Co-authored-by: Igor Grzankowski <igorg@splunk.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: rlieberman-splunk <rlieberman-splunk@users.noreply.github.com>

vivekr-splunk added 2 commits October 28, 2024 23:26

adding cr specific configmap

51a47c4

Signed-off-by: Vivek Reddy <vivekr@splunk.com>

formatting changes

e08d441

vivekr-splunk changed the base branch from main to develop October 28, 2024 23:34

vivekr-splunk self-assigned this Oct 28, 2024

vivekr-splunk added 10 commits October 29, 2024 02:45

fallback

ae9c624

adding logic for manual update

1f0e459

Signed-off-by: Vivek Reddy <vivekr@splunk.com>

working logic

267a93b

commenting unit test for now

65cd4e6

comment unit test for now

db28794

comment unit test in makefile

9593814

fixed field manualUpdate in per Cr config

86826ff

Signed-off-by: Vivek Reddy <vivekr@splunk.com>

add ownership to config

97d4e18

order changed for config creation

1dc3d37

fix manualUpdate per CR

fb52259

vivekr-splunk requested a review from akondur November 21, 2024 06:29

vivekr-splunk and others added 11 commits November 21, 2024 06:33

unit test cases fixed

e53a19c

CSPL-2983: doc changes

c6044a1

Signed-off-by: Vivek Reddy <vivekr@splunk.com>

fixed unit test cases

59f9205

Signed-off-by: Vivek Reddy <vivekr@splunk.com>

uncomment unit test

49309e2

Signed-off-by: Vivek Reddy <vivekr@splunk.com>

adding go mod changes

8526218

Signed-off-by: Vivek Reddy <vivekr@splunk.com>

Merge branch 'develop' into feature/CSPL-2966

7816b9a

Merge branch 'develop' into feature/CSPL-2966

5dfba62

some more changes to go sum

3debe20

fixed mc list test case

c208301

fixed searchhead for dev merge

4803790

Signed-off-by: Vivek Reddy <vivekr@splunk.com>

adding per cr changes

4eb8128

Signed-off-by: Vivek Reddy <vivekrsplunk@github.com>

vivekr-splunk changed the title ~~[Draft]: CSPL-2966: Feature: Manual App Updates per Custom Resource (CR) in Splunk Operator~~ CSPL-2966: Feature: Manual App Updates per Custom Resource (CR) in Splunk Operator Jan 14, 2025

rlieberman-splunk reviewed Jan 21, 2025

View reviewed changes

pkg/splunk/enterprise/configuration.go Outdated Show resolved Hide resolved

test/appframework_aws/s1/appframework_aws_test.go Outdated Show resolved Hide resolved

test/appframework_aws/s1/appframework_aws_test.go Outdated Show resolved Hide resolved

fixed log messages removed comments

34d1914

Signed-off-by: Vivek Reddy <vivekrsplunk@github.com>

vivekr-splunk added the 2.7.1 label Jan 22, 2025

replaced test label

c5ddf52

Signed-off-by: Vivek Reddy <vivekrsplunk@github.com>

rlieberman-splunk approved these changes Jan 22, 2025

View reviewed changes

akondur approved these changes Jan 23, 2025

View reviewed changes

pkg/splunk/enterprise/configuration.go Outdated Show resolved Hide resolved

Vivek Reddy and others added 3 commits January 26, 2025 17:06

added few doc and code changes

f4cc54a

Signed-off-by: Vivek Reddy <vivekrsplunk@github.com>

Merge branch 'develop' into feature/CSPL-2966

ad65507

Merge branch 'develop' into feature/CSPL-2966

ddd712e

vivekr-splunk merged commit 9598514 into develop Jan 27, 2025
31 checks passed

vivekr-splunk deleted the feature/CSPL-2966 branch January 27, 2025 15:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CSPL-2966: Feature: Manual App Updates per Custom Resource (CR) in Splunk Operator #1395

CSPL-2966: Feature: Manual App Updates per Custom Resource (CR) in Splunk Operator #1395

vivekr-splunk commented Oct 28, 2024 •

edited

Loading

akondur left a comment

CSPL-2966: Feature: Manual App Updates per Custom Resource (CR) in Splunk Operator #1395

CSPL-2966: Feature: Manual App Updates per Custom Resource (CR) in Splunk Operator #1395

Conversation

vivekr-splunk commented Oct 28, 2024 • edited Loading

Description

Key Changes

Testing and Verification

Next Steps

Related Issues

akondur left a comment

Choose a reason for hiding this comment

vivekr-splunk commented Oct 28, 2024 •

edited

Loading