|
2 | 2 |
|
3 | 3 | This Helm chart installs [Argus](https://github.com/logicmonitor/k8s-argus). A [LogicMonitor](https://www.logicmonitor.com) account is required. |
4 | 4 |
|
5 | | -**Install Argus:** |
6 | | - |
7 | | -Get the configuration file downloaded from the LogicMonitor UI or you can create from the template [here](https://github.com/logicmonitor/k8s-helm-charts/blob/master/config-templates/Configuration.md#argus). |
8 | | - |
9 | | -Update configuration parameters in configuration file. |
10 | | - |
11 | | -```bash |
12 | | -# Export the configuration file path & use it in the helm command. |
13 | | -$ export ARGUS_CONF_FILE=<argus-configuration-file-path> |
14 | | - |
15 | | -$ helm upgrade \ |
16 | | - --install \ |
17 | | - --debug \ |
18 | | - --wait \ |
19 | | - --namespace="$NAMESPACE" \ |
20 | | - -f "$ARGUS_CONF_FILE" \ |
21 | | - argus logicmonitor/argus |
22 | | -``` |
23 | | - |
24 | | ---- |
25 | | - |
26 | | -Required Values: |
27 | | - |
28 | | -- **accessID (default: `""`):** The LogicMonitor API key ID. |
29 | | -- **accessKey (default: `""`):** The LogicMonitor API key. |
30 | | -- **account (default: `""`):** The LogicMonitor account name. |
31 | | -- **clusterName (default: `""`):** A unique name given to the cluster's resource group. |
32 | | -- **debug (default: `false`):** To enable verbose logging at debug level. |
33 | | -- **deleteDevices (default: `true`):** On a delete event, either delete from LogicMonitor or move the resource to the `_deleted` resource group. |
34 | | -- **disableAlerting (default: `false`):** Disables LogicMonitor alerting for all the cluster resources. |
35 | | -- **collector.replicas (default: `1`):** The number of collectors to create and use with Argus. |
36 | | -- **collector.size (default: `""`):** The collector size to install. Can be nano, small, medium, or large. |
37 | | -- **collector.imageRepository (default: `logicmonitor/collector`):** The image repository of the [Collector](https://hub.docker.com/r/logicmonitor/collector) container. |
38 | | -- **collector.imageTag:** The image tag of the [Collector](https://hub.docker.com/r/logicmonitor/collector/tags) container. |
39 | | -- **collector.imagePullPolicy (default: `Always`):** The image pull policy of the Collector container. |
40 | | -- **collector.secretName (default: `"collector"`):** The Secret resource name of the collectors. |
41 | | - |
42 | | -Optional Values: |
43 | | - |
44 | | -- **enableRBAC (default: `true`):** Enable RBAC. If your cluster does not have RBAC enabled, this value should be set to false. |
45 | | -- **clusterGroupID (default: `0`):** A parent group id of the cluster's resource group. |
46 | | -- **etcdDiscoveryToken (default: `""`):** The public etcd discovery token used to add etcd hosts to the cluster resource group. |
47 | | -- **imagePullPolicy (default: `"Always"`):** The image pull policy of the Argus container. |
48 | | -- **imageRepository (default: `"logicmonitor/argus"`):** The image respository of the [Argus](https://hub.docker.com/r/logicmonitor/argus) container. |
49 | | -- **imageTag:** The image tag of the [Argus](https://hub.docker.com/r/logicmonitor/argus/tags) container. |
50 | | -- **proxyURL (default: `""`):** The Http/s proxy url. |
51 | | -- **proxyUser (default: `""`):** The Http/s proxy username. |
52 | | -- **proxyPass (default: `""`):** The Http/s proxy password. |
53 | | -- **nodeSelector (default: `{}`):** It provides the simplest way to run Pod on particular Node(s) based on labels on the node. |
54 | | -- **affinity (default: `{}`):** It allows you to constrain which nodes your pod is eligible to be scheduled on. |
55 | | -- **priorityClassName (default: `""`):** The priority class name for Pod priority. If this parameter is set then user must have PriorityClass resource created otherwise Pod will be rejected. |
56 | | -- **tolerations (default: `[]`):** Tolerations are applied to pods, and allow the pods to schedule onto nodes with matching taints. |
57 | | -- **filters.pod (default: `""`):** The filtered expression for Pod resource type. Based on this parameter, Pods would be added/deleted for discovery on LM. |
58 | | -- **filters.service (default: `""`):** The filtered expression for Service resource type. Based on this parameter, Services would be added/deleted for discovery on LM. |
59 | | -- **filters.node (default: `""`):** The filtered expression for Node resource type. Based on this parameter, Nodes would be added/deleted for discovery on LM. |
60 | | -- **filters.deployment (default: `""`):** The filtered expression for Deployment resource type. Based on this parameter, Deployments would be added/deleted for discovery on LM. |
61 | | -- **collector.groupID (default: `0`):** The ID of the group of the collectors. |
62 | | -- **collector.escalationChainID (default: `0`):** The ID of the escalation chain of the collectors. |
63 | | -- **collector.collectorVersion (default: `0`):** The version of the collectors. |
64 | | -- **collector.useEA (default: `false`):** On a collector downloading event, either download the latest EA version or the latest GD version. |
65 | | -- **collector.proxyURL (default: `""`):** The Http/s proxy url of the collectors. |
66 | | -- **collector.proxyUser (default: `""`):** The Http/s proxy username of the collectors. |
67 | | -- **collector.proxyPass (default: `""`):** The Http/s proxy password of the collectors. |
68 | | -- **collector.statefulsetspec:** Holds the Collector pod's Statefulfulset specification as per the Kubernetes statefulset object's spec format. Refer [statefulset basics](https://kubernetes.io/docs/tutorials/stateful-application/basic-stateful-set/) for more info |
69 | | - |
70 | | ---- |
71 | | - |
72 | | -**Tolerations Example:** |
73 | | - |
74 | | -```bash |
75 | | -$ helm upgrade --reuse-values \ |
76 | | - --set tolerations[0].key="key1" \ |
77 | | - --set tolerations[0].operator="Equal" \ |
78 | | - --set tolerations[0].value="value1" \ |
79 | | - --set tolerations[0].effect="NoSchedule" \ |
80 | | - argus logicmonitor/argus |
81 | | -``` |
82 | | - |
83 | | -**Discovery Filter Example:** |
84 | | - |
85 | | -```bash |
86 | | -helm upgrade --reuse-values \ |
87 | | - --set filters.deployment="app =~ 'QA' || app =~ 'Dev'" |
88 | | - --set filters.pod="app =~ 'node-app'" \ |
89 | | - --set filters.service=\"*\" |
90 | | - argus logicmonitor/argus |
91 | | -``` |
92 | | - |
93 | | -**Discovery Filter Example:** |
94 | | - |
95 | | -```bash |
96 | | -helm upgrade --reuse-values \ |
97 | | - --set filters.deployment="app =~ 'QA' || app =~ 'Dev'" |
98 | | - --set filters.pod="app =~ 'node-app'" \ |
99 | | - --set filters.service=\"*\" |
100 | | - argus logicmonitor/argus |
101 | | -``` |
| 5 | +See [Logicmonitor Support Documentation](https://www.logicmonitor.com/support/monitoring/containers/kubernetes/about-logicmonitors-kubernetes-monitoring) for more details on installation |
0 commit comments