diff --git a/docs/docs/configuration/index.html b/docs/docs/configuration/index.html index e0f842ee2..effba7d22 100644 --- a/docs/docs/configuration/index.html +++ b/docs/docs/configuration/index.html @@ -340,9 +340,9 @@

Configuration

-

Configuring the Collecorset Controller via the Helm Chart

+

Configuring the Collectorset Controller via the Helm Chart

-

The Collectorset controller Helm chart supports the fololowing values:

+

The Collectorset controller Helm chart supports the following values:

Required Values:

@@ -356,11 +356,14 @@

Configuring t

Optional Values:

Configuring Argus via the Helm Chart

@@ -375,29 +378,39 @@

Configuring Argus via the Helm Cha
  • account: The LogicMonitor account name.
  • clusterName: A unique name given to the cluster’s device group.
  • collector.replicas: The number of collectors to create and use with Argus.
    • -
  • collector.size: The collector size to install. Can be nano, small, medium, or large.
    • +
  • collector.size: The collector size to install. Can be nano, small, medium, +or large.

    • Optional Values:

    Configuring Argus Manually

    -

    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’ configuration from two different sources for each of these types.

    +

    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’ configuration from two +different sources for each of these types.

    -

    For non-sensitive configuration options, Arugs will read from a file on disk. For sensitive information, Arugs will read from environment variables.

    +

    For non-sensitive configuration options, Argus will read from a file on disk. + For sensitive information, Argus will read from environment variables.

    -

    To configure the non-sensitive information, create a YAML file located at /etc/argus/config.yaml. Here is an example file you can modify to your needs:

    +

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

    cluster_name:
 debug: false
@@ -405,7 +418,8 @@ 
    Configuring Argus Manually
    
 disable_alerting: false
    -

    To configure the sensitive information, export the following environment variables:

    +

    To configure the sensitive information, export the following environment +variables:

    ACCESS_ID
 ACCESS_KEY
diff --git a/docs/docs/index.xml b/docs/docs/index.xml
index 88273dab9..269455a75 100644
--- a/docs/docs/index.xml
+++ b/docs/docs/index.xml
@@ -37,10 +37,10 @@ Device Groups Argus has an opinionated way of representing a cluster in the Logi
       Wed, 16 Aug 2017 17:54:55 -0700
       
       https://logicmonitor.github.io/k8s-argus/docs/configuration/
-      Configuring the Collecorset Controller via the Helm Chart The Collectorset controller Helm chart supports the fololowing values:
+      Configuring the Collectorset Controller via the Helm Chart The Collectorset controller Helm chart supports the following values:
 Required Values:
  accessID: The LogicMonitor API key ID. accessKey: The LogicMonitor API key. account: The LogicMonitor account name. clusterName: A unique name given to the cluster’s device group.  Optional Values:
- enableRBAC (default: true): Enable RBAC. etcdDiscoveryToken: The public etcd discovery token used to add etcd hosts to the cluster device group.
+ enableRBAC (default: true): Enable RBAC. If your cluster does not have RBAC enabled, this value should be set to false.
     
     
     
diff --git a/docs/getting-started/index.html b/docs/getting-started/index.html
index 32ec9a612..e4a6ba0a7 100644
--- a/docs/getting-started/index.html
+++ b/docs/getting-started/index.html
@@ -346,15 +346,14 @@ 
    Getting Started 
    
 
    The simplest way to get started with Argus is to install it using Helm. Prior to installation, you will need a
 cluster-admin serviceaccount for tiller:
    
 
-
    $ kubectl create serviceaccount tiller --namespace $NAMESPACE
-$ kubectl create clusterrolebinding tiller --clusterrole=cluster-admin --serviceaccount=$NAMESPACE:tiller
+
    $ kubectl create serviceaccount tiller --namespace="kube-system"
+$ kubectl create clusterrolebinding tiller --clusterrole=cluster-admin --serviceaccount=kube-system:tiller
 $ helm init --service-account=tiller
 
    
 
 
    You’ll also need to add the LogicMonitor chart repository:
    
 
 
    $ helm repo add logicmonitor https://logicmonitor.github.com/k8s-helm-charts
-"logicmonitor" has been added to your repositories
 
    
 
 
    Now you can install the LogicMonitor Collectorset controller:
    
@@ -367,11 +366,14 @@ 
    Getting Started 
    
   --set accessKey="$ACCESS_KEY" \
   --set account="$ACCOUNT" \
   --set clusterName="$CLUSTER_NAME" \
-  --set etcdDiscoveryToken="$ETCD_DISCOVERY_TOKEN" \
   --set imageTag="$IMAGE_TAG" \
   collectorset-controller logicmonitor/collectorset-controller
 
    
 
+
    See the configuration page for a complete
+list of values the Collectorset Controller helm chart supports, and their
+descriptions.
    
+
 
    
 
    Note: The Collectorset controller should be installed only once per cluster.
    
 
    
@@ -386,13 +388,15 @@ 
    Getting Started 
    
     --set accessKey="$ACCESS_KEY" \
     --set account="$ACCOUNT" \
     --set clusterName="$CLUSTER_NAME" \
-    --set etcdDiscoveryToken="$ETCD_DISCOVERY_TOKEN" \
     --set imageTag="$IMAGE_TAG" \
     --set collector.replicas="$COLLECTOR_REPLICAS" \
     --set collector.size="$COLLECTOR_SIZE" \
     argus logicmonitor/argus
    +

    See the configuration page for a complete +list of values the Argus helm chart supports, and their descriptions.

    +

    Note: Argus should be installed only once per cluster.

    diff --git a/docs/getting-started/index.xml b/docs/getting-started/index.xml index 0be2aec67..94be7a7b4 100644 --- a/docs/getting-started/index.xml +++ b/docs/getting-started/index.xml @@ -18,8 +18,9 @@ https://logicmonitor.github.io/k8s-argus/getting-started/ The simplest way to get started with Argus is to install it using Helm. Prior to installation, you will need a cluster-admin serviceaccount for tiller: -$ kubectl create serviceaccount tiller --namespace $NAMESPACE $ kubectl create clusterrolebinding tiller --clusterrole=cluster-admin --serviceaccount=$NAMESPACE:tiller $ helm init --service-account=tiller You’ll also need to add the LogicMonitor chart repository: -$ helm repo add logicmonitor https://logicmonitor.github.com/k8s-helm-charts "logicmonitor" has been added to your repositories Now you can install the LogicMonitor Collectorset controller: +$ kubectl create serviceaccount tiller --namespace="kube-system" $ kubectl create clusterrolebinding tiller --clusterrole=cluster-admin --serviceaccount=kube-system:tiller $ helm init --service-account=tiller You’ll also need to add the LogicMonitor chart repository: +$ helm repo add logicmonitor https://logicmonitor.github.com/k8s-helm-charts Now you can install the LogicMonitor Collectorset controller: +$ helm upgrade \ --install \ --debug \ --wait \ --set accessID="$ACCESS_ID" \ --set accessKey="$ACCESS_KEY" \ --set account="$ACCOUNT" \ --set clusterName="$CLUSTER_NAME" \ --set imageTag="$IMAGE_TAG" \ collectorset-controller logicmonitor/collectorset-controller See the configuration page for a complete list of values the Collectorset Controller helm chart supports, and their descriptions. diff --git a/docs/index.xml b/docs/index.xml index 1b5fd3055..979b9e8aa 100644 --- a/docs/index.xml +++ b/docs/index.xml @@ -37,10 +37,10 @@ Device Groups Argus has an opinionated way of representing a cluster in the Logi Wed, 16 Aug 2017 17:54:55 -0700 https://logicmonitor.github.io/k8s-argus/docs/configuration/ - Configuring the Collecorset Controller via the Helm Chart The Collectorset controller Helm chart supports the fololowing values: + Configuring the Collectorset Controller via the Helm Chart The Collectorset controller Helm chart supports the following values: Required Values: accessID: The LogicMonitor API key ID. accessKey: The LogicMonitor API key. account: The LogicMonitor account name. clusterName: A unique name given to the cluster’s device group. Optional Values: - enableRBAC (default: true): Enable RBAC. etcdDiscoveryToken: The public etcd discovery token used to add etcd hosts to the cluster device group. + enableRBAC (default: true): Enable RBAC. If your cluster does not have RBAC enabled, this value should be set to false. @@ -80,8 +80,9 @@ Argus is a community driven project in an alpha state. LogicMonitor support will https://logicmonitor.github.io/k8s-argus/getting-started/ The simplest way to get started with Argus is to install it using Helm. Prior to installation, you will need a cluster-admin serviceaccount for tiller: -$ kubectl create serviceaccount tiller --namespace $NAMESPACE $ kubectl create clusterrolebinding tiller --clusterrole=cluster-admin --serviceaccount=$NAMESPACE:tiller $ helm init --service-account=tiller You’ll also need to add the LogicMonitor chart repository: -$ helm repo add logicmonitor https://logicmonitor.github.com/k8s-helm-charts "logicmonitor" has been added to your repositories Now you can install the LogicMonitor Collectorset controller: +$ kubectl create serviceaccount tiller --namespace="kube-system" $ kubectl create clusterrolebinding tiller --clusterrole=cluster-admin --serviceaccount=kube-system:tiller $ helm init --service-account=tiller You’ll also need to add the LogicMonitor chart repository: +$ helm repo add logicmonitor https://logicmonitor.github.com/k8s-helm-charts Now you can install the LogicMonitor Collectorset controller: +$ helm upgrade \ --install \ --debug \ --wait \ --set accessID="$ACCESS_ID" \ --set accessKey="$ACCESS_KEY" \ --set account="$ACCOUNT" \ --set clusterName="$CLUSTER_NAME" \ --set imageTag="$IMAGE_TAG" \ collectorset-controller logicmonitor/collectorset-controller See the configuration page for a complete list of values the Collectorset Controller helm chart supports, and their descriptions. diff --git a/docs/source/content/docs/configuration.md b/docs/source/content/docs/configuration.md index 0cf409c3f..bd7a4fb53 100644 --- a/docs/source/content/docs/configuration.md +++ b/docs/source/content/docs/configuration.md @@ -9,9 +9,9 @@ menu: weight: 1 --- -# Configuring the Collecorset Controller via the Helm Chart +# Configuring the Collectorset Controller via the Helm Chart -The Collectorset controller Helm chart supports the fololowing values: +The Collectorset controller Helm chart supports the following values: Required Values: @@ -22,11 +22,14 @@ Required Values: Optional Values: -- **enableRBAC (default: `true`):** Enable RBAC. -- **etcdDiscoveryToken:** The public etcd discovery token used to add etcd hosts to the cluster device group. +- **enableRBAC (default: `true`):** Enable RBAC. If your cluster does not have +RBAC enabled, this value should be set to false. +- **etcdDiscoveryToken:** The public etcd discovery token used to add etcd hosts + to the cluster device group. - **imagePullPolicy (default: `"Always"`):** -- **imageRepository (default: `"logicmonitor/collectorset-controller"`):** The respository to use for the collectorset-controller docker image. -- **imageTag:** The collectorset-controller image tag to use. +- **imageRepository (default: `"logicmonitor/collectorset-controller"`):** The +respository to use for the collectorset-controller docker image. +- **imageTag:** The collectorset-controller [image tag] (https://hub.docker.com/r/logicmonitor/collectorset-controller/tags/) to use. # Configuring Argus via the Helm Chart @@ -39,26 +42,36 @@ Required Values: - **account:** The LogicMonitor account name. - **clusterName:** A unique name given to the cluster's device group. - **collector.replicas:** The number of collectors to create and use with Argus. -- **collector.size:** The collector size to install. Can be nano, small, medium, or large. +- **collector.size:** The collector size to install. Can be nano, small, medium, + or large. Optional Values: - **debug (default: `false`):** Enable debug logging. -- **deleteDevices (default: `true`):** On a delete event, either delete from LogicMonitor or move the device to the `_delted` device group. +- **deleteDevices (default: `true`):** On a delete event, either delete from +LogicMonitor or move the device to the `_delted` device group. - **disableAlerting (default: `false`):** Disable alerting for all devices added. -- **enableRBAC (default: `true`):** Enable RBAC. -- **etcdDiscoveryToken:** The public etcd discovery token used to add etcd hosts to the cluster device group. +- **enableRBAC (default: `true`):** Enable RBAC. If your cluster does not have +RBAC enabled, this value should be set to false. +- **etcdDiscoveryToken:** The public etcd discovery token used to add etcd hosts + to the cluster device group. - **imagePullPolicy (default: `"Always"`):** -- **imageRepository (default: `"logicmonitor/argus"`):** The respository to use for the Argus docker image. -- **imageTag:** The argus container image tag to use. +- **imageRepository (default: `"logicmonitor/argus"`):** The respository to use +for the Argus docker image. +- **imageTag:** The argus container [image tag] (https://hub.docker.com/r/logicmonitor/argus/tags/) to use. # Configuring Argus Manually -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' configuration from two different sources for each of these types. +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' configuration from two +different sources for each of these types. - For non-sensitive configuration options, Arugs will read from a file on disk. For sensitive information, Arugs will read from environment variables. + For non-sensitive configuration options, Argus will read from a file on disk. + For sensitive information, Argus will read from environment variables. -To configure the non-sensitive information, create a YAML file located at `/etc/argus/config.yaml`. Here is an example file you can modify to your needs: +To configure the non-sensitive information, create a YAML file located at +`/etc/argus/config.yaml`. Here is an example file you can modify to your needs: ```yaml cluster_name: @@ -67,7 +80,8 @@ delete_devices: true disable_alerting: false ``` -To configure the sensitive information, export the following environment variables: +To configure the sensitive information, export the following environment +variables: ```bash ACCESS_ID diff --git a/docs/source/content/getting-started/index.md b/docs/source/content/getting-started/index.md index 758e59a11..9f535c3ee 100644 --- a/docs/source/content/getting-started/index.md +++ b/docs/source/content/getting-started/index.md @@ -8,8 +8,8 @@ The simplest way to get started with Argus is to install it using [Helm] (https://github.com/kubernetes/helm). Prior to installation, you will need a cluster-admin serviceaccount for tiller: ```bash -$ kubectl create serviceaccount tiller --namespace $NAMESPACE -$ kubectl create clusterrolebinding tiller --clusterrole=cluster-admin --serviceaccount=$NAMESPACE:tiller +$ kubectl create serviceaccount tiller --namespace="kube-system" +$ kubectl create clusterrolebinding tiller --clusterrole=cluster-admin --serviceaccount=kube-system:tiller $ helm init --service-account=tiller ``` @@ -17,7 +17,6 @@ You'll also need to add the LogicMonitor chart repository: ```bash $ helm repo add logicmonitor https://logicmonitor.github.com/k8s-helm-charts -"logicmonitor" has been added to your repositories ``` Now you can install the LogicMonitor Collectorset controller: @@ -31,11 +30,15 @@ $ helm upgrade \ --set accessKey="$ACCESS_KEY" \ --set account="$ACCOUNT" \ --set clusterName="$CLUSTER_NAME" \ - --set etcdDiscoveryToken="$ETCD_DISCOVERY_TOKEN" \ --set imageTag="$IMAGE_TAG" \ collectorset-controller logicmonitor/collectorset-controller ``` +See the [configuration page] +(https://logicmonitor.github.io/k8s-argus/docs/configuration/) for a complete +list of values the Collectorset Controller helm chart supports, and their +descriptions. + > Note: The Collectorset controller should be installed only once per cluster. Next, install Argus: @@ -49,12 +52,14 @@ Next, install Argus: --set accessKey="$ACCESS_KEY" \ --set account="$ACCOUNT" \ --set clusterName="$CLUSTER_NAME" \ - --set etcdDiscoveryToken="$ETCD_DISCOVERY_TOKEN" \ --set imageTag="$IMAGE_TAG" \ --set collector.replicas="$COLLECTOR_REPLICAS" \ --set collector.size="$COLLECTOR_SIZE" \ argus logicmonitor/argus ``` +See the [configuration page] +(https://logicmonitor.github.io/k8s-argus/docs/configuration/) for a complete +list of values the Argus helm chart supports, and their descriptions. > Note: Argus should be installed only once per cluster.