jikkou
The Open source Resource as Code framework for Apache Kafka. Jikkou helps you implement GitOps for Kafka at scale!
Safety scan
A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.
Badge for your README
Markdown
[](/listings/streamthoughts--kafka-specs)HTML
<a href="/listings/streamthoughts--kafka-specs"><img src="/api/listings/streamthoughts--kafka-specs/badge.svg" alt="findsafeskills safety rating" /></a>Install
Install instructions from the README
As written by the repo's author. findsafeskills has not verified these steps.
Install
# Via SDKMan (recommended) sdk install jikkou # Or via Docker docker pull streamthoughts/jikkou
> See the full [installation guide](https://jikkou.io/docs/install/) for native binaries, Homebrew, and more.
Define a Kafka topic
# kafka-topics.yaml
apiVersion: 'kafka.jikkou.io/v1beta2'
kind: 'KafkaTopic'
metadata:
name: 'my-topic'
spec:
partitions: 12
replicas: 3
configs:
min.insync.replicas: 2Preview, then apply
# Preview the change against the real cluster, not a state file jikkou diff --files ./kafka-topics.yaml # Apply it jikkou apply --files ./kafka-topics.yaml
That's it. Jikkou computes the diff and applies only the necessary changes:
TASK [CREATE] Create a new topic my-topic (partitions=12, replicas=3) - CHANGED EXECUTION in 2s 661ms ok: 0, created: 1, altered: 0, deleted: 0, failed: 0
What was scanned
The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.
.claude-plugin/marketplace.json · Manifest · 11 lines
View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)
- {
- "name": "jikkou",
- "owner": { "name": "Jikkou" },
- "plugins": [
- {
- "name": "jikkou",
- "source": "./",
- "description": "Official Jikkou skills for AI agents: manage Kafka topics, ACLs, quotas, schemas, and connectors declaratively with the Jikkou CLI."
- }
- ]
- }
README.md · README · 224 lines
View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)
- <p align="center">
- <img src="./assets/jikkou-logo-title.png" alt="Jikkou Logo" width="400"/>
- </p>
- <h3 align="center">Resource as Code for Apache Kafka and beyond</h3>
- <p align="center">
- Topics, ACLs, schemas, quotas, and connectors: declared in Git, reconciled against your real clusters.<br/>
- Kafka-first. Platform-ready.
- </p>
- <p align="center">
- <a href="https://github.com/streamthoughts/jikkou/actions/workflows/maven-build.yml"><img src="https://github.com/streamthoughts/jikkou/actions/workflows/maven-build.yml/badge.svg" alt="Build Status"/></a>
- <a href="https://github.com/streamthoughts/jikkou/blob/main/LICENSE"><img src="https://img.shields.io/github/license/streamthoughts/jikkou" alt="License"/></a>
- <a href="https://github.com/streamthoughts/jikkou/releases"><img src="https://img.shields.io/github/v/release/streamthoughts/jikkou?color=blue&label=latest" alt="Release"/></a>
- <a href="https://github.com/streamthoughts/jikkou/stargazers"><img src="https://img.shields.io/github/stars/streamthoughts/jikkou?style=flat" alt="Stars"/></a>
- </p>
- <p align="center">
- <a href="https://sonarcloud.io/dashboard?id=streamthoughts_jikkou"><img src="https://sonarcloud.io/api/project_badges/measure?project=streamthoughts_jikkou&metric=reliability_rating" alt="Reliability"/></a>
- <a href="https://sonarcloud.io/dashboard?id=streamthoughts_jikkou"><img src="https://sonarcloud.io/api/project_badges/measure?project=streamthoughts_jikkou&metric=sqale_rating" alt="Maintainability"/></a>
- <a href="https://sonarcloud.io/dashboard?id=streamthoughts_jikkou"><img src="https://sonarcloud.io/api/project_badges/measure?project=streamthoughts_jikkou&metric=coverage" alt="Coverage"/></a>
- </p>
- <p align="center">
- <a href="https://jikkou.io/">Documentation</a> •
- <a href="https://jikkou.io/docs/install/">Install</a> •
- <a href="https://jikkou.io/docs/tutorials/">Tutorials</a> •
- <a href="https://join.slack.com/t/jikkou-io/shared_invite/zt-27c0pt61j-F10NN7d7ZEppQeMMyvy3VA">Slack</a>
- </p>
- ---
- **Your platform team runs Kafka for everyone else.** Fifty app teams, and every new topic is a ticket.
- Configs drift between staging and production because someone "fixed" something by hand during an incident.
- Nobody can say who changed what, or why.
- **Jikkou** (jikkou / 実行, *execution* in Japanese) fixes this the way `kubectl` fixed Kubernetes:
- declare your Kafka resources (topics, ACLs, quotas, schemas, connectors) as YAML in Git, review changes
- in pull requests, and let Jikkou reconcile the desired state against your **real clusters**. Kafka-first,
- and platform-ready: the same engine manages Schema Registry, Kafka Connect, Confluent Cloud, Aiven,
- Amazon MSK, AWS Glue, and Apache Iceberg.
- <p align="center">
- <img src="./assets/demo.gif" alt="Jikkou in action" width="800"/>
- </p>
- ## Why Jikkou?
- | Your problem | Jikkou's answer |
- |---|---|
- | "Someone changed a topic by hand and nobody noticed" | **Stateless reconciliation.** No state file; `jikkou diff` compares Git against the actual cluster, so drift is always visible |
- | "300 topics that differ by one value" | **Jinja templating.** One definition, per-environment values files |
- | "Same config must land on five clusters" | **Multi-cluster apply.** Provider groups target a whole fleet in one command |
- | "Every change needs review and an audit trail" | **GitOps-native.** YAML in Git, `diff` in the pull request, `apply` in CI |
- | "We can't let a typo reach production" | **Validations & dry-run.** Platform rules (naming, min ISR, partition limits) enforced before anything is applied |
- | "We also run Schema Registry, Connect, Iceberg…" | **One agnostic engine.** Pluggable providers, one resource model across your whole data platform |
- ## How Jikkou Compares
- - **[Jikkou vs Terraform](https://www.jikkou.io/docs/comparisons/jikkou-vs-terraform/)**: Terraform provisions clusters; Jikkou manages what lives inside them, without a state file to drift.
- - **[Jikkou vs Strimzi Topic Operator](https://www.jikkou.io/docs/comparisons/jikkou-vs-strimzi/)**: on Strimzi, keep the Topic Operator for topics; Jikkou covers everything it can't reach.
- ## Quick Start
- ### Install
- ```bash
- # Via SDKMan (recommended)
- sdk install jikkou
- # Or via Docker
- docker pull streamthoughts/jikkou
- ```
- > See the full [installation guide](https://jikkou.io/docs/install/) for native binaries, Homebrew, and more.
- ### Define a Kafka topic
- ```yaml
- # kafka-topics.yaml
- apiVersion: 'kafka.jikkou.io/v1beta2'
- kind: 'KafkaTopic'
- metadata:
- name: 'my-topic'
- spec:
- partitions: 12
- replicas: 3
- configs:
- min.insync.replicas: 2
- ```
- ### Preview, then apply
- ```bash
- # Preview the change against the real cluster, not a state file
- jikkou diff --files ./kafka-topics.yaml
- # Apply it
- jikkou apply --files ./kafka-topics.yaml
- ```
- That's it. Jikkou computes the diff and applies only the necessary changes:
- ```
- TASK [CREATE] Create a new topic my-topic (partitions=12, replicas=3) - CHANGED
- EXECUTION in 2s 661ms
- ok: 0, created: 1, altered: 0, deleted: 0, failed: 0
- ```
- ## One Model, Every Platform
- The same declarative YAML model covers your entire streaming platform. And because the engine is
- platform-agnostic, it extends beyond Kafka: Apache Iceberg tables, views, and namespaces are managed
- with the exact same workflow.
- | Apache Kafka | Schema Registry | Kafka Connect | Apache Iceberg | Cloud Providers |
- |:---:|:---:|:---:|:---:|:---:|
- | Topics & Configs | Avro Schemas | Connectors | Tables | Aiven (ACLs, Quotas) |
- | ACLs | JSON Schemas | | Views | Confluent Cloud (RBAC) |
- | Quotas | Protobuf Schemas | | Namespaces | AWS Glue Schemas |
- | Consumer Groups | | | | |
- | Brokers & Users | | | | |
- | KTable Records | | | | |
- ## How It Works
- <p align="center">
- <img src="./docs/content/en/docs/Overview/jikkou-architecture-overview.png" alt="Architecture" width="800"/>
- </p>
- Jikkou follows a simple reconciliation loop:
- 1. **Read** your resource definitions from YAML files (with Jinja templating support)
- 2. **Compute** the differences between desired state and actual cluster state
- 3. **Apply** only the minimal set of changes needed
- 4. **Report** what was created, updated, or deleted
- ## Deployment Modes
- | Mode | Description |
- |-------------------|-----------------------------------------------------------------------------------------------|
- | **CLI** | Run as a command-line tool — perfect for local development and CI/CD pipelines |
- | **API Server** | Run as a REST API server — ideal for platform teams and automation |
- | **Docker** | Available as container images on [Docker Hub](https://hub.docker.com/r/streamthoughts/jikkou) |
- | **Native Binary** | GraalVM-compiled native executables for instant startup |
- ## Use Jikkou with AI Agents
- Jikkou ships official [Agent Skills](https://agentskills.io) so coding agents can manage
- your Kafka resources through the CLI — with validation and dry-runs built into the workflow.
- **Claude Code:**
- ```
- /plugin marketplace add streamthoughts/jikkou
- /plugin install jikkou
- ```
- **Other agents:** copy [`skills/managing-kafka-resources`](./skills/managing-kafka-resources) into your agent's skills directory.
- The skill never applies changes without showing a diff or dry-run first, and asks before
- installing anything.
- ## Documentation
- Full documentation is available at **[jikkou.io](https://jikkou.io/)**.
- - [Getting Started](https://jikkou.io/docs/install/)
- - [Concepts & Architecture](https://jikkou.io/docs/concepts/)
- - [Providers Reference](https://jikkou.io/docs/providers/)
- - [Tutorials](https://jikkou.io/docs/tutorials/)
- ## Developers
- For build instructions, development setup, and contribution guidelines, see:
- - **[CONTRIBUTING.md](./CONTRIBUTING.md)** — How to contribute, coding guidelines, commit conventions
- - **[AGENTS.md](./AGENTS.md)** — Detailed development guidelines, build commands, and architecture
- ### Quick Build
- ```bash
- # Build and run all tests
- ./mvnw clean verify
- # Build without tests
- ./mvnw clean verify -DskipTests
- # Apply code formatting
- ./mvnw spotless:apply
- ```
- **Requirements:** Java 25, Docker (for integration tests), GraalVM (for native builds)
- ## Contributors
- Jikkou is built by its community. Thank you to everyone who has contributed!
- <!-- CONTRIBUTORS-START -->
- <a href="https://github.com/streamthoughts/jikkou/graphs/contributors">
- <img src="https://contrib.rocks/image?repo=streamthoughts/jikkou&max=100&columns=12" alt="Contributors"/>
- </a>
- <!-- CONTRIBUTORS-END -->
- Want to see your name here? Check out the [contribution guide](./CONTRIBUTING.md) and [open issues](https://github.com/streamthoughts/jikkou/issues).
- ## Support the Project
- If you find Jikkou useful, please consider:
- - **Using Jikkou in production?** Add your organization to [ADOPTERS.md](./ADOPTERS.md) or [tell us in GitHub Discussions](https://github.com/streamthoughts/jikkou/discussions): real-world usage reports help the project more than anything else
- - Giving it a **[star on GitHub](https://github.com/streamthoughts/jikkou)** to help others discover it
- - Joining the **[Slack community](https://join.slack.com/t/jikkou-io/shared_invite/zt-27c0pt61j-F10NN7d7ZEppQeMMyvy3VA)** to ask questions and share feedback
- - **[Contributing](./CONTRIBUTING.md)** code, documentation, or bug reports
- ## License
- Licensed under the [Apache License, Version 2.0](./LICENSE).
- ---
- <p align="center">
- Developed with ❤ by <a href="https://github.com/fhussonnois">Florian Hussonnois</a> and the Jikkou community.
- </p>
mvnw.cmd · Bundled script · 187 lines · 1 finding marked
- @REM ----------------------------------------------------------------------------
- @REM Licensed to the Apache Software Foundation (ASF) under one
- @REM or more contributor license agreements. See the NOTICE file
- @REM distributed with this work for additional information
- @REM regarding copyright ownership. The ASF licenses this file
- @REM to you under the Apache License, Version 2.0 (the
- @REM "License"); you may not use this file except in compliance
- @REM with the License. You may obtain a copy of the License at
- @REM
- @REM http://www.apache.org/licenses/LICENSE-2.0
- @REM
- @REM Unless required by applicable law or agreed to in writing,
- @REM software distributed under the License is distributed on an
- @REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- @REM KIND, either express or implied. See the License for the
- @REM specific language governing permissions and limitations
- @REM under the License.
- @REM ----------------------------------------------------------------------------
- @REM ----------------------------------------------------------------------------
- @REM Apache Maven Wrapper startup batch script, version 3.1.1
- @REM
- @REM Required ENV vars:
- @REM JAVA_HOME - location of a JDK home dir
- @REM
- @REM Optional ENV vars
- @REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands
- @REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a keystroke before ending
- @REM MAVEN_OPTS - parameters passed to the Java VM when running Maven
- @REM e.g. to debug Maven itself, use
- @REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000
- @REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files
- @REM ----------------------------------------------------------------------------
- @REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on'
- @echo off
- @REM set title of command window
- title %0
- @REM enable echoing by setting MAVEN_BATCH_ECHO to 'on'
- @if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO%
- @REM set %HOME% to equivalent of $HOME
- if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%")
- @REM Execute a user defined script before this one
- if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre
- @REM check for pre script, once with legacy .bat ending and once with .cmd ending
- if exist "%USERPROFILE%\mavenrc_pre.bat" call "%USERPROFILE%\mavenrc_pre.bat" %*
- if exist "%USERPROFILE%\mavenrc_pre.cmd" call "%USERPROFILE%\mavenrc_pre.cmd" %*
- :skipRcPre
- @setlocal
- set ERROR_CODE=0
- @REM To isolate internal variables from possible post scripts, we use another setlocal
- @setlocal
- @REM ==== START VALIDATION ====
- if not "%JAVA_HOME%" == "" goto OkJHome
- echo.
- echo Error: JAVA_HOME not found in your environment. >&2
- echo Please set the JAVA_HOME variable in your environment to match the >&2
- echo location of your Java installation. >&2
- echo.
- goto error
- :OkJHome
- if exist "%JAVA_HOME%\bin\java.exe" goto init
- echo.
- echo Error: JAVA_HOME is set to an invalid directory. >&2
- echo JAVA_HOME = "%JAVA_HOME%" >&2
- echo Please set the JAVA_HOME variable in your environment to match the >&2
- echo location of your Java installation. >&2
- echo.
- goto error
- @REM ==== END VALIDATION ====
- :init
- @REM Find the project base dir, i.e. the directory that contains the folder ".mvn".
- @REM Fallback to current working directory if not found.
- set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR%
- IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir
- set EXEC_DIR=%CD%
- set WDIR=%EXEC_DIR%
- :findBaseDir
- IF EXIST "%WDIR%"\.mvn goto baseDirFound
- cd ..
- IF "%WDIR%"=="%CD%" goto baseDirNotFound
- set WDIR=%CD%
- goto findBaseDir
- :baseDirFound
- set MAVEN_PROJECTBASEDIR=%WDIR%
- cd "%EXEC_DIR%"
- goto endDetectBaseDir
- :baseDirNotFound
- set MAVEN_PROJECTBASEDIR=%EXEC_DIR%
- cd "%EXEC_DIR%"
- :endDetectBaseDir
- IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig
- @setlocal EnableExtensions EnableDelayedExpansion
- for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a
- @endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS%
- :endReadAdditionalConfig
- SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe"
- set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar"
- set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain
- set WRAPPER_URL="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.1/maven-wrapper-3.1.1.jar"
- Dismissed after review: Links to a Windows program from code, which is how droppers fetch their payload
- Line 122 on GitHub
- FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO (
- IF "%%A"=="wrapperUrl" SET WRAPPER_URL=%%B
- )
- @REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central
- @REM This allows using the maven wrapper in projects that prohibit checking in binary data.
- if exist %WRAPPER_JAR% (
- if "%MVNW_VERBOSE%" == "true" (
- echo Found %WRAPPER_JAR%
- )
- ) else (
- if not "%MVNW_REPOURL%" == "" (
- SET WRAPPER_URL="%MVNW_REPOURL%/org/apache/maven/wrapper/maven-wrapper/3.1.1/maven-wrapper-3.1.1.jar"
- )
- if "%MVNW_VERBOSE%" == "true" (
- echo Couldn't find %WRAPPER_JAR%, downloading it ...
- echo Downloading from: %WRAPPER_URL%
- )
- powershell -Command "&{"^
- "$webclient = new-object System.Net.WebClient;"^
- "if (-not ([string]::IsNullOrEmpty('%MVNW_USERNAME%') -and [string]::IsNullOrEmpty('%MVNW_PASSWORD%'))) {"^
- "$webclient.Credentials = new-object System.Net.NetworkCredential('%MVNW_USERNAME%', '%MVNW_PASSWORD%');"^
- "}"^
- "[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; $webclient.DownloadFile('%WRAPPER_URL%', '%WRAPPER_JAR%')"^
- "}"
- if "%MVNW_VERBOSE%" == "true" (
- echo Finished downloading %WRAPPER_JAR%
- )
- )
- @REM End of extension
- @REM Provide a "standardized" way to retrieve the CLI args that will
- @REM work with both Windows and non-Windows executions.
- set MAVEN_CMD_LINE_ARGS=%*
- %MAVEN_JAVA_EXE% ^
- %JVM_CONFIG_MAVEN_PROPS% ^
- %MAVEN_OPTS% ^
- %MAVEN_DEBUG_OPTS% ^
- -classpath %WRAPPER_JAR% ^
- "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" ^
- %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %*
- if ERRORLEVEL 1 goto error
- goto end
- :error
- set ERROR_CODE=1
- :end
- @endlocal & set ERROR_CODE=%ERROR_CODE%
- if not "%MAVEN_SKIP_RC%"=="" goto skipRcPost
- @REM check for post script, once with legacy .bat ending and once with .cmd ending
- if exist "%USERPROFILE%\mavenrc_post.bat" call "%USERPROFILE%\mavenrc_post.bat"
- if exist "%USERPROFILE%\mavenrc_post.cmd" call "%USERPROFILE%\mavenrc_post.cmd"
- :skipRcPost
- @REM pause the script if MAVEN_BATCH_PAUSE is set to 'on'
- if "%MAVEN_BATCH_PAUSE%"=="on" pause
- if "%MAVEN_TERMINATE_CMD%"=="on" exit %ERROR_CODE%
- cmd /C exit /B %ERROR_CODE%
Ratings and comments
Sign in to rate this skill.
Sign inFree to use. If it’s helped, pass it on.