Updated naming throughout project per issue #117

Author: gp510

.gitignore

@@ -23,7 +23,7 @@ hs_err_pid*
 target/*
 .idea/*
 
-kafka-connect-splunk/
+splunk-kafka-connect/
 pom.xml.versionsBackup
 .classpath
 .project

README.md

@@ -17,25 +17,25 @@ A Kafka Connect Sink for Splunk features:
 
 ## Build
 
-1. Clone the repo from https://github.com/splunk/kafka-connect-splunk
+1. Clone the repo from https://github.com/splunk/splunk-kafka-connect
 2. Verify that Java8 JRE or JDK is installed.
 3. Run `bash build.sh`. The build script will download all dependencies and build the Splunk Kafka Connector.
 
-Note: The resulting "kafka-connect-splunk-*.tar.gz" package is self-contained. Bundled within it are the Kafka Connect framework, all 3rd party libraries, and the Splunk Kafka Connector.
+Note: The resulting "splunk-kafka-connect-*.tar.gz" package is self-contained. Bundled within it are the Kafka Connect framework, all 3rd party libraries, and the Splunk Kafka Connector.
 
 ## Quick Start
 
 1. [Start](https://kafka.apache.org/quickstart) your Kafka Cluster and confirm it is running.
 2. If this is a new install, create a test topic (eg: `perf`). Inject events into the topic. This can be done using [Kafka data-gen-app](https://github.com/dtregonning/kafka-data-gen) or the Kafka bundle [kafka-console-producer](https://kafka.apache.org/quickstart#quickstart_send).
-3. Untar the package created from the build script: `tar xzvf kafka-connect-splunk-*.tar.gz` (Default target location is /tmp/kafka-connect-splunk-build/kafka-connect-splunk).
-4. Navigate to kafka-connect-splunk directory `cd kafka-connect-splunk`.
+3. Untar the package created from the build script: `tar xzvf splunk-kafka-connect-*.tar.gz` (Default target location is /tmp/splunk-kafka-connect-build/splunk-kafka-connect).
+4. Navigate to splunk-kafka-connect directory `cd splunk-kafka-connect`.
 5. Adjust values for `bootstrap.servers` and `plugin.path` inside `config/connect-distributed-quickstart.properties` to fit your environment. Default values should work for experimentation.
 6. Run `./bin/connect-distributed.sh config/connect-distributed-quickstart.properties` to start Kafka Connect.
 7. Run the following command to create connector tasks. Adjust `topics` to set the topic, and  `splunk.hec.token`  to set your HEC token.
 
     ```
 	curl localhost:8083/connectors -X POST -H "Content-Type: application/json" -d '{
-	"name": "kafka-connect-splunk",
+	"name": "splunk-kafka-connect",
 	"config": {
 	   "connector.class": "com.splunk.kafka.connect.SplunkSinkConnector",
 	   "tasks.max": "3",
@@ -71,17 +71,17 @@ Note: The resulting "kafka-connect-splunk-*.tar.gz" package is self-contained. B
     # List active connectors
     curl http://localhost:8083/connectors
 
-    # Get kafka-connect-splunk connector info
-    curl http://localhost:8083/connectors/kafka-connect-splunk
+    # Get splunk-kafka-connect connector info
+    curl http://localhost:8083/connectors/splunk-kafka-connect
 
-    # Get kafka-connect-splunk connector config info
-    curl http://localhost:8083/connectors/kafka-connect-splunk/config
+    # Get splunk-kafka-connect connector config info
+    curl http://localhost:8083/connectors/splunk-kafka-connect/config
 
-    # Delete kafka-connect-splunk connector
-    curl http://localhost:8083/connectors/kafka-connect-splunk -X DELETE
+    # Delete splunk-kafka-connect connector
+    curl http://localhost:8083/connectors/splunk-kafka-connect -X DELETE
 
-    # Get kafka-connect-splunk connector task info
-    curl http://localhost:8083/connectors/kafka-connect-splunk/tasks
+    # Get splunk-kafka-connect connector task info
+    curl http://localhost:8083/connectors/splunk-kafka-connect/tasks
     ```
 
     See the [the Confluent doucumentation](https://docs.confluent.io/current/connect/managing.html#common-rest-examples) for additional REST examples.
@@ -98,11 +98,11 @@ Use the following connector deployment options:
 ### Connector in a dedicated Kafka Connect Cluster 
 Running the Splunk Kafka Connector in a dedicated Kafka Connect Cluster is recommended. Isolating the Splunk connector from other Kafka connectors results in significant performance benefits in high throughput environments.
 
-1. Untar the **kafka-connect-splunk-*.tar.gz** package and navigate to the **kafka-connect-splunk** directory.
+1. Untar the **splunk-kafka-connect-*.tar.gz** package and navigate to the **splunk-kafka-connect** directory.
 
     ```
-    tar xzvf kafka-connect-splunk-*.tar.gz
-    cd kafka-connect-splunk
+    tar xzvf splunk-kafka-connect-*.tar.gz
+    cd splunk-kafka-connect
     ```
 
 2. Update config/connect-distributed.properties to match your environment.
@@ -118,26 +118,26 @@ Running the Splunk Kafka Connector in a dedicated Kafka Connect Cluster is recom
 	> Note: The below topics should be created by Kafka Connect when deploying the Splunk Connector. If the Kafka Connect cluster **does not have permission** to create these topics, create these manually before starting Kafka Connect cluster.
 
     ```
-	group.id=kafka-connect-splunk-hec-sink    # consumer group id of Kafka Connect, which is used to form a Kafka Connect cluster
+	group.id=splunk-kafka-connect-hec-sink    # consumer group id of Kafka Connect, which is used to form a Kafka Connect cluster
 
-	config.storage.topic=__kafka-connect-splunk-task-configs # kafka topic used to persistent connector task configurations
+	config.storage.topic=__splunk-kafka-connect-task-configs # kafka topic used to persistent connector task configurations
 	config.storage.replication.factor=3
 
-	offset.storage.topic=__kafka-connect-splunk-offsets # kafka topic used to persistent task checkpoints
+	offset.storage.topic=__splunk-kafka-connect-offsets # kafka topic used to persistent task checkpoints
 	offset.storage.replication.factor=3
 	offset.storage.partitions=25
 
-	status.storage.topic=__kafka-connect-splunk-statuses # kafka topic used to persistent task statuses
+	status.storage.topic=__splunk-kafka-connect-statuses # kafka topic used to persistent task statuses
 	status.storage.replication.factor=3
 	status.storage.partitions=5
 	```
 
-4. Deploy/Copy the **kafka-connect-splunk** directory to all target hosts (virtual machines, physical machines or containers).
+4. Deploy/Copy the **splunk-kafka-connect** directory to all target hosts (virtual machines, physical machines or containers).
 5. Start Kafka Connect on all target hosts using the below commands:
 
 	```
-	cd kafka-connect-splunk
-	export KAFKA_HEAP_OPTS="-Xmx6G -Xms2G" && ./bin/connect-distributed.sh config/connect-distributed.properties >> kafka-connect-splunk.log 2>&1
+	cd splunk-kafka-connect
+	export KAFKA_HEAP_OPTS="-Xmx6G -Xms2G" && ./bin/connect-distributed.sh config/connect-distributed.properties >> splunk-kafka-connect.log 2>&1
 	```
 
 	> Note: The **KAFKA\_HEAP\_OPTS** environment variable controls how much memory Kafka Connect can use. Set the **KAFKA\_HEAP\_OPTS** with the recommended value stated in the example above.
@@ -167,13 +167,13 @@ internal.value.converter.schemas.enable=false
 offset.flush.interval.ms=10000
 
 #Recommended
-group.id=kafka-connect-splunk-hec-sink
-config.storage.topic=__kafka-connect-splunk-task-configs
+group.id=splunk-kafka-connect-hec-sink
+config.storage.topic=__splunk-kafka-connect-task-configs
 config.storage.replication.factor=3
-offset.storage.topic=__kafka-connect-splunk-offsets
+offset.storage.topic=__splunk-kafka-connect-offsets
 offset.storage.replication.factor=3
 offset.storage.partitions=25
-status.storage.topic=__kafka-connect-splunk-statuses
+status.storage.topic=__splunk-kafka-connect-statuses
 status.storage.replication.factor=3
 status.storage.partitions=5
 

build.sh

@@ -2,7 +2,7 @@
 
 # variables
 kafkaversion=0.11.0.2
-builddir=/tmp/kafka-connect-splunk-build/kafka-connect-splunk
+builddir=/tmp/splunk-kafka-connect-build/splunk-kafka-connect
 
 githash=`git rev-parse --short HEAD 2>/dev/null | sed "s/\(.*\)/@\1/"` # get current git hash
 gitbranch=`git rev-parse --abbrev-ref HEAD` # get current git branch
@@ -15,7 +15,7 @@ if [[ -z "$gitversion" ]]; then
   jarversion=${gitversion}-SNAPSHOT
 fi
 
-packagename=kafka-connect-splunk-${gitversion}.tar.gz
+packagename=splunk-kafka-connect-${gitversion}.tar.gz
 
 # record git info in version.properties file under resources folder
 resourcedir='src/main/resources'
@@ -39,8 +39,8 @@ mvn versions:set -DnewVersion=${jarversion}
 mvn package > /dev/null
 
 # Copy over the pacakge
-echo "Copy over kafka-connect-splunk jar ..."
-cp target/kafka-connect-splunk-${jarversion}.jar ${builddir}/connectors
+echo "Copy over splunk-kafka-connect jar ..."
+cp target/splunk-kafka-connect-${jarversion}.jar ${builddir}/connectors
 cp config/* ${builddir}/config
 cp README.md ${builddir}
 cp LICENSE ${builddir}
@@ -64,19 +64,19 @@ echo "Clean up ..."
 
 # Package up
 echo "Package ${packagename} ..."
-cd .. && tar czf ${packagename} kafka-connect-splunk
+cd .. && tar czf ${packagename} splunk-kafka-connect
 
 echo "Copy package ${packagename} to ${curdir} ..."
 cp ${packagename} ${curdir}
 
-/bin/rm -rf kafka-connect-splunk ${packagename}
+/bin/rm -rf splunk-kafka-connect ${packagename}
 echo "Done with build & packaging"
 
 echo
 
 cat << EOP
-To run the kafka-connect-splunk, do the following steps:
-1. untar the package: tar xzf kafka-connect-splunk.tar.gz
+To run the splunk-kafka-connect, do the following steps:
+1. untar the package: tar xzf splunk-kafka-connect.tar.gz
 2. config config/connect-distributed.properties according to your env
 3. run: bash bin/connect-distributed.sh config/connect-distributed.properties
 4. Use Kafka Connect REST api to create data collection tasks

ci/Jenkinsfile

@@ -8,7 +8,7 @@ def dockerReq = new DockerRequest(steps,
                                   env,
                                   [imageName: "repo.splunk.com/splunk/products/splact:1.0.9",
                                    userId: "10777",
-                                   repoName: "[email protected]:splunk/kafka-connect-splunk.git",
+                                   repoName: "[email protected]:splunk/splunk-kafka-connect.git",
                                    runner: "yarn",
                                    remotePath: "/build"])
 

ci/kafka_orca_gen.py

@@ -6,7 +6,7 @@
 
 DATA_GEN_IMAGE = 'repo.splunk.com/kafka-data-gen:0.4'
 KAFKA_IMAGE = 'repo.splunk.com/kafka-cluster:0.12'
-KAFKA_CONNECT_IMAGE = 'repo.splunk.com/kafka-connect-splunk:1.8'
+KAFKA_CONNECT_IMAGE = 'repo.splunk.com/splunk-kafka-connect:1.8'
 KAFKA_BASTION_IMAGE = 'repo.splunk.com/kafka-bastion:1.8'
 
 

ci/run_bastion.sh

@@ -1,15 +1,15 @@
 #!/bin/bash
 
 curdir=`pwd`
-git clone [email protected]:splunk/kafka-connect-splunk.git
+git clone [email protected]:splunk/splunk-kafka-connect.git
 branch=${KAFKA_CONNECT_BRANCH:-develop}
-cd kafka-connect-splunk && git checkout ${branch}
+cd splunk-kafka-connect && git checkout ${branch}
 
 duration=${SLEEP:-600}
 sleep ${duration}
 
-bash ${curdir}/kafka-connect-splunk/ci/fix_hosts.sh > /tmp/fixhosts 2>&1 &
+bash ${curdir}/splunk-kafka-connect/ci/fix_hosts.sh > /tmp/fixhosts 2>&1 &
 
-python ${curdir}/kafka-connect-splunk/ci/perf.py
+python ${curdir}/splunk-kafka-connect/ci/perf.py
 
 tail -f /dev/null

ci/run_kafka_connect.sh

@@ -1,17 +1,17 @@
 #!/bin/bash
 
-# Checkout, build and run kafka-connect-splunk in the fight
+# Checkout, build and run splunk-kafka-connect in the fight
 
 curdir=`pwd`
-git clone [email protected]:splunk/kafka-connect-splunk.git
+git clone [email protected]:splunk/splunk-kafka-connect.git
 
 branch=${KAFKA_CONNECT_BRANCH:-develop}
 # build the package
-cd kafka-connect-splunk && git checkout ${branch} && bash build.sh
+cd splunk-kafka-connect && git checkout ${branch} && bash build.sh
 
 # untar the package
-tar xzf kafka-connect-splunk*.tar.gz
-cd kafka-connect-splunk
+tar xzf splunk-kafka-connect*.tar.gz
+cd splunk-kafka-connect
 
 sed -i"" "[email protected]=.*@bootstrap.servers=$KAFKA_BOOTSTRAP_SERVERS@g" config/connect-distributed.properties
 
@@ -24,7 +24,7 @@ duration=${SLEEP:-300}
 sleep ${duration}
 
 echo "Run fix hosts"
-bash ${curdir}/kafka-connect-splunk/ci/fix_hosts.sh > /tmp/fixhosts 2>&1 &
+bash ${curdir}/splunk-kafka-connect/ci/fix_hosts.sh > /tmp/fixhosts 2>&1 &
 
 echo "Run proc monitor"
 cd proc_monitor

config/connect-distributed-quickstart.properties

@@ -25,15 +25,15 @@ offset.flush.interval.ms=10000
 
 plugin.path=connectors/
 
-group.id=kafka-connect-splunk-hec-sink
-config.storage.topic=__kafka-connect-splunk-task-configs
+group.id=splunk-kafka-connect-hec-sink
+config.storage.topic=__splunk-kafka-connect-task-configs
 config.storage.replication.factor=1
 
-offset.storage.topic=__kafka-connect-splunk-offsets
+offset.storage.topic=__splunk-kafka-connect-offsets
 offset.storage.replication.factor=1
 offset.storage.partitions=1
 
-status.storage.topic=__kafka-connect-splunk-statuses
+status.storage.topic=__splunk-kafka-connect-statuses
 status.storage.replication.factor=1
 status.storage.partitions=1
 

config/connect-distributed.properties

@@ -25,15 +25,15 @@ offset.flush.interval.ms=10000
 
 plugin.path=connectors/
 
-group.id=kafka-connect-splunk-hec-sink
-config.storage.topic=__kafka-connect-splunk-task-configs
+group.id=splunk-kafka-connect-hec-sink
+config.storage.topic=__splunk-kafka-connect-task-configs
 config.storage.replication.factor=3
 
-offset.storage.topic=__kafka-connect-splunk-offsets
+offset.storage.topic=__splunk-kafka-connect-offsets
 offset.storage.replication.factor=3
 offset.storage.partitions=25
 
-status.storage.topic=__kafka-connect-splunk-statuses
+status.storage.topic=__splunk-kafka-connect-statuses
 status.storage.replication.factor=3
 status.storage.partitions=5
 

dependency-reduced-pom.xml

@@ -2,9 +2,9 @@
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
   <modelVersion>4.0.0</modelVersion>
   <groupId>com.github.splunk.kafka.connect</groupId>
-  <artifactId>kafka-connect-splunk</artifactId>
-  <name>kafka-connect-splunk</name>
-  <version>dev-SNAPSHOT</version>
+  <artifactId>splunk-kafka-connect</artifactId>
+  <name>splunk-kafka-connect</name>
+  <version>v1.0.0-LAR</version>
   <build>
     <plugins>
       <plugin>