Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 0 additions & 2 deletions docs/Examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ deployments.
- [Indexer part](#indexer-part)
- [Search Head Clusters](#search-head-clusters)
- [Cluster Services](#cluster-services)
- [Creating a Cluster with Data Fabric Search (DFS)](#creating-a-cluster-with-data-fabric-search-dfs)
- [Cleaning Up](#cleaning-up)
- [Smartstore Index Management](#smartstore-index-management)
- [Using Default Settings](#using-default-settings)
Expand Down Expand Up @@ -340,7 +339,6 @@ resources in favor of `Standalone`, unless you have a specific reason not to.
To remove the resources created from this example, run

```
kubectl delete standalone dfsexample
kubectl delete standalone single
kubectl delete shc example
kubectl delete idc example
Expand Down
61 changes: 0 additions & 61 deletions docs/FAQ.md

This file was deleted.

60 changes: 23 additions & 37 deletions docs/Images.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,25 @@
# Required Docker Images

The Splunk operator requires three docker images to be present or available
to your Kubernetes cluster:
The Splunk Operator requires three docker images to be present or available to your Kubernetes cluster:

* `splunk/splunk-operator`: The Splunk Operator image (built by this repository)
* `splunk/splunk:8.1.0`: The [Splunk Enterprise image](https://github.com/splunk/docker-splunk) (8.1.0 or later)

All of these images are publicly available on [Docker Hub](https://hub.docker.com/).
If your cluster does not have access to pull from Docker Hub, you will need to
manually download and push these images to an accessible registry. You will
also need to specify the location of these images by using either an environment
variable passed to the operator or adding additional `spec` parameters to your
All of these images are publicly available, and published on [Docker Hub](https://hub.docker.com/).

If your cluster does not have access to pull directly from Docker Hub, you will need to manually download and push these images to an accessible registry. You will also need to specify the location of these images by using an environment variable passed to the Operator, or by adding additional `spec` parameters to your
custom resource definition.

Use the `RELATED_IMAGE_SPLUNK_ENTERPRISE` environment variable or the `image`
custom resource parameter to change the location of the Splunk Enterprise
image. Please see the
[Advanced Installation Instructions](Install.md) or
[Custom Resource Guide](CustomResources.md) for more details.
Use the `RELATED_IMAGE_SPLUNK_ENTERPRISE` environment variable or the `image` custom resource parameter to change the location of your Splunk Enterprise image.

For additional detail, see the [Advanced Installation Instructions](Install.md) page, and the [Custom Resource Guide](CustomResources.md) page.


## Using a Private Registry
## Using a private registry

If your Kubernetes workers have access to pull from a Private registry, it is
easiest to retag and push the required images to directly to the private registry.
If your Kubernetes workers have access to pull from a private registry, it is easy to retag and push the required images to directly to your private registry.

For example, users of Amazon’s Elastic Container Registry may do something
like the following:
An example of tagging with an Amazon Elastic Container Registry:

```
$(aws ecr get-login --no-include-email --region us-west-2)
Expand All @@ -36,10 +29,9 @@ docker tag splunk/splunk-operator:latest 111000.dkr.ecr.us-west-2.amazonaws.com/
docker push 111000.dkr.ecr.us-west-2.amazonaws.com/splunk/splunk-operator:latest
```

(Note that you need to replace "111000" with your account number, and
"us-west-2" with your region)
Note that you need to replace "111000" with your account number, and "us-west-2" with your region.

Users of Google Kubernetes Engine may do something like the following:
An example of tagging using the Google Kubernetes Engine:

```
gcloud auth configure-docker
Expand All @@ -49,47 +41,41 @@ docker tag splunk/splunk-operator:latest gcr.io/splunk-operator-testing/splunk-o
docker push gcr.io/splunk-operator-testing/splunk-operator:latest
```

(Note that you need to replace "splunk-operator-testing" with the name of your GKE cluster)
Note that you need to replace "splunk-operator-testing" with the name of your GKE cluster.


## Manually Exporting and Importing Images
## Manually exporting and importing images

Another option is to export each of the required images to a tarball, transfer
the tarball to each of your Kubernetes workers (perhaps using something like
Ansible, Puppet or Chef), and import the images on your workers.
Another option is to export each of the required images as a tarball, transfer the tarball to each of your Kubernetes workers using a tool such as Ansible, Puppet, or Chef, and import the images on your workers.

For example, you can use the following to export the `splunk/splunk-operator`
image to a tarball:
For example, you can export the `splunk/splunk-operator`image to a tarball:

```
docker image save splunk/splunk-operator:latest | gzip -c > splunk-operator.tar.gz
```

On your Kubernetes workers, you can then import this image using:
And on your Kubernetes workers, you can import the tarball using:

```
docker load -i splunk-operator.tar.gz
```


## Simple Script to Push Images
## A simple script to push images

The script `build/push_images.sh` is included to push Docker images to multiple remote hosts using SSH. The script takes the name of a container and an image path, and pushes the image to all the entries in `push_targets`.

`build/push_images.sh` is a simple script that makes it easier to push docker
images to multiple remote hosts, using the SSH protocol.
To use the script:

Create a file in your current working directory named `push_targets`. This
file should include every host that you want to push images to, one user@host
on each line. For example:
1. Create a file in your current working directory named `push_targets`. This file should include every host that you want to push images to, one `user@host` on each line. For example:

```
ubuntu@myvm1.splunk.com
ubuntu@myvm2.splunk.com
ubuntu@myvm3.splunk.com
```

This script takes one argument, the name of a container, and pushes it to
all the entries in `push_targets`. For example, you can push the
`splunk/splunk-operator` image to each of these nodes by running
2. Run the script with the image path. For example, you can push the `splunk/splunk-operator` image to each of these nodes by running:

```
./build/push_images.sh splunk/splunk-operator
Expand Down
Loading