Skip to content

Commit

Permalink
docs(gh-page): update
Browse files Browse the repository at this point in the history
  • Loading branch information
fhussonnois committed Nov 29, 2023
1 parent bcc6248 commit 6297af8
Show file tree
Hide file tree
Showing 30 changed files with 10,876 additions and 298 deletions.
2,781 changes: 2,781 additions & 0 deletions docs/asciinema/demo.cast

Large diffs are not rendered by default.

4 changes: 4 additions & 0 deletions docs/asciinema/run.sh
@@ -0,0 +1,4 @@
#!/usr/bin/env bash

rm -f demo.cast
asciinema rec demo.cast -c "./scenario.sh"
43 changes: 43 additions & 0 deletions docs/asciinema/scenario.sh
@@ -0,0 +1,43 @@
echo "# See Jikkou in action!" | pv -qL 12
echo "# Jikkou is available as a native command line interface (CLI)" | pv -qL 12
echo "# that you can install easily via SDKMan!" | pv -qL 12
echo "sdk install jikkou" | pv -qL 12
echo '# And it can be used to manage an Apache Kafka cluster.' | pv -qL 12
echo 'jikkou config set-context localhost --config-props=kafka.client.bootstrap.servers=localhost:9092' | pv -qL 12
echo 'jikkou config use-context localhost' | pv -qL 12
echo 'jikkou health get kafka'
jikkou health get kafka | lolcat
echo '------------------------' | pv -qL 6
echo "# Let's say you would like to create and manage a Kafka Topic with Jikkou" | pv -qL 12
echo '# First, write a KafkaTopic descriptor file:' | pv -qL 12
echo 'cat topic.yaml' | pv -qL 12
cat topic.yaml | lolcat
echo ''
echo '------------------------' | pv -qL 6
echo '# And apply it to your Kafka Cluster:' | pv -qL 12
echo 'jikkou create -f topic.yaml -o YAML' | pv -qL 12
jikkou apply -f topic.yaml -o YAML | lolcat
echo '# Next, you can use Jikkou to describe your Kafka Topics:' | pv -qL 12
echo 'jikkou get kafkatopics --name my-topic' | pv -qL 12
jikkou get kafkatopics --name my-topic | lolcat
echo '# Of course, you can use Jikkou to modify your Kafka Topic (e.g., adding property: retention.ms=86400000)' | pv -qL 12
echo "# Let's update our descriptor file:" | pv -qL 12
cp topic.yaml topic.bk.yaml
echo " retention.ms: 86400000 # updated" >> topic.yaml
echo 'cat topic.yaml' | pv -qL 12
cat topic.yaml | lolcat
echo ''
echo '------------------------' | pv -qL 6
echo '# And apply it to your Kafka cluster as previously:' | pv -qL 12
echo 'jikkou apply -f topic.yaml -o yaml' | pv -qL 12
jikkou apply -f topic.yaml -o yaml | lolcat
echo '# And it is done :)' | pv -qL 12
echo '------------------------' | pv -qL 6
echo '# Jikkou is not limited to Kafka Topic, but can be used for' | pv -qL 12
echo '# managing Schema Registry, Kafka Connect, etc...' | pv -qL 12
echo '# You can run Jikkou command manually, or execute it ' | pv -qL 12
echo '# part of your CI/CD pipeline.' | pv -qL 12
echo '# Jikkou has a Github Action and Server API as well' | pv -qL 12
echo '# Learn more about Jikkou at ' | pv -qL 12
echo '# https://streamthoughts.github.io/jikkou/docs' | cat | pv -qL 12 | lolcat
rm topic.yaml && mv topic.bk.yaml topic.yaml
12 changes: 12 additions & 0 deletions docs/asciinema/topic.yaml
@@ -0,0 +1,12 @@
---
apiVersion: "kafka.jikkou.io/v1beta2"
kind: KafkaTopic
metadata:
name: 'my-topic'
labels:
environment: demo
spec:
partitions: 3
replicas: 1
configs:
cleanup.policy: 'delete'

0 comments on commit 6297af8

Please sign in to comment.