This is an automated email from the ASF dual-hosted git repository.
jamesnetherton pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel-quarkus.git
The following commit(s) were added to refs/heads/main by this push:
new 3de09bf67b fixes #6992 make azure-key-vault readme clearer
3de09bf67b is described below
commit 3de09bf67b85d9ea0d03f7322216253b72c3d74f
Author: Jiri Ondrusek <[email protected]>
AuthorDate: Tue Feb 11 10:11:57 2025 +0100
fixes #6992 make azure-key-vault readme clearer
---
.../azure/azure-key-vault/README.adoc | 46 +++++++++++++++-------
1 file changed, 32 insertions(+), 14 deletions(-)
diff --git a/integration-test-groups/azure/azure-key-vault/README.adoc
b/integration-test-groups/azure/azure-key-vault/README.adoc
index 829a674560..9306a8e9b4 100644
--- a/integration-test-groups/azure/azure-key-vault/README.adoc
+++ b/integration-test-groups/azure/azure-key-vault/README.adoc
@@ -12,9 +12,36 @@
https://docs.microsoft.com/en-us/azure/storage/blobs/storage-quickstart-blobs-po
* An
https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-get-connection-string[Event
Hubs connection string]
* A https://learn.microsoft.com/en-us/azure/key-vault/general/overview[Key
Vault] configured in your Azure account
-To add resources required for key-vault tests, you can use
`key-vault-resources.sh` script as follows. Ensure that you have installed (and
logged in) the https://docs.microsoft.com/en-us/cli/azure/[Azure CLI]
beforehand.
-The script prerequisites are permissions, resource group and event hub
namespace.
-If you need such resources created as well, please follow instructions from
the parent module.
+=== Required resources
+
+For running the test following resources have to exist:
+
+* event hubs
+* blob container
+
+The configuration is handed to the test via environmental variables. All
following variables are required for the test execution.
+
+[source,shell]
+----
+export AZURE_CLIENT_ID=<your-azure-app-client-id>
+export AZURE_CLIENT_SECRET=<your-azure-app-client-secret>
+export AZURE_TENANT_ID=<your-azure-app-tenant-id>
+export AZURE_VAULT_NAME=<your-azure-key-vault-name>
+export AZURE_VAULT_EVENT_HUBS_BLOB_CONTAINER_NAME=<container for storing
position of eventhub consumer>
+export AZURE_VAULT_EVENT_HUBS_CONNECTION_STRING=<connection string for
eventhub>
+export AZURE_STORAGE_ACCOUNT_KEY=<storage account key required for context
refresh configuration>
+----
+
+=== Script for resource configuration
+
+To add resources required for the key-vault tests, you can use
`key-vault-resources.sh` script as follows.
+
+* Ensure that you have installed (and logged in) the
https://docs.microsoft.com/en-us/cli/azure/[Azure CLI] beforehand.
+* You have to have permissions for eventhubs and storage container creation,
existing resource group and event hub namespace.
+
+(In case you have an "empty" cloud and need to create all resources, please
follow instructions from the parent module.)
+
+Command for script execution:
[source,shell]
----
@@ -23,7 +50,7 @@ $ ./key-vault-resources.sh create
The script outputs a set of export commands that you may want to paste to your
shell.
-Here are the environment variables you need to set:
+Here are the environment variables you need to set before the script execution:
[source,shell]
----
@@ -40,7 +67,7 @@ To clean up, run
$ ./key-vault-resources.sh delete
----
-=== What is created by the script
+==== What is created by the script
* eventhub used for testing context reload
* storage container required for storing position of eventhub consumer
@@ -53,12 +80,3 @@ Following properties are generated by the script and are
required for the test e
export AZURE_STORAGE_ACCOUNT_KEY=<storage account key required for context
refresh configuration>
----
-Following properties have to be set manually before test execution
-
-[source,shell]
-----
-export AZURE_CLIENT_ID=<your-azure-app-client-id>
-export AZURE_CLIENT_SECRET=<your-azure-app-client-secret>
-export AZURE_TENANT_ID=<your-azure-app-tenant-id>
-export AZURE_VAULT_NAME=<your-azure-key-vault-name>
-----
\ No newline at end of file
