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.

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

Move to prod: settings metric reference and settings metrics #310

Merged
merged 8 commits into from
Oct 10, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 9 additions & 0 deletions content/en/os/1.15.x/api/settings-index/_index.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
+++
title="Settings Index"
type="docs"
toc_hide=true
description="Comprehesive list of all documented settings"
hide_summary=true
+++

{{< all-settings >}}
9 changes: 9 additions & 0 deletions content/en/os/1.15.x/api/settings/metrics/_index.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
+++
title="metrics"
type="docs"
toc_hide=true
description="Settings related to metrics (`settings.metrics.*`)"
+++


{{< settings >}}
29 changes: 29 additions & 0 deletions data/settings/1.15.x/metrics.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
[[docs.ref.metrics-url]]
description = "The URL where Bottlerocket sends metrics."
default = "`https://metrics.bottlerocket.aws/v1/metrics`"

[[docs.ref.send-metrics]]
description = """
Determines if anonymous metrics are sent.
If set to `true`, Bottlerocket will send metrics to the URL defined by `settings.metrics.metrics-url` at boot and every six hours.
If `false`, Bottlerocket will not send metrics.
"""
accepted_values = [
"`true`",
"`false`"
]
default = "`true` (except on `dev` variants, where it is `false`)"

[[docs.ref.service-checks]]
description = "A list of systemd services that Bottlerocket will check to determine if a host is healthy."
default = """The default services vary by variant:

- `apiserver` (all variants)
- `chronyd` (all variants)
- `containerd` (all variants)
- `host-containerd` (all variants)
- `docker` (`aws-ecs-*`, `aws-dev-*`)
- `ecs` (`aws-ecs-*`)
- `kubelet` (`*-k8s-*`)
- `vmtoolsd` (`vmware-*`)
"""
2 changes: 1 addition & 1 deletion data/settings/1.15.x/oci-defaults.toml
Original file line number Diff line number Diff line change
Expand Up @@ -358,7 +358,7 @@ see = [
["`CAP_MAC_OVERRIDE` on the [Linux `capabilities` manual page](https://man7.org/linux/man-pages/man7/capabilities.7.html)"]
]

[[docs.ref.capabilities.net-admin]]
[[docs.ref.capabilities_net-admin]]
name_override = "capabilities_net-admin"
tags = [ "capabilities" ]
accepted_values = [
Expand Down
26 changes: 26 additions & 0 deletions layouts/shortcodes/all-settings.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@

{{- /* get the path of the doc calling the shortcode */ -}}
{{- $currentPath := print .Page.File.Dir -}}
{{- /* break apart the path */ -}}
{{- $parts := split $currentPath "/" -}}
{{- /* 2nd (base 0) index has the version */ -}}
{{- $version := index $parts 1 -}}

{{- $settings_file := index $.Site.Data.settings $version -}}

{{- range $settings_category, $settings_ref := $settings_file -}}
<!-- <h2>settings.{{ $settings_category }}</h2> -->
{{- range $setting_name, $setting_details := $settings_ref.docs.ref -}}
<code>
<a href="../settings/{{ $settings_category }}/#{{ $setting_name }}">
settings.{{ $settings_category }}
{{- if reflect.IsSlice $setting_details -}}
{{- range $setting_details -}}
.{{ ( or .name_override $setting_name ) }}
{{- end -}}
{{- end -}}
</a>
</code>
<br />
{{- end -}}
{{- end -}}
14 changes: 7 additions & 7 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"devDependencies": {
"autoprefixer": "^10.4.8",
"postcss": "^8.4.16"
"postcss": "^8.4.31"
},
"dependencies": {
"postcss-cli": "^10.1.0"
Expand Down