Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

upgrade helm-docs to v1.14.2 #89

Closed
wants to merge 1 commit into from
Closed

upgrade helm-docs to v1.14.2 #89

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/linter.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:

- name: Check Docs
run: |
docker run --rm --volume "$(pwd):/helm-docs" -u "$(id -u)" jnorwood/helm-docs:v1.9.1
docker run --rm --volume "$(pwd):/helm-docs" -u "$(id -u)" jnorwood/helm-docs:v1.14.2
if ! git diff --exit-code; then
echo "Documentation not up to date. Please run helm-docs and commit changes!" >&2
exit 1
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,5 +32,5 @@ Charts should start at `1.0.0`. Any breaking (backwards incompatible) changes to
NB: CI requires specific `helm-docs` version to pass, so if you generate docs with a different one it may still fail
The easiest way to generate proper `README.md` is to run generation the same way as it's done in CI, i.e.:
```bash
docker run --rm --volume "$(pwd):/helm-docs" -u "$(id -u)" jnorwood/helm-docs:v1.9.1
docker run --rm --volume "$(pwd):/helm-docs" -u "$(id -u)" jnorwood/helm-docs:v1.14.2
```
2 changes: 1 addition & 1 deletion charts/aws-cost-reporter/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,4 +61,4 @@ $ helm install aws-cost-reporter neondatabase/aws-cost-reporter \
| tolerations | list | `[]` | Tolerations for pod assignment. |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.9.1](https://github.com/norwoodj/helm-docs/releases/v1.9.1)
Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)
6 changes: 3 additions & 3 deletions charts/neon-pg-sni-router/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,8 @@ Kubernetes: `^1.18.x-x`
| settings.authEndpoint | string | `""` | auth endpoint, e.g. "http://console.neon/authenticate_proxy_request/" |
| settings.destination | string | `"svc.cluster.local"` | append this domain zone to the transformed SNI hostname to get the destination address, e.g. "svc.cluster.local" |
| settings.domain | string | `"dummy"` | domain used in TLS cert for client postgres connections |
| settings.metricCollectionEndpoint | string | `""` | (url) endpoint used to send metrics to. If null, metrics will not be sent. |
| settings.metricCollectionInterval | string | `""` | (string) how often metrics should be sent. |
| settings.metricCollectionEndpoint | url | `""` | endpoint used to send metrics to. If null, metrics will not be sent. |
| settings.metricCollectionInterval | string | `""` | how often metrics should be sent. |
| settings.sentryEnvironment | string | `"development"` | "development" or "production". It will be visible in sentry in order to filter issues |
| settings.sentryUrl | string | `""` | url (will be converted into `SENTRY_DSN` environment variable) used by sentry to collect error/panic events in neon-pg-sni-router |
| settings.uri | string | `""` | |
Expand All @@ -79,4 +79,4 @@ Kubernetes: `^1.18.x-x`
| useCertManager | bool | `false` | |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.9.1](https://github.com/norwoodj/helm-docs/releases/v1.9.1)
Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)
60 changes: 30 additions & 30 deletions charts/neon-proxy/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,48 +67,48 @@ Kubernetes: `^1.18.x-x`
| settings.authEndpoint | string | `""` | auth endpoint, e.g. "http://console.neon/authenticate_proxy_request/" |
| settings.authRateLimits | string | `nil` | |
| settings.authRateLimitsEnabled | bool | `nil` | Whether to enable the authentication rate limiter |
| settings.awsAccessKeyId | string | `""` | (string) AWS Access Key ID |
| settings.awsRegion | string | `""` | (string) Aws region to retrieve credentials |
| settings.awsSecretAccessKey | string | `""` | (string) AWS Secret Access Key |
| settings.connectComputeLock | string | `""` | (string) Configures the locking of connect_compute per compute |
| settings.controlplane_token | string | `""` | (string) JWT token to pass to control plane management API |
| settings.disableDynamicRateLimiter | bool | `true` | (bool) Disable dynamic rate limiter |
| settings.awsAccessKeyId | string | `""` | AWS Access Key ID |
| settings.awsRegion | string | `""` | Aws region to retrieve credentials |
| settings.awsSecretAccessKey | string | `""` | AWS Secret Access Key |
| settings.connectComputeLock | string | `""` | Configures the locking of connect_compute per compute |
| settings.controlplane_token | string | `""` | JWT token to pass to control plane management API |
| settings.disableDynamicRateLimiter | bool | `true` | Disable dynamic rate limiter |
| settings.domain | string | `""` | domain used in TLS cert for client postgres connections |
| settings.endpointCacheConfig | string | `""` | (string) Config for cache for all valid endpoints |
| settings.endpointRpsLimits | list | `[]` | (list) list of rate limiters for connection attempts over different time intervals |
| settings.endpointCacheConfig | string | `""` | Config for cache for all valid endpoints |
| settings.endpointRpsLimits | list | `[]` | list of rate limiters for connection attempts over different time intervals |
| settings.extraDomains | list | `[]` | domains used in extra TLS certs for client postgres connections |
| settings.httpPoolOptIn | bool | `true` | (bool) Sets the SQL over HTTP Pool to opt-in-only mode if true. Set false to enable it always |
| settings.metricBackupCollectionChunkSize | string | `"4194304"` | (string) How large each chunk of the metric backup files should be in bytes |
| settings.httpPoolOptIn | bool | `true` | Sets the SQL over HTTP Pool to opt-in-only mode if true. Set false to enable it always |
| settings.metricBackupCollectionChunkSize | string | `"4194304"` | How large each chunk of the metric backup files should be in bytes |
| settings.metricBackupCollectionInterval | string | `"10m"` | |
| settings.metricBackupCollectionRemoteStorage | string | `""` | (string) Storage location to upload the metric backup files to |
| settings.metricCollectionEndpoint | string | `""` | (url) endpoint used to send metrics to. If null, metrics will not be sent. |
| settings.metricCollectionInterval | string | `""` | (string) how often metrics should be sent. |
| settings.metricBackupCollectionRemoteStorage | string | `""` | Storage location to upload the metric backup files to |
| settings.metricCollectionEndpoint | url | `""` | endpoint used to send metrics to. If null, metrics will not be sent. |
| settings.metricCollectionInterval | string | `""` | how often metrics should be sent. |
| settings.otelExporterDisabled | bool | `false` | Disables OpenTelemetry (will be converted into `OTEL_SDK_DISABLED` environment variable) |
| settings.otelExporterOtlpEndpoint | string | `""` | OpenTelemetry collector URL (will be converted into `OTEL_EXPORTER_OTLP_ENDPOINT` environment variable) |
| settings.parquetUploadCompression | string | `"uncompressed"` | (string) What level of compression to use |
| settings.parquetUploadDisconnectEventsRemoteStorage | string | `""` | (string) Storage location to upload the parquet files with disconnect events to. |
| settings.parquetUploadMaximumDuration | string | `"20m"` | (string) How long to wait before forcing a file upload |
| settings.parquetUploadPageSize | string | `"1048576"` | (string) How large each column page should be in bytes |
| settings.parquetUploadRemoteStorage | string | `""` | (string) Storage location to upload the parquet files to. |
| settings.parquetUploadRowGroupSize | string | `"8192"` | (string) How many rows to include in a row group |
| settings.parquetUploadSize | string | `"100000000"` | (string) How large the total parquet file should be in bytes |
| settings.redisClusterName | string | `"regional-control-plane-redis"` | (string) Redis cluster name, used in aws elasticache |
| settings.redisHost | string | `""` | (string) Redis host for streaming connections (might be different from the notifications host) |
| settings.redisNotifications | string | `""` | (url) Configures redis client |
| settings.redisPort | string | `""` | (string) Redis port for streaming connections |
| settings.redisUserId | string | `"neon"` | (string) Redis user_id, used in aws elasticache |
| settings.region | string | `""` | (string) Region this proxy service is deployed into |
| settings.parquetUploadCompression | string | `"uncompressed"` | What level of compression to use |
| settings.parquetUploadDisconnectEventsRemoteStorage | string | `""` | Storage location to upload the parquet files with disconnect events to. |
| settings.parquetUploadMaximumDuration | string | `"20m"` | How long to wait before forcing a file upload |
| settings.parquetUploadPageSize | string | `"1048576"` | How large each column page should be in bytes |
| settings.parquetUploadRemoteStorage | string | `""` | Storage location to upload the parquet files to. |
| settings.parquetUploadRowGroupSize | string | `"8192"` | How many rows to include in a row group |
| settings.parquetUploadSize | string | `"100000000"` | How large the total parquet file should be in bytes |
| settings.redisClusterName | string | `"regional-control-plane-redis"` | Redis cluster name, used in aws elasticache |
| settings.redisHost | string | `""` | Redis host for streaming connections (might be different from the notifications host) |
| settings.redisNotifications | url | `""` | Configures redis client |
| settings.redisPort | string | `""` | Redis port for streaming connections |
| settings.redisUserId | string | `"neon"` | Redis user_id, used in aws elasticache |
| settings.region | string | `""` | Region this proxy service is deployed into |
| settings.rustLog | string | `"INFO"` | Proxy log level |
| settings.sentryEnvironment | string | `"development"` | "development" or "production". It will be visible in sentry in order to filter issues |
| settings.sentryUrl | string | `""` | url (will be converted into `SENTRY_DSN` environment variable) used by sentry to collect error/panic events in neon-proxy |
| settings.sqlOverHttpTimeout | string | `"15s"` | (string) timeout for http connection requests |
| settings.sqlOverHttpTimeout | string | `"15s"` | timeout for http connection requests |
| settings.uri | string | `""` | |
| settings.useCertManager | bool | `true` | |
| settings.wakeComputeLimits | list | `[]` | (list) list of rate limiters for wake_compute over different time intervals |
| settings.wakeComputeLock | string | `"permits=0"` | (string) Configures the locking of wake_compute per endpoint |
| settings.wakeComputeLimits | list | `[]` | list of rate limiters for wake_compute over different time intervals |
| settings.wakeComputeLock | string | `"permits=0"` | Configures the locking of wake_compute per endpoint |
| settings.wssPort | int | `nil` | numeric port used for wss/https connections. If null, wss server will not be started |
| terminationGracePeriodSeconds | int | `30` | Deployment's terminationGracePeriodSeconds |
| tolerations | list | `[]` | Tolerations for pod assignment. |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.9.1](https://github.com/norwoodj/helm-docs/releases/v1.9.1)
Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)
2 changes: 1 addition & 1 deletion charts/neon-storage-broker/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,4 +65,4 @@ Kubernetes: `^1.18.x-x`
| tolerations | list | `[]` | Tolerations for pod assignment. |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.9.1](https://github.com/norwoodj/helm-docs/releases/v1.9.1)
Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)
2 changes: 1 addition & 1 deletion charts/neon-storage-controller/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,4 +73,4 @@ Kubernetes: `^1.18.x-x`
| tolerations | list | `[]` | Tolerations for pod assignment. |

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