# splunk-token-operator

**Repository Path**: mirrors_openshift/splunk-token-operator

## Basic Information

- **Project Name**: splunk-token-operator
- **Description**: Operator to manage the lifecycle of Splunk HTTP Event Collector tokens for hive-managed clusters
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-08-08
- **Last Updated**: 2026-01-31

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# splunk-token-operator
// TODO(user): Add simple overview of use/purpose

## Description
// TODO(user): An in-depth paragraph about your project and overview of use

## Getting Started

### Prerequisites
- go version v1.24.0+
- docker version 17.03+.
- kubectl version v1.11.3+.
- Access to a Kubernetes v1.11.3+ cluster.

### To Deploy on the cluster
**Build and push your image to the location specified by `IMG`:**

```sh
make docker-build docker-push IMG=<some-registry>/splunk-token-operator:tag
```

**NOTE:** This image ought to be published in the personal registry you specified.
And it is required to have access to pull the image from the working environment.
Make sure you have the proper permission to the registry if the above commands don’t work.

**Install the CRDs into the cluster:**

```sh
make install
```

**Deploy the Manager to the cluster with the image specified by `IMG`:**

```sh
make deploy IMG=<some-registry>/splunk-token-operator:tag
```

> **NOTE**: If you encounter RBAC errors, you may need to grant yourself cluster-admin
privileges or be logged in as admin.

**Create instances of your solution**
You can apply the samples (examples) from the config/sample:

```sh
kubectl apply -k config/samples/
```

>**NOTE**: Ensure that the samples has default values to test it out.

### To Uninstall
**Delete the instances (CRs) from the cluster:**

```sh
kubectl delete -k config/samples/
```

**Delete the APIs(CRDs) from the cluster:**

```sh
make uninstall
```

**UnDeploy the controller from the cluster:**

```sh
make undeploy
```

## Project Distribution

Following the options to release and provide this solution to the users.

### By providing a bundle with all YAML files

1. Build the installer for the image built and published in the registry:

```sh
make build-installer IMG=<some-registry>/splunk-token-operator:tag
```

**NOTE:** The makefile target mentioned above generates an 'install.yaml'
file in the dist directory. This file contains all the resources built
with Kustomize, which are necessary to install this project without its
dependencies.

2. Using the installer

Users can just run 'kubectl apply -f <URL for YAML BUNDLE>' to install
the project, i.e.:

```sh
kubectl apply -f https://raw.githubusercontent.com/<org>/splunk-token-operator/<tag or branch>/dist/install.yaml
```

## Contributing

> [!TIP]
> Run `make help` for more information on all potential `make` targets

More information can be found via the [Kubebuilder Documentation](https://book.kubebuilder.io/introduction.html)

## Testing

### Running Locally

#### Prerequisites

* The [project dependencies](/.tool-versions).
* [OpenShift Local](https://developers.redhat.com/products/openshift-local/overview),
[minikube](https://minikube.sigs.k8s.io/docs/), or any Kubernetes cluster where you have sufficient permissions.
* A Splunk Cloud authentication token with permissions to manage HEC tokens.

#### Steps

1. Start or log in to your cluster.
1. Create the required Kubernetes resources and apply them to your cluster.
    ```sh
    make dev-resources && kubectl apply -f dist/local.yaml
    ```
1. Add the Splunk token to your environment
    ```sh
    export SPLUNK_API_TOKEN=<splunk-token>
    ```
1. Run the operator.
    ```sh
    make run
    ```

You should see console output from the operator.
Since the local resources include a SplunkToken object the operator will reconcile it immediately.

> [!NOTE]
> The operator will use the [local configuration file](/config/local/config.toml).
> Change this file to meet your specific needs.

## License

Copyright 2025.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.