migrated to io.conduktor (#106)

* migrated to io.conduktor

* removed failing test again..

* changed version to 0.11-SNAPSHOT

Author: simplesteph

.bsp/sbt.json

@@ -0,0 +1 @@
+{"name":"sbt","version":"1.5.2","bspVersion":"2.0.0-M5","languages":["scala"],"argv":["/Users/stephanemaarek/.sdkman/candidates/java/11.0.10.9.1-amzn/bin/java","-Xms100m","-Xmx100m","-classpath","/Users/stephanemaarek/Library/Application Support/JetBrains/IntelliJIdea2020.3/plugins/Scala/launcher/sbt-launch.jar","xsbt.boot.Boot","-bsp","--sbt-launch-jar=/Users/stephanemaarek/Library/Application%20Support/JetBrains/IntelliJIdea2020.3/plugins/Scala/launcher/sbt-launch.jar"]}

CHANGELOG.md

@@ -4,7 +4,9 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-## [0.11.0] - SNAPSHOT
+## [0.11] - SNAPSHOT
+- Renamed packages to `io.conduktor`
+- Prepared release to sonatype and Maven
 
 ## [0.10.2] - 12/05/2021
 - Removed gRPC

README.md

@@ -92,13 +92,13 @@ This is a Scala app and therefore should run on the JVM like any other applicati
 
 By using the JAR dependency, you can create your own `SourceAcl`.
 
-SNAPSHOTS artifacts are deployed to [Sonatype](https://oss.sonatype.org/content/repositories/snapshots/com/github/conduktor/ksm/)
+SNAPSHOTS artifacts are deployed to [Sonatype](https://oss.sonatype.org/content/repositories/snapshots/io/conduktor/)
 
-RELEASES artifacts are deployed to [Maven Central](http://search.maven.org/#search%7Cga%7C1%7Ccom.github.conduktor):
+RELEASES artifacts are deployed to [Maven Central](http://search.maven.org/#search%7Cga%7C1%7Cio.conduktor):
 
-`build.sbt` (see [Maven Central](http://search.maven.org/#search%7Cga%7C1%7Ccom.github.conduktor) for the latest `version`)
+`build.sbt` (see [Maven Central](http://search.maven.org/#search%7Cga%7C1%7Cio.conduktor) for the latest `version`)
 ```
-libraryDependencies += "com.github.conduktor" %% "kafka-security-manager" % "version"
+libraryDependencies += "io.conduktor" %% "kafka-security-manager" % "version"
 ```
 
 # Configuration
@@ -128,7 +128,7 @@ Client {
 ```
 
 ## Security configuration - Admin client
-When configured authorizer class is `com.github.conduktor.ksm.compat.AdminClientAuthorizer`,
+When configured authorizer class is `io.conduktor.ksm.compat.AdminClientAuthorizer`,
 `kafka-security-manager` will use kafka admin client instead of direct zookeeper connection.
 Configuration example would be
 ```
@@ -160,7 +160,7 @@ The [default configurations](src/main/resources/application.conf) can be overwri
   - `AUTHORIZER_ZOOKEEPER_CONNECT`: zookeeper connection string
   - `AUTHORIZER_ZOOKEEPER_SET_ACL=true` (default `false`): set to true if you want your ACLs in Zookeeper to be secure (you probably do want them to be secure) - when in doubt set as the same as your Kafka brokers.
 
-  No-zookeeper authorizer class on top of Kafka Admin Client is bundled with KSM as `com.github.conduktor.ksm.compat.AdminClientAuthorizer`,
+  No-zookeeper authorizer class on top of Kafka Admin Client is bundled with KSM as `io.conduktor.ksm.compat.AdminClientAuthorizer`,
   configured with options for `org.apache.kafka.clients.admin.AdminClientConfig`:
   - `ADMIN_CLIENT_ID` - `client.id`, an id to pass to the server when making requests, for tracing/audit purposes, default `kafka-security-manager`
   Properties below are not provided to client unless environment variable is set:
@@ -175,25 +175,25 @@ The [default configurations](src/main/resources/application.conf) can be overwri
   - `ADMIN_CLIENT_SSL_TRUSTSTORE_PASSWORD` - `ssl.truststore.password`
 
 - `SOURCE_CLASS`: Source class. Valid values include
-    - `com.github.conduktor.ksm.source.NoSourceAcl` (default): No source for the ACLs. Only use with `KSM_READONLY=true`
-    - `com.github.conduktor.ksm.source.FileSourceAcl`: get the ACL source from a file on disk. Good for POC
-    - `com.github.conduktor.ksm.source.GitHubSourceAcl`: get the ACL from GitHub. Great to get started quickly and store the ACL securely under version control.
-    - `com.github.conduktor.ksm.source.GitLabSourceAcl`: get the ACL from GitLab using personal access tokens. Great to get started quickly and store the ACL securely under version control.
+    - `io.conduktor.ksm.source.NoSourceAcl` (default): No source for the ACLs. Only use with `KSM_READONLY=true`
+    - `io.conduktor.ksm.source.FileSourceAcl`: get the ACL source from a file on disk. Good for POC
+    - `io.conduktor.ksm.source.GitHubSourceAcl`: get the ACL from GitHub. Great to get started quickly and store the ACL securely under version control.
+    - `io.conduktor.ksm.source.GitLabSourceAcl`: get the ACL from GitLab using personal access tokens. Great to get started quickly and store the ACL securely under version control.
       - `SOURCE_GITLAB_REPOID` GitLab project id
       - `SOURCE_GITLAB_FILEPATH` Path to the ACL file in GitLab project
       - `SOURCE_GITLAB_BRANCH` Git Branch name
       - `SOURCE_GITLAB_HOSTNAME` GitLab Hostname
       - `SOURCE_GITLAB_ACCESSTOKEN` GitLab Personal Access Token. See [Personal access tokens
 ](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html) to authenticate with the GitLab API.
-    - `com.github.conduktor.ksm.source.S3SourceAcl`: get the ACL from S3. Good for when you have a S3 bucket managed by Terraform or Cloudformation. This requires `region`, `bucketname` and `objectkey`. See [Access credentials](https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/credentials.html) for credentials management.
+    - `io.conduktor.ksm.source.S3SourceAcl`: get the ACL from S3. Good for when you have a S3 bucket managed by Terraform or Cloudformation. This requires `region`, `bucketname` and `objectkey`. See [Access credentials](https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/credentials.html) for credentials management.
       - `SOURCE_S3_REGION` AWS S3 Region
       - `SOURCE_S3_BUCKETNAME` AWS S3 Bucket name
       - `SOURCE_S3_OBJECTKEY` The Object containing the ACL CSV in S3
-    - `com.github.conduktor.ksm.source.BitbucketServerSourceAcl`: get the ACL from Bitbucket Server using the v1 REST API. Great if you have private repos in Bitbucket.
-    - `com.github.conduktor.ksm.source.BitbucketCloudSourceAcl`: get the ACL from Bitbucket Cloud using the Bitbucket Cloud REST API v2.
+    - `io.conduktor.ksm.source.BitbucketServerSourceAcl`: get the ACL from Bitbucket Server using the v1 REST API. Great if you have private repos in Bitbucket.
+    - `io.conduktor.ksm.source.BitbucketCloudSourceAcl`: get the ACL from Bitbucket Cloud using the Bitbucket Cloud REST API v2.
 - `NOTIFICATION_CLASS`: Class for notification in case of ACL changes in Kafka.
-    - `com.github.conduktor.ksm.notification.ConsoleNotification` (default): Print changes to the console. Useful for logging
-    - `com.github.conduktor.ksm.notification.SlackNotification`: Send notifications to a Slack channel (useful for devops / admin team)
+    - `io.conduktor.ksm.notification.ConsoleNotification` (default): Print changes to the console. Useful for logging
+    - `io.conduktor.ksm.notification.SlackNotification`: Send notifications to a Slack channel (useful for devops / admin team)
 - `ACL_PARSER_CSV_DELIMITER`: Change the delimiter character for the CSV Parser (useful when you have SSL)
 
 # Running on Docker
@@ -254,7 +254,8 @@ You can then use place this CSV anywhere and use it as your source of truth.
 
 KSM Version | Kafka Version | Notes
 --- | --- | ---
-0.10 | 2.5.x | YAML support<br>Add configurable num failed refreshes before notification 
+0.11.0 | 2.5.x | renamed packages to `io.conduktor` 
+0.10.0 | 2.5.x | YAML support<br>Add configurable num failed refreshes before notification 
 0.9 | 2.5.x | Upgrade to Kafka 2.5.x
 0.8 | 2.3.1 | Add a "run once" mode
 0.7 | 2.1.1 | Kafka Based ACL refresher available (no zookeeper dependency)

build.sbt

@@ -16,7 +16,7 @@ inThisBuild(List(
 name := "kafka-security-manager"
 
 
-version := "0.11.0-SNAPSHOT"
+version := "1.0-SNAPSHOT"
 
 scalaVersion := "2.12.8"
 
@@ -65,7 +65,7 @@ libraryDependencies ++= Seq(
 
 )
 
-mainClass in Compile := Some("com.github.conduktor.ksm.KafkaSecurityManager")
+mainClass in Compile := Some("io.conduktor.ksm.KafkaSecurityManager")
 
 parallelExecution in Test := false
 

docker-compose.yml

@@ -33,10 +33,10 @@ services:
       KSM_READONLY: "false"
       AUTHORIZER_ZOOKEEPER_CONNECT: "zoo1:2181"
       # FILE:
-      SOURCE_CLASS: "com.github.conduktor.ksm.source.FileSourceAcl"
+      SOURCE_CLASS: "io.conduktor.ksm.source.FileSourceAcl"
       SOURCE_FILE_FILENAME: "example/acls.csv"
       # GITHUB:
-#      SOURCE_CLASS: "com.github.conduktor.ksm.source.GitHubSourceAcl"
+#      SOURCE_CLASS: "io.conduktor.ksm.source.GitHubSourceAcl"
 #      SOURCE_GITHUB_USER: "conduktor"
 #      SOURCE_GITHUB_REPO: "kafka-security-manager-example"
 #      SOURCE_GITHUB_FILEPATH: "acls.csv"
@@ -46,7 +46,7 @@ services:
       # REQUIRES KAFKA TO BE CONFIGURED IN SECURED MODE
       # PR ACCEPTED :)
 
-      # AUTHORIZER_CLASS: "com.github.conduktor.ksm.compat.AdminClientAuthorizer"
+      # AUTHORIZER_CLASS: "io.conduktor.ksm.compat.AdminClientAuthorizer"
       # ADMIN_CLIENT_BOOTSTRAP_SERVERS: "kafka1:19092"
       # set ADMIN_CLIENT_SECURITY_PROTOCOL, ADMIN_CLIENT_SASL_JAAS_CONFIG, ADMIN_CLIENT_SASL_MECHANISM, ADMIN_CLIENT_SSL_KEY_PASSWORD, ADMIN_CLIENT_SSL_KEYSTORE_LOCATION, ADMIN_CLIENT_SSL_KEYSTORE_PASSWORD, ADMIN_CLIENT_SSL_TRUSTSTORE_LOCATION, ADMIN_CLIENT_SSL_TRUSTSTORE_PASSWORD for a secure Kafka setup
     volumes:

src/main/resources/application.conf

@@ -31,7 +31,7 @@ authorizer {
   class = "kafka.security.auth.SimpleAclAuthorizer"
   class = ${?AUTHORIZER_CLASS}
   admin-client-config {
-    // options below needed when AUTHORIZER_CLASS is "com.github.conduktor.ksm.compat.AdminClientAuthorizer"
+    // options below needed when AUTHORIZER_CLASS is "io.conduktor.ksm.compat.AdminClientAuthorizer"
     // see org.apache.kafka.clients.admin.AdminClientConfig for more options
     "client.id"               = "kafka-security-manager"
     "client.id"               = ${?ADMIN_CLIENT_ID}
@@ -57,7 +57,7 @@ authorizer {
 
 source {
   // we default to a no "source" acl
-  class = "com.github.conduktor.ksm.source.NoSourceAcl"
+  class = "io.conduktor.ksm.source.NoSourceAcl"
   class = ${?SOURCE_CLASS}
   file {
     filename = "example/acls.csv"
@@ -136,7 +136,7 @@ source {
 }
 
 notification {
-  class = "com.github.conduktor.ksm.notification.ConsoleNotification"
+  class = "io.conduktor.ksm.notification.ConsoleNotification"
   class = ${?NOTIFICATION_CLASS}
   console {
 

src/main/scala/com/github/conduktor/ksm/AclSynchronizer.scala renamed to src/main/scala/io/conduktor/ksm/AclSynchronizer.scala

@@ -1,7 +1,8 @@
-package com.github.conduktor.ksm
+package io.conduktor.ksm
 
-import com.github.conduktor.ksm.notification.Notification
-import com.github.conduktor.ksm.source.{ParsingContext, SourceAcl}
+import io.conduktor.ksm.source.SourceAcl
+import io.conduktor.ksm.notification.Notification
+import io.conduktor.ksm.source.{ParsingContext, SourceAcl}
 import kafka.security.auth.{Acl, Authorizer, Resource}
 import org.slf4j.{Logger, LoggerFactory}
 

src/main/scala/com/github/conduktor/ksm/AppConfig.scala renamed to src/main/scala/io/conduktor/ksm/AppConfig.scala

@@ -1,9 +1,9 @@
-package com.github.conduktor.ksm
+package io.conduktor.ksm
 
-import com.github.conduktor.ksm.notification.Notification
-import com.github.conduktor.ksm.parser.AclParserRegistry
-import com.github.conduktor.ksm.source.SourceAcl
 import com.typesafe.config.Config
+import io.conduktor.ksm.notification.Notification
+import io.conduktor.ksm.parser.AclParserRegistry
+import io.conduktor.ksm.source.SourceAcl
 import kafka.security.auth.Authorizer
 import kafka.utils.CoreUtils
 

src/main/scala/com/github/conduktor/ksm/ExtractAcl.scala renamed to src/main/scala/io/conduktor/ksm/ExtractAcl.scala

@@ -1,6 +1,6 @@
-package com.github.conduktor.ksm
+package io.conduktor.ksm
 
-import com.github.conduktor.ksm.parser.AclParser
+import io.conduktor.ksm.parser.AclParser
 import kafka.security.auth.{Acl, Authorizer, Resource}
 import org.slf4j.{Logger, LoggerFactory}
 

src/main/scala/com/github/conduktor/ksm/KafkaSecurityManager.scala renamed to src/main/scala/io/conduktor/ksm/KafkaSecurityManager.scala

@@ -1,7 +1,7 @@
-package com.github.conduktor.ksm
+package io.conduktor.ksm
 
-import com.github.conduktor.ksm.parser.AclParserRegistry
 import com.typesafe.config.ConfigFactory
+import io.conduktor.ksm.parser.AclParserRegistry
 import org.slf4j.LoggerFactory
 
 import java.util.concurrent.atomic.AtomicBoolean