Skip to content

docs: Remove Splunk General Terms references from Helm deployment guide #76

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vivekr-splunk wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Remove Splunk General Terms references from Helm deployment guide #76

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 5 additions & 75 deletions docs/deployment/helm-deployment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <<EOF
# Accept Splunk General Terms (REQUIRED)
splunk-ai-operator:
splunk-operator:
acceptGeneralTerms: true
splunkOperator:
splunkGeneralTerms: "<required value>"

# Object storage configuration
objectStorage:
path: "s3://my-bucket/artifacts"
Expand All @@ -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="<required value>"
--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)
Expand All @@ -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="<required value>"
--create-namespace

# Install platform
helm install my-ai-platform \
Expand All @@ -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="<required value>"
--create-namespace

# Install platform
helm install my-ai-platform \
Expand All @@ -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:
Expand All @@ -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="<required value>"
--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: "<required value>"

# Operator image configuration
image:
repository: ghcr.io/splunk/splunk-ai-operator
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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: "<required value>"

# Use images from AWS ECR
image:
repository: "123456789012.dkr.ecr.us-west-2.amazonaws.com/splunk-ai-operator"
tag: "v0.1.0"
Expand All @@ -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
Expand All @@ -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: "<required value>"

# Minimal configuration for testing
objectStorage:
path: "s3://test-bucket"
Expand Down Expand Up @@ -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: "<required value>"

objectStorage:
path: "s3://prod-ai-bucket/artifacts"
region: "us-west-2"
Expand Down Expand Up @@ -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
Expand Down
Loading