Convert tables to raw md style

RedHatInsights · Aug 29, 2024 · fad796d · fad796d
1 parent 27c6647
commit fad796d
Show file tree

Hide file tree

Showing 12 changed files with 534 additions and 740 deletions.
diff --git a/docs/api_ref.md b/docs/api_ref.md
@@ -1188,4 +1188,4 @@ Must be one of:
 **Description:** The external hostname of the deployment, where applicable
 
 ----------------------------------------------------------------------------------------------------------------------------
-Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2024-07-29 at 11:17:42 +0100
+Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2024-08-28 at 14:57:43 +0200
diff --git a/docs/api_reference.md b/docs/api_reference.md
diff --git a/docs/developer-guide.md b/docs/developer-guide.md
@@ -417,17 +417,17 @@ defined in the below.
 Clowder currently support several feature flags which are intended to enable or disable certain 
 behaviour. They are detailed as follows:
 
-| Flag Name | Description | Permanent
-|--|--|--
-| ``features.createServiceMonitor`` | Enables the creation of prometheus ``ServiceMonitor`` resources. | No
-| ``features.disableWebhooks`` | While testing locally and for the ``suite_test``, the webhooks need to be disabled. this option facilitates that. | Yes
-| ``features.watchStrimziResources`` | When enabled, Clowder will assume ownership of the ``Kafka`` and ``KafkaConnect`` resources it creates. It will then respond to changes to these resources. | No
-| ``features.useComplexStrimziTopicNames`` | This flag switches Clowder to use non-colliding names for strimzi resources. This is important if using a singular strimzi server for multiple ``ClowdEnvironment`` resources. | Yes
-| ``features.enableAuthSidecarHook`` | Turns the sidecar functionality on or off globally. | Yes
-| ``features.enablekedaResources`` | Turns on the addition of Keda resources into the protectedGVK list. | No
-| ``features.perProviderMetrics`` | Turns on metrics that calculate reconciliation time per provider. | Yes
-| ``features.reconciliationMetrics`` | Enables extra detailed metrics on reconciliations per application. | Yes
-| ``features.enableDependencyMetrics`` | Turns on metrics that report availability of a ClowdApps dependencies. | Yes
-| ``disableCloudWatchLogging`` | Disables logging to CloudWatch. | Yes
-| ``enableExternalStrimzi`` | Enables talking to Strimzi via a local nodeport (only useful on minikube) | Yes
-| ``disableRandomRoutes`` | Gives the ability to disable the extra portion of randomness added to routes. | Yes
+| Flag Name                                      | Description                                                                                                                                         | Permanent |
+|------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|-----------|
+| `features.createServiceMonitor`                | Enables the creation of prometheus `ServiceMonitor` resources.                                                                                      | No        |
+| `features.disableWebhooks`                     | While testing locally and for the `suite_test`, the webhooks need to be disabled. this option facilitates that.                                      | Yes       |
+| `features.watchStrimziResources`               | When enabled, Clowder will assume ownership of the `Kafka` and `KafkaConnect` resources it creates. It will then respond to changes to these resources. | No        |
+| `features.useComplexStrimziTopicNames`         | This flag switches Clowder to use non-colliding names for strimzi resources. This is important if using a singular strimzi server for multiple `ClowdEnvironment` resources. | Yes       |
+| `features.enableAuthSidecarHook`               | Turns the sidecar functionality on or off globally.                                                                                                 | Yes       |
+| `features.enablekedaResources`                 | Turns on the addition of Keda resources into the protectedGVK list.                                                                                  | No        |
+| `features.perProviderMetrics`                  | Turns on metrics that calculate reconciliation time per provider.                                                                                    | Yes       |
+| `features.reconciliationMetrics`               | Enables extra detailed metrics on reconciliations per application.                                                                                   | Yes       |
+| `features.enableDependencyMetrics`             | Turns on metrics that report availability of a ClowdApps dependencies.                                                                               | Yes       |
+| `disableCloudWatchLogging`                     | Disables logging to CloudWatch.                                                                                                                      | Yes       |
+| `enableExternalStrimzi`                        | Enables talking to Strimzi via a local nodeport (only useful on minikube)                                                                            | Yes       |
+| `disableRandomRoutes`                          | Gives the ability to disable the extra portion of randomness added to routes.                                                                        | Yes       |
diff --git a/docs/providers/database.md b/docs/providers/database.md
@@ -116,12 +116,13 @@ A client helper is available for the RDS CA, used in app-interface mode.
 For supported languages, the database configuration is access via the following
 attribute names.
 
-Language | Attribute 
------------- | ------------- 
-Python | `LoadedConfig.database`
-Go | `LoadedConfig.Database`
-Javascript | `LoadedConfig.database`
-Ruby | `LoadedConfig.database`
+| Language    | Attribute                 |
+|-------------|---------------------------|
+| Python      | `LoadedConfig.database`   |
+| Go          | `LoadedConfig.Database`   |
+| JavaScript  | `LoadedConfig.database`   |
+| Ruby        | `LoadedConfig.database`   |
+
 
 
 ### Client helpers
@@ -131,12 +132,12 @@ Ruby | `LoadedConfig.database`
 Returns a filename which points to a temporary file containing the
 contents of the CA cert.
 
-Language | Attribute 
------------- | ------------- 
-Python |`LoadedConfig.rds_ca()`
-Go |`LoadedConfig.RdsCa()`
-Javascript | Not yet implemented
-Ruby | Not yet implemented
+| Language    | Attribute                  |
+|-------------|----------------------------|
+| Python      | `LoadedConfig.rds_ca()`    |
+| Go          | `LoadedConfig.RdsCa()`     |
+| JavaScript  | Not yet implemented        |
+| Ruby        | Not yet implemented        |
 
 ### ClowdEnv Configuration
 

diff --git a/docs/providers/dependencies.md b/docs/providers/dependencies.md
@@ -78,20 +78,22 @@ LoadedConfig.dependencyEndpoints["app_name1"]["deployment1"]
 For supported languages, the dependency configuration is access via the
 following attribute names.
 
-Language   | Attribute Name   
---|--                   
-Python     | ``LoadedConfig.dependencyEndpoints``
-Go         | ``LoadedConfig.DependencyEndpoints``
-Javascript | ``LoadedConfig.dependencyEndpoints``
-Ruby       | ``LoadedConfig.dependencyEndpoints``
+| Language   | Attribute Name                      |
+|------------|-------------------------------------|
+| Python     | `LoadedConfig.dependencyEndpoints`  |
+| Go         | `LoadedConfig.DependencyEndpoints`  |
+| JavaScript | `LoadedConfig.dependencyEndpoints`  |
+| Ruby       | `LoadedConfig.dependencyEndpoints`  |
+
 
 
 Private endpoints are accessible via these attribute names.
 
-Language   | Attribute Name        
---|--                     
-Python     | ``LoadedConfig.privateDependencyEndpoints``
-Go         | ``LoadedConfig.PrivateDependencyEndpoints``
-Javascript | ``LoadedConfig.privateDependencyEndpoints``
-Ruby       | ``LoadedConfig.privateDependencyEndpoints``
+| Language   | Attribute Name                             |
+|------------|--------------------------------------------|
+| Python     | `LoadedConfig.privateDependencyEndpoints`  |
+| Go         | `LoadedConfig.PrivateDependencyEndpoints`  |
+| JavaScript | `LoadedConfig.privateDependencyEndpoints`  |
+| Ruby       | `LoadedConfig.privateDependencyEndpoints`  |
+
 
diff --git a/docs/providers/featureflags.md b/docs/providers/featureflags.md
@@ -51,12 +51,13 @@ following structure.
 For supported languages, the feature flags configuration is access via the
 following attribute names.
 
-Language  | Attribute Name               
---|--
-Python    | ``LoadedConfig.featureFlags``
-Go        | ``LoadedConfig.FeatureFlags``
-Javscript | ``LoadedConfig.featureFlags``
-Ruby      | ``LoadedConfig.featureFlags``
+| Language   | Attribute Name               |
+|------------|------------------------------|
+| Python     | `LoadedConfig.featureFlags`  |
+| Go         | `LoadedConfig.FeatureFlags`  |
+| JavaScript | `LoadedConfig.featureFlags` |
+| Ruby       | `LoadedConfig.featureFlags`  |
+
 
 
 ### ClowdEnv Configuration

diff --git a/docs/providers/inmemorydb.md b/docs/providers/inmemorydb.md
@@ -63,12 +63,13 @@ following structure.
 For supported languages, the In-Memory DB configuration is accessed via the following
 attribute names.
 
-Language  | Attribute Name       
---|--      
-Python    | ``LoadedConfig.inMemoryDb``
-Go        | ``LoadedConfig.InMemoryDb``
-Javscript | ``LoadedConfig.inMemoryDb``
-Ruby      | ``LoadedConfig.inMemoryDb``
+| Language   | Attribute Name             |
+|------------|----------------------------|
+| Python     | `LoadedConfig.inMemoryDb`  |
+| Go         | `LoadedConfig.InMemoryDb`  |
+| JavaScript | `LoadedConfig.inMemoryDb`  |
+| Ruby       | `LoadedConfig.inMemoryDb`  |
+
 
 
 ### ClowdEnv Configuration

diff --git a/docs/providers/kafka.md b/docs/providers/kafka.md
@@ -144,26 +144,28 @@ A User auth enabled Kafka will look like this
 For supported languages, the kafka configuration is accessed via the following
 attribute names.
 
-Language  | Attribute Name
---|--
-Python    | `LoadedConfig.kafka`
-Go        | `LoadedConfig.Kafka`
-Javscript | `LoadedConfig.kafka`
-Ruby      | `LoadedConfig.kafka`
+| Language   | Attribute Name        |
+|------------|-----------------------|
+| Python     | `LoadedConfig.kafka`  |
+| Go         | `LoadedConfig.Kafka`  |
+| JavaScript | `LoadedConfig.kafka`  |
+| Ruby       | `LoadedConfig.kafka`  |
+
 
 ### Client helpers
 
 `KafkaTopics` Returns a map of topic objects, using the original requested name
 as the key and the topic object the value. `KafkaServers` Returns a list of
 Kafka broker strings comprising of hostname and port.
 
-Name        | Kafka Topics                      | Kafka Servers
---|--|--
-Description | Returns a map of topic objects, using the original requested name as the key and the topic object the value. | Returns a list of Kafka broker strings comprising of hostname and port.
-Python      | `KafkaTopics`                     | `KafkaServers`
-Go          | `KafkaTopics`                     | `KafkaServers`
-Javscript   | `KafkaTopics`                     | `KafkaServers`
-Ruby        | `KafkaTopics`                     | `KafkaServers`
+| Name        | Kafka Topics                                                                 | Kafka Servers                                                           |
+|-------------|------------------------------------------------------------------------------|-------------------------------------------------------------------------|
+| Description | Returns a map of topic objects, using the original requested name as the key and the topic object as the value. | Returns a list of Kafka broker strings comprising of hostname and port. |
+| Python      | `KafkaTopics`                                                                | `KafkaServers`                                                          |
+| Go          | `KafkaTopics`                                                                | `KafkaServers`                                                          |
+| JavaScript  | `KafkaTopics`                                                                | `KafkaServers`                                                          |
+| Ruby        | `KafkaTopics`                                                                | `KafkaServers`                                                          |
+
 
 ### ClowdEnv Configuration
 

diff --git a/docs/providers/logging.md b/docs/providers/logging.md
@@ -46,12 +46,12 @@ structure. The example below is given for `app-interface` mode.
 For supported languages, the logging configuration is access via the following
 attribute names.
 
-| Language  | Attribute Name        
---|--
-| Python    | `LoadedConfig.logging`
-| Go        | `LoadedConfig.Logging`
-| Javscript | `LoadedConfig.logging`
-| Ruby      | `LoadedConfig.logging`
+| Language   | Attribute Name          |
+|------------|-------------------------|
+| Python     | `LoadedConfig.logging`  |
+| Go         | `LoadedConfig.Logging`  |
+| Javascript | `LoadedConfig.logging`  |
+| Ruby       | `LoadedConfig.logging`  |
 
 ### ClowdEnv Configuration
 

diff --git a/docs/providers/metrics.md b/docs/providers/metrics.md
@@ -43,12 +43,12 @@ structure.
 For supported languages, the metrics configuration is access via the following
 attribute names.
 
-Language  | Attribute Name              
---|--
-Python    | `LoadedConfig.metricsPort`
-Go        | `LoadedConfig.MetricsPort`
-Javscript | `LoadedConfig.metricsPort`
-Ruby      | `LoadedConfig.metricsPort`
+| Language   | Attribute Name              |
+|------------|-----------------------------|
+| Python     | `LoadedConfig.metricsPort`  |
+| Go         | `LoadedConfig.MetricsPort`  |
+| Javascript | `LoadedConfig.metricsPort`  |
+| Ruby       | `LoadedConfig.metricsPort`  |
 
 
 ### ClowdEnv Configuration

diff --git a/docs/providers/objectstore.md b/docs/providers/objectstore.md
@@ -86,25 +86,25 @@ A helper is available below to facilitate quick access via a map.
 For supported languages, the object store configuration is access via the
 following attribute names.
 
-Language  | Attribute Name            
---|--
-Python    | `LoadedConfig.objectStore`
-Go        | `LoadedConfig.ObjectStore`
-Javscript | `LoadedConfig.objectStore`
-Ruby      | `LoadedConfig.objectStore`
+| Language    | Attribute Name              |
+|-------------|-----------------------------|
+| Python      | `LoadedConfig.objectStore`  |
+| Go          | `LoadedConfig.ObjectStore`  |
+| Javascript  | `LoadedConfig.objectStore`  |
+| Ruby        | `LoadedConfig.objectStore`  |
 
 
 ### Client helpers
 
 `ObjectBuckets` returns a map of bucket objects, using the original requested
 name as the key and the bucket object as the value.                    
 
-Name        | Object Store Buckets
---|--
-Python      | `ObjectBuckets`     
-Go          | `ObjectBuckets`     
-Javscript   | `ObjectBuckets`     
-Ruby        | `ObjectBuckets`     
+| Name        | Object Store Buckets  |
+|-------------|-----------------------|
+| Python      | `ObjectBuckets`       |
+| Go          | `ObjectBuckets`       |
+| Javascript  | `ObjectBuckets`       |
+| Ruby        | `ObjectBuckets`       |
 
 ### ClowdEnv Configuration
 

diff --git a/docs/providers/web.md b/docs/providers/web.md
@@ -154,12 +154,12 @@ structure.
 For supported languages, the web configuration is access via the following
 attribute names.
 
-Language  | Attribute Name      
---|--     
-Python    | `LoadedConfig.publicPort`
-Go        | `LoadedConfig.PublicPort`
-Javscript | `LoadedConfig.publicPort`
-Ruby      | `LoadedConfig.publicPort`
+| Language   | Attribute Name             |
+|------------|----------------------------|    
+| Python     | `LoadedConfig.publicPort`  |
+| Go         | `LoadedConfig.PublicPort`  |
+| Javascript | `LoadedConfig.publicPort`  |
+| Ruby       | `LoadedConfig.publicPort`  |
 
 ### ClowdEnv Configuration