Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(refactor): moves annotations content #9717

Merged
merged 1 commit into from
Feb 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 6 additions & 0 deletions documentation/assemblies/configuring/assembly-config.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,10 @@ include::../../modules/configuring/con-config-kafka.adoc[leveloffset=+1]
include::../../modules/managing/proc-setting-broker-limits.adoc[leveloffset=+2]
//Zookeeper's default configuration
include::../../modules/configuring/con-zookeeper-default-config.adoc[leveloffset=+2]
//steps to delete kafka nodes using annotations
include::../../modules/configuring/proc-manual-delete-pod-pvc-kafka.adoc[leveloffset=+2]
//steps to delete zookeeper nodes using annotations
include::../../modules/configuring/proc-manual-delete-pod-pvc-zookeeper.adoc[leveloffset=+2]

//configuring node pools
include::../../modules/configuring/con-config-node-pools.adoc[leveloffset=+1]
Expand All @@ -81,6 +85,8 @@ include::../../modules/configuring/con-configuring-user-operator.adoc[leveloffse

//cluster operator config env vars
include::../../modules/operators/con-configuring-cluster-operator.adoc[leveloffset=+1]
//pausing reconciliation of custom resources
include::../../modules/operators/proc-pausing-reconciliation.adoc[leveloffset=+2]
//enabling leader election
include::../../assemblies/operators/assembly-using-multiple-cluster-operators.adoc[leveloffset=+2]
//cluster operator proxy config
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,5 @@ ifdef::Section[]
include::../../modules/security/proc-accessing-kafka-using-ingress.adoc[leveloffset=+1]
endif::Section[]
include::../../modules/security/proc-accessing-kafka-using-routes.adoc[leveloffset=+1]

//discover internal bootstrap service and Bridge
include::../../modules/deploying/con-service-discovery.adoc[leveloffset=+1]
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,7 @@ include::../../modules/deploying/proc-deploy-kafka-cluster.adoc[leveloffset=+1]
include::../../modules/deploying/proc-deploy-topic-operator-with-cluster-operator.adoc[leveloffset=+1]
//Include User Operator in deployment
include::../../modules/deploying/proc-deploy-user-operator-with-cluster-operator.adoc[leveloffset=+1]
//Connecting to ZooKeeper from terminal
include::../../modules/configuring/proc-connecting-to-zookeeper.adoc[leveloffset=+1]
//Kafka cluster resources created
include::../../modules/configuring/ref-list-of-kafka-cluster-resources.adoc[leveloffset=+1]
18 changes: 0 additions & 18 deletions documentation/assemblies/managing/assembly-management-tasks.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,32 +9,14 @@
Managing Strimzi requires performing various tasks to keep the Kafka clusters and associated resources running smoothly.
Use `kubectl` commands to check the status of resources, configure maintenance windows for rolling updates, and leverage tools such as the Strimzi Drain Cleaner and Kafka Static Quota plugin to manage your deployment effectively.

//discover internal bootstrap service and HTTP Bridge
include::../../modules/managing/con-service-discovery.adoc[leveloffset=+1]

//connecting to ZooKeeper from terminal
include::../../modules/configuring/proc-connecting-to-zookeeper.adoc[leveloffset=+1]

//pausing reconciliation of custom resources
include::../../modules/managing/proc-pausing-reconciliation.adoc[leveloffset=+1]

//windows (time) for maintenance
include::assembly-maintenance-time-windows.adoc[leveloffset=+1]

//steps to delete kafka nodes using annotations
include::../../modules/configuring/proc-manual-delete-pod-pvc-kafka.adoc[leveloffset=+1]

//steps to delete zookeeper nodes using annotations
include::../../modules/configuring/proc-manual-delete-pod-pvc-zookeeper.adoc[leveloffset=+1]

//performing manual rolling updates
include::assembly-rolling-updates.adoc[leveloffset=+1]

//recover a cluster from a PV
include::assembly-cluster-recovery-volume.adoc[leveloffset=+1]

//uninstalling the product
include::assembly-uninstalling.adoc[leveloffset=+1]

//faqs for cluster operator
include::../../modules/managing/con-cluster-operator-faqs.adoc[leveloffset=+1]
2 changes: 2 additions & 0 deletions documentation/deploying/deploying.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,8 @@ include::assemblies/deploying/assembly-drain-cleaner.adoc[leveloffset=+1]
include::assemblies/upgrading/assembly-upgrade.adoc[leveloffset=+1]
//Downgrading the deployment
include::assemblies/upgrading/assembly-downgrade.adoc[leveloffset=+1]
//uninstalling the product
include::assemblies/deploying/assembly-uninstalling.adoc[leveloffset=+1]
//How to monitor restart events
include::assemblies/deploying/assembly-deploy-restart-events.adoc[leveloffset=+1]
//tuning configuration
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,22 @@
// managing/assembly-management-tasks.adoc

[id='proc-add-service-discovery-{context}']
= Discovering services using labels and annotations
= Returning connection details for services

[role="_abstract"]
Service discovery makes it easier for client applications running in the same Kubernetes cluster as Strimzi to interact with a Kafka cluster.

A _service discovery_ label and annotation is generated for services used to access the Kafka cluster:
A _service discovery_ label and annotation are generated for services used to access the Kafka cluster:

* Internal Kafka bootstrap service
* HTTP Bridge service
* Kafka Bridge service

The label helps to make the service discoverable, and the annotation provides connection details that a client application can use to make the connection.
The label helps to make the service discoverable, while the annotation provides connection details for client applications to establish connections.

The service discovery label, `strimzi.io/discovery`, is set as `true` for the `Service` resources.
The service discovery annotation has the same key, providing connection details in JSON format for each service.

[discrete]
== Example internal Kafka bootstrap service

.Example internal Kafka bootstrap service
[source,yaml,subs="attributes+"]
----
apiVersion: v1
Expand Down Expand Up @@ -48,8 +47,7 @@ spec:
#...
----

[discrete]
== Example HTTP Bridge service
.Example Kafka Bridge service

[source,yaml,subs="attributes+"]
----
Expand All @@ -71,13 +69,12 @@ metadata:
strimzi.io/name: my-bridge-bridge-service
----

== Returning connection details on services

You can find the services by specifying the discovery label when fetching services from the command line or a corresponding API call.
Find services by specifying the discovery label when fetching services from the command line or a corresponding API call.

.Returning services using the discovery label
[source,yaml]
----
kubectl get service -l strimzi.io/discovery=true
----

The connection details are returned when retrieving the service discovery label.
Connection details are returned when retrieving the service discovery label.
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,7 @@ env:
----

[id='ref-operator-cluster-periodic-reconciliation-{context}']
== Configuring periodic reconciliation by the Cluster Operator
== Setting periodic reconciliation of custom resources

Use the `STRIMZI_FULL_RECONCILIATION_INTERVAL_MS` variable to set the time interval for periodic reconciliations by the Cluster Operator.
Replace its value with the required interval in milliseconds.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@

[id='proc-pausing-reconciliation-{context}']

= Pausing reconciliation of custom resources
= Pausing reconciliation of custom resources using annotations

Sometimes it is useful to pause the reconciliation of custom resources managed by Strimzi Operators,
Sometimes it is useful to pause the reconciliation of custom resources managed by Strimzi operators,
so that you can perform fixes or make updates.
If reconciliations are paused, any changes made to custom resources are ignored by the Operators until the pause ends.
If reconciliations are paused, any changes made to custom resources are ignored by the operators until the pause ends.

If you want to pause reconciliation of a custom resource, set the `strimzi.io/pause-reconciliation` annotation to `true` in its configuration.
This instructs the appropriate Operator to pause reconciliation of the custom resource.
This instructs the appropriate operator to pause reconciliation of the custom resource.
For example, you can apply the annotation to the `KafkaConnect` resource so that reconciliation by the Cluster Operator is paused.

You can also create a custom resource with the pause annotation enabled.
Expand Down