Skip to content
This repository was archived by the owner on Jan 16, 2023. It is now read-only.

Commit 23f2cd3

Browse files
author
Jeremy Tang
committed
Merge pull request #21 in DEV/k8s-argus from DEV-41301-upgrade-the-go-sdk-to-v2 to develop
* commit '69f8fb54b9df0a573f1415bcbb99070779cd975d': (21 commits) DEV-41301 Upgrade the go sdk to v2 DEV-41301 Upgrade the go sdk to v2 DEV-41301 Upgrade the go sdk to v2 DEV-41301 Upgrade the go sdk to v2 DEV-41301 Upgrade the go sdk to v2 DEV-48974 Upgrade the go version of the argus from 1.9 to 1.11 (#104) DEV-48974 Upgrade Argus from golang 1.9 to 1.11 Develop (#103) Dev 49046 fix the internal ip cannot found (#102) Update node_test.go Develop (#99) Dev 42060 improve the initSync and the branch of the lm sdk (#98) remove beta tag (#96) Remove beta tag (#97) Develop (#95) bump version Dev-40217 support to set log levels and improve (#94) Dev-40217 support to set log levels and improve Stash to GitHub (#92) Updating docs & readme (#91) ...
2 parents fa9fe85 + 69f8fb5 commit 23f2cd3

File tree

9,117 files changed

+2058406
-808670
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

9,117 files changed

+2058406
-808670
lines changed

Gopkg.lock

Lines changed: 548 additions & 116 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Gopkg.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222

2323

2424
[[constraint]]
25-
branch = "v1"
25+
branch = "v2"
2626
name = "github.com/logicmonitor/lm-sdk-go"
2727

2828
[[constraint]]

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
NAMESPACE := logicmonitor
22
REPOSITORY := argus
3-
VERSION := 0.2.0-alpha.2
3+
VERSION := 1.0.0
44

55
all:
66
docker build --build-arg VERSION=$(VERSION) -t $(NAMESPACE)/$(REPOSITORY):latest .

README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,18 @@
1212
<a href="https://github.com/logicmonitor/k8s-argus/releases/latest"><img alt="GitHub (pre-)release" src="https://img.shields.io/github/release/logicmonitor/argus/all.svg?style=flat-square"></a>
1313
</p>
1414

15-
> **Note:** Argus is a community driven project in an alpha state. LogicMonitor support will not be able to assist with any issues related to Argus.
16-
17-
**Argus** is a tool for monitoring Kubernetes with [LogicMonitor](https://www.logicmonitor.com). Some of the key features of Argus are:
18-
- **Automated Device Group Management:** Leverages Kubernetes events to provide real-time accuracy of a cluster's resources in LogicMonitor, and organizes them by resource type and namespace in the [Device Tree](https://www.logicmonitor.com/support/devices/devices-page-overview/navigating-devices/).
19-
- **Automated Device Management:** Discovers etcd members, cluster nodes, services, and pods, and automates the management of their lifecycle as [Devices](https://www.logicmonitor.com/support/devices/) in LogicMonitor.
20-
- **Automated Device Property Management:** Discovers Kubernetes resource metadata and maps them to [Device Properties](https://www.logicmonitor.com/support/devices/adding-managing-devices/device-properties/).
15+
**Argus** is a tool for monitoring Kubernetes with
16+
[LogicMonitor](https://www.logicmonitor.com). Some of the key features of Argus
17+
are:
18+
- **Automated Resource Discovery:** Leverages Kubernetes events and
19+
LogicMonitor's API to provide real-time accuracy of a cluster's resources in
20+
LogicMonitor. Discovers etcd members, cluster Nodes, Services, and Pods, and
21+
automates the management of their lifecycle as
22+
[Resources](https://www.logicmonitor.com/support/devices/) in LogicMonitor.
23+
- **Comprehensive Monitoring:** Dockerized LogicMonitor Collectors running in a
24+
Stateful Set and managed by Argus collect data via the Kubernetes API for Nodes,
25+
Pods, Services, and Containers. Additionally, you can leverage LogicMonitor
26+
DataSources to monitor your applications running within the cluster.
2127

2228
See the [documentation](https://logicmonitor.github.io/k8s-argus) to discover more about Argus.
2329

cmd/watch.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ func pollCollectorSetStatus(conn *grpc.ClientConn) (bool, error) {
111111
for {
112112
select {
113113
case <-timeout:
114-
return false, fmt.Errorf("Timeout waiting for collectors to become available")
114+
return false, fmt.Errorf("timeout waiting for collectors to become available")
115115
case <-ticker.C:
116116
log.Debugf("Checking collectors status")
117117
ctx, cancel := context.WithTimeout(context.Background(), time.Millisecond*500)

docs/argus/index.html

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -338,14 +338,13 @@
338338
<div class="wrapper">
339339
<h1>Argus </h1>
340340

341-
<div class="admonition warning">
342-
<p class="admonition-title">Warning</p>
343-
<p>Argus is a community driven project in an alpha state. LogicMonitor support will not be able to assist with any issues related to Argus.</p>
344-
</div>
345-
346-
<hr />
347-
348-
<p>Argus is a tool that helps users of <a href="https://www.logicmonitor.com">LogicMonitor</a> keep up with the highly dynamic topology of a Kubernetes cluster.</p>
341+
<p>Argus is a tool that helps users of <a href="https://www.logicmonitor.com">LogicMonitor</a>
342+
keep up with the highly dynamic nature of a Kubernetes cluster. Argus runs as a
343+
Pod in your cluster, and uses LogicMonitor&rsquo;s API to add Nodes, Pods, and
344+
Services into monitoring. Once in monitoring, data collection starts
345+
automatically. Data is collected for Nodes, Pods, Containers, and Services via
346+
the Kubernetes API. Additionally, you can leverage LogicMonitor DataSources to
347+
monitor your applications running within the cluster.</p>
349348

350349
<!-- __*"And the goddess stirred in him unwearying strength: sleep never fell upon his eyes; but he kept sure watch always."*__
351350

docs/argus/index.xml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,7 @@
1717
<pubDate>Sat, 12 Aug 2017 17:16:07 -0700</pubDate>
1818

1919
<guid>https://logicmonitor.github.io/k8s-argus/argus/</guid>
20-
<description>Warning
21-
Argus is a community driven project in an alpha state. LogicMonitor support will not be able to assist with any issues related to Argus.
22-
Argus is a tool that helps users of LogicMonitor keep up with the highly dynamic topology of a Kubernetes cluster.</description>
20+
<description>Argus is a tool that helps users of LogicMonitor keep up with the highly dynamic nature of a Kubernetes cluster. Argus runs as a Pod in your cluster, and uses LogicMonitor&amp;rsquo;s API to add Nodes, Pods, and Services into monitoring. Once in monitoring, data collection starts automatically. Data is collected for Nodes, Pods, Containers, and Services via the Kubernetes API. Additionally, you can leverage LogicMonitor DataSources to monitor your applications running within the cluster.</description>
2321
</item>
2422

2523
</channel>

docs/docs/configuration/index.html

Lines changed: 30 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -340,9 +340,9 @@ <h1>Configuration </h1>
340340

341341

342342

343-
<h1 id="configuring-the-collecorset-controller-via-the-helm-chart">Configuring the Collecorset Controller via the Helm Chart</h1>
343+
<h1 id="configuring-the-collectorset-controller-via-the-helm-chart">Configuring the Collectorset Controller via the Helm Chart</h1>
344344

345-
<p>The Collectorset controller Helm chart supports the fololowing values:</p>
345+
<p>The Collectorset controller Helm chart supports the following values:</p>
346346

347347
<p>Required Values:</p>
348348

@@ -356,11 +356,14 @@ <h1 id="configuring-the-collecorset-controller-via-the-helm-chart">Configuring t
356356
<p>Optional Values:</p>
357357

358358
<ul>
359-
<li><strong>enableRBAC (default: <code>true</code>):</strong> Enable RBAC.</li>
360-
<li><strong>etcdDiscoveryToken:</strong> The public etcd discovery token used to add etcd hosts to the cluster device group.</li>
359+
<li><strong>enableRBAC (default: <code>true</code>):</strong> Enable RBAC. If your cluster does not have
360+
RBAC enabled, this value should be set to false.</li>
361+
<li><strong>etcdDiscoveryToken:</strong> The public etcd discovery token used to add etcd hosts
362+
to the cluster device group.</li>
361363
<li><strong>imagePullPolicy (default: <code>&quot;Always&quot;</code>):</strong></li>
362-
<li><strong>imageRepository (default: <code>&quot;logicmonitor/collectorset-controller&quot;</code>):</strong> The respository to use for the collectorset-controller docker image.</li>
363-
<li><strong>imageTag:</strong> The collectorset-controller image tag to use.</li>
364+
<li><strong>imageRepository (default: <code>&quot;logicmonitor/collectorset-controller&quot;</code>):</strong> The
365+
respository to use for the collectorset-controller docker image.</li>
366+
<li><strong>imageTag:</strong> The collectorset-controller <a href="https://hub.docker.com/r/logicmonitor/collectorset-controller/tags/">image tag</a> to use.</li>
364367
</ul>
365368

366369
<h1 id="configuring-argus-via-the-helm-chart">Configuring Argus via the Helm Chart</h1>
@@ -375,29 +378,39 @@ <h1 id="configuring-argus-via-the-helm-chart">Configuring Argus via the Helm Cha
375378
<li><strong>account:</strong> The LogicMonitor account name.</li>
376379
<li><strong>clusterName:</strong> A unique name given to the cluster&rsquo;s device group.</li>
377380
<li><strong>collector.replicas:</strong> The number of collectors to create and use with Argus.</li>
378-
<li><strong>collector.size:</strong> The collector size to install. Can be nano, small, medium, or large.</li>
381+
<li><strong>collector.size:</strong> The collector size to install. Can be nano, small, medium,
382+
or large.</li>
379383
</ul>
380384

381385
<p>Optional Values:</p>
382386

383387
<ul>
384388
<li><strong>debug (default: <code>false</code>):</strong> Enable debug logging.</li>
385-
<li><strong>deleteDevices (default: <code>true</code>):</strong> On a delete event, either delete from LogicMonitor or move the device to the <code>_delted</code> device group.</li>
389+
<li><strong>deleteDevices (default: <code>true</code>):</strong> On a delete event, either delete from
390+
LogicMonitor or move the device to the <code>_delted</code> device group.</li>
386391
<li><strong>disableAlerting (default: <code>false</code>):</strong> Disable alerting for all devices added.</li>
387-
<li><strong>enableRBAC (default: <code>true</code>):</strong> Enable RBAC.</li>
388-
<li><strong>etcdDiscoveryToken:</strong> The public etcd discovery token used to add etcd hosts to the cluster device group.</li>
392+
<li><strong>enableRBAC (default: <code>true</code>):</strong> Enable RBAC. If your cluster does not have
393+
RBAC enabled, this value should be set to false.</li>
394+
<li><strong>etcdDiscoveryToken:</strong> The public etcd discovery token used to add etcd hosts
395+
to the cluster device group.</li>
389396
<li><strong>imagePullPolicy (default: <code>&quot;Always&quot;</code>):</strong></li>
390-
<li><strong>imageRepository (default: <code>&quot;logicmonitor/argus&quot;</code>):</strong> The respository to use for the Argus docker image.</li>
391-
<li><strong>imageTag:</strong> The argus container image tag to use.</li>
397+
<li><strong>imageRepository (default: <code>&quot;logicmonitor/argus&quot;</code>):</strong> The respository to use
398+
for the Argus docker image.</li>
399+
<li><strong>imageTag:</strong> The argus container <a href="https://hub.docker.com/r/logicmonitor/argus/tags/">image tag</a> to use.</li>
392400
</ul>
393401

394402
<h1 id="configuring-argus-manually">Configuring Argus Manually</h1>
395403

396-
<p>In most applications there are generally two types of configuration options available. Options that do not contain sensitive information, and options that do contain sensitive information. Argus retrieves its&rsquo; configuration from two different sources for each of these types.</p>
404+
<p>In most applications there are generally two types of configuration options
405+
available. Options that do not contain sensitive information, and options that
406+
do contain sensitive information. Argus retrieves its&rsquo; configuration from two
407+
different sources for each of these types.</p>
397408

398-
<p>For non-sensitive configuration options, Arugs will read from a file on disk. For sensitive information, Arugs will read from environment variables.</p>
409+
<p>For non-sensitive configuration options, Argus will read from a file on disk.
410+
For sensitive information, Argus will read from environment variables.</p>
399411

400-
<p>To configure the non-sensitive information, create a YAML file located at <code>/etc/argus/config.yaml</code>. Here is an example file you can modify to your needs:</p>
412+
<p>To configure the non-sensitive information, create a YAML file located at
413+
<code>/etc/argus/config.yaml</code>. Here is an example file you can modify to your needs:</p>
401414

402415
<pre><code class="language-yaml">cluster_group_id:
403416
cluster_name:
@@ -406,7 +419,8 @@ <h1 id="configuring-argus-manually">Configuring Argus Manually</h1>
406419
disable_alerting: false
407420
</code></pre>
408421

409-
<p>To configure the sensitive information, export the following environment variables:</p>
422+
<p>To configure the sensitive information, export the following environment
423+
variables:</p>
410424

411425
<pre><code class="language-bash">ACCESS_ID
412426
ACCESS_KEY

docs/docs/index.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,10 @@ Device Groups Argus has an opinionated way of representing a cluster in the Logi
3737
<pubDate>Wed, 16 Aug 2017 17:54:55 -0700</pubDate>
3838

3939
<guid>https://logicmonitor.github.io/k8s-argus/docs/configuration/</guid>
40-
<description>Configuring the Collecorset Controller via the Helm Chart The Collectorset controller Helm chart supports the fololowing values:
40+
<description>Configuring the Collectorset Controller via the Helm Chart The Collectorset controller Helm chart supports the following values:
4141
Required Values:
4242
accessID: The LogicMonitor API key ID. accessKey: The LogicMonitor API key. account: The LogicMonitor account name. clusterName: A unique name given to the cluster&amp;rsquo;s device group. Optional Values:
43-
enableRBAC (default: true): Enable RBAC. etcdDiscoveryToken: The public etcd discovery token used to add etcd hosts to the cluster device group.</description>
43+
enableRBAC (default: true): Enable RBAC. If your cluster does not have RBAC enabled, this value should be set to false.</description>
4444
</item>
4545

4646
<item>

docs/getting-started/index.html

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -346,15 +346,14 @@ <h1>Getting Started </h1>
346346
<p>The simplest way to get started with Argus is to install it using <a href="https://github.com/kubernetes/helm">Helm</a>. Prior to installation, you will need a
347347
cluster-admin serviceaccount for tiller:</p>
348348

349-
<pre><code class="language-bash">$ kubectl create serviceaccount tiller --namespace $NAMESPACE
350-
$ kubectl create clusterrolebinding tiller --clusterrole=cluster-admin --serviceaccount=$NAMESPACE:tiller
349+
<pre><code class="language-bash">$ kubectl create serviceaccount tiller --namespace=&quot;kube-system&quot;
350+
$ kubectl create clusterrolebinding tiller --clusterrole=cluster-admin --serviceaccount=kube-system:tiller
351351
$ helm init --service-account=tiller
352352
</code></pre>
353353

354354
<p>You&rsquo;ll also need to add the LogicMonitor chart repository:</p>
355355

356356
<pre><code class="language-bash">$ helm repo add logicmonitor https://logicmonitor.github.com/k8s-helm-charts
357-
&quot;logicmonitor&quot; has been added to your repositories
358357
</code></pre>
359358

360359
<p>Now you can install the LogicMonitor Collectorset controller:</p>
@@ -367,11 +366,14 @@ <h1>Getting Started </h1>
367366
--set accessKey=&quot;$ACCESS_KEY&quot; \
368367
--set account=&quot;$ACCOUNT&quot; \
369368
--set clusterName=&quot;$CLUSTER_NAME&quot; \
370-
--set etcdDiscoveryToken=&quot;$ETCD_DISCOVERY_TOKEN&quot; \
371369
--set imageTag=&quot;$IMAGE_TAG&quot; \
372370
collectorset-controller logicmonitor/collectorset-controller
373371
</code></pre>
374372

373+
<p>See the <a href="https://logicmonitor.github.io/k8s-argus/docs/configuration/">configuration page</a> for a complete
374+
list of values the Collectorset Controller helm chart supports, and their
375+
descriptions.</p>
376+
375377
<blockquote>
376378
<p>Note: The Collectorset controller should be installed only once per cluster.</p>
377379
</blockquote>
@@ -387,13 +389,15 @@ <h1>Getting Started </h1>
387389
--set account=&quot;$ACCOUNT&quot; \
388390
--set clusterGroupID=&quot;$CLUSTER_GROUP_ID&quot; \
389391
--set clusterName=&quot;$CLUSTER_NAME&quot; \
390-
--set etcdDiscoveryToken=&quot;$ETCD_DISCOVERY_TOKEN&quot; \
391392
--set imageTag=&quot;$IMAGE_TAG&quot; \
392393
--set collector.replicas=&quot;$COLLECTOR_REPLICAS&quot; \
393394
--set collector.size=&quot;$COLLECTOR_SIZE&quot; \
394395
argus logicmonitor/argus
395396
</code></pre>
396397

398+
<p>See the <a href="https://logicmonitor.github.io/k8s-argus/docs/configuration/">configuration page</a> for a complete
399+
list of values the Argus helm chart supports, and their descriptions.</p>
400+
397401
<blockquote>
398402
<p>Note: Argus should be installed only once per cluster.</p>
399403
</blockquote>

0 commit comments

Comments
 (0)