Skip to content

Commit

Permalink
chore: updates chart docs with v1.13.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@norwoodj
norwoodj committed Feb 24, 2024
1 parent 6cdd5ff commit a8411d8
Show file tree
Hide file tree
Showing 21 changed files with 42 additions and 0 deletions.
2 changes: 2 additions & 0 deletions example-charts/best-values-example/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,5 @@ One of the best values parsing example charts here, exhibits several more compli
| statefulset.livenessProbe | object | `{"enabled":false}` | Configure the healthcheck for the database |
| statefulset.podLabels | object | `{}` | The labels to be applied to instances of the database |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.13.0](https://github.com/norwoodj/helm-docs/releases/v1.13.0)
2 changes: 2 additions & 0 deletions example-charts/custom-template/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,3 +58,5 @@ $ helm install my-release foo-bar/custom-template
| controller.service.annotations."external-dns.alpha.kubernetes.io/hostname" | string | `"stupidchess.jmn23.com"` | Hostname to be assigned to the ELB for the service |
| controller.service.type | string | `"LoadBalancer"` | |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.13.0](https://github.com/norwoodj/helm-docs/releases/v1.13.0)
2 changes: 2 additions & 0 deletions example-charts/custom-value-notation-type/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1104,3 +1104,5 @@ string
</tbody>
</table>

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.13.0](https://github.com/norwoodj/helm-docs/releases/v1.13.0)
2 changes: 2 additions & 0 deletions example-charts/dos-line-endings/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,5 @@ A chart whose values file has dos line endings rather than unix ones
| livenessProbe.httpGet.path | string | `"/healthz"` | This is the liveness check endpoint |
| livenessProbe.httpGet.port | string | `"http"` | |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.13.0](https://github.com/norwoodj/helm-docs/releases/v1.13.0)
2 changes: 2 additions & 0 deletions example-charts/files-values/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -67,3 +67,5 @@ File: example-charts/files-values/values.yaml
| statefulset.livenessProbe | object | `{"enabled":false}` | Configure the healthcheck for the database |
| statefulset.podLabels | object | `{}` | The labels to be applied to instances of the database |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.13.0](https://github.com/norwoodj/helm-docs/releases/v1.13.0)
2 changes: 2 additions & 0 deletions example-charts/full-template/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -162,3 +162,5 @@ Kubernetes: `<=1.18`
| controller.service.annotations."external-dns.alpha.kubernetes.io/hostname" | string | `"stupidchess.jmn23.com"` | Hostname to be assigned to the ELB for the service |
| controller.service.type | string | `"LoadBalancer"` | |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.13.0](https://github.com/norwoodj/helm-docs/releases/v1.13.0)
2 changes: 2 additions & 0 deletions example-charts/fully-documented/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,5 @@ A simple wrapper around the stable/nginx-ingress chart that adds a few of our co
| controller.image.tag | string | `"18.0831"` | The tag of the image of the controller |
| controller.name | string | `"controller"` | The name of the controller |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.13.0](https://github.com/norwoodj/helm-docs/releases/v1.13.0)
2 changes: 2 additions & 0 deletions example-charts/funky-version/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,5 @@ A very simple chart with a funky version

* <https://github.com/norwoodj/helm-docs/tree/master/example-charts/funky-version>

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.13.0](https://github.com/norwoodj/helm-docs/releases/v1.13.0)
2 changes: 2 additions & 0 deletions example-charts/helm-3/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,5 @@ A simple wrapper around the stable/nginx-ingress chart that adds a few of our co
| controller.service.annotations."external-dns.alpha.kubernetes.io/hostname" | string | `"stupidchess.jmn23.com"` | Hostname to be assigned to the ELB for the service |
| controller.service.type | string | `"LoadBalancer"` | |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.13.0](https://github.com/norwoodj/helm-docs/releases/v1.13.0)
2 changes: 2 additions & 0 deletions example-charts/ignored-values-example/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,5 @@ Based on best-values-example
| statefulset.livenessProbe | object | `{"enabled":false}` | Configure the healthcheck for the database |
| statefulset.podLabels | object | `{}` | The labels to be applied to instances of the database |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.13.0](https://github.com/norwoodj/helm-docs/releases/v1.13.0)
2 changes: 2 additions & 0 deletions example-charts/most-empty/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,5 @@ There is a flower though:
__|_____________
```

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.13.0](https://github.com/norwoodj/helm-docs/releases/v1.13.0)
2 changes: 2 additions & 0 deletions example-charts/nginx-ingress-but-auto-comments/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,5 @@ A simple wrapper around the stable/nginx-ingress chart that adds a few of our co
| controller.service.annotations."external-dns.alpha.kubernetes.io/hostname" | string | `"stupidchess.jmn23.com"` | Hostname to be assigned to the ELB for the service |
| controller.service.type | string | `"LoadBalancer"` | |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.13.0](https://github.com/norwoodj/helm-docs/releases/v1.13.0)
2 changes: 2 additions & 0 deletions example-charts/nginx-ingress/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,5 @@ A simple wrapper around the stable/nginx-ingress chart that adds a few of our co
| controller.service.annotations."external-dns.alpha.kubernetes.io/hostname" | string | `"stupidchess.jmn23.com"` | Hostname to be assigned to the ELB for the service |
| controller.service.type | string | `"LoadBalancer"` | |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.13.0](https://github.com/norwoodj/helm-docs/releases/v1.13.0)
2 changes: 2 additions & 0 deletions example-charts/no-requirements/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,5 @@ A simple chart that installs, let's say PrometheusRules, that needs no sub-chart
| rules.statusCodes.codes.5xx.duration | string | `"5m"` | Duration for which the percent of 5xx responses must be above the threshold to alert |
| rules.statusCodes.codes.5xx.threshold | float | `1.5` | Threshold percentage of 5xx responses above which the alert will fire |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.13.0](https://github.com/norwoodj/helm-docs/releases/v1.13.0)
2 changes: 2 additions & 0 deletions example-charts/no-values/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,5 @@ A very simple chart that doesn't even need any values for customization

* <https://github.com/norwoodj/helm-docs/tree/master/example-charts/no-values>

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.13.0](https://github.com/norwoodj/helm-docs/releases/v1.13.0)
2 changes: 2 additions & 0 deletions example-charts/special-characters-but-auto-comments/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,5 @@ A chart demonstrating handling of special characters in values files
| htmlSnippets.three | string | `"<html><head></head></html>"` | Another description |
| htmlSnippets.two | string | `""` | Let's put it in the description <html></html> |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.13.0](https://github.com/norwoodj/helm-docs/releases/v1.13.0)
2 changes: 2 additions & 0 deletions example-charts/special-characters/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,5 @@ A chart demonstrating handling of special characters in values files
| htmlSnippets.three | string | `"<html><head></head></html>"` | Another description |
| htmlSnippets.two | string | `""` | Let's put it in the description <html></html> |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.13.0](https://github.com/norwoodj/helm-docs/releases/v1.13.0)
2 changes: 2 additions & 0 deletions example-charts/umbrella/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,5 @@ A chart demonstrating that values documentation from child charts are aggregated
| sub-a.mySubKeyA | string | `"my-sub-value-a"` | Value for sub-chart A |
| sub-b.mySubKeyB | string | `"my-sub-value-b"` | Value for sub-chart B |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.13.0](https://github.com/norwoodj/helm-docs/releases/v1.13.0)
2 changes: 2 additions & 0 deletions example-charts/umbrella/charts/sub-a/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,5 @@ A sub-chart.
| global.myGlobalSubChartKey | string | `"my-global-sub-chart-value"` | A global key defined in a sub chart |
| mySubKeyA | string | `"my-sub-value-a"` | Value for sub-chart A |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.13.0](https://github.com/norwoodj/helm-docs/releases/v1.13.0)
2 changes: 2 additions & 0 deletions example-charts/umbrella/charts/sub-b/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,5 @@ A sub-chart.
| global.myGlobalKey | string | `"my-global-value"` | A global key |
| mySubKeyB | string | `"my-sub-value-b"` | Value for sub-chart B |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.13.0](https://github.com/norwoodj/helm-docs/releases/v1.13.0)
2 changes: 2 additions & 0 deletions example-charts/umbrella/charts/sub-c/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,5 @@ A sub-chart.
|-----|------|---------|-------------|
| global | object | `{}` | |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.13.0](https://github.com/norwoodj/helm-docs/releases/v1.13.0)

0 comments on commit a8411d8

Please sign in to comment.