Skip to content

Commit 3b46037

Browse files
committed
Update auto generated table in readme.
1 parent 8fa8699 commit 3b46037

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,8 @@ For agent changelog, please see <https://github.com/scalyr/scalyr-agent-2/blob/r
155155
| affinity | object | `{}` | optional affinity rules |
156156
| controllerType | string | `"daemonset"` | Wether to setup a daemonset or a deployment for the Scalyr agent A daemonset should be used for Kubernetes monitoring while a deployment should be used for single resource monitorings (e.g. hosted databases, etc.) Valid values: "daemonset" or "deployment" |
157157
| deployment.replicaCount | int | `1` | The count of replicas to use when using the deployment controller setup |
158+
| existingSecretRef | string | `""` | Use this value if the Scalyr API key is already stored in a Kubernetes secret that was created by an external secrets operator or similar. |
159+
| extraEnvVars | string | `nil` | Additional environment variables to set |
158160
| fullnameOverride | string | `""` | Override the default full name that helm calculates |
159161
| image.pullPolicy | string | `"IfNotPresent"` | |
160162
| image.repository | string | `"scalyr/scalyr-k8s-agent"` | Image to use. Defaults to the official scalyr agent image |
@@ -167,20 +169,22 @@ For agent changelog, please see <https://github.com/scalyr/scalyr-agent-2/blob/r
167169
| nodeSelector | object | `{}` | optional node selectors |
168170
| podAnnotations | object | `{}` | optional pod annotations |
169171
| podLabels | object | `{}` | optional arbitrary pod metadata labels |
170-
| podSecurityContext | object | `{}` | |
172+
| podSecurityContext | object | `{}` | optional pod security context entries |
171173
| resources | object | `{"limits":{"cpu":"500m","memory":"500Mi"},"requests":{"cpu":"500m","memory":"500Mi"}}` | Pod resources. Defaults to the values documented in the official [Installation guide](https://app.scalyr.com/help/install-agent-kubernetes) |
172174
| scalyr.apiKey | string | `""` | The Scalyr API key to use |
173175
| scalyr.base64Config | bool | `true` | As Helm is currently [unable to correctly pass JSON strings](https://github.com/helm/helm/issues/5618), this can be set to true so all values of scalyr.config are expected to be base64 encoded and will be decoded in the chart |
174176
| scalyr.config | object | `{}` | A hash of configuration files and their content as documented in the [Scalyr agent configmap configuration documentation](https://app.scalyr.com/help/scalyr-agent-k8s#modify-config) |
175177
| scalyr.debugLevel | int | `0` | Set this to number between 1 and 5 (inclusive - 1 being least verbose and 5 being most verbose) to enable additional debug logging into agent_debug.log file. NOTE: If you want this debug log file to be ingested into Scalyr, you also need to set scalyr.ingestDebugLog option to true. |
176-
| scalyr.ingestDebugLog | bool | `false` | |
178+
| scalyr.ingestDebugLog | bool | `false` | Set this to true to enable ingesting of agent_debug.log file. Keep in mind that depending on the debug log level set, this may result in large log volume. |
177179
| scalyr.k8s.caCert | string | `""` | The path to the CA certificate to use to verify TLS-connection to the kubelet |
178180
| scalyr.k8s.clusterName | string | `""` | The kubernetes cluster name (when using the kubernetes monitoring) |
179181
| scalyr.k8s.enableEvents | bool | `true` | Enable fetching Kubernetes events |
180182
| scalyr.k8s.enableExplorer | bool | `false` | Enable Kubernetes Explorer functionality (https://www.dataset.com/blog/introducing-dataset-kubernetes-explorer/). This functionality may require additional setup, for more information, please refer to the docs - https://app.scalyr.com/help/scalyr-agent-k8s-explorer NOTE: Explorer functionality is only supported when using DaemonSet agent deployment model. |
181183
| scalyr.k8s.enableLogs | bool | `true` | Enable fetching Pod/Container logs from Kubernetes |
182184
| scalyr.k8s.enableMetrics | bool | `true` | Enable fetching Kubernetes metrics. This requires scalyr.k8s.enableLogs to be true |
183185
| scalyr.k8s.eventsIgnoreMaster | bool | `true` | Set to false to also allow Kubernetes Events monitor to run on master node. |
186+
| scalyr.k8s.explorerSampleInterval | int | `60` | Sample internal (in seconds) for Kubernetes Explorer functionality. |
187+
| scalyr.k8s.explorerScrapeInterval | int | `60` | Scrape internal (in seconds) for Kubernetes Explorer functionality. |
184188
| scalyr.k8s.installExplorerDependencies | bool | `false` | Set to true to install additional dependencies which are needed for the complete Kubernetes Explorer experience. This includes node-exporter DaemonSet and kube-state-metrics Deployment. Both of the components are installed into the same namespace as the scalyr agent for easier cleanup. In production deployments, those two components usually get installed into monitoring or kube-system namespace. This functionality is only meant to be used on new clusters which don't already have those components running (e.g. local minikube cluster). |
185189
| scalyr.k8s.verifyKubeletQueries | bool | `true` | Set this to false to disable TLS cert validation of queries to k8s kubelet. By default cert validation is enabled and connection is verified using the CA configured via the service account certificate (/run/secrets/kubernetes.io/serviceaccount/ca.crt file). If you want to use a custom CA bundle, you can do that by setting scalyr.k8s.caCert config option to point to this file (this file needs to be available inside the agent container). In some test environments such as minikube where self signed certs are used you may want to set this to false. |
186190
| scalyr.server | string | `"agent.scalyr.com"` | The Scalyr server to send logs to. Use eu.scalyr.com for EU |
@@ -190,7 +194,6 @@ For agent changelog, please see <https://github.com/scalyr/scalyr-agent-2/blob/r
190194
| volumeMounts | object | `{}` | Additional volume mounts to set up |
191195
| volumes | object | `{}` | Additional volumes to mount |
192196

193-
194197
## Development, CI/CD
195198

196199
On each push to master and other branches Github Actions workflow runs which performs basic helm

0 commit comments

Comments
 (0)