docs(glossary): improve glossaries (kroxylicious#3076)

Signed-off-by: Keith Wall <[email protected]>

Author: k-wall

kroxylicious-docs/docs/_modules/record-encryption/ref-glossary.adoc

@@ -0,0 +1,10 @@
+:_mod-docs-content-type: REFERENCE
+
+= Glossary
+
+[role="_abstract"]
+Glossary of terms used in the Record Encryption guide.
+
+DEK:: Data Encryption Key, a secret key used to encrypt the kafka records
+KEK:: Key Encryption Key, a secret key that resides within the boundaries of a KMS.
+KMS:: Key Management System. A dedicated system for controlling access to cryptographic material, and providing operations which use that material.

kroxylicious-docs/docs/_modules/ref-glossary.adoc

@@ -1,3 +1,8 @@
+// This glossary is shared by both proxy and operator.
+// For terms that are applicable to only one guide, use ifeval conditionals.
+// Don't define terms specific to the domain of filters here, use a filter guide specific
+// glossary instead.
+
 :_mod-docs-content-type: REFERENCE
 
 = Glossary
@@ -7,9 +12,10 @@ Glossary of terms used in the Kroxylicious documentation.
 
 API:: Application Programmer Interface.
 CA:: Certificate Authority. An organization that issues certificates.
+ifeval::["{guide}" == "operator"]
 CR:: Custom Resource. An instance resource of a CRD. In other words, a resource of a kind that is not built into Kubernetes.
 CRD:: Custom Resource Definition. A Kubernetes API for defining Kubernetes API extensions.
-KMS:: Key Management System. A dedicated system for controlling access to cryptographic material, and providing operations which use that material.
+endif::[]
 mTLS:: Mutual Transport Layer Security. A configuration of TLS where the client presents a certificate to a server, which the server authenticates.
 TLS:: The Transport Layer Security. A secure transport protocol where a server presents a certificate to a client, which the client authenticates. TLS was previously known as the Secure Sockets Layer (SSL).
 TCP:: The Transmission Control Protocol.

kroxylicious-docs/docs/kroxylicious-proxy/index.adoc

@@ -27,5 +27,7 @@ include::_modules/con-community-filters.adoc[leveloffset=+1]
 //monitoring
 include::_assemblies/assembly-{guide}-monitoring.adoc[leveloffset=+1]
 
+include::_modules/ref-glossary.adoc[leveloffset=+1]
+
 //trademark notices
 include::_assets/trademarks.adoc[leveloffset=+1]

kroxylicious-docs/docs/record-encryption-guide/index.adoc

@@ -51,3 +51,6 @@ include::_assemblies/assembly-operations-record-encryption-filter.adoc[leveloffs
 
 //trademark notices
 include::_assets/trademarks.adoc[leveloffset=+1]
+
+// glossary
+include::_modules/record-encryption/ref-glossary.adoc[leveloffset=+1]