docs(gh-page): update

docs/content/en/docs/Community/Contribution guidelines/_index.md

@@ -6,7 +6,7 @@ description: >
   How to contribute to Jikkou
 ---
 
-Jikkou is an open source project and we love getting patches and contributions to make Jikkou and its docs even better.
+Jikkou is an open source project, and we love getting patches and contributions to make Jikkou and its docs even better.
 
 
 ## Contributing to Jikkou

docs/content/en/docs/Concepts/Collector.md

@@ -1,12 +1,12 @@
 ---
 tags: [ "concept", "feature", "extension" ]
-title: "External Resource Collectors"
+title: "Collectors"
 linkTitle: "Collectors"
 weight: 8
 ---
 
 {{% pageinfo color="info" %}}
-_**ExternalResourceCollectors**_ are used to collect and describe all entities that exist into your system for a
+_**Collectors**_ are used to collect and describe all entities that exist into your system for a
 specific resource type.
 {{% /pageinfo %}}
 
@@ -15,5 +15,5 @@ specific resource type.
 You can list all the available collectors using the Jikkou CLI command:
 
 ```bash
-jikkou extensions list --type=ExternalResourceCollector [-kinds <a resource kind to filter returned results>]
+jikkou extensions list --type=Collector [-kinds <a resource kind to filter returned results>]
 ```

docs/content/en/docs/Concepts/Controller.md

@@ -1,12 +1,12 @@
 ---
 tags: [ "concept", "feature", "extension" ]
-title: "External Resource Controllers"
+title: "Controllers"
 linkTitle: "Controllers"
 weight: 9
 ---
 
 {{% pageinfo color="info" %}}
-_**ExternalResourceControllers**_ are used to compute and apply changes required to reconcile resources into a managed
+_**Controllers**_ are used to compute and apply changes required to reconcile resources into a managed
 system.
 {{% /pageinfo %}}
 
@@ -15,5 +15,5 @@ system.
 You can list all the available controllers using the Jikkou CLI command:
 
 ```bash
-jikkou extensions list --type=ExternalResourceController [-kinds <a resource kind to filter returned results>]
+jikkou extensions list --type=Controller [-kinds <a resource kind to filter returned results>]
 ```

docs/content/en/docs/Concepts/labels-and-annotations.md

@@ -22,7 +22,8 @@ The keys in the map must be string, but values can be any scalar types (_string_
 {{% /alert %}}
 
 {{% alert title="Labels are not persistent" color="warning" %}}
-Jikkou is completely stateless. In other words, it will not store any state about the describe resources objects. Thus, when
+Jikkou is completely stateless. In other words, it will not store any state about the describe resources objects. Thus,
+when
 retrieving objects from your system labels may not be reattached to the metadata objects.
 {{% /alert %}}
 
@@ -59,6 +60,13 @@ Used on: All Objects.
 
 This annotation indicates whether the object should be ignored for reconciliation.
 
+#### `jikkou.io/bypass-validations`
+
+Used on: All Objects.
+
+This annotation indicates whether the object should bypass the validation chain. In other words, no validations will be
+applied on the object.
+
 #### `jikkou.io/delete`
 
 Used on: All Objects.
@@ -76,9 +84,3 @@ This annotation is automatically added by Jikkou to an object when loaded from y
 Used by jikkou.
 
 This annotation is automatically added by Jikkou to an object collection grouping several resources of homogeneous type.
-
-#### `kafka.jikkou.io/cluster-id`
-
-Used by jikkou.
-
-The annotation is automatically added by Jikkou to a describe object part of an Apache Kafka cluster.

docs/content/en/docs/Introduction/getting_started.md

@@ -39,7 +39,7 @@ $ ./up              # use ./down for stopping the docker-compose stack
 Run the following commands to install the latest version:
 
 ```bash
-wget https://github.com/streamthoughts/jikkou/releases/download/0.18.0/jikkou.deb && \
+wget https://github.com/streamthoughts/jikkou/releases/download/0.20.0/jikkou.deb && \
 sudo dpkg -i jikkou.deb && \
 source <(jikkou generate-completion) && \
 jikkou --version

docs/content/en/docs/Introduction/installation.md

@@ -16,25 +16,25 @@ Jikkou can be installed either from source, or from releases.
 
 Every [`release`](https://github.com/streamthoughts/jikkou/releases) released versions of Jikkou is available: 
 
-* As a zip/tar.gz package from [GitHub Releases](https://github.com/streamthoughts/jikkou/releases/tag/v0.17.0)
-* As a fatJar available from [Maven Central](https://repo.maven.apache.org/maven2/io/streamthoughts/jikkou/0.17.0/)
+* As a zip/tar.gz package from [GitHub Releases](https://github.com/streamthoughts/jikkou/releases/tag/v0.20.0)
+* As a fatJar available from [Maven Central](https://repo.maven.apache.org/maven2/io/streamthoughts/jikkou/0.20.0/)
 * As a docker image available from [Docker Hub](https://hub.docker.com/r/streamthoughts/jikkou).
-* As a Debian package from [GitHub Releases](https://github.com/streamthoughts/jikkou/releases/tag/v0.17.0)
+* As a Debian package from [GitHub Releases](https://github.com/streamthoughts/jikkou/releases/tag/v0.20.0)
 
 These are the official ways to get Jikkou releases that you manually downloaded and installed.
 
 #### Install From Tarball distribution
 
 1. Download your desired [version](https://github.com/streamthoughts/jikkou/releases)
-2. Unpack it (`tar -zxvf jikkou-0.18.0-runner.tar.gz`)
-3. Move the unpacked directory to its desired destination (`mv jikkou-0.18.0-runner /opt`)
+2. Unpack it (`tar -zxvf jikkou-0.20.0-runner.tar.gz`)
+3. Move the unpacked directory to its desired destination (`mv jikkou-0.20.0-runner /opt`)
 4. Add the executable to your PATH (`export PATH=$PATH:/opt/jikkou/bin`)
 
 #### Install From Debian distribution
 
 1. Download your desired [version](https://github.com/streamthoughts/jikkou/releases)
 ```bash
-$ wget https://github.com/streamthoughts/jikkou/releases/download/0.18.0/jikkou.deb
+$ wget https://github.com/streamthoughts/jikkou/releases/download/0.20.0/jikkou.deb
 $ sudo dpkg -i jikkou.deb
 ```
 

docs/content/en/docs/Introduction/using_jikkou.md

@@ -125,6 +125,7 @@ jikkou {
   # The paths from which to load extensions
   extension.paths = [${?JIKKOU_EXTENSION_PATH}]
 
+  # Kafka Extension
   kafka {
     # The default Kafka AdminClient configuration
     client  {
@@ -133,41 +134,50 @@ jikkou {
     }
     brokers {
       # If 'True' 
-      wait-for-enabled = true
-      wait-for-enabled = ${?JIKKOU_KAFKA_BROKERS_WAIT_FOR_ENABLED}
+      waitForEnabled = true
+      waitForEnabled = ${?JIKKOU_KAFKA_BROKERS_WAIT_FOR_ENABLED}
       # The minimal number of brokers that should be alive for the CLI stops waiting.
-      wait-for-min-available = 1
-      wait-for-min-available = ${?JIKKOU_KAFKA_BROKERS_WAIT_FOR_MIN_AVAILABLE}
+      waitForMinAvailable = 1
+      waitForMinAvailable = ${?JIKKOU_KAFKA_BROKERS_WAIT_FOR_MIN_AVAILABLE}
       # The amount of time to wait before verifying that brokers are available.
-      wait-for-retry-backoff-ms = 1000
-      wait-for-retry-backoff-ms = ${?JIKKOU_KAFKA_BROKERS_WAIT_FOR_RETRY_BACKOFF_MS}
+      waitForRetryBackoffMs = 1000
+      waitForRetryBackoffMs = ${?JIKKOU_KAFKA_BROKERS_WAIT_FOR_RETRY_BACKOFF_MS}
       # Wait until brokers are available or this timeout is reached.
-      wait-for-timeout-ms = 60000
-      wait-for-timeout-ms = ${?JIKKOU_KAFKA_BROKERS_WAIT_FOR_TIMEOUT_MS}
+      waitForTimeoutMs = 60000
+      waitForTimeoutMs = ${?JIKKOU_KAFKA_BROKERS_WAIT_FOR_TIMEOUT_MS}
     }
   }
 
-  # The default validation rules to apply on any specification files.
+  # The default custom transformations to apply on any resources.
+  transformations = []
+
+  # The default custom validations to apply on any resources.
   validations = [
     {
-      type = TopicNameRegexValidation
+      name = "topicMustHaveValidName"
+      type = io.streamthoughts.jikkou.kafka.validation.TopicNameRegexValidation
+      priority = 100
       config = {
-        topic-name-regex = "[a-zA-Z0-9\\._\\-]+"
-        topic-name-regex = ${?VALIDATION_DEFAULT_TOPIC_NAME_REGEX}
+        topicNameRegex = "[a-zA-Z0-9\\._\\-]+"
+        topicNameRegex = ${?VALIDATION_DEFAULT_TOPIC_NAME_REGEX}
       }
     },
     {
-      type = TopicMinNumPartitionsValidation
+      name = "topicMustHaveParitionsEqualsOrGreaterThanOne"
+      type = io.streamthoughts.jikkou.kafka.validation.TopicMinNumPartitionsValidation
+      priority = 100
       config = {
-        topic-min-num-partitions = 1
-        topic-min-num-partitions = ${?VALIDATION_DEFAULT_TOPIC_MIN_NUM_PARTITIONS}
+        topicMinNumPartitions = 1
+        topicMinNumPartitions = ${?VALIDATION_DEFAULT_TOPIC_MIN_NUM_PARTITIONS}
       }
     },
     {
-      type = TopicMinReplicationFactorValidation
+      name = "topicMustHaveReplicasEqualsOrGreaterThanOne"
+      type = io.streamthoughts.jikkou.kafka.validation.TopicMinReplicationFactorValidation
+      priority = 100
       config = {
-        topic-min-replication-factor = 1
-        topic-min-replication-factor = ${?VALIDATION_DEFAULT_TOPIC_MIN_REPLICATION_FACTOR}
+        topicMinReplicationFactor = 1
+        topicMinReplicationFactor = ${?VALIDATION_DEFAULT_TOPIC_MIN_REPLICATION_FACTOR}
       }
     }
   ]

docs/content/en/docs/User Guide/Kafka/Annotations/_index.md

@@ -0,0 +1,19 @@
+---
+title: "Annotations"
+linkTitle: "Annotations"
+weight: 60
+description: >
+  Learn how to use the metadata annotations provided by the extensions for Apache Kafka.
+---
+
+{{% pageinfo %}}
+Here, you will find information about the annotations provided the Apache Kafka extension for Jikkou.
+{{% /pageinfo %}}
+
+### List of built-in annotations
+
+#### `kafka.jikkou.io/cluster-id`
+
+Used by jikkou.
+
+The annotation is automatically added by Jikkou to a describe object part of an Apache Kafka cluster.