Skip to content

Conversation

@rlieberman-splunk
Copy link
Collaborator

Description

This pull request introduces improvements and additional cleanup steps to the EKS cluster setup and teardown scripts, focusing on more robust resource management and clearer configuration. The most significant change is the addition of automated deletion of EBS volumes associated with the cluster during cleanup, ensuring no orphaned storage resources remain after cluster deletion. There are also enhancements to image configuration documentation and S3 endpoint handling.

Related Issues

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Refactoring (no functional changes)
  • Performance improvement
  • Test improvement
  • CI/CD improvement
  • Chore (dependency updates, etc.)

Changes Made

Resource Cleanup Improvements

  • Added a new delete_cluster_ebs_volumes function to automatically find and delete all EBS volumes associated with the cluster, including those tagged by Kubernetes and the EBS CSI driver. This function is now called as part of the delete_cluster_minimal cleanup process.
  • Updated cleanup summary and verification instructions to include EBS volume deletion, and provided commands to check for any remaining volumes after cleanup.

Configuration and Documentation Enhancements

  • Improved documentation for specifying Splunk Enterprise image paths in cluster-config.yaml, clarifying the difference between relative and full image paths and their resulting behavior.
  • Ensured the Splunk Operator is configured with the correct full image URL by using the build_image_url helper function during installation.
  • Modified S3 endpoint configuration to use region-specific endpoints, improving compatibility with multi-region deployments.

Testing Performed

Ran ./eks_cluster_with_stack delete-full to clean up and existing cluster and verified all EBS resources were deleted.

  • Unit tests pass (make test)
  • Linting passes (make lint)
  • Integration tests pass (if applicable)
  • E2E tests pass (if applicable)
  • Manual testing performed

Documentation

  • Updated inline code comments
  • Updated README.md (if adding features)
  • Updated API documentation
  • Updated deployment guides
  • Updated CHANGELOG.md
  • No documentation needed

Checklist

  • My code follows the project's style guidelines
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published
  • I have updated the Helm chart version (if applicable)
  • I have updated CRD schemas (if applicable)

Additional Notes

These changes were requested by a Splunk employee who is going through the ai tier setup.

@coveralls
Copy link

coveralls commented Dec 5, 2025

Pull Request Test Coverage Report for Build 19974079302

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 36.822%

Totals Coverage Status
Change from base Build 19728053519: 0.0%
Covered Lines: 2336
Relevant Lines: 6344

💛 - Coveralls

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This pull request enhances the EKS cluster setup script with improved resource cleanup capabilities and configuration documentation. The primary focus is on preventing orphaned EBS volumes after cluster deletion, along with fixes to image URL handling and S3 endpoint configuration.

Key changes:

  • Added automated EBS volume cleanup function that identifies and deletes volumes associated with the cluster during teardown
  • Fixed Splunk Operator image configuration to use the build_image_url helper for consistent image URL handling
  • Updated S3 endpoint configuration for regional deployments (though with an incorrect format that needs correction)

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
tools/cluster_setup/eks_cluster_with_stack.sh Added delete_cluster_ebs_volumes function for EBS cleanup, integrated it into the minimal delete workflow, fixed Splunk Operator image URL handling, and updated S3 endpoint configuration
tools/cluster_setup/cluster-config.yaml Enhanced documentation for Splunk Enterprise image path configuration, clarifying the difference between relative and full image paths

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants