Skip to content

Commit 6b371c4

Browse files
add link to required value for SGT, fix Jekyll hyperlinks (#1635)
1 parent 93c4e92 commit 6b371c4

File tree

4 files changed

+15
-17
lines changed

4 files changed

+15
-17
lines changed

docs/CustomResources.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -355,7 +355,7 @@ The MC pod is referenced by using the `monitoringConsoleRef` parameter. There is
355355

356356
## Examples of Guaranteed and Burstable QoS
357357

358-
You can change the CPU and memory resources, and assign different Quality of Services (QoS) classes to your pods using the [Kubernetes Quality of Service section](README.md#using-kubernetes-quality-of-service-classes). Here are some examples:
358+
You can change the CPU and memory resources, and assign different Quality of Services (QoS) classes to your pods. Here are some examples:
359359

360360
### A Guaranteed QoS Class example:
361361
Set equal ```requests``` and ```limits``` values for CPU and memory to establish a QoS class of Guaranteed.

docs/Helm.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -107,10 +107,8 @@ release "splunk-operator-test" uninstalled
107107

108108
## Splunk Enterprise deployments
109109

110-
The Splunk Enterprise chart allows you to install and configure Splunk Enterprise custom resources. The ```splunk/splunk-enterprise``` chart has the ```splunk/splunk-operator``` chart as a dependency by default. To satisfy the dependencies please use the following command:
111-
```
112-
helm dependency build splunk/splunk-enterprise
113-
```
110+
The Splunk Enterprise chart allows you to install and configure Splunk Enterprise custom resources. The ```splunk/splunk-enterprise``` chart has the ```splunk/splunk-operator``` chart as a dependency by default.
111+
114112
If the operator is already installed then you will need to disable the dependency:
115113
```
116114
helm install --set splunk-operator.enabled=false <RELEASE_NAME> splunk/splunk-enterprise -n <RELEASE_NAMESPACE>

docs/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ This repository is used to build the Splunk
1919
for Kubernetes (SOK). If you are just looking for documentation on how to
2020
deploy and use the latest release, please visit the published
2121
[Splunk Operator documentation site](https://splunk.github.io/splunk-operator/)
22-
or review the in-repo [Getting Started Documentation](GettingStarted.md).
22+
or review the in-repo [Getting Started Documentation](GettingStarted.html).
2323

2424
## Splunk General Terms Acceptance
2525

@@ -35,7 +35,7 @@ By default, the SPLUNK_GENERAL_TERMS environment variable will be set to an empt
3535
make deploy IMG=docker.io/splunk/splunk-operator:<tag name> WATCH_NAMESPACE="namespace1" RELATED_IMAGE_SPLUNK_ENTERPRISE="splunk/splunk:edge" SPLUNK_GENERAL_TERMS="--accept-sgt-current-at-splunk-com"
3636
```
3737

38-
For more information about this change, see the [Splunk General Terms Migration Documentation](SplunkGeneralTermsMigration.md).
38+
For more information about this change, see the [Splunk General Terms Migration Documentation](SplunkGeneralTermsMigration.html).
3939

4040
## Prerequisites
4141

@@ -107,7 +107,7 @@ In addition to the source code, this repository includes:
107107
* `tools`: Build scripts, templates, etc. used to build the container image
108108
* `config`: Kubernetes YAML templates used to install the Splunk Operator
109109
* `docs`: Getting Started Guide and other documentation in Markdown format
110-
* `test`: Integration test framework built using Ginko. See [docs](test/README.md) for more info.
110+
* `test`: Integration test framework built using Ginkgo. See [docs](https://github.com/splunk/splunk-operator/blob/main/test/README.md) for more info.
111111

112112
## Building the operator
113113

@@ -158,7 +158,7 @@ make run
158158
This will use your current Kubernetes context from `~/.kube/config` to manage
159159
resources in your current namespace.
160160

161-
Please see the [Getting Started Documentation](GettingStarted.md) for more
161+
Please see the [Getting Started Documentation](GettingStarted.html) for more
162162
information, including instructions on how to install the operator in your
163163
cluster.
164164

docs/SplunkGeneralTermsMigration.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ All users deploying Splunk Enterprise 10.x or later image versions instances mus
1616

1717
Starting with the 3.0.0 release, there is now a mandatory acknowledgment mechanism for the Splunk General Terms (SGT) within the Splunk Operator for Kubernetes. **This is a breaking change, and user action is required.** This involves creating a new `SPLUNK_GENERAL_TERMS` environment variable in the splunk operator deployment, which gets passed to every CRD.
1818

19-
To learn more about the required value for this variable, please see the [README](../README.md) or Splunk Enterprise 10.x image’s README.
19+
To learn more about the required value for this variable, please see the [README](index.html#splunk-general-terms-acceptance) or Splunk Enterprise 10.x image’s README.
2020

2121
## How does this affect existing deployments?
2222

@@ -25,11 +25,11 @@ Existing deployments of the Splunk Operator for Kubernetes will not be affected
2525
## How to plan for a migration?
2626

2727
When you are ready to upgrade from version 1.x.x or 2.x.x to 3.0.0 or later, there are a few options you have to set the `SPLUNK_GENERAL_TERMS` to the proper value. By default, the SPLUNK_GENERAL_TERMS environment variable will be set to an empty string.
28-
1. Pass the `SPLUNK_GENERAL_TERMS` parameter with the required value to the `make deploy` command
28+
1. Pass the `SPLUNK_GENERAL_TERMS` parameter with the [required value](index.html#splunk-general-terms-acceptance) to the `make deploy` command.
2929
```
30-
make deploy IMG=docker.io/splunk/splunk-operator:<tag name> SPLUNK_GENERAL_TERMS="[required value]"
30+
make deploy IMG=docker.io/splunk/splunk-operator:<tag name> SPLUNK_GENERAL_TERMS="<required value>"
3131
```
32-
2. Update the value in the Splunk Operator installation file from the release on GitHub
32+
2. Update the value in the Splunk Operator installation file from the [release](https://github.com/splunk/splunk-operator/releases/latest) on GitHub with the [required value](index.html#splunk-general-terms-acceptance).
3333
```yaml
3434
...
3535
env:
@@ -40,19 +40,19 @@ make deploy IMG=docker.io/splunk/splunk-operator:<tag name> SPLUNK_GENERAL_TERMS
4040
- name: OPERATOR_NAME
4141
value: splunk-operator
4242
- name: SPLUNK_GENERAL_TERMS
43-
value: "[required value]"
43+
value: "<required value>"
4444
- name: POD_NAME
4545
valueFrom:
4646
fieldRef:
4747
apiVersion: v1
4848
fieldPath: metadata.name
4949
...
5050
```
51-
3. Set the value in a `helm install` command
51+
3. Set the [required value](index.html#splunk-general-terms-acceptance) in a `helm install` command.
5252
```
53-
helm install -f new_values.yaml --set splunkOperator.splunkGeneralTerms="[required value]" <RELEASE_NAME> splunk/splunk-operator -n <RELEASE_NAMESPACE>
53+
helm install -f new_values.yaml --set splunkOperator.splunkGeneralTerms="<required value>" <RELEASE_NAME> splunk/splunk-operator -n <RELEASE_NAMESPACE>
5454
```
55-
4. Edit the splunk-operator-controller-manager deployment after it is deployed
55+
4. Edit the splunk-operator-controller-manager deployment after it is deployed to include the [required value](index.html#splunk-general-terms-acceptance).
5656
```
5757
kubectl edit deployment splunk-operator-controller-manager -n splunk-operator
5858
```

0 commit comments

Comments
 (0)