Skip to content

Commit 6c9c7dd

Browse files
attributeerrorattributeerror
committed
fix: remove param comments from httpRoutes array & add example comment
Signed-off-by: Paul Reffell <attributeerror@amthst.dev>
1 parent 104da43 commit 6c9c7dd

2 files changed

Lines changed: 91 additions & 111 deletions

File tree

‎bitnami/schema-registry/README.md‎

Lines changed: 37 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -354,60 +354,43 @@ For annotations, please see [this document](https://github.com/kubernetes/ingres
354354

355355
### Exposure Parameters
356356

357-
| Name | Description | Value |
358-
| ------------------------------------------ | ----------------------------------------------------------------------------------------------------- | ------------------------ |
359-
| `service.type` | Kubernetes service type | `ClusterIP` |
360-
| `service.ports.http` | Service HTTP port | `8081` |
361-
| `service.nodePorts.http` | Service HTTP node port | `""` |
362-
| `service.clusterIP` | Schema Registry service clusterIP IP | `""` |
363-
| `service.externalTrafficPolicy` | Enable client source IP preservation | `Cluster` |
364-
| `service.loadBalancerIP` | loadBalancerIP if service type is LoadBalancer | `""` |
365-
| `service.loadBalancerSourceRanges` | Address that are allowed when service is LoadBalancer | `[]` |
366-
| `service.annotations` | Annotations for Schema Registry service | `{}` |
367-
| `service.labels` | Labels for Schema Registry service | `{}` |
368-
| `service.extraPorts` | Extra ports to expose in Schema Registry service (normally used with the `sidecars` value) | `[]` |
369-
| `service.sessionAffinity` | Control where client requests go, to the same pod or round-robin | `None` |
370-
| `service.sessionAffinityConfig` | Additional settings for the sessionAffinity | `{}` |
371-
| `service.headless.annotations` | Annotations for the headless service. | `{}` |
372-
| `networkPolicy.enabled` | Specifies whether a NetworkPolicy should be created | `true` |
373-
| `networkPolicy.allowExternal` | Don't require client label for connections | `true` |
374-
| `networkPolicy.allowExternalEgress` | Allow the pod to access any range of port and all destinations. | `true` |
375-
| `networkPolicy.extraIngress` | Add extra ingress rules to the NetworkPolicy | `[]` |
376-
| `networkPolicy.extraEgress` | Add extra ingress rules to the NetworkPolicy | `[]` |
377-
| `networkPolicy.ingressNSMatchLabels` | Labels to match to allow traffic from other namespaces | `{}` |
378-
| `networkPolicy.ingressNSPodMatchLabels` | Pod labels to match to allow traffic from other namespaces | `{}` |
379-
| `ingress.enabled` | Enable ingress record generation for Schema Registry | `false` |
380-
| `ingress.pathType` | Ingress path type | `ImplementationSpecific` |
381-
| `ingress.apiVersion` | Force Ingress API version (automatically detected if not set) | `""` |
382-
| `ingress.hostname` | Default host for the ingress record | `schema-registry.local` |
383-
| `ingress.ingressClassName` | IngressClass that will be be used to implement the Ingress (Kubernetes 1.18+) | `""` |
384-
| `ingress.path` | Default path for the ingress record | `/` |
385-
| `ingress.annotations` | Additional custom annotations for the ingress record | `{}` |
386-
| `ingress.tls` | Enable TLS configuration for the host defined at `ingress.hostname` parameter | `false` |
387-
| `ingress.selfSigned` | Create a TLS secret for this ingress record using self-signed certificates generated by Helm | `false` |
388-
| `ingress.extraHosts` | An array with additional hostname(s) to be covered with the ingress record | `[]` |
389-
| `ingress.extraPaths` | An array with additional arbitrary paths that may need to be added to the ingress under the main host | `[]` |
390-
| `ingress.extraTls` | TLS configuration for additional hostname(s) to be covered with this ingress record | `[]` |
391-
| `ingress.secrets` | Custom TLS certificates as secrets | `[]` |
392-
| `ingress.extraRules` | Additional rules to be covered with this ingress record | `[]` |
393-
| `httpRoutes` | HTTPRoute resources to create. | `[]` |
394-
| `httpRoutes.enabled` | Enable this HTTPRoute | `""` |
395-
| `httpRoutes.hostnames` | Hostnames to expose this HTTPRoute under | `[]` |
396-
| `httpRoutes.annotations` | Additional annotations for the HTTPRoute resource. | `{}` |
397-
| `httpRoutes.labels` | Labels for the HTTPRoute | `{}` |
398-
| `httpRoutes.nameOverride` | The name to give this HTTPRoute resource. | `""` |
399-
| `httpRoutes.gatewayParentRefs` | Which gateway to bind this HTTPRoute to | `[]` |
400-
| `httpRoutes.gatewayParentRefs.name` | The name of the gateway to bind this HTTPRoute to. | `""` |
401-
| `httpRoutes.gatewayParentRefs.namespace` | The namespace that the gateway is defined under. | `""` |
402-
| `httpRoutes.gatewayParentRefs.sectionName` | The section name of the listener to bind to on the Gateway. | `""` |
403-
| `httpRoutes.shouldStripPath` | Whether to strip the path before sending the request to the service. | `""` |
404-
| `httpRoutes.shouldRouteToService` | Whether this HTTPRoute should route to the backend service. | `""` |
405-
| `httpRoutes.matches` | HTTPRoute match rules | `[]` |
406-
| `httpRoutes.matches.path` | Match the route based on this path structure. | `{}` |
407-
| `httpRoutes.matches.path.type` | One of Exact, PathPrefix or RegularExpression. | `""` |
408-
| `httpRoutes.matches.path.value` | The path to match on after the host. | `""` |
409-
| `httpRoutes.filters` | HTTPRoute filters | `[]` |
410-
| `httpRoutes.timeouts` | HTTPRoute timeouts | `{}` |
357+
| Name | Description | Value |
358+
| --------------------------------------- | ----------------------------------------------------------------------------------------------------- | ------------------------ |
359+
| `service.type` | Kubernetes service type | `ClusterIP` |
360+
| `service.ports.http` | Service HTTP port | `8081` |
361+
| `service.nodePorts.http` | Service HTTP node port | `""` |
362+
| `service.clusterIP` | Schema Registry service clusterIP IP | `""` |
363+
| `service.externalTrafficPolicy` | Enable client source IP preservation | `Cluster` |
364+
| `service.loadBalancerIP` | loadBalancerIP if service type is LoadBalancer | `""` |
365+
| `service.loadBalancerSourceRanges` | Address that are allowed when service is LoadBalancer | `[]` |
366+
| `service.annotations` | Annotations for Schema Registry service | `{}` |
367+
| `service.labels` | Labels for Schema Registry service | `{}` |
368+
| `service.extraPorts` | Extra ports to expose in Schema Registry service (normally used with the `sidecars` value) | `[]` |
369+
| `service.sessionAffinity` | Control where client requests go, to the same pod or round-robin | `None` |
370+
| `service.sessionAffinityConfig` | Additional settings for the sessionAffinity | `{}` |
371+
| `service.headless.annotations` | Annotations for the headless service. | `{}` |
372+
| `networkPolicy.enabled` | Specifies whether a NetworkPolicy should be created | `true` |
373+
| `networkPolicy.allowExternal` | Don't require client label for connections | `true` |
374+
| `networkPolicy.allowExternalEgress` | Allow the pod to access any range of port and all destinations. | `true` |
375+
| `networkPolicy.extraIngress` | Add extra ingress rules to the NetworkPolicy | `[]` |
376+
| `networkPolicy.extraEgress` | Add extra ingress rules to the NetworkPolicy | `[]` |
377+
| `networkPolicy.ingressNSMatchLabels` | Labels to match to allow traffic from other namespaces | `{}` |
378+
| `networkPolicy.ingressNSPodMatchLabels` | Pod labels to match to allow traffic from other namespaces | `{}` |
379+
| `ingress.enabled` | Enable ingress record generation for Schema Registry | `false` |
380+
| `ingress.pathType` | Ingress path type | `ImplementationSpecific` |
381+
| `ingress.apiVersion` | Force Ingress API version (automatically detected if not set) | `""` |
382+
| `ingress.hostname` | Default host for the ingress record | `schema-registry.local` |
383+
| `ingress.ingressClassName` | IngressClass that will be be used to implement the Ingress (Kubernetes 1.18+) | `""` |
384+
| `ingress.path` | Default path for the ingress record | `/` |
385+
| `ingress.annotations` | Additional custom annotations for the ingress record | `{}` |
386+
| `ingress.tls` | Enable TLS configuration for the host defined at `ingress.hostname` parameter | `false` |
387+
| `ingress.selfSigned` | Create a TLS secret for this ingress record using self-signed certificates generated by Helm | `false` |
388+
| `ingress.extraHosts` | An array with additional hostname(s) to be covered with the ingress record | `[]` |
389+
| `ingress.extraPaths` | An array with additional arbitrary paths that may need to be added to the ingress under the main host | `[]` |
390+
| `ingress.extraTls` | TLS configuration for additional hostname(s) to be covered with this ingress record | `[]` |
391+
| `ingress.secrets` | Custom TLS certificates as secrets | `[]` |
392+
| `ingress.extraRules` | Additional rules to be covered with this ingress record | `[]` |
393+
| `httpRoutes` | Array of HTTPRoute resources to create. | `[]` |
411394

412395
### RBAC parameters
413396

0 commit comments

Comments
 (0)