docs(refactor): reoragnise record-encryption content ready to pull out key creation as a top-level section

k-wall · k-wall · commit 6969f76292ae · 2025-12-18T20:57:25.000Z
no user facing changes in this commit.

Signed-off-by: Keith Wall &lt;kwall@apache.org&gt;
diff --git a/kroxylicious-docs/docs/_assemblies/record-encryption/assembly-configuring-record-encryption-filter.adoc b/kroxylicious-docs/docs/_assemblies/record-encryption/assembly-configuring-record-encryption-filter.adoc
@@ -46,22 +46,22 @@ ifdef::include-platform-kubernetes[]
 * In a Kubernetes deployment using a `KafkaProtocolFilter` resource. See <<con-example-kafkaprotocolfilter-resource-{context}>>
 endif::[]
 
-include::../_modules/record-encryption/hashicorp-vault/con-vault-plugin-configuration.adoc[leveloffset=+1]
+include::../../_modules/record-encryption/hashicorp-vault/con-vault-plugin-configuration.adoc[leveloffset=+1]
 
-include::../_modules/record-encryption/aws-kms/con-aws-kms-plugin-configuration.adoc[leveloffset=+1]
+include::../../_modules/record-encryption/aws-kms/con-aws-kms-plugin-configuration.adoc[leveloffset=+1]
 
-include::../_modules/record-encryption/azure-key-vault/con-azure-key-vault-plugin-configuration.adoc[leveloffset=+1]
+include::../../_modules/record-encryption/azure-key-vault/con-azure-key-vault-plugin-configuration.adoc[leveloffset=+1]
 
 ifdef::include-fortanix-dsm-kms[]
-include::../_modules/record-encryption/fortanix-dsm/con-fortanix-dsm-plugin-configuration.adoc[leveloffset=+1]
+include::../../_modules/record-encryption/fortanix-dsm/con-fortanix-dsm-plugin-configuration.adoc[leveloffset=+1]
 endif::[]
 
-include::../_modules/record-encryption/con-record-encryption-filter-config.adoc[leveloffset=+1]
+include::../../_modules/record-encryption/con-record-encryption-filter-config.adoc[leveloffset=+1]
 
 ifdef::include-platform-bare-metal[]
-include::../_modules/record-encryption/con-example-proxy-config.adoc[leveloffset=+1]
+include::../../_modules/record-encryption/con-example-proxy-config.adoc[leveloffset=+1]
 endif::[]
 
 ifdef::include-platform-kubernetes[]
-include::../_modules/record-encryption/con-example-kafkaprotocolfilter-resource.adoc[leveloffset=+1]
+include::../../_modules/record-encryption/con-example-kafkaprotocolfilter-resource.adoc[leveloffset=+1]
 endif::[]
diff --git a/kroxylicious-docs/docs/_assemblies/record-encryption/assembly-kms-preparing.adoc b/kroxylicious-docs/docs/_assemblies/record-encryption/assembly-kms-preparing.adoc
@@ -2,20 +2,20 @@
 
 // record-encryption-guide/index.adoc
 
-[id='assembly-preparing-kms-{context}']
+[id='assembly-kms-preparing-{context}']
 = Preparing your KMS
 
 [role="_abstract"]
 This section assumes that you already have a supported KMS instance up and running.
 It describes how to prepare the KMS for use with the filter.
 
 //setting up hashicorp vault
-include::assembly-hashicorp-vault.adoc[leveloffset=+1]
+include::hashicorp-vault/assembly-preparing-hashicorp-vault.adoc[leveloffset=+1]
 //setting up AWS KMS
-include::assembly-aws-kms.adoc[leveloffset=+1]
+include::aws-kms/assembly-preparing-aws-kms.adoc[leveloffset=+1]
 //setting up Azure Key Vault KMS
-include::assembly-azure-key-vault.adoc[leveloffset=+1]
+include::azure-key-vault/assembly-preparing-azure-key-vault.adoc[leveloffset=+1]
 ifdef::include-fortanix-dsm-kms[]
-include::assembly-fortanix-dsm.adoc[leveloffset=+1]
+include::fortanix-dsm/assembly-preparing-fortanix-dsm.adoc[leveloffset=+1]
 endif::[]
 
diff --git a/kroxylicious-docs/docs/_assemblies/record-encryption/assembly-monitoring-record-encryption-filter.adoc b/kroxylicious-docs/docs/_assemblies/record-encryption/assembly-monitoring-record-encryption-filter.adoc
@@ -10,4 +10,4 @@
 [role="_abstract"]
 This section describes how to monitor the Record Encryption filter.
 
-include::../_modules/record-encryption/con-metrics.adoc[leveloffset=+1]
+include::../../_modules/record-encryption/con-metrics.adoc[leveloffset=+1]
diff --git a/kroxylicious-docs/docs/_assemblies/record-encryption/assembly-operations-record-encryption-filter.adoc b/kroxylicious-docs/docs/_assemblies/record-encryption/assembly-operations-record-encryption-filter.adoc
@@ -11,4 +11,4 @@
 
 This section documents the operational aspects of using the record encryption filter.
 
-include::../_modules/record-encryption/con-lost-kek.adoc[leveloffset=+1]
+include::../../_modules/record-encryption/con-lost-kek.adoc[leveloffset=+1]
diff --git a/kroxylicious-docs/docs/_assemblies/record-encryption/aws-kms/assembly-preparing-aws-kms.adoc b/kroxylicious-docs/docs/_assemblies/record-encryption/aws-kms/assembly-preparing-aws-kms.adoc
@@ -4,7 +4,7 @@
 //
 // assembly-record-encryption-filter.adoc
 
-[id='assembly-aws-kms-{context}']
+[id='assembly-preparing-aws-kms-{context}']
 = Preparing AWS KMS
 
 [role="_abstract"]
@@ -15,5 +15,5 @@ To prepare {aws}/kms/latest/developerguide/overview.html[AWS Key Management Serv
 
 You'll need a privileged AWS user that is capable of creating users and policies to perform the set-up.
 
-include::../_modules/record-encryption/aws-kms/con-aws-kms-setup.adoc[leveloffset=+1]
-include::../_modules/record-encryption/aws-kms/proc-aws-kms-key-creation.adoc[leveloffset=+1]
+include::../../../_modules/record-encryption/aws-kms/con-aws-kms-setup.adoc[leveloffset=+1]
+include::../../../_modules/record-encryption/aws-kms/proc-aws-kms-key-creation.adoc[leveloffset=+1]
diff --git a/kroxylicious-docs/docs/_assemblies/record-encryption/azure-key-vault/assembly-preparing-azure-key-vault.adoc b/kroxylicious-docs/docs/_assemblies/record-encryption/azure-key-vault/assembly-preparing-azure-key-vault.adoc
@@ -4,7 +4,7 @@
 //
 // assembly-record-encryption-filter.adoc
 
-[id='assembly-azure-key-vault-{context}']
+[id='assembly-preparing-azure-key-vault-{context}']
 = Preparing Azure Key Vault
 
 [role="_abstract"]
@@ -16,8 +16,8 @@ To prepare Azure Key Vault for use with the Record Encryption filter, use the fo
 
 You'll need a privileged Azure user that is capable of creating users and resources to perform the set-up.
 
-include::../_modules/record-encryption/azure-key-vault/proc-azure-key-vault-setup.adoc[leveloffset=+1]
-include::../_modules/record-encryption/azure-key-vault/proc-azure-key-vault-key-creation.adoc[leveloffset=+1]
+include::../../../_modules/record-encryption/azure-key-vault/proc-azure-key-vault-setup.adoc[leveloffset=+1]
+include::../../../_modules/record-encryption/azure-key-vault/proc-azure-key-vault-key-creation.adoc[leveloffset=+1]
 
 [role="_additional-resources"]
 .Additional resources
diff --git a/kroxylicious-docs/docs/_assemblies/record-encryption/fortanix-dsm/assembly-preparing-fortanix-dsm.adoc b/kroxylicious-docs/docs/_assemblies/record-encryption/fortanix-dsm/assembly-preparing-fortanix-dsm.adoc
@@ -4,7 +4,7 @@
 //
 // assembly-record-encryption-filter.adoc
 
-[id='assembly-fortanix-dsm-{context}']
+[id='assembly-preparing-fortanix-dsm-{context}']
 = Preparing Fortanix Data Security Manager (DSM)
 
 [role="_abstract"]
@@ -14,5 +14,5 @@ To prepare Fortanix Data Security Manager (DSM) for use with the Record Encrypti
 * Create an application identity, with an API key, for the Record Encryption filter.
 * Create Fortanix DSM keys.
 
-include::../_modules/record-encryption/fortanix-dsm/con-fortanix-dsm-setup.adoc[leveloffset=+1]
-include::../_modules/record-encryption/fortanix-dsm/proc-fortanix-dsm-key-creation.adoc[leveloffset=+1]
+include::../../../_modules/record-encryption/fortanix-dsm/con-fortanix-dsm-setup.adoc[leveloffset=+1]
+include::../../../_modules/record-encryption/fortanix-dsm/proc-fortanix-dsm-key-creation.adoc[leveloffset=+1]
diff --git a/kroxylicious-docs/docs/_assemblies/record-encryption/hashicorp-vault/assembly-preparing-hashicorp-vault.adoc b/kroxylicious-docs/docs/_assemblies/record-encryption/hashicorp-vault/assembly-preparing-hashicorp-vault.adoc
@@ -4,7 +4,7 @@
 //
 // assembly-record-encryption-filter.adoc
 
-[id='assembly-hashicorp-vault-{context}']
+[id='assembly-preparing-hashicorp-vault-{context}']
 = Preparing HashiCorp Vault
 
 [role="_abstract"]
@@ -14,6 +14,6 @@ To use HashiCorp Vault with the Record Encryption filter, use the following setu
 * Create a Vault policy specifically for the filter with permissions for generating and decrypting Data Encryption Keys (DEKs) for envelope encryption.
 * Obtain a Vault token that includes the filter policy.
 
-include::../_modules/record-encryption/hashicorp-vault/con-vault-setup.adoc[leveloffset=+1]
+include::../../../_modules/record-encryption/hashicorp-vault/con-vault-setup.adoc[leveloffset=+1]
 
-include::../_modules/record-encryption/hashicorp-vault/proc-vault-key-creation.adoc[leveloffset=+1]
+include::../../../_modules/record-encryption/hashicorp-vault/proc-vault-key-creation.adoc[leveloffset=+1]
diff --git a/kroxylicious-docs/docs/_modules/record-encryption/aws-kms/con-aws-kms-setup.adoc b/kroxylicious-docs/docs/_modules/record-encryption/aws-kms/con-aws-kms-setup.adoc
@@ -2,7 +2,7 @@
 
 // file included in the following:
 //
-// assembly-aws-kms.adoc
+// assembly-preparing-aws-kms.adoc
 
 [id='con-aws-kms-setup-{context}']
 = Establish an aliasing convention for keys within AWS KMS
diff --git a/kroxylicious-docs/docs/_modules/record-encryption/aws-kms/proc-aws-kms-key-creation.adoc b/kroxylicious-docs/docs/_modules/record-encryption/aws-kms/proc-aws-kms-key-creation.adoc
@@ -2,9 +2,9 @@
 
 // file included in the following:
 //
-// assembly-aws-kms.adoc
+// assembly-preparing-aws-kms.adoc
 
-[id='con-aws-kms-key-creation-{context}']
+[id='proc-aws-kms-key-creation-{context}']
 = Creating AWS KMS keys
 
 [role="_abstract"]
diff --git a/kroxylicious-docs/docs/_modules/record-encryption/azure-key-vault/proc-azure-key-vault-key-creation.adoc b/kroxylicious-docs/docs/_modules/record-encryption/azure-key-vault/proc-azure-key-vault-key-creation.adoc
@@ -2,9 +2,9 @@
 
 // file included in the following:
 //
-// assembly-azure-key-vault.adoc
+// assembly-preparing-azure-key-vault.adoc
 
-[id='con-azure-key-vault-key-creation-{context}']
+[id='proc-azure-key-vault-key-creation-{context}']
 = Creating Azure Key Vault keys
 
 [role="_abstract"]
diff --git a/kroxylicious-docs/docs/_modules/record-encryption/azure-key-vault/proc-azure-key-vault-setup.adoc b/kroxylicious-docs/docs/_modules/record-encryption/azure-key-vault/proc-azure-key-vault-setup.adoc
@@ -2,7 +2,7 @@
 
 // file included in the following:
 //
-// assembly-azure-key-vault.adoc
+// assembly-preparing-azure-key-vault.adoc
 
 [id='proc-azure-key-vault-setup-{context}']
 = Setting up Azure resources
diff --git a/kroxylicious-docs/docs/_modules/record-encryption/fortanix-dsm/proc-fortanix-dsm-key-creation.adoc b/kroxylicious-docs/docs/_modules/record-encryption/fortanix-dsm/proc-fortanix-dsm-key-creation.adoc
@@ -2,9 +2,9 @@
 
 // file included in the following:
 //
-// assembly-fortanix-dsm.adoc
+// assembly-preparing-fortanix-dsm.adoc
 
-[id='con-fortanix-dsm-key-creation-{context}']
+[id='proc-fortanix-dsm-key-creation-{context}']
 = Creating Fortanix DSM keys
 
 [role="_abstract"]
diff --git a/kroxylicious-docs/docs/_modules/record-encryption/hashicorp-vault/con-vault-setup.adoc b/kroxylicious-docs/docs/_modules/record-encryption/hashicorp-vault/con-vault-setup.adoc
@@ -2,7 +2,7 @@
 
 // file included in the following:
 //
-// assembly-hashicorp-vault.adoc
+// assembly-preparing-hashicorp-vault.adoc
 
 [id='con-vault-setup-{context}']
 = Enable the Transit Engine
diff --git a/kroxylicious-docs/docs/_modules/record-encryption/hashicorp-vault/proc-vault-key-creation.adoc b/kroxylicious-docs/docs/_modules/record-encryption/hashicorp-vault/proc-vault-key-creation.adoc
@@ -2,9 +2,9 @@
 
 // file included in the following:
 //
-// assembly-hashicorp-vault.adoc
+// assembly-preparing-hashicorp-vault.adoc
 
-[id='con-vault-key-creation-{context}']
+[id='proc-vault-key-creation-{context}']
 = Creating HashiCorp Vault keys
 
 [role="_abstract"]
diff --git a/kroxylicious-docs/docs/record-encryption-guide/index.adoc b/kroxylicious-docs/docs/record-encryption-guide/index.adoc
@@ -38,16 +38,16 @@ include::_modules/record-encryption/con-record-encryption-overview.adoc[leveloff
 
 // preparing the KMS (might be done by a KMS admin, rather
 // than the person setting up the filter)
-include::_assemblies/assembly-preparing-kms.adoc[leveloffset=+1]
+include::_assemblies/record-encryption/assembly-kms-preparing.adoc[leveloffset=+1]
 
 //configuring the record encryption filter
-include::_assemblies/assembly-configuring-record-encryption-filter.adoc[leveloffset=+1]
+include::_assemblies/record-encryption/assembly-configuring-record-encryption-filter.adoc[leveloffset=+1]
 
 //monitoring the record encryption filter
-include::_assemblies/assembly-monitoring-record-encryption-filter.adoc[leveloffset=+1]
+include::_assemblies/record-encryption/assembly-monitoring-record-encryption-filter.adoc[leveloffset=+1]
 
 //operational issues affecting the record encryption filter
-include::_assemblies/assembly-operations-record-encryption-filter.adoc[leveloffset=+1]
+include::_assemblies/record-encryption/assembly-operations-record-encryption-filter.adoc[leveloffset=+1]
 
 //trademark notices
 include::_assets/trademarks.adoc[leveloffset=+1]

Original file line number	Diff line number	Diff line change
`@@ -11,4 +11,4 @@`
`11`	`11`
`12`	`12`	`This section documents the operational aspects of using the record encryption filter.`
`13`	`13`
`14`		`-include::../_modules/record-encryption/con-lost-kek.adoc[leveloffset=+1]`
	`14`	`+include::../../_modules/record-encryption/con-lost-kek.adoc[leveloffset=+1]`