Merge branch 'release/v1.3.9'

.github/workflows/integ-tests.yml

@@ -5,12 +5,12 @@ name: integration tests
 
 on:
   push:
-    branches: [ master, release-1.3.5 ]
+    branches: [ master ]
   pull_request:
-    branches: [ master, release-1.3.5 ]
+    branches: [ master ]
   workflow_dispatch:
     inputs:
-    branches: [ master, release-1.3.5 ]
+    branches: [ master]
 
 
 jobs:

.github/workflows/unit-tests.yml

@@ -1,6 +1,8 @@
 name: build
 
-on: [push]
+on:
+  push:
+    branches-ignore:
 
 jobs:
   build:

README.md

@@ -7,19 +7,19 @@
 Timeseries big data analytics tools
 
 
-
 ## User
 
 Please find the code/documentation for your version :
 
+* [release v1.3.9](https://github.com/Hurence/historian/tree/v1.3.9)
 * [release v1.3.6](https://github.com/Hurence/historian/tree/v1.3.6)
 * [release v1.3.5](https://github.com/Hurence/historian/tree/v1.3.5)
 
-the user guide can be read in [https://github.com/Hurence/historian/tree/master/docs/generated-docs/pdf/en/userguide.pdf](https://github.com/Hurence/historian/tree/master/docs/generated-docs/pdf/en/userguide.pdf)
+the user guide can be read in [https://hurence.github.io/historian/](https://hurence.github.io/historian/)
 
 ## Development
 
-Please see our documentation [here](DEVELOPMENT.md)
+Please see our documentation [here](docs/developer-guide.md)
 
 ## Build
 Build with maven through a JDK 8+

assembly/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <artifactId>historian</artifactId>
         <groupId>com.hurence.historian</groupId>
-        <version>1.3.8</version>
+        <version>1.3.9</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 

docker-compose.yml

@@ -0,0 +1,42 @@
+version: '2'
+services:
+  solrnode1:
+    image: docker.io/bitnami/solr:8
+    environment:
+      - SOLR_ENABLE_CLOUD_MODE=yes
+      - SOLR_CLOUD_BOOTSTRAP=yes
+      - SOLR_NUMBER_OF_NODES=1
+      - SOLR_ZK_HOSTS=zk1:2181
+      - SOLR_HOST=solrnode1
+      - SOLR_ENABLE_AUTHENTICATION=no
+    ports:
+      - '8983:8983'
+    volumes:
+      - 'solr_data:/bitnami/solr'
+  zk1:
+    image: docker.io/bitnami/zookeeper:3.7
+    ports:
+      - '2181'
+    volumes:
+      - zookeeper_data:/bitnami
+    environment:
+      - ZOO_SERVER_ID=1
+      - ALLOW_ANONYMOUS_LOGIN=yes
+      - ZOO_SERVERS=zk1:2888:3888
+      - ZOO_4LW_COMMANDS_WHITELIST=srvr,mntr,conf,ruok
+  grafana:
+    image: docker.io/bitnami/grafana:8
+    ports:
+      - '3000:3000'
+    environment:
+      - 'GF_SECURITY_ADMIN_PASSWORD=bitnami'
+    volumes:
+      - grafana_data:/opt/bitnami/grafana/data
+
+volumes:
+  solr_data:
+    driver: local
+  zookeeper_data:
+    driver: local
+  grafana_data:
+    driver: local

docs/404.html

@@ -0,0 +1,10 @@
+---
+layout: default
+---
+
+<div class="container text-center">
+  <h1>404</h1>
+
+  <p><strong>Page not found :(</strong></p>
+  <p>The requested page could not be found.</p>
+</div>

docs/CONTRIBUTING.md

@@ -0,0 +1,85 @@
+# Contributing to this project
+
+* [Contributors Agreement](#user-content-contributors-agreement)
+* [Introduction](#Introduction)
+  * [I don't want to read this whole thing I just have a question!!!](#user-content-i-dont-want-to-read-this-whole-thing-i-just-have-a-question)
+* [How Can I Contribute?](#user-content-how-can-i-contribute)
+  * [Reporting Bugs](#user-content-reporting-bugs)
+  * [Suggesting Enhancements](#user-content-suggesting-enhancements)
+  * [Creating Pull Requests](#user-content-creating-pull-requests)
+
+## Contributors Agreement
+
+By submitting patches to this project you agree to allow them to be redistributed under the project's license, according to the normal forms and usages of the open-source community.
+
+## Introduction
+
+First off, thank you for considering contributing to this project. It's people like you that make it such a great tool.
+
+Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.
+
+This is an open source project and we love to receive contributions from our community — you! There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into the main project itself.
+
+### I don't want to read this whole thing I just have a question!!!
+
+We currently allow our users to use the issue tracker for support questions. But please be wary that maintaining an open source project can take a lot of time from the maintainers. If asking for a support question, state it clearly and take the time to explain your problem properly. Also, if your problem is not strictly related to this project we recommend you to use Stack Overlow instead.
+
+## How Can I Contribute?
+
+### Reporting Bugs
+
+Before creating bug reports, please check the existing bug reports as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible.
+
+#### How Do I Submit A (Good) Bug Report?
+
+Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/). Create an issue on the project's repository and provide the following information.
+
+Explain the problem and include additional details to help maintainers reproduce the problem:
+
+* **Use a clear and descriptive title** for the issue to identify the problem.
+* **Describe the exact steps which reproduce the problem** in as many details as possible. For example, start by explaining how you used the project. When listing steps, **don't just say what you did, but explain how you did it**.
+* **Provide specific examples to demonstrate the steps**. It's always better to get more information. You can include links to files or GitHub projects, copy/pasteable snippets or even print screens or animated GIFS. If you're providing snippets in the issue, use [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines).
+* **Describe the behavior you observed after following the steps** and point out what exactly is the problem with that behavior.
+* **Explain which behavior you expected to see instead and why.**
+* **If the problem wasn't triggered by a specific action**, describe what you were doing before the problem happened and share more information using the guidelines below.
+
+Provide more context by answering these questions:
+
+* **Did the problem start happening recently** (e.g. after updating to a new version) or was this always a problem?
+* If the problem started happening recently, **can you reproduce the problem in an older version?** What's the most recent version in which the problem doesn't happen?
+* **Can you reliably reproduce the issue?** If not, provide details about how often the problem happens and under which conditions it normally happens.
+
+Include details about your configuration and environment:
+
+* **Which version of the project are you using?**
+* **What's the name and version of the OS you're using**?
+* **Any other information that could be useful about you environment**
+
+### Suggesting Enhancements
+
+This section guides you through submitting an enhancement suggestion for this project, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion and find related suggestions.
+
+Before creating enhancement suggestions, please check the list of enhancements suggestions in the issue tracker as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please include as many details as possible.
+
+#### How Do I Submit A (Good) Enhancement Suggestion?
+
+Enhancement suggestions are tracked as [GitHub issues](https://guides.github.com/features/issues/). Create an issue on the project's repository and provide the following information:
+
+* **Use a clear and descriptive title** for the issue to identify the suggestion.
+* **Provide a step-by-step description of the suggested enhancement** in as many details as possible.
+* **Provide specific examples to demonstrate the steps**. It's always better to get more information. You can include links to files or GitHub projects, copy/pasteable snippets or even print screens or animated GIFS. If you're providing snippets in the issue, use [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines).
+* **Describe the current behavior** and **explain which behavior you expected to see instead** and why.
+* **List some other similar projects where this enhancement exists.**
+* **Specify which version of the project you're using.**
+* **Specify the current environment you're using.** if this is a useful information.
+
+### Creating Pull Requests
+
+#### How Do I Submit A (Good) Pull Request?
+
+* **Be warned that the contributors agreement displayed on top of this document is applicable as soon as you create a pull request**.
+* **Use a clear and descriptive title** for the pull request to state the improvement you made to the code or the bug you solved.
+* **Provide a link to the related issue** if the pull request is a follow up of an existing bug report or enhancement suggestion.
+* **Comment why this pull request represents an enhancement** and give a rationale explaining why you did it that way and not another way.
+* **Use the same coding style than the one used in this project**.
+* **Welcome suggestions from the maintainers to improve your pull request**. 

docs/Gemfile

@@ -0,0 +1,16 @@
+source "https://rubygems.org"
+
+# Hello! This is where you manage which Jekyll version is used to run.
+# When you want to use a different version, change it below, save the
+# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
+#
+#     bundle exec jekyll serve
+#
+# This will help ensure the proper Jekyll version is running.
+# Happy Jekylling!
+#gem "jekyll", "~> 3.7.3"
+
+
+# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
+# uncomment the line below. To upgrade, run `bundle update github-pages`.
+gem "github-pages", group: :jekyll_plugins

docs/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Nicolas Vanhoren
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

docs/README.md

@@ -1,24 +1,19 @@
-Building the documentation is simple. You must be in the docs folder and launch the maven process using this command:
 
-``mvn process-resources``
+# Boostrap 4 Github Pages
 
-Currently only the french and english documentation are built. 
+A [Bootstrap 4](https://getbootstrap.com/) template project for [Github Pages](https://pages.github.com/) and [Jekyll](https://jekyllrb.com/).
 
-The process for editing is the following: the userguide is edited in asciidoc in all supported languages in a 
-sub-directory corresponding to the language locale. Asciidoctor processors are then used to take the asciidoc 
-files and generate the other formats. The maven process generates html5 and pdf versions at the moment. 
-Future versions will support other languages than French as well as the DocBook and EPub formats.
+* A full Bootstrap 4 theme usable both on Github Pages and with a standalone Jekyll.
+* Recompiles Bootstrap from SCSS files, which allows to customize Bootstrap's variables and use Bootstrap themes.
+* Full support of Bootstrap's JavaScript plugins.
+* Supports all features of Github Pages and Jekyll.
 
-# Dev
+[See the website for demonstration and documentation](https://nicolas-van.github.io/bootstrap-4-github-pages/).
 
-If you are editing the doc and want to test if its work, you can run only your doc generation with this command
+## Contribution
 
-```shell script
-mvn clean <plugin-prefix>:<plugin-goal>@<execution-id>
-```
+[See the contribution guide.](CONTRIBUTING.md)
 
-For example if you want to only generate the french user guide in pdf I would execute
+## License
 
-```shell script
-mvn clean asciidoctor:process-asciidoc@fr-usermanual-to-pdf
-```
+[See the license file.](LICENSE.md)

docs/_config.yml

@@ -1,8 +1,46 @@
-theme: jekyll-theme-cayman
-title: Hurence Data Historian
-description: big data timeseries storage and analytics
-show_downloads: "true"
-google_analytics: [Your Google Analytics tracking ID]
-github:
-  zip_url: http://example.com/download.zip
-  hurence_url:  http://www.hurence.com
+# Welcome to Jekyll!
+#
+# This config file is meant for settings that affect your whole blog, values
+# which you are expected to set up once and rarely edit after that. If you find
+# yourself editing this file very often, consider using Jekyll's data files
+# feature for the data you need to update frequently.
+#
+# For technical reasons, this file is *NOT* reloaded automatically when you use
+# 'bundle exec jekyll serve'. If you change this file, please restart the server process.
+
+# Site settings
+# These are used to personalize your new site. If you look in the HTML files,
+# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
+# You can create any custom variable you would like, and they will be accessible
+# in the templates via {{ site.myvariable }}.
+title: Hurence Historian
+email: ""
+description: >- # this means to ignore newlines until "baseurl:"
+  Main documentation
+#baseurl: "" # the subpath of your site, e.g. /blog
+#url: "" # the base hostname & protocol for your site, e.g. http://example.com
+#twitter_username: jekyllrb
+#github_username:  jekyll
+
+repository: "hurence/historian"
+
+# Build settings
+plugins:
+  - jekyll-feed
+  - jekyll-sitemap
+
+# A list of the pages to display in the navigation bar
+header_pages:
+  - features
+  - getting-started
+
+# Exclude from processing.
+# The following items will not be processed, by default. Create a custom list
+# to override the default setting.
+exclude:
+  - Gemfile
+  - Gemfile.lock
+  - node_modules
+  - update_boostrap.sh
+
+theme: jekyll-theme-minimal

docs/_data/members.csv

@@ -0,0 +1,4 @@
+name,github
+Eric Mill,konklone
+Parker Moore,parkr
+Liu Fengyun,liufengyun

docs/_data/pages.yml

@@ -0,0 +1,53 @@
+toc:
+  - title: Introduction
+    subfolderitems:
+      - page: Features
+        content: what do we mean by “Industrial Data Management System” ?
+        url: features
+      - page: Concepts
+        content: core entities for manipulating time series and chunks
+        url: concepts
+      - page: Architecture
+        content: all the building blocks of that framework
+        url: architecture
+      - page: Data Model
+        content: to dive deeper into the concepts and the object model.
+        url: data-model
+      - page: PromQL dialect
+        content: to interact with the data
+        url: promql
+      - page: REST api
+        content: query historian with http calls
+        url: api
+  - title: Tutorials
+    subfolderitems:
+      - page: Getting started
+        content: the first link to click if you want to play right now
+        url: tutorials/getting-started
+      - page: Big Data api with Spark
+        url: tutorials/spark-api
+        content: different ways to feed historian with data
+      - page: Timeseries clustering
+        url: tutorials/clustering
+        content: find anomalies with tie series clustering (keans over mllib)
+      - page: Data visualisation
+        url: tutorials/data-viz
+        content: how to use grafana to get visual insights
+     # - page: Alerting on prediction
+     #   url: data-prediction
+      #   content: how to generate grafana alerts based on predictions
+        # - page: Data mining with python
+        #   url: py-data-mining
+      #  content: let's play with pandas, scikit and other py toys
+  - title: Operational
+    subfolderitems:
+      - page: Run on kube
+        content: learn how to use Helm to easily deploy on Kubernetes
+        url: kube-setup
+    #  - page: Monitoring
+    #    content: how do we monitor our Smart Historian
+    #    url: monitoring
+      - page: Developer guide
+        content: everything about building, test and extending the framework
+        url: developer-guide
+