diff --git a/docs/deployment/helm-deployment.md b/docs/deployment/helm-deployment.md index cb3a8fd..067293e 100644 --- a/docs/deployment/helm-deployment.md +++ b/docs/deployment/helm-deployment.md @@ -63,19 +63,9 @@ Umbrella chart that includes: ### Deploy Operator + AIPlatform (All-in-One) -**IMPORTANT:** You must explicitly accept the Splunk General Terms before installing. -Review the terms at: https://www.splunk.com/en_us/legal/splunk-general-terms.html - ```bash # Create a values file cat > my-platform-values.yaml <" - # Object storage configuration objectStorage: path: "s3://my-bucket/artifacts" @@ -102,25 +92,16 @@ helm install my-ai-platform \ --values my-platform-values.yaml ``` -**Note**: For the required value for `splunkGeneralTerms`, see the [Splunk Operator README](https://github.com/splunk/splunk-operator?tab=readme-ov-file#splunk-general-terms-acceptance). - ### Deploy Operator Only -**IMPORTANT:** You must explicitly accept the Splunk General Terms. -Review the terms at: https://www.splunk.com/en_us/legal/splunk-general-terms.html - ```bash helm install splunk-ai-operator \ oci://ghcr.io/splunk/charts/splunk-ai-operator \ --version 0.1.0 \ --namespace splunk-ai-operator-system \ - --create-namespace \ - --set splunk-operator.acceptGeneralTerms=true \ - --set splunk-operator.splunkOperator.splunkGeneralTerms="" + --create-namespace ``` -**Note**: For the required value for `splunkGeneralTerms`, see the [Splunk Operator README](https://github.com/splunk/splunk-operator?tab=readme-ov-file#splunk-general-terms-acceptance). - ## Installation Methods ### Method 1: OCI Registry (Recommended) @@ -129,14 +110,11 @@ Requires Helm 3.8+: ```bash # Install operator -# NOTE: Requires Splunk General Terms acceptance helm install splunk-ai-operator \ oci://ghcr.io/splunk/charts/splunk-ai-operator \ --version 0.1.0 \ --namespace splunk-ai-operator-system \ - --create-namespace \ - --set splunk-operator.acceptGeneralTerms=true \ - --set splunk-operator.splunkOperator.splunkGeneralTerms="" + --create-namespace # Install platform helm install my-ai-platform \ @@ -147,21 +125,16 @@ helm install my-ai-platform \ --values values.yaml ``` -**Note**: For the required value for `splunkGeneralTerms`, see the [Splunk Operator README](https://github.com/splunk/splunk-operator?tab=readme-ov-file#splunk-general-terms-acceptance). - ### Method 2: GitHub Releases Compatible with Helm 3.0+: ```bash # Install operator -# NOTE: Requires Splunk General Terms acceptance helm install splunk-ai-operator \ https://github.com/splunk/splunk-ai-operator/releases/download/v0.1.0/splunk-ai-operator-0.1.0.tgz \ --namespace splunk-ai-operator-system \ - --create-namespace \ - --set splunk-operator.acceptGeneralTerms=true \ - --set splunk-operator.splunkOperator.splunkGeneralTerms="" + --create-namespace # Install platform helm install my-ai-platform \ @@ -171,8 +144,6 @@ helm install my-ai-platform \ --values values.yaml ``` -**Note**: For the required value for `splunkGeneralTerms`, see the [Splunk Operator README](https://github.com/splunk/splunk-operator?tab=readme-ov-file#splunk-general-terms-acceptance). - ### Method 3: kubectl (Manifests) For environments where Helm is not available: @@ -187,32 +158,19 @@ Use this when you want to manually create AIPlatform resources via kubectl. ### Basic Installation -**IMPORTANT:** You must explicitly accept the Splunk General Terms. -Review the terms at: https://www.splunk.com/en_us/legal/splunk-general-terms.html - ```bash helm install splunk-ai-operator \ oci://ghcr.io/splunk/charts/splunk-ai-operator \ --version 0.1.0 \ --namespace splunk-ai-operator-system \ - --create-namespace \ - --set splunk-operator.acceptGeneralTerms=true \ - --set splunk-operator.splunkOperator.splunkGeneralTerms="" + --create-namespace ``` -**Note**: For the required value for `splunkGeneralTerms`, see the [Splunk Operator README](https://github.com/splunk/splunk-operator?tab=readme-ov-file#splunk-general-terms-acceptance). - ### Custom Configuration Create `operator-values.yaml`: ```yaml -# Accept Splunk General Terms (REQUIRED) -splunk-operator: - acceptGeneralTerms: true - splunkOperator: - splunkGeneralTerms: "" - # Operator image configuration image: repository: ghcr.io/splunk/splunk-ai-operator @@ -263,8 +221,6 @@ helm install splunk-ai-operator \ --values operator-values.yaml ``` -**Note**: For the required value for `splunkGeneralTerms`, see the [Splunk Operator README](https://github.com/splunk/splunk-operator?tab=readme-ov-file#splunk-general-terms-acceptance). - ### View Operator Configuration Options ```bash @@ -541,14 +497,8 @@ helm install my-platform \ ### Example 1: Private Registry Configuration ```yaml -# Accept Splunk General Terms (REQUIRED) +# Use images from AWS ECR splunk-ai-operator: - splunk-operator: - acceptGeneralTerms: true - splunkOperator: - splunkGeneralTerms: "" - - # Use images from AWS ECR image: repository: "123456789012.dkr.ecr.us-west-2.amazonaws.com/splunk-ai-operator" tag: "v0.1.0" @@ -563,8 +513,6 @@ images: - name: ecr-registry-secret ``` -**Note**: For the required value for `splunkGeneralTerms`, see the [Splunk Operator README](https://github.com/splunk/splunk-operator?tab=readme-ov-file#splunk-general-terms-acceptance). - Create the image pull secret: ```bash @@ -578,13 +526,6 @@ kubectl create secret docker-registry ecr-registry-secret \ ### Example 2: Development/Testing Setup ```yaml -# Accept Splunk General Terms (REQUIRED) -splunk-ai-operator: - splunk-operator: - acceptGeneralTerms: true - splunkOperator: - splunkGeneralTerms: "" - # Minimal configuration for testing objectStorage: path: "s3://test-bucket" @@ -625,18 +566,9 @@ opentelemetry-operator: enabled: false ``` -**Note**: For the required value for `splunkGeneralTerms`, see the [Splunk Operator README](https://github.com/splunk/splunk-operator?tab=readme-ov-file#splunk-general-terms-acceptance). - ### Example 3: Production Setup with HA ```yaml -# Accept Splunk General Terms (REQUIRED) -splunk-ai-operator: - splunk-operator: - acceptGeneralTerms: true - splunkOperator: - splunkGeneralTerms: "" - objectStorage: path: "s3://prod-ai-bucket/artifacts" region: "us-west-2" @@ -694,8 +626,6 @@ sidecars: prometheusOperator: true ``` -**Note**: For the required value for `splunkGeneralTerms`, see the [Splunk Operator README](https://github.com/splunk/splunk-operator?tab=readme-ov-file#splunk-general-terms-acceptance). - ## Upgrading ### Upgrade Operator