CSPL-3357: Enforce Acknowledgment of Splunk General Terms (SGT)

[rlieberman-splunk]

This description was generated in part by GitHub Copilot.

Description

This pull request introduces changes to support a mandatory acknowledgment mechanism for the Splunk General Terms (SGT) in the Splunk Operator for Kubernetes. The updates include adding a new SPLUNK_GENERAL_TERMS environment variable, modifying deployment configurations, and updating documentation to guide users on the new requirements.

Key Changes

Configuration Updates

• Added a new environment variable SPLUNK_GENERAL_TERMS with a default empty value in multiple configuration files, including Makefile, kustomization.yaml, and deployment manifests. This variable must be set to "--accept-current-at-splunk-com" to comply with the SGT acknowledgment mechanism. [1] [2] [3] [4] [5]

Deployment Behavior

• Updated deployment commands and scripts to include the SPLUNK_GENERAL_TERMS variable, ensuring it is passed during deployment or artifact generation. [1] [2] [3]

Documentation Enhancements

• Added detailed guidance in README.md and docs/Install.md on how to configure the SPLUNK_GENERAL_TERMS variable during deployment. [1] [2]
• Introduced a new FAQ document, SplunkGeneralTermsMigration.md, explaining the motivation, impact, and migration steps for the SGT acknowledgment mechanism.

Minor Fixes

• Corrected a typo in docs/AppFramework.md (changed "LicenceManager" to "LicenseManager").

Testing and Verification

• Existing unit tests have been updated to set the SPLUNK_GENERAL_TERMS environment variable
• Unit tests have been added for each CRD to test the creation failure if the SPLUNK_GENERAL_TERMS environment variable is not set
• Manual tests to deploy the operator and multiple different svas via helm and kubectl manifest files have been completed on an aws eks cluster
• Manual tests with the existing splunk operator and a splunk enterprise 10 version were completed to verify that the changes in this PR fix required changes for splunk 10

Related Issues

• https://splunk.atlassian.net/browse/CSPL-3357
• Documentation: https://docs.google.com/document/d/1NAXK0vfNVP4NxO-JYl7wme8bANfkdrMr7QHXbpLrdFk/edit?usp=sharing

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.