CSPL-4026: Update app framework documentation to deploy apps with multiple scopes #1598
Conversation
rlieberman-splunk
requested review from
kubabuczak,
vivekr-splunk,
patrykw-splunk,
Igor-splunk,
kasiakoziol,
gabrielm-splunk and
Copilot
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the App Framework documentation by adding comprehensive guides for deploying apps with multiple scopes on both Indexer Clusters and Search Head Clusters. The documentation now provides clear instructions for configuring apps to be installed both locally and across cluster peers using the same remote storage location.
- Added detailed installation guides for dual-scope app deployment on Indexer and Search Head Clusters
- Expanded the CRD support table to clarify install locations for different scopes and resource types
- Provided complete YAML examples for S3, Azure Blob, and GCP storage backends
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
…nto CSPL_4026_multiple_scope
|
I was going through this doc today and I think we should spend some time to simplify it. It is very long while it could be shortened to a part of it because there are many duplicates. |
Pull Request Test Coverage Report for Build 18386577711Details
💛 - Coveralls |
The most recent commit includes a refactoring of the whole file. I removed over 250 duplicated lines, added a table of contents, and put the contents in a more useful pattern (prerequisites, setting up access, creating the folder structure, and examples). |
| - [App is not correctly copying to pod](#app-is-not-correctly-copying-to-pod) | ||
|
|
||
| ## About App Framework | ||
|
|
||
| The Splunk Operator provides support for Splunk app and add-on deployment using the App Framework. The App Framework specification supports configuration management using the Splunk Enterprise cluster and standalone [custom resources](https://splunk.github.io/splunk-operator/CustomResources.html) (CR). |
There was a problem hiding this comment.
"using the Splunk Enterprise cluster and standalone" - do you know what someone meant here by "the Splunk Enterprise cluster"?
| * An Amazon S3 or S3-API-compliant remote object storage location | ||
| * Azure blob storage | ||
| * GCP Cloud Storage | ||
| 2) The App framework requires read-only access to the path used to host the apps. DO NOT give any other access to the operator to maintain the integrity of data in S3 bucket , Azure blob container or GCP bucket. | ||
| 3) Splunk apps and add-ons should be stored in a .tgz or .spl archive format. |
There was a problem hiding this comment.
We also added suport for .tar.gz - https://github.com/splunk/splunk-operator/blob/main/pkg/splunk/enterprise/util.go#L1242.
Description
This pull request adds comprehensive documentation for installing Splunk apps using the App Framework for both local and cluster scopes on Indexer Clusters and Search Head Clusters. It also expands the CRD support table to clarify install locations for each scope and resource type. The changes provide step-by-step instructions and example configurations for S3, Azure Blob, and GCP storage backends.
Key Changes
ClusterManager.yamlmanifests for S3, Azure Blob, and GCP buckets.SearchHeadCluster.yamlmanifests for S3, Azure Blob, and GCP buckets.Testing and Verification
Related Issues
PR Checklist