feat: update catalog naming (#245)

aklivity · Jul 23, 2024 · dd3257b · dd3257b
1 parent 5870a13
commit dd3257b
Show file tree

Hide file tree

Showing 8 changed files with 66 additions and 39 deletions.
diff --git a/src/concepts/catalogs.md b/src/concepts/catalogs.md
@@ -23,6 +23,6 @@ The simplest catalogs allow Zilla to access resources directly. The [filesystem]
 
 ## Remote Catalogs
 
-Zilla can reference remote configs stored in third-party services like Schema Registry. The [schema-registry](../reference/config/catalogs/catalog-schema-registry.md) and [apicurio](../reference/config/catalogs/catalog-apicurio.md) catalogs allow zilla to interact with those services through their admin APIs.
+Zilla can reference remote configs stored in third-party services like Schema Registry. The [schema-registry](../reference/config/catalogs/catalog-schema-registry.md) and [apicurio-registry](../reference/config/catalogs/catalog-apicurio-registry.md) catalogs allow zilla to interact with those services through their admin APIs.
 
 > [Apicurio in the Petstore REST Demo](https://github.com/aklivity/zilla-demos/tree/main/petstore) | [http.kafka.karapace example](https://github.com/aklivity/zilla-examples/tree/main/http.kafka.karapace)
diff --git a/...rence/config/catalogs/catalog-apicurio.md → ...fig/catalogs/catalog-apicurio-registry.md b/...rence/config/catalogs/catalog-apicurio.md → ...fig/catalogs/catalog-apicurio-registry.md
@@ -1,17 +1,19 @@
 ---
-shortTitle: apicurio
-description: Zilla runtime apicurio catalog
+shortTitle: apicurio-registry
+description: Zilla runtime apicurio-registry catalog
 category:
   - Catalog
 ---
 
-# apicurio Catalog
+# apicurio-registry Catalog
 
-Zilla runtime apicurio catalog
+Zilla runtime apicurio-registry catalog.
+
+Accepted `type` aliases:  `apicurio`
 
 ```yaml {2}
 catalog:
-  type: apicurio
+  type: apicurio-registry
   options:
     url: http://localhost:8080
     group-id: schemas

diff --git a/src/reference/config/catalogs/catalog-aws-glue.md b/src/reference/config/catalogs/catalog-aws-glue.md
@@ -11,7 +11,7 @@ category:
 [Available in <ZillaPlus/>](https://www.aklivity.io/products/zilla-plus)
 {.zilla-plus-badge .hint-container .info}
 
-Zilla runtime aws-glue catalog.
+Zilla runtime aws-glue catalog supports the official [AWS Glue](https://aws.amazon.com/glue/) registry.
 
 ```yaml {2}
 catalog:

diff --git a/src/reference/config/catalogs/catalog-filesystem.md b/src/reference/config/catalogs/catalog-filesystem.md
@@ -7,7 +7,7 @@ category:
 
 # filesystem Catalog
 
-Zilla runtime filesystem catalog
+Zilla runtime filesystem catalog.
 
 ```yaml {2}
 catalogs:

diff --git a/src/reference/config/catalogs/catalog-inline.md b/src/reference/config/catalogs/catalog-inline.md
@@ -7,7 +7,7 @@ category:
 
 # inline Catalog
 
-Zilla runtime inline catalog
+Zilla runtime inline catalog.
 
 ```yaml {2}
 catalog:

diff --git a/...rence/config/catalogs/catalog-karapace.md → ...alogs/catalog-karapace-schema-registry.md b/...rence/config/catalogs/catalog-karapace.md → ...alogs/catalog-karapace-schema-registry.md
@@ -1,17 +1,19 @@
 ---
-shortTitle: karapace
-description: Zilla runtime karapace catalog
+shortTitle: karapace-schema-registry
+description: Zilla runtime karapace-schema-registry catalog
 category:
   - Catalog
 ---
 
-# karapace Catalog
+# karapace-schema-registry Catalog
 
-Zilla runtime karapace catalog
+Zilla runtime karapace-schema-registry catalog
+
+Accepted `type` aliases: `karapace`
 
 ```yaml {2}
 catalog:
-  type: karapace
+  type: karapace-schema-registry
   options:
     url: http://reg.example.com:8081
     context: default

diff --git a/src/reference/config/catalogs/catalog-schema-registry.md b/src/reference/config/catalogs/catalog-schema-registry.md
@@ -1,17 +1,13 @@
 ---
 shortTitle: schema-registry
 description: Zilla runtime schema-registry catalog
-icon: aky-zilla-plus
 category:
   - Catalog
 ---
 
 # schema-registry Catalog
 
-[Available in <ZillaPlus/>](https://www.aklivity.io/products/zilla-plus)
-{.zilla-plus-badge .hint-container .info}
-
-Zilla runtime schema-registry catalog
+Zilla runtime schema-registry catalog.
 
 ```yaml {2}
 catalog:

diff --git a/src/reference/config/telemetry/events.md b/src/reference/config/telemetry/events.md
@@ -16,25 +16,32 @@ Named events from Zilla that can be exported and logged.
 - [BINDING\_HTTP\_REQUEST\_ACCEPTED](#binding-http-request-accepted)
 - [BINDING\_KAFKA\_API\_VERSION\_REJECTED](#binding-kafka-api-version-rejected)
 - [BINDING\_KAFKA\_AUTHORIZATION\_FAILED](#binding-kafka-authorization-failed)
+- [BINDING\_KAFKA\_CLUSTER\_AUTHORIZATION\_FAILED](#binding-kafka-cluster-authorization-failed)
 - [BINDING\_MQTT\_CLIENT\_CONNECTED](#binding-mqtt-client-connected)
 - [BINDING\_MQTT\_KAFKA\_NON\_COMPACT\_SESSIONS\_TOPIC](#binding-mqtt-kafka-non-compact-sessions-topic)
 - [BINDING\_TCP\_DNS\_FAILED](#binding-tcp-dns-failed)
 - [BINDING\_TLS\_HANDSHAKE\_FAILED](#binding-tls-handshake-failed)
 - [BINDING\_TLS\_KEY\_REJECTED](#binding-tls-key-rejected)
 - [BINDING\_TLS\_PEER\_NOT\_VERIFIED](#binding-tls-peer-not-verified)
 - [BINDING\_TLS\_PROTOCOL\_REJECTED](#binding-tls-protocol-rejected)
+- [BINDING\_TLS\_TLS\_KEY\_VERIFICATION\_FAILED](#binding-tls-tls-key-verification-failed)
 - [BINDING\_TLS\_TLS\_FAILED](#binding-tls-tls-failed)
-- [CATALOG\_APICURIO\_RETRIEVED\_ARTIFACT\_ID](#catalog-apicurio-retrieved-artifact-id)
-- [CATALOG\_APICURIO\_RETRIEVED\_ARTIFACT\_SUBJECT\_VERSION](#catalog-apicurio-retrieved-artifact-subject-version)
-- [CATALOG\_APICURIO\_UNRETRIEVABLE\_ARTIFACT\_ID](#catalog-apicurio-unretrievable-artifact-id)
-- [CATALOG\_APICURIO\_UNRETRIEVABLE\_ARTIFACT\_SUBJECT\_VERSION\_STALE\_ARTIFACT](#catalog-apicurio-unretrievable-artifact-subject-version-stale-artifact)
-- [CATALOG\_APICURIO\_UNRETRIEVABLE\_ARTIFACT\_SUBJECT\_VERSION](#catalog-apicurio-unretrievable-artifact-subject-version)
+- [CATALOG\_APICURIO\_REGISTRY\_RETRIEVED\_ARTIFACT\_ID](#catalog-apicurio-registry-retrieved-artifact-id)
+- [CATALOG\_APICURIO\_REGISTRY\_RETRIEVED\_ARTIFACT\_SUBJECT\_VERSION](#catalog-apicurio-registry-retrieved-artifact-subject-version)
+- [CATALOG\_APICURIO\_REGISTRY\_UNRETRIEVABLE\_ARTIFACT\_ID](#catalog-apicurio-registry-unretrievable-artifact-id)
+- [CATALOG\_APICURIO\_REGISTRY\_UNRETRIEVABLE\_ARTIFACT\_SUBJECT\_VERSION\_STALE\_ARTIFACT](#catalog-apicurio-registry-unretrievable-artifact-subject-version-stale-artifact)
+- [CATALOG\_APICURIO\_REGISTRY\_UNRETRIEVABLE\_ARTIFACT\_SUBJECT\_VERSION](#catalog-apicurio-registry-unretrievable-artifact-subject-version)
 - [CATALOG\_FILESYSTEM\_FILE\_NOT\_FOUND](#catalog-filesystem-file-not-found)
-- [CATALOG\_KARAPACE\_RETRIEVED\_SCHEMA\_ID](#catalog-karapace-retrieved-schema-id)
-- [CATALOG\_KARAPACE\_RETRIEVED\_SCHEMA\_SUBJECT\_VERSION](#catalog-karapace-retrieved-schema-subject-version)
-- [CATALOG\_KARAPACE\_UNRETRIEVABLE\_SCHEMA\_ID](#catalog-karapace-unretrievable-schema-id)
-- [CATALOG\_KARAPACE\_UNRETRIEVABLE\_SCHEMA\_SUBJECT\_VERSION\_STALE\_SCHEMA](#catalog-karapace-unretrievable-schema-subject-version-stale-schema)
-- [CATALOG\_KARAPACE\_UNRETRIEVABLE\_SCHEMA\_SUBJECT\_VERSION](#catalog-karapace-unretrievable-schema-subject-version)
+- [CATALOG\_KARAPACE\_SCHEMA\_REGISTRY\_RETRIEVED\_SCHEMA\_ID](#catalog-karapace-schema-registry-retrieved-schema-id)
+- [CATALOG\_KARAPACE\_SCHEMA\_REGISTRY\_RETRIEVED\_SCHEMA\_SUBJECT\_VERSION](#catalog-karapace-schema-registry-retrieved-schema-subject-version)
+- [CATALOG\_KARAPACE\_SCHEMA\_REGISTRY\_UNRETRIEVABLE\_SCHEMA\_ID](#catalog-karapace-schema-registry-unretrievable-schema-id)
+- [CATALOG\_KARAPACE\_SCHEMA\_REGISTRY\_UNRETRIEVABLE\_SCHEMA\_SUBJECT\_VERSION\_STALE\_SCHEMA](#catalog-karapace-schema-registry-unretrievable-schema-subject-version-stale-schema)
+- [CATALOG\_KARAPACE\_SCHEMA\_REGISTRY\_UNRETRIEVABLE\_SCHEMA\_SUBJECT\_VERSION](#catalog-karapace-schema-registry-unretrievable-schema-subject-version)
+- [CATALOG\_SCHEMA\_REGISTRY\_RETRIEVED\_SCHEMA\_ID](#catalog-schema-registry-retrieved-schema-id)
+- [CATALOG\_SCHEMA\_REGISTRY\_RETRIEVED\_SCHEMA\_SUBJECT\_VERSION](#catalog-schema-registry-retrieved-schema-subject-version)
+- [CATALOG\_SCHEMA\_REGISTRY\_UNRETRIEVABLE\_SCHEMA\_ID](#catalog-schema-registry-unretrievable-schema-id)
+- [CATALOG\_SCHEMA\_REGISTRY\_UNRETRIEVABLE\_SCHEMA\_SUBJECT\_VERSION\_STALE\_SCHEMA](#catalog-schema-registry-unretrievable-schema-subject-version-stale-schema)
+- [CATALOG\_SCHEMA\_REGISTRY\_UNRETRIEVABLE\_SCHEMA\_SUBJECT\_VERSION](#catalog-schema-registry-unretrievable-schema-subject-version)
 - [GUARD\_JWT\_AUTHORIZATION\_FAILED](#guard-jwt-authorization-failed)
 - [MODEL\_AVRO\_VALIDATION\_FAILED](#model-avro-validation-failed)
 - [MODEL\_CORE\_VALIDATION\_FAILED](#model-core-validation-failed)
@@ -97,50 +104,70 @@ A TLS key verification failed because the key is missing or invalid.
 
 A generic error detected by an SSL subsystem.
 
-### CATALOG_APICURIO_RETRIEVED_ARTIFACT_ID
+### CATALOG_APICURIO_REGISTRY_RETRIEVED_ARTIFACT_ID
 
 Fetching the Apicurio artifact was successful.
 
-### CATALOG_APICURIO_RETRIEVED_ARTIFACT_SUBJECT_VERSION
+### CATALOG_APICURIO_REGISTRY_RETRIEVED_ARTIFACT_SUBJECT_VERSION
 
 Fetching the Apicurio artifact by version was successful.
 
-### CATALOG_APICURIO_UNRETRIEVABLE_ARTIFACT_ID
+### CATALOG_APICURIO_REGISTRY_UNRETRIEVABLE_ARTIFACT_ID
 
 Fetching the Apicurio artifact was unsuccessful.
 
-### CATALOG_APICURIO_UNRETRIEVABLE_ARTIFACT_SUBJECT_VERSION_STALE_ARTIFACT
+### CATALOG_APICURIO_REGISTRY_UNRETRIEVABLE_ARTIFACT_SUBJECT_VERSION_STALE_ARTIFACT
 
 Fetching the Apicurio artifact by version was unsuccessful, but an previously fetched artifact is still being used.
 
-### CATALOG_APICURIO_UNRETRIEVABLE_ARTIFACT_SUBJECT_VERSION
+### CATALOG_APICURIO_REGISTRY_UNRETRIEVABLE_ARTIFACT_SUBJECT_VERSION
 
 Fetching the Apicurio artifact by version was unsuccessful.
 
 ### CATALOG_FILESYSTEM_FILE_NOT_FOUND
 
 No file was found at the specified location.
 
-### CATALOG_KARAPACE_RETRIEVED_SCHEMA_ID
+### CATALOG_KARAPACE_SCHEMA_REGISTRY_RETRIEVED_SCHEMA_ID
 
 Fetching the Karapace schema was successful.
 
-### CATALOG_KARAPACE_RETRIEVED_SCHEMA_SUBJECT_VERSION
+### CATALOG_KARAPACE_SCHEMA_REGISTRY_RETRIEVED_SCHEMA_SUBJECT_VERSION
 
 Fetching the Karapace schema by version was successful.
 
-### CATALOG_KARAPACE_UNRETRIEVABLE_SCHEMA_ID
+### CATALOG_KARAPACE_SCHEMA_REGISTRY_UNRETRIEVABLE_SCHEMA_ID
 
 Fetching the Karapace schema was unsuccessful.
 
-### CATALOG_KARAPACE_UNRETRIEVABLE_SCHEMA_SUBJECT_VERSION_STALE_SCHEMA
+### CATALOG_KARAPACE_SCHEMA_REGISTRY_UNRETRIEVABLE_SCHEMA_SUBJECT_VERSION_STALE_SCHEMA
 
 Fetching the Karapace schema by version was unsuccessful, but an previously fetched schema is still being used.
 
-### CATALOG_KARAPACE_UNRETRIEVABLE_SCHEMA_SUBJECT_VERSION
+### CATALOG_KARAPACE_SCHEMA_REGISTRY_UNRETRIEVABLE_SCHEMA_SUBJECT_VERSION
 
 Fetching the Karapace schema by version was unsuccessful.
 
+### CATALOG_SCHEMA_REGISTRY_RETRIEVED_SCHEMA_ID
+
+Fetching the registry schema was successful.
+
+### CATALOG_SCHEMA_REGISTRY_RETRIEVED_SCHEMA_SUBJECT_VERSION
+
+Fetching the registry schema by version was successful.
+
+### CATALOG_SCHEMA_REGISTRY_UNRETRIEVABLE_SCHEMA_ID
+
+Fetching the registry schema was unsuccessful.
+
+### CATALOG_SCHEMA_REGISTRY_UNRETRIEVABLE_SCHEMA_SUBJECT_VERSION_STALE_SCHEMA
+
+Fetching the registry schema by version was unsuccessful, but an previously fetched schema is still being used.
+
+### CATALOG_SCHEMA_REGISTRY_UNRETRIEVABLE_SCHEMA_SUBJECT_VERSION
+
+Fetching the registry schema by version was unsuccessful.
+
 ### GUARD_JWT_AUTHORIZATION_FAILED
 
 A client failed authorization for a JWT Guarded route.