Skip to content

Commit

Permalink
Fix typos (#108)
Browse files Browse the repository at this point in the history 
Found via `codespell -H`
  • Loading branch information
@kianmeng
kianmeng authored Sep 20, 2024
1 parent ea0578e commit c0227b4
Show file tree
Hide file tree
Showing 6 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion EXAMPLE/prometheus-advanced.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -523,7 +523,7 @@ <h2>Values</h2>
</tr>
<tr>
<td>serviceAccounts.server.automountServiceAccountToken</td>
<td>Opt out of automounting Kubernetes API credentials. It will be overriden by server.automountServiceAccountToken value, if set.</td>
<td>Opt out of automounting Kubernetes API credentials. It will be overridden by server.automountServiceAccountToken value, if set.</td>
<td><pre>serviceAccounts:<br> server:<br> automountServiceAccountToken: false<br></pre></td>
<td></td>
</tr>
Expand Down
2 changes: 1 addition & 1 deletion EXAMPLE/prometheus.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -449,7 +449,7 @@ <h2>Values</h2>
</tr>
<tr>
<td>serviceAccounts.server.automountServiceAccountToken</td>
<td>Opt out of automounting Kubernetes API credentials. It will be overriden by server.automountServiceAccountToken value, if set.</td>
<td>Opt out of automounting Kubernetes API credentials. It will be overridden by server.automountServiceAccountToken value, if set.</td>
<td><pre>serviceAccounts:<br> server:<br> automountServiceAccountToken: false<br></pre></td>
<td></td>
</tr>
Expand Down
2 changes: 1 addition & 1 deletion EXAMPLE/prometheus.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ The following values can/will be used for deployments.
| server.useExistingClusterRoleName | Use a ClusterRole (and ClusterRoleBinding). If set to false, we define a RoleBinding in the defined namespaces ONLY. NB: because we need a Role with nonResourceURL's ("/metrics") - you must get someone with Cluster-admin privileges to define this role for you, before running with this setting enabled. This makes prometheus work - for users who do not have ClusterAdmin privs, but wants prometheus to operate on their own namespaces, instead of clusterwide. You MUST also set namespaces to the ones you have access to and want monitored by Prometheus. | <pre>server:<br> useExistingClusterRoleName: false<br></pre> | |
| serverFiles | | <details><summary>Expand</summary><pre>serverFiles:<br> alerting_rules.yml: {}<br> alerts: {}<br> prometheus.yml:<br> rule_files:<br> - /etc/config/recording_rules.yml<br> - /etc/config/alerting_rules.yml<br> - /etc/config/rules<br> - /etc/config/alerts<br> scrape_configs:<br> - job_name: prometheus<br> static_configs:<br> - targets:<br> - localhost:9090<br> - bearer_token_file: /var/run/secrets/kubernetes.io/serviceaccount/token<br> job_name: kubernetes-apiservers<br> kubernetes_sd_configs:<br> - role: endpoints<br> relabel_configs:<br> - action: keep<br> regex: default;kubernetes;https<br> source_labels:<br> - __meta_kubernetes_namespace<br> - __meta_kubernetes_service_name<br> - __meta_kubernetes_endpoint_port_name<br> scheme: https<br> tls_config:<br> ca_file: /var/run/secrets/kubernetes.io/serviceaccount/ca.crt<br> insecure_skip_verify: true<br> - bearer_token_file: /var/run/secrets/kubernetes.io/serviceaccount/token<br> job_name: kubernetes-nodes<br> kubernetes_sd_configs:<br> - role: node<br> relabel_configs:<br> - action: labelmap<br> regex: __meta_kubernetes_node_label_(.+)<br> - replacement: kubernetes.default.svc:443<br> target_label: __address__<br> - regex: (.+)<br> replacement: /api/v1/nodes/$1/proxy/metrics<br> source_labels:<br> - __meta_kubernetes_node_name<br> target_label: __metrics_path__<br> scheme: https<br> tls_config:<br> ca_file: /var/run/secrets/kubernetes.io/serviceaccount/ca.crt<br> insecure_skip_verify: true<br> - bearer_token_file: /var/run/secrets/kubernetes.io/serviceaccount/token<br> job_name: kubernetes-nodes-cadvisor<br> kubernetes_sd_configs:<br> - role: node<br> relabel_configs:<br> - action: labelmap<br> regex: __meta_kubernetes_node_label_(.+)<br> - replacement: kubernetes.default.svc:443<br> target_label: __address__<br> - regex: (.+)<br> replacement: /api/v1/nodes/$1/proxy/metrics/cadvisor<br> source_labels:<br> - __meta_kubernetes_node_name<br> target_label: __metrics_path__<br> scheme: https<br> tls_config:<br> ca_file: /var/run/secrets/kubernetes.io/serviceaccount/ca.crt<br> insecure_skip_verify: true<br> - honor_labels: true<br> job_name: kubernetes-service-endpoints<br> kubernetes_sd_configs:<br> - role: endpoints<br> relabel_configs:<br> - action: keep<br> regex: true<br> source_labels:<br> - __meta_kubernetes_service_annotation_prometheus_io_scrape<br> - action: drop<br> regex: true<br> source_labels:<br> - __meta_kubernetes_service_annotation_prometheus_io_scrape_slow<br> - action: replace<br> regex: (https?)<br> source_labels:<br> - __meta_kubernetes_service_annotation_prometheus_io_scheme<br> target_label: __scheme__<br> - action: replace<br> regex: (.+)<br> source_labels:<br> - __meta_kubernetes_service_annotation_prometheus_io_path<br> target_label: __metrics_path__<br> - action: replace<br> regex: (.+?)(?::\d+)?;(\d+)<br> replacement: $1:$2<br> source_labels:<br> - __address__<br> - __meta_kubernetes_service_annotation_prometheus_io_port<br> target_label: __address__<br> - action: labelmap<br> regex: __meta_kubernetes_service_annotation_prometheus_io_param_(.+)<br> replacement: __param_$1<br> - action: labelmap<br> regex: __meta_kubernetes_service_label_(.+)<br> - action: replace<br> source_labels:<br> - __meta_kubernetes_namespace<br> target_label: namespace<br> - action: replace<br> source_labels:<br> - __meta_kubernetes_service_name<br> target_label: service<br> - action: replace<br> source_labels:<br> - __meta_kubernetes_pod_node_name<br> target_label: node<br> - honor_labels: true<br> job_name: kubernetes-service-endpoints-slow<br> kubernetes_sd_configs:<br> - role: endpoints<br> relabel_configs:<br> - action: keep<br> regex: true<br> source_labels:<br> - __meta_kubernetes_service_annotation_prometheus_io_scrape_slow<br> - action: replace<br> regex: (https?)<br> source_labels:<br> - __meta_kubernetes_service_annotation_prometheus_io_scheme<br> target_label: __scheme__<br> - action: replace<br> regex: (.+)<br> source_labels:<br> - __meta_kubernetes_service_annotation_prometheus_io_path<br> target_label: __metrics_path__<br> - action: replace<br> regex: (.+?)(?::\d+)?;(\d+)<br> replacement: $1:$2<br> source_labels:<br> - __address__<br> - __meta_kubernetes_service_annotation_prometheus_io_port<br> target_label: __address__<br> - action: labelmap<br> regex: __meta_kubernetes_service_annotation_prometheus_io_param_(.+)<br> replacement: __param_$1<br> - action: labelmap<br> regex: __meta_kubernetes_service_label_(.+)<br> - action: replace<br> source_labels:<br> - __meta_kubernetes_namespace<br> target_label: namespace<br> - action: replace<br> source_labels:<br> - __meta_kubernetes_service_name<br> target_label: service<br> - action: replace<br> source_labels:<br> - __meta_kubernetes_pod_node_name<br> target_label: node<br> scrape_interval: 5m<br> scrape_timeout: 30s<br> - honor_labels: true<br> job_name: prometheus-pushgateway<br> kubernetes_sd_configs:<br> - role: service<br> relabel_configs:<br> - action: keep<br> regex: pushgateway<br> source_labels:<br> - __meta_kubernetes_service_annotation_prometheus_io_probe<br> - honor_labels: true<br> job_name: kubernetes-services<br> kubernetes_sd_configs:<br> - role: service<br> metrics_path: /probe<br> params:<br> module:<br> - http_2xx<br> relabel_configs:<br> - action: keep<br> regex: true<br> source_labels:<br> - __meta_kubernetes_service_annotation_prometheus_io_probe<br> - source_labels:<br> - __address__<br> target_label: __param_target<br> - replacement: blackbox<br> target_label: __address__<br> - source_labels:<br> - __param_target<br> target_label: instance<br> - action: labelmap<br> regex: __meta_kubernetes_service_label_(.+)<br> - source_labels:<br> - __meta_kubernetes_namespace<br> target_label: namespace<br> - source_labels:<br> - __meta_kubernetes_service_name<br> target_label: service<br> - honor_labels: true<br> job_name: kubernetes-pods<br> kubernetes_sd_configs:<br> - role: pod<br> relabel_configs:<br> - action: keep<br> regex: true<br> source_labels:<br> - __meta_kubernetes_pod_annotation_prometheus_io_scrape<br> - action: drop<br> regex: true<br> source_labels:<br> - __meta_kubernetes_pod_annotation_prometheus_io_scrape_slow<br> - action: replace<br> regex: (https?)<br> source_labels:<br> - __meta_kubernetes_pod_annotation_prometheus_io_scheme<br> target_label: __scheme__<br> - action: replace<br> regex: (.+)<br> source_labels:<br> - __meta_kubernetes_pod_annotation_prometheus_io_path<br> target_label: __metrics_path__<br> - action: replace<br> regex: (\d+);(([A-Fa-f0-9]{1,4}::?){1,7}[A-Fa-f0-9]{1,4})<br> replacement: '[$2]:$1'<br> source_labels:<br> - __meta_kubernetes_pod_annotation_prometheus_io_port<br> - __meta_kubernetes_pod_ip<br> target_label: __address__<br> - action: replace<br> regex: (\d+);((([0-9]+?)(\.\|$)){4})<br> replacement: $2:$1<br> source_labels:<br> - __meta_kubernetes_pod_annotation_prometheus_io_port<br> - __meta_kubernetes_pod_ip<br> target_label: __address__<br> - action: labelmap<br> regex: __meta_kubernetes_pod_annotation_prometheus_io_param_(.+)<br> replacement: __param_$1<br> - action: labelmap<br> regex: __meta_kubernetes_pod_label_(.+)<br> - action: replace<br> source_labels:<br> - __meta_kubernetes_namespace<br> target_label: namespace<br> - action: replace<br> source_labels:<br> - __meta_kubernetes_pod_name<br> target_label: pod<br> - action: drop<br> regex: Pending\|Succeeded\|Failed\|Completed<br> source_labels:<br> - __meta_kubernetes_pod_phase<br> - action: replace<br> source_labels:<br> - __meta_kubernetes_pod_node_name<br> target_label: node<br> - honor_labels: true<br> job_name: kubernetes-pods-slow<br> kubernetes_sd_configs:<br> - role: pod<br> relabel_configs:<br> - action: keep<br> regex: true<br> source_labels:<br> - __meta_kubernetes_pod_annotation_prometheus_io_scrape_slow<br> - action: replace<br> regex: (https?)<br> source_labels:<br> - __meta_kubernetes_pod_annotation_prometheus_io_scheme<br> target_label: __scheme__<br> - action: replace<br> regex: (.+)<br> source_labels:<br> - __meta_kubernetes_pod_annotation_prometheus_io_path<br> target_label: __metrics_path__<br> - action: replace<br> regex: (\d+);(([A-Fa-f0-9]{1,4}::?){1,7}[A-Fa-f0-9]{1,4})<br> replacement: '[$2]:$1'<br> source_labels:<br> - __meta_kubernetes_pod_annotation_prometheus_io_port<br> - __meta_kubernetes_pod_ip<br> target_label: __address__<br> - action: replace<br> regex: (\d+);((([0-9]+?)(\.\|$)){4})<br> replacement: $2:$1<br> source_labels:<br> - __meta_kubernetes_pod_annotation_prometheus_io_port<br> - __meta_kubernetes_pod_ip<br> target_label: __address__<br> - action: labelmap<br> regex: __meta_kubernetes_pod_annotation_prometheus_io_param_(.+)<br> replacement: __param_$1<br> - action: labelmap<br> regex: __meta_kubernetes_pod_label_(.+)<br> - action: replace<br> source_labels:<br> - __meta_kubernetes_namespace<br> target_label: namespace<br> - action: replace<br> source_labels:<br> - __meta_kubernetes_pod_name<br> target_label: pod<br> - action: drop<br> regex: Pending\|Succeeded\|Failed\|Completed<br> source_labels:<br> - __meta_kubernetes_pod_phase<br> - action: replace<br> source_labels:<br> - __meta_kubernetes_pod_node_name<br> target_label: node<br> scrape_interval: 5m<br> scrape_timeout: 30s<br> recording_rules.yml: {}<br> rules: {}<br></pre></details> | |
| serviceAccounts | Define serviceAccount names for components. Defaults to component's fully qualified name. | <pre>serviceAccounts:<br> server:<br> annotations: {}<br> automountServiceAccountToken: false<br> create: true<br> name: ''<br></pre> | |
| serviceAccounts.server.automountServiceAccountToken | Opt out of automounting Kubernetes API credentials. It will be overriden by server.automountServiceAccountToken value, if set. | <pre>serviceAccounts:<br> server:<br> automountServiceAccountToken: false<br></pre> | |
| serviceAccounts.server.automountServiceAccountToken | Opt out of automounting Kubernetes API credentials. It will be overridden by server.automountServiceAccountToken value, if set. | <pre>serviceAccounts:<br> server:<br> automountServiceAccountToken: false<br></pre> | |


*Automatic helm documentation generated using [very-doge-wow/stella](https://github.com/very-doge-wow/stella).*
Expand Down
2 changes: 1 addition & 1 deletion EXAMPLE/prometheus/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ Extra command-line arguments specified via configmapReload.prometheus.extraArgs
Prometheus has been updated to version v2.40.5.

Prometheus-pushgateway was updated to version 2.0.0 which adapted [Helm label and annotation best practices](https://helm.sh/docs/chart_best_practices/labels/).
See the [upgrade docs of the prometheus-pushgateway chart](https://github.com/prometheus-community/helm-charts/tree/main/charts/prometheus-pushgateway#to-200) to see whats to do, before you upgrade Prometheus!
See the [upgrade docs of the prometheus-pushgateway chart](https://github.com/prometheus-community/helm-charts/tree/main/charts/prometheus-pushgateway#to-200) to see what's to do, before you upgrade Prometheus!

The condition in Chart.yaml to disable kube-state-metrics has been changed from `kubeStateMetrics.enabled` to `kube-state-metrics.enabled`

Expand Down
2 changes: 1 addition & 1 deletion EXAMPLE/prometheus/values.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ serviceAccounts:
annotations: {}
# -- stella
# Opt out of automounting Kubernetes API credentials.
# It will be overriden by server.automountServiceAccountToken value, if set.
# It will be overridden by server.automountServiceAccountToken value, if set.
automountServiceAccountToken: false

# -- stella
Expand Down
2 changes: 1 addition & 1 deletion stella.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
# write doc from gathered data
doc_writer.write(output=args.output, doc=result, template=args.template, format_html=args.format_html, advanced_html=args.advanced_html, css=args.css)
except Exception as err:
logging.exception("Error occured.")
logging.exception("Error occurred.")
exit(1)

logging.info("Done!")

0 comments on commit c0227b4

Please sign in to comment.