From d967e3219329e2f87178877a6c334c83568d2e1b Mon Sep 17 00:00:00 2001 From: Regan Kuchan Date: Mon, 5 Dec 2016 13:02:44 -0800 Subject: [PATCH] Update README and INSTALLATION for the beta release --- README.md | 16 +++++++++++++--- docs/INSTALLATION.md | 16 ++++++++++------ 2 files changed, 23 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index b7da02ecc7..6c2a01dda3 100644 --- a/README.md +++ b/README.md @@ -68,12 +68,22 @@ A UI for [Kapacitor](https://github.com/influxdata/kapacitor) alert creation and ## Versions -Chronograf v1.1.0-alpha is an [alpha release](https://www.influxdata.com/announcing-the-new-chronograf-a-ui-for-the-tick-stack-and-a-complete-open-source-monitoring-solution/). +Chronograf v1.1.0-beta is a [beta release](https://www.influxdata.com/TODO/). We will be iterating quickly based on user feedback and recommend using the [nightly builds](https://www.influxdata.com/downloads/) for the time being. Spotted a bug or have a feature request? Please open [an issue](https://github.com/influxdata/chronograf/issues/new)! +### Known Issues + +The Chronograf team has identified and is working on the following issues: + +* Chronograf v1.1.0-beta does not support creating and editing raw queries in the [Data Explorer](https://github.com/influxdata/chronograf/blob/master/docs/GETTING_STARTED.md#data-explorer). +Currently, users must create all queries with the Data Explorer's query builder. +* Chronograf's [OAuth 2.0 Style Authentication](https://github.com/influxdata/chronograf/blob/master/docs/auth.md) allows all users to authenticate with their GitHub account. +It does not yet offer any security or allow administrators to filter users. +* Currently, Chronograf requires users to run Telegraf's [CPU](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/system/CPU_README.md) and [system](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/system/SYSTEM_README.md) plugins to ensure that all Apps appear on the [HOST LIST](https://github.com/influxdata/chronograf/blob/master/docs/GETTING_STARTED.md#host-list) page. + ## Installation Check out the [INSTALLATION](https://github.com/influxdata/chronograf/blob/master/docs/INSTALLATION.md) guide to get up and running with Chronograf with as little configuration and code as possible. @@ -93,8 +103,8 @@ docker pull quay.io/influxdb/chronograf:latest ### From Source -* Chronograf works with go 1.7.3, npm 3.10.7 and node v6.6.0. Additional version support of these projects will be implemented soon, but these are the only supported versions to date. -* Chronograf requires [Kapacitor](https://github.com/influxdata/kapacitor) 1.1 to create and store alerts. +* Chronograf works with go 1.7.4, npm 3.10.7 and node v6.6.0. Additional version support of these projects will be implemented soon, but these are the only supported versions to date. +* Chronograf requires [Kapacitor](https://github.com/influxdata/kapacitor) 1.1.x to create and store alerts. 1. [Install Go](https://golang.org/doc/install) 1. [Install Node and NPM](https://nodejs.org/en/download/) diff --git a/docs/INSTALLATION.md b/docs/INSTALLATION.md index 4fab0e7428..bd439a4f30 100644 --- a/docs/INSTALLATION.md +++ b/docs/INSTALLATION.md @@ -20,8 +20,8 @@ Check out the [downloads](https://www.influxdata.com/downloads/) page for links #### 1. Download and Install InfluxDB ``` -wget https://dl.influxdata.com/influxdb/releases/influxdb_1.1.0_amd64.deb -sudo dpkg -i influxdb_1.1.0_amd64.deb +wget https://dl.influxdata.com/influxdb/releases/influxdb_1.1.1_amd64.deb +sudo dpkg -i influxdb_1.1.1_amd64.deb ``` #### 2. Start InfluxDB @@ -49,8 +49,8 @@ Kapacitor is responsible for creating and sending alerts in Chronograf. #### 1. Download and Install Kapacitor ``` -wget https://dl.influxdata.com/kapacitor/releases/kapacitor_1.1.0_amd64.deb -sudo dpkg -i kapacitor_1.1.0_amd64.deb +wget https://dl.influxdata.com/kapacitor/releases/kapacitor_1.1.1_amd64.deb +sudo dpkg -i kapacitor_1.1.1_amd64.deb ``` #### 2. Start Kapacitor @@ -83,10 +83,14 @@ In a production environment, Telegraf would be installed on your servers and wou Ultimately, you will configure a Telegraf input plugin for each application that you want to monitor. At the end of this guide we provide sample configurations for additional applications. +> Note: +Currently, Chronograf requires users to run Telegraf's [CPU](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/system/CPU_README.md) and [system](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/system/SYSTEM_README.md) plugins to ensure that all Apps appear on the [HOST LIST](https://github.com/influxdata/chronograf/blob/master/docs/GETTING_STARTED.md#host-list) page. +This is a known issue. + #### 1. Download and Install Telegraf ``` -wget https://dl.influxdata.com/telegraf/releases/telegraf_1.1.1_amd64.deb -sudo dpkg -i telegraf_1.1.1_amd64.deb +wget https://dl.influxdata.com/telegraf/releases/telegraf_1.1.2_amd64.deb +sudo dpkg -i telegraf_1.1.2_amd64.deb ``` #### 2. Start Telegraf