Skip to content

Commit

Permalink
docs(gh-pages): update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
fhussonnois committed Jul 9, 2024
1 parent 8805589 commit 9d3095e
Show file tree
Hide file tree
Showing 4 changed files with 95 additions and 24 deletions.
48 changes: 48 additions & 0 deletions docs/content/en/docs/Frequently Asked Questions/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,51 @@ description: >
{{% pageinfo %}}
This section regroups all frequently asked questions about Jikkou.
{{% /pageinfo %}}

### Is Jikkou Free to Use?
Yes, Jikkou is developed and distributed under the [Apache License 2.0](https://spdx.org/licenses/Apache-2.0.html).

### Can I Use Jikkou with Any Kafka Implementation?
Yes, Jikkou can be used with a wide range of Apache Kafka infrastructures, including:

* [Apache Kafka](https://kafka.apache.org/)
* [Aiven](https://aiven.io/kafka)
* [Amazon MSK](https://aws.amazon.com/fr/msk/)
* [Confluent Cloud](https://www.confluent.io/confluent-cloud/)
* [Redpanda](https://redpanda.com/)

### Why would I use Jikkou over Terraform?

#### What is Terraform and how is it typically used?

Terraform ([OpenToFu](https://opentofu.org/)) is widely recognized as the leading solution for infrastructure
provisioning and management. It is commonly used by operations teams for managing cloud infrastructure through
its HCL (HashiCorp Configuration Language) syntax.

#### What are the limitations of Terraform for Kafka Users ?

Many development teams find Terraform challenging to use because:

* They need to learn HCL syntax, which is not commonly known among developers.
* They often lack the necessary permissions to apply configuration files directly.
* They often struggle with Terraform states.

#### How does Jikkou address these limitations?

Jikkou is designed to be a straightforward CLI tool for both developers and operations teams. It simplifies the process
of managing infrastructure, especially for development teams who may not have expertise in HCL or the permissions
required for Terraform.

#### What are the benefits of using Jikkou for Kafka management?

* **On-Premises and Multi-Cloud Support**: Unlike many Terraform providers which focus on cloud-based Kafka services (
e.g., Confluent Cloud), Jikkou supports on-premises, multi-cloud, and hybrid infrastructures.

* **Versatility**: Jikkou can manage Kafka topics across various environments, including local Kafka clusters in Docker,
ephemeral clusters in Kubernetes for CI/CD, and production clusters in Aiven Cloud.

* **Auditing and Backup**: Beyond provisioning, Jikkou can audit Kafka platforms for configuration issues and create
backups of Kafka configurations (Topics, ACLs, Quotas, etc.).

There are, of course, many reasons to use Terraform rather than Jikkou and vice versa. As usual, the choice of tool
really depends on your needs, the organization you're in, the skills of the people involved and so on.
50 changes: 26 additions & 24 deletions docs/content/en/docs/Overview/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,40 +13,42 @@ ui.breadcrumb_disable: false
Welcome to the Jikkou documentation! Jikkou, means “execution (e.g. of a plan) or actual state (of things)” in Japanese.
{{% /pageinfo %}}

## What is Jikkou ?
## What Is Jikkou ?

Jikkou is a lightweight open-source tool designed to provide an efficient and easy way to manage, automate and provision
resources on **Event-Driven Data Mesh platforms** (or, more simply, on any **Apache Kafka Infrastructures**).
Jikkou is a powerful, flexible open-source framework that enables self-serve resource provisioning.
It allows developers and DevOps teams to easily manage, automate, and provision all the resources needed for their
**Apache Kafka®** platform.

## How does Jikkou work ?
Jikkou was born with the aim to streamline day-to-day operations on Apache Kafka®, ensuring that platform governance is
no longer a tedious and boring task for both developers and administrators.

Jikkou adopts a stateless approach and thus does not store any state internally. Instead, it leverages your platforms
or services as the source of truth. This design allows you to seamlessly integrate Jikkou with other solutions
(such as Ansible, Terraform, etc.) or use it on an ad hoc basis for specific needs, making it incredibly flexible and versatile.
## What Are The Use-Cases ?

{{< figure src="./jikkou-how-it-works.svg" width="80%" class="center" >}}

## Why Jikkou ? The Story Behind Jikkou.
Jikkou is primarily used as a GitOps solution for Kafka configuration management.

Jikkou was originally created as a side project to help development teams quickly recreate topics on Apache Kafka
clusters used for testing purposes (the project was called _Kafka Specs_). At the time, the aim was to ensure
that environments were always clean and ready to run integration tests.
Here are some of the various use cases we've observed in different projects:

But over time, new features were added, and so Jikkou was born with the aim to streamline day-to-day operations
on Apache Kafka, ensuring that platform governance is no longer a tedious and boring task for both developers and
administrators.
* **Topic as a Service**: Build a self-serve platform for managing Kafka topics.
* **ACL Management**: Centrally manage all ACLs of an Apache Kafka cluster.
* **Kafka Connectors Management**: Deploy and manage Kafka Connect connectors.
* **Ad Hoc Changes**: Apply ad hoc changes as needed.
* **Audit**: Easily check configurations of topics, brokers, or identify divergences between different environments.
* **Kafka Configuration Backup**: Periodically export all critical configurations of your Kafka cluster.
* **Configuration Replication**: Replicate the Kafka configuration from one cluster to another.

Today, Jikkou is used in production on several projects, providing efficient management of Kafka resources through
a GitOps approach. The project continues to evolve as an open-source project, as the solutions that have
appeared over time in the Kafka ecosystem do not meet the needs of Kafka developers and administrators as well.
In fact, existing solutions are either designed to work only with Kubernetes, or rely on dedicated services to manage
the state of the solution.
## How Does Jikkou Work ?

Now, we sincerely believe that Jikkou can play a role in bootstrapping a _self-service platform_ for a Data Mesh
organization, by unifying the way to manage the various assets required to create and manage a Data Product
exposed through Apache Kafka.
Jikkou offers flexibility in deployment, functioning either as a simple CLI (Command Line Interface) or as a REST
server, based on your requirements.

## Is Jikkou for me ?
By adopting a stateless approach, Jikkou does not store any internal state. Instead, it leverages your platforms or
services as the source of truth. This design enables seamless integration with other solutions, such as Ansible and
Terraform, or allows for ad hoc use for specific tasks, making Jikkou incredibly flexible and versatile.

{{< figure src="./jikkou-architecture-overview.svg" width="80%" class="center" >}}

## Is Jikkou For Me ?

Jikkou can be implemented regardless of the size of your team or data platform.

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 21 additions & 0 deletions docs/content/en/docs/Overview/jikkou-architecture-overview.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 9d3095e

Please sign in to comment.