diff --git a/README.md b/README.md index 4f2c8a7b..d53dfb9e 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,16 @@ Simplified Monitoring and Management for ElasticSearch clusters. * Active project used by Fortune 100 companies around the world. * Free and (Real) Open Source. ;-) -## Installation +## Quickstart: Docker + +We are hosted on Dockerhub: [ElasticHQ on Dockerhub](https://hub.docker.com/r/elastichq/elasticsearch-hq/) + +1. ``docker run -p 5000:5000 elastichq/elasticsearch-hq`` +2. Access HQ with: `` http://localhost:5000 `` + +For further instructions on docker commands and configuration, please see relevant documentation: [Docker Images](http://docs.elastichq.org/installation.html#docker-images). + +## Source Installation ### Requirements @@ -44,15 +53,6 @@ For **full** installation and configuration instructions, see [Getting Started]( For further installation and configuration help, please read the docs: [ElasticHQ Documentation](http://docs.elastichq.org) -## Docker Installation - -We are hosted on Dockerhub: [ElasticHQ on Dockerhub](https://hub.docker.com/r/elastichq/elasticsearch-hq/) - -1. ``docker run -p 5000:5000 elastichq/elasticsearch-hq`` -2. Access HQ with: `` http://localhost:5000 `` - -For further instructions, please see relevant documentation: [Docker Images](http://docs.elastichq.org/installation.html#docker-images). - ## OpenShift Installation Please see relevant documentation: [ElasticHQ on OpenShift](openshift/README.md). diff --git a/docs/.buildinfo b/docs/.buildinfo index de623a26..843757ed 100644 --- a/docs/.buildinfo +++ b/docs/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 7941a7fdcaed6c9c9192da5b0438d143 +config: d95de450ee0c2c25942b746b3626a6b0 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/.doctrees/environment.pickle b/docs/.doctrees/environment.pickle index b554b675..f0fb7c8b 100644 Binary files a/docs/.doctrees/environment.pickle and b/docs/.doctrees/environment.pickle differ diff --git a/docs/.doctrees/index.doctree b/docs/.doctrees/index.doctree index e2af0196..95839178 100644 Binary files a/docs/.doctrees/index.doctree and b/docs/.doctrees/index.doctree differ diff --git a/docs/.doctrees/installation.doctree b/docs/.doctrees/installation.doctree index e4ea9531..a8d1c2dc 100644 Binary files a/docs/.doctrees/installation.doctree and b/docs/.doctrees/installation.doctree differ diff --git a/docs/.doctrees/rest-api.doctree b/docs/.doctrees/rest-api.doctree index 97cba0b2..4a8a8dcd 100644 Binary files a/docs/.doctrees/rest-api.doctree and b/docs/.doctrees/rest-api.doctree differ diff --git a/docs/_sources/index.txt b/docs/_sources/index.txt index 9cd1a7c9..24605632 100644 --- a/docs/_sources/index.txt +++ b/docs/_sources/index.txt @@ -4,7 +4,7 @@ ElasticHQ Documentation .. toctree:: - :includehidden: + :hidden: installation rest-api diff --git a/docs/_sources/installation.txt b/docs/_sources/installation.txt index 833b57b5..8c1ccfc2 100644 --- a/docs/_sources/installation.txt +++ b/docs/_sources/installation.txt @@ -3,23 +3,46 @@ Getting Started =============== .. contents:: Table of Contents - :depth: 3 + :depth: 2 :local: - - Quick-Start Guide ----------------- +1. :any:`docker images` +2. :any:`run from source` + +.. _docker images: + +Running with Docker +------------------- + +Docker images are offered on the `ElasticHQ Dockerhub `_. + +Run with: + +.. code-block:: bash + + docker run -p 5000:5000 elastichq/elasticsearch-hq + +Access HQ with: http://localhost:5000 + +When starting with Docker, see :any:`environment variables` for passing startup args. Environment variables are passed to docker using the `-e` flag. + +ie. ``-e HQ_DEFAULT_URL='http://aa.com:1212'`` + +.. note:: The ``latest`` tag deploys the latest stable release. Where ``develop`` is the latest unstable working branch. -Installation ------------- +.. _run from source: + +Install from Source +------------------- Requirements ^^^^^^^^^^^^ * Python 3.4+ -* Elasticsearch. Supported versions: 2.x, 5.x, 6.x +* Elasticsearch. Supported versions: 2.x, 5.x, 6.x, 7.x Install ElasticHQ ^^^^^^^^^^^^^^^^^ @@ -31,24 +54,6 @@ Install ElasticHQ .. note:: Alternatively, you can start the server with ``python manage.py runserver`` -.. _docker images: - -Docker Images -^^^^^^^^^^^^^ - -Docker images are offered on the `ElasticHQ Dockerhub `_. - -The ``latest`` tag deploys the latest stable release. Where ``develop`` is the latest unstable working branch. - -When starting with Docker, see :any:`environment variables` for passing startup args. Environment variables are passed to docker using the `-e` flag. - -ie. ``-e HQ_DEFAULT_URL='http://aa.com:1212'`` - -To run/install container: - -``docker run -p 5000:5000 elastichq/elasticsearch-hq`` - -Access HQ with: http://localhost:5000 Pre-Releases ^^^^^^^^^^^^ @@ -103,6 +108,15 @@ The ``application.py`` start script takes parameters passed in as arguments from ``--verify_certs`` True Whether HQ should attempt to validate certs. Set to False for self-signed certs. ================== ========================= ================================================================================ +Example: +======== + +.. code-block:: bash + + python -m application + --enable-ssl + --ca-certs /path/to/your/ca.crt + .. _environment variables: Environment Variables @@ -118,6 +132,14 @@ Environment Variables ``HQ_DEBUG`` False If True, enables debug level on logging. =================== ========================= ================================================================================ +Example: +======== + +.. code-block:: bash + + docker run -p 5000:5000 elastichq/elasticsearch-hq + -e HQ_DEFAULT_URL='http://aa.com:1212' + -e HQ_ENABLE_SSL=False Logging ^^^^^^^ diff --git a/docs/developer-guide.html b/docs/developer-guide.html index a05478ea..8b059eec 100644 --- a/docs/developer-guide.html +++ b/docs/developer-guide.html @@ -66,10 +66,8 @@

Navigation

diff --git a/docs/faq.html b/docs/faq.html index 7afee245..ec0962f9 100644 --- a/docs/faq.html +++ b/docs/faq.html @@ -62,10 +62,8 @@

Navigation

-
- -

Table Of Contents

@@ -87,7 +85,6 @@

Table Of Contents

-
+
diff --git a/docs/genindex.html b/docs/genindex.html index da4d1d76..dfe602a1 100644 --- a/docs/genindex.html +++ b/docs/genindex.html @@ -59,10 +59,8 @@

Navigation

-
- -

Table Of Contents

@@ -80,7 +78,6 @@

Table Of Contents

-
+
diff --git a/docs/http-routingtable.html b/docs/http-routingtable.html index daa30a48..9fcca6c1 100644 --- a/docs/http-routingtable.html +++ b/docs/http-routingtable.html @@ -65,10 +65,8 @@

Navigation

-
- -

Table Of Contents

@@ -86,7 +84,6 @@

Table Of Contents

-
+
diff --git a/docs/index.html b/docs/index.html index 5ddce2d7..e1d39b42 100644 --- a/docs/index.html +++ b/docs/index.html @@ -62,10 +62,8 @@

Navigation

-
- -

Table Of Contents

@@ -83,7 +81,6 @@

Table Of Contents

-
+
@@ -114,122 +112,6 @@

Table Of Contents

ElasticHQ Documentation

-

Overview

diff --git a/docs/installation.html b/docs/installation.html index 0d793105..f924f6a2 100644 --- a/docs/installation.html +++ b/docs/installation.html @@ -66,10 +66,8 @@

Navigation

+
+

Running with Docker

+

Docker images are offered on the ElasticHQ Dockerhub.

+

Run with:

+
docker run -p 5000:5000 elastichq/elasticsearch-hq
+
-
-

Installation

+

Access HQ with: http://localhost:5000

+

When starting with Docker, see Environment Variables for passing startup args. Environment variables are passed to docker using the -e flag.

+

ie. -e HQ_DEFAULT_URL='http://aa.com:1212'

+
+

Note

+

The latest tag deploys the latest stable release. Where develop is the latest unstable working branch.

+
+
+
+

Install from Source

-

Requirements

+

Requirements

  • Python 3.4+
    • -
  • Elasticsearch. Supported versions: 2.x, 5.x, 6.x
    • +
  • Elasticsearch. Supported versions: 2.x, 5.x, 6.x, 7.x
-

Install ElasticHQ

+

Install ElasticHQ

  1. Download or clone the repository https://github.com/ElasticHQ/elasticsearch-HQ
  2. Navigate to the root of the repository: pip install -r requirements.txt
    3. @@ -191,16 +234,6 @@

    Install ElasticHQAlternatively, you can start the server with python manage.py runserver

-
-

Docker Images

-

Docker images are offered on the ElasticHQ Dockerhub.

-

The latest tag deploys the latest stable release. Where develop is the latest unstable working branch.

-

When starting with Docker, see Environment Variables for passing startup args. Environment variables are passed to docker using the -e flag.

-

ie. -e HQ_DEFAULT_URL='http://aa.com:1212'

-

To run/install container:

-

docker run -p 5000:5000 elastichq/elasticsearch-hq

-

Access HQ with: http://localhost:5000

-

Pre-Releases

Pre-release versions are made available as branches in the github repository. We use GitFlow methodology and adhere to semantic versioning.

@@ -231,7 +264,7 @@

Initial Login

Configuration

-

Command line Parameters

+

Command line Parameters

The application.py start script takes parameters passed in as arguments from the command line:

@@ -278,9 +311,17 @@

Configuration

+
+

Example:

+
python -m application
+--enable-ssl
+--ca-certs /path/to/your/ca.crt
+
+
+
-

Environment Variables

+

Environment Variables

@@ -318,6 +359,14 @@

Configuration

+
+

Example:

+
docker run -p 5000:5000 elastichq/elasticsearch-hq
+-e HQ_DEFAULT_URL='http://aa.com:1212'
+-e HQ_ENABLE_SSL=False
+
+
+

Logging

@@ -409,7 +458,7 @@

Upgrading Minor and Patch versions

Running in Production

We advise that under any considerable usage/load, this application should be run with a multithreaded server. The current flask implementation by itself should not be run in production without this, as it is a single-threaded process.

-

We recommend running this WSGI application with gunicorn. The Docker container available on DockerHub is pre-configured to run with gunicorn, and is preferred. See the Docker Images

+

We recommend running this WSGI application with gunicorn. The Docker container available on DockerHub is pre-configured to run with gunicorn, and is preferred. See the Running with Docker

If you wish to run without a container, install gunicorn by either commenting out the line in the requirements.txt file or simply running pip install gunicorn

In console, run gunicorn with:

gunicorn -w 1 -b :5000 --worker-class eventlet application:application

diff --git a/docs/objects.inv b/docs/objects.inv index b4384e39..78bafd98 100644 Binary files a/docs/objects.inv and b/docs/objects.inv differ diff --git a/docs/rest-api.html b/docs/rest-api.html index bf88fff0..b5bfd79d 100644 --- a/docs/rest-api.html +++ b/docs/rest-api.html @@ -66,10 +66,8 @@

Navigation

@@ -182,6 +216,51 @@

REST APIConnection APIs

Connections

+
+
+DELETE /api/clusters/(string: cluster_name)/_connect
+
+ +
+
+DELETE /api/clusters/_connect
+

Deletes a connection from the connection pool and the database, by cluster name.

+ +++ + + + +
Note:This method does NOT delete your Elasticsearch Cluster, just the connection from HQ to it.
+

Example request:

+
DELETE /clusters/_connect/<CLUSTER_NAME> HTTP/1.1
+Accept: application/json
+
+
+ +++ + + + + + + + +
Parameters:
    +
  • cluster_name (string) – Name of cluster connection to remove.
    • +
+
Returns:

List of active clusters.

+
Status Codes: +
+
+
POST /api/clusters/(string: cluster_name)/_connect
@@ -280,51 +359,6 @@

Connections

-
-
-DELETE /api/clusters/(string: cluster_name)/_connect
-
- -
-
-DELETE /api/clusters/_connect
-

Deletes a connection from the connection pool and the database, by cluster name.

- --- - - - -
Note:This method does NOT delete your Elasticsearch Cluster, just the connection from HQ to it.
-

Example request:

-
DELETE /clusters/_connect/<CLUSTER_NAME> HTTP/1.1
-Accept: application/json
-
-
- --- - - - - - - - -
Parameters:
    -
  • cluster_name (string) – Name of cluster connection to remove.
    • -
-
Returns:

List of active clusters.

-
Status Codes: -
-
-
@@ -559,31 +593,6 @@

Nodes StatsIndex APIs

Indices

-
-
-GET /api/indices/(string: cluster_name)/(string: index_name)
-
- -
-
-GET /api/indices/(string: cluster_name)
-

Wrapper around https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-index.html

- --- - - - - - -
Parameters:
    -
  • cluster_name –
    • -
  • index_name –
    • -
-
Return:
-
-
POST /api/indices/(string: cluster_name)/(string: index_name)
@@ -658,6 +667,31 @@

Indices +
+GET /api/indices/(string: cluster_name)/(string: index_name)
+

+ +
+
+GET /api/indices/(string: cluster_name)
+

Wrapper around https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-index.html

+ +++ + + + + + +
Parameters:
    +
  • cluster_name –
    • +
  • index_name –
    • +
+
Return:
+
+

Indices Summary

@@ -783,20 +817,20 @@

Index Shards

Index Alias

-
-
-GET /api/indices/(string: cluster_name)/(string: index_name)/(string: alias_name)/_aliases
+
+
+DELETE /api/indices/(string: cluster_name)/(string: index_name)/(string: alias_name)/_aliases
-
-
-GET /api/indices/(string: cluster_name)/(string: index_name)/_aliases
+
+
+DELETE /api/indices/(string: cluster_name)/(string: index_name)/_aliases
-
-
-GET /api/indices/(string: cluster_name)/_aliases
-

Get all aliases for this index

+
+
+DELETE /api/indices/(string: cluster_name)/_aliases
+

Deletes an alias.

@@ -804,6 +838,7 @@

Index Alias

@@ -844,20 +879,20 @@

Index Alias -
-
-DELETE /api/indices/(string: cluster_name)/(string: index_name)/(string: alias_name)/_aliases
+
+
+GET /api/indices/(string: cluster_name)/(string: index_name)/(string: alias_name)/_aliases
-
-
-DELETE /api/indices/(string: cluster_name)/(string: index_name)/_aliases
+
+
+GET /api/indices/(string: cluster_name)/(string: index_name)/_aliases
-
-
-DELETE /api/indices/(string: cluster_name)/_aliases
-

Deletes an alias.

+
+
+GET /api/indices/(string: cluster_name)/_aliases
+

Get all aliases for this index

Parameters:
  • cluster_name –
  • index_name –
    • +
  • alias_name (string) – Alias to delete
@@ -865,7 +900,6 @@

Index Alias

diff --git a/docs/search.html b/docs/search.html index 31c20164..47e22005 100644 --- a/docs/search.html +++ b/docs/search.html @@ -66,10 +66,8 @@

Navigation

-
- -

Table Of Contents

@@ -87,7 +85,7 @@

Table Of Contents

- +
diff --git a/docs/searchindex.js b/docs/searchindex.js index c8a9abb2..17c51832 100644 --- a/docs/searchindex.js +++ b/docs/searchindex.js @@ -1 +1 @@ -Search.setIndex({envversion:50,filenames:["developer-guide","faq","index","installation","rest-api"],objects:{"":{"/api/clusters":[4,0,1,"get--api-clusters"],"/api/clusters/(string:cluster_name)/_connect":[4,2,1,"post--api-clusters-(string-cluster_name)-_connect"],"/api/clusters/(string:cluster_name)/_health":[4,0,1,"get--api-clusters-(string-cluster_name)-_health"],"/api/clusters/(string:cluster_name)/_state":[4,0,1,"get--api-clusters-(string-cluster_name)-_state"],"/api/clusters/(string:cluster_name)/_summary":[4,0,1,"get--api-clusters-(string-cluster_name)-_summary"],"/api/clusters/(string:cluster_name)/diagnostics/_summary":[4,0,1,"get--api-clusters-(string-cluster_name)-diagnostics-_summary"],"/api/clusters/_connect":[4,2,1,"post--api-clusters-_connect"],"/api/indices/(string:cluster_name)":[4,2,1,"post--api-indices-(string-cluster_name)"],"/api/indices/(string:cluster_name)/(string:index_name)":[4,2,1,"post--api-indices-(string-cluster_name)-(string-index_name)"],"/api/indices/(string:cluster_name)/(string:index_name)/(string:alias_name)/_aliases":[4,2,1,"post--api-indices-(string-cluster_name)-(string-index_name)-(string-alias_name)-_aliases"],"/api/indices/(string:cluster_name)/(string:index_name)/_aliases":[4,2,1,"post--api-indices-(string-cluster_name)-(string-index_name)-_aliases"],"/api/indices/(string:cluster_name)/(string:index_name)/_mapping":[4,0,1,"get--api-indices-(string-cluster_name)-(string-index_name)-_mapping"],"/api/indices/(string:cluster_name)/(string:index_name)/_mapping/(string:mapping_name)":[4,0,1,"get--api-indices-(string-cluster_name)-(string-index_name)-_mapping-(string-mapping_name)"],"/api/indices/(string:cluster_name)/(string:index_name)/action/(string:action)":[4,3,1,"put--api-indices-(string-cluster_name)-(string-index_name)-action-(string-action)"],"/api/indices/(string:cluster_name)/(string:index_names)/_shards":[4,0,1,"get--api-indices-(string-cluster_name)-(string-index_names)-_shards"],"/api/indices/(string:cluster_name)/(string:index_names)/_stats":[4,0,1,"get--api-indices-(string-cluster_name)-(string-index_names)-_stats"],"/api/indices/(string:cluster_name)/(string:index_names)/_summary":[4,0,1,"get--api-indices-(string-cluster_name)-(string-index_names)-_summary"],"/api/indices/(string:cluster_name)/_aliases":[4,2,1,"post--api-indices-(string-cluster_name)-_aliases"],"/api/indices/(string:cluster_name)/_reindex":[4,2,1,"post--api-indices-(string-cluster_name)-_reindex"],"/api/indices/(string:cluster_name)/_shards":[4,0,1,"get--api-indices-(string-cluster_name)-_shards"],"/api/indices/(string:cluster_name)/_stats":[4,0,1,"get--api-indices-(string-cluster_name)-_stats"],"/api/indices/(string:cluster_name)/_summary":[4,0,1,"get--api-indices-(string-cluster_name)-_summary"],"/api/indices/(string:cluster_name)/action/(string:action)":[4,3,1,"put--api-indices-(string-cluster_name)-action-(string-action)"],"/api/nodes/(string:cluster_name)/(string:node_ids)/_info":[4,0,1,"get--api-nodes-(string-cluster_name)-(string-node_ids)-_info"],"/api/nodes/(string:cluster_name)/(string:node_ids)/_stats":[4,0,1,"get--api-nodes-(string-cluster_name)-(string-node_ids)-_stats"],"/api/nodes/(string:cluster_name)/(string:node_ids)/_summary":[4,0,1,"get--api-nodes-(string-cluster_name)-(string-node_ids)-_summary"],"/api/nodes/(string:cluster_name)/_info":[4,0,1,"get--api-nodes-(string-cluster_name)-_info"],"/api/nodes/(string:cluster_name)/_stats":[4,0,1,"get--api-nodes-(string-cluster_name)-_stats"],"/api/nodes/(string:cluster_name)/_summary":[4,0,1,"get--api-nodes-(string-cluster_name)-_summary"],"/api/repositories/(string:cluster_name)":[4,0,1,"get--api-repositories-(string-cluster_name)"],"/api/rest/(string:cluster_name)/(string:command)":[4,0,1,"get--api-rest-(string-cluster_name)-(string-command)"],"/api/routes":[4,0,1,"get--api-routes"],"/api/snapshots/(string:cluster_name)/repository/(string:repository_name)":[4,0,1,"get--api-snapshots-(string-cluster_name)-repository-(string-repository_name)"],"/api/status":[4,0,1,"get--api-status"]}},objnames:{"0":["http","get","HTTP get"],"1":["http","delete","HTTP delete"],"2":["http","post","HTTP post"],"3":["http","put","HTTP put"]},objtypes:{"0":"http:get","1":"http:delete","2":"http:post","3":"http:put"},terms:{"boolean":4,"byte":[],"case":0,"class":3,"default":[0,3],"delete":[0,4],"final":0,"long":3,"new":[0,1,4],"null":4,"return":[0,4],"static":0,"true":[],"while":0,_alias:4,_cach:4,_close:4,_cluster:3,_connect:4,_expunge_delet:4,_flush:4,_force_merg:4,_health:4,_info:4,_map:4,_open:4,_optim:4,_refresh:4,_reindex:4,_shard:4,_sqlalchemy_database_uri:3,_stat:4,_state:4,_summari:4,about:[1,4],accept:[3,4],access:[0,1,2,3],accomplish:0,across:[],action:4,activ:4,active_primary_shard:4,active_shard:4,active_shards_percent_as_numb:4,actual:4,add:4,address:4,adher:3,adjust:3,admin:3,advanc:3,advis:3,again:0,against:[0,3],age:0,agre:3,alias:[2,4],alias_nam:4,all:[0,4],allow:[0,3],along:3,alreadi:4,also:4,alter:3,altern:3,alwai:3,ani:[0,2,3],any:3,apach:[2,3],api:[],appear:0,applic:[0,2,3,4],applicaiton:0,arg:3,argument:3,around:4,asked:1,assum:3,attempt:3,attent:0,auth:3,authent:[1,3],author:3,automat:0,avail:[2,3,4],awsaccesskeyid:[],bad:4,base:3,basepath:3,basic:3,basis:3,been:3,befor:0,below:0,between:3,bin:[],binari:[],blob:[],block:3,body:4,both:4,branch:[0,3],bring:0,broadcast:3,browser:3,bucket:[],built:0,bundl:0,bundleid:[],bundletask:[],bundletaskerror:[],cacert:[],cach:4,call:[3,4],can:[0,1,2,3,4],candid:3,caus:[0,3],ccelastichq:[],cert:[],certif:3,certificate_verify_failed:3,chang:[0,3],check:3,clean:3,click:2,clone:3,close:4,cluster:[],cluster_connect:4,cluster_health:4,cluster_host:4,cluster_ip:4,cluster_nam:4,cluster_name:4,cluster_port:4,cluster_schem:4,cluster_vers:4,code:[0,3,4],collect:4,com:3,come:3,comma:4,command:[],comment:3,commonli:2,commun:[3,4],complet:4,complianc:3,compos:0,condens:4,conditions:3,conf:3,config:3,confirm:3,connect:[],consider:3,consol:3,contain:[],control:[0,3],copi:[3,4],copyright:3,cover:[],coverag:0,creat:[0,4],credenti:[0,3],crt:3,curl:3,current:[3,4],current_stable_vers:4,custom:0,cycl:0,dai:3,data:[3,4],date:0,datetim:[],db_name:3,debug:[],definit:3,delayed_unassigned_shard:4,delet:[3,4],delimit:4,deploi:3,depth:[],destin:4,destination_index:4,destination_index_nam:4,detach:3,detail:4,dev:[],dict:4,did:3,differ:0,direct:2,directli:[1,3,4],directori:[],directory:3,disabl:3,disk:4,displai:3,doc:[0,3,4],dockerhub:[],doe:4,doesn:4,domain:3,down:0,download:3,easi:3,easier:0,edit:[],effect:0,either:[3,4],elast:[3,4],elastichq:[],elasticsearch:[0,2,3,4],enabl:3,end:0,endpoint:[2,4],enough:3,enter:3,entir:0,entri:1,environ:[],error:[],es_v2:4,esv:0,etc:3,even:4,event:[0,3],eventlet:3,everyth:3,evil:3,exampl:4,except:3,exec:3,execut:4,exist:4,expect:3,expir:3,expirat:3,expos:3,express:3,fail:3,failur:3,fals:[3,4],featur:[],feel:1,field:3,file:[0,3],find:3,first:0,fix:0,flag:3,flask:[0,3,4],flush:4,follow:3,foo:[],footer:3,forc:4,form:[0,3],format:[0,3],formerli:4,forum:[1,2],found:[3,4],free:1,freeli:2,frequent:1,from:4,further:3,futur:3,gener:[0,4],get:[],gitflow:3,github:[0,1,3,4],given:4,gmt:0,govern:3,guarante:0,guidelin:0,gunicorn:3,handler:[],happen:3,hasn:3,have:[0,1,3],help:1,here:3,homepag:2,host:[3,4],hq_ca_certs:3,hq_debug:3,hq_default_url:3,hq_enable_ssl:3,hq_verify_certs:3,html:[0,4],htmlcov:0,htmlout11:[],htmlout:0,https:4,imag:3,immedi:0,implemen:[],implement:3,impli:3,includ:[0,2],index:[],index_nam:4,indic:[2,4],individu:0,info:[],inform:[3,4],informat:3,initi:3,initializing_shard:4,input:3,instal:[0,3],installed_vers:4,instanc:3,instanceid:[],instruct:1,integr:[0,3],integrat:[],interfac:4,internal:4,issu:3,itself:3,jan:0,join:3,json:[0,3,4],just:4,kept:3,kill_es_vers:0,kind:3,known:4,languag:3,larg:4,law:3,left:[],length:0,level:3,librari:0,licens:[],license:3,like:3,limit:3,line:[],list:[],load:3,local:0,localhost:[0,1,3,4],locat:3,logfil:3,logger:3,made:3,mai:[3,4],major:[0,3],major_version:0,manag:[0,2,3],mani:[2,4],manual:[],mapping_nam:4,mapping_onli:4,master:[3,4],match:3,max:0,merg:4,messag:4,meta:3,method:[0,4],methodolog:3,metric:3,millisecond:0,modifi:[],monitor:2,most:3,multithread:3,must:3,name:[0,3,4],navig:[0,3],necessari:3,need:0,net:3,network:3,next:3,node:[],node_id:4,normal:0,npm:0,number:3,number_of_data_nod:4,number_of_in_flight_fetch:4,number_of_nod:4,number_of_pending_task:4,number_of_replica:4,number_of_shard:4,obtain:3,offer:3,onc:0,once:0,one:[2,4],onli:4,open:4,option:[3,4],options:0,org:[3,4],organ:3,origin:[0,3],other:[],otherwis:4,our:3,out:[3,4],output:[0,3],over:3,pack:[],param:[],pass:[3,4],password:3,patch:[],path:[0,3],payload:4,pend:[],perform:0,permiss:3,ping:4,pip:[0,3],plain:3,platform:2,pleas:0,pocoo:4,point:3,pool:4,port:[0,3,4],possibl:4,post:[0,4],prefer:[0,3],prefix:[],preserv:[],pretti:3,prioriti:0,process:3,progress:[],project:[],proper:3,prune:0,pull:4,purchas:3,put:[0,4],pytest:0,python3:3,python:[0,3],question:[1,3],reach:3,reachabl:3,read:[0,3],readme:[],realiz:3,reason:[0,3],receiv:0,recommend:3,reconnect:3,recreat:3,refer:[],refresh:[0,4],reindex_opt:4,reload:3,relocating_shard:4,rememb:[],remov:[],repo:0,report:0,repositori:[],repository_nam:4,request:[0,4],requir:[],respect:[],response_tim:4,rest:[],retriev:3,right:[],roadmap:2,roi:3,root:[0,3],royrusso:[],rule:4,run_es_vers:0,run_test:[],runserv:3,russo:3,same:[2,3],save:[2,4],scheme:3,screen:3,script:[0,3],sdsd:[],searchabl:4,section:3,secur:3,sed:3,see:[1,3],segment:4,self:3,semant:3,separ:0,serv:[0,2],server:[0,3,4],set:[],sever:[3,4],shard:[],ship:3,should:[0,3],shutdown:[],sign:3,signer:3,silent:3,simpli:[3,4],sinc:2,singl:3,site:0,slate:3,snippet:4,softwar:[2,3],some:3,sourc:[0,3,4],source_index:4,source_index_nam:4,specif:[0,3],specifi:3,sphinx:0,sqlalchemy_database_uri:3,sqlite:3,sqllite:3,src:3,ssl:[],stabl:3,standard:[0,3],standard_handl:[],start:[],start_clust:[],starttim:[],status_cod:4,still:0,stop:0,storag:[],store:3,string:4,success:4,suggest:1,suit:0,supervisor:3,supervisord:3,support:3,tag:[],take:[0,3],taken:4,task_max_waiting_in_queue_milli:4,templat:0,termin:3,text:3,thank:3,thei:[],them:0,thi:[0,1,3,4],those:3,thread:3,through:0,thru:4,time:[0,2,3,4],timed_out:4,todo:[],took:0,trigger:4,trust:3,txt:[0,3],type:[0,4],typic:0,unassigned_shard:4,under:[0,1,2,3],uninstal:3,unless:3,unstabl:[0,3],until:0,updatetim:[],upgrad:3,uploadpolici:[],uploadpolicysignatur:[],url:[3,4],usag:3,use_ssl:4,user:[],usernam:3,username:3,v5_docker:[],valid:3,validate_cert:3,valu:3,vari:4,veri:0,verif:3,verifi:3,verify_cert:3,version:[],via:[3,4],view:[],virtual:[],volum:3,wait:[],want:3,warn:[],warning:4,warranties:3,websit:3,websocket:3,wed:0,welcom:0,well:3,werkzeug:0,when:[3,4],where:3,whether:[3,4],which:0,window:3,wish:[0,3],within:3,without:3,work:[],worker:3,working:3,wrapper:4,write:[3,4],wsgi:3,www:[3,4],xget:3,yellow:4,yml:[],you:[0,1,3,4],your:[3,4]},titles:["For Developers","FAQ","ElasticHQ Documentation","Getting Started","REST API"],titleterms:{"true":0,across:3,alia:4,api:4,bug:0,build:0,cert:3,cluster:4,command:[3,4],configur:3,connect:[3,4],contain:3,content:[0,1,3,4],contribut:0,dashboard:[],databas:3,debug:0,develop:0,diagnos:3,diagnost:4,directori:[],distribut:0,docker:3,dockerhub:0,document:[0,2],elastichq:[1,2,3],environ:[0,3],error:3,external:3,faq:1,featur:2,from:0,get:3,guid:3,header:0,health:4,how:1,http:0,image:3,index:4,indice:4,info:4,initial:3,install:[0,3],installat:3,integrat:3,issue:0,kei:2,latest:3,licens:3,line:3,list:4,log:3,login:3,main:[],manual:0,map:4,minor:3,node:4,note:0,openshift:3,other:[],overview:2,pack:3,paramet:3,patch:3,pre:[0,3],preserv:3,product:3,project:2,pull:0,quick:3,refer:[],reindex:4,releas:[0,3],remov:[],repositori:4,requir:3,resourc:[],respons:0,rest:4,restart:3,rout:4,run:[0,3],set:0,shard:4,snapshot:4,ssl:3,start:3,startup:[],stat:4,state:4,statu:[0,4],structur:[],summari:4,tabl:[0,1,3,4],tag:0,test:0,troubleshoot:3,upgrade:3,user:[],using:1,variabl:3,version:3,view:3,work:3}}) \ No newline at end of file +Search.setIndex({envversion:50,filenames:["developer-guide","faq","index","installation","rest-api"],objects:{"":{"/api/clusters":[4,0,1,"get--api-clusters"],"/api/clusters/(string:cluster_name)/_connect":[4,2,1,"post--api-clusters-(string-cluster_name)-_connect"],"/api/clusters/(string:cluster_name)/_health":[4,0,1,"get--api-clusters-(string-cluster_name)-_health"],"/api/clusters/(string:cluster_name)/_state":[4,0,1,"get--api-clusters-(string-cluster_name)-_state"],"/api/clusters/(string:cluster_name)/_summary":[4,0,1,"get--api-clusters-(string-cluster_name)-_summary"],"/api/clusters/(string:cluster_name)/diagnostics/_summary":[4,0,1,"get--api-clusters-(string-cluster_name)-diagnostics-_summary"],"/api/clusters/_connect":[4,2,1,"post--api-clusters-_connect"],"/api/indices/(string:cluster_name)":[4,2,1,"post--api-indices-(string-cluster_name)"],"/api/indices/(string:cluster_name)/(string:index_name)":[4,2,1,"post--api-indices-(string-cluster_name)-(string-index_name)"],"/api/indices/(string:cluster_name)/(string:index_name)/(string:alias_name)/_aliases":[4,2,1,"post--api-indices-(string-cluster_name)-(string-index_name)-(string-alias_name)-_aliases"],"/api/indices/(string:cluster_name)/(string:index_name)/_aliases":[4,2,1,"post--api-indices-(string-cluster_name)-(string-index_name)-_aliases"],"/api/indices/(string:cluster_name)/(string:index_name)/_mapping":[4,0,1,"get--api-indices-(string-cluster_name)-(string-index_name)-_mapping"],"/api/indices/(string:cluster_name)/(string:index_name)/_mapping/(string:mapping_name)":[4,0,1,"get--api-indices-(string-cluster_name)-(string-index_name)-_mapping-(string-mapping_name)"],"/api/indices/(string:cluster_name)/(string:index_name)/action/(string:action)":[4,3,1,"put--api-indices-(string-cluster_name)-(string-index_name)-action-(string-action)"],"/api/indices/(string:cluster_name)/(string:index_names)/_shards":[4,0,1,"get--api-indices-(string-cluster_name)-(string-index_names)-_shards"],"/api/indices/(string:cluster_name)/(string:index_names)/_stats":[4,0,1,"get--api-indices-(string-cluster_name)-(string-index_names)-_stats"],"/api/indices/(string:cluster_name)/(string:index_names)/_summary":[4,0,1,"get--api-indices-(string-cluster_name)-(string-index_names)-_summary"],"/api/indices/(string:cluster_name)/_aliases":[4,2,1,"post--api-indices-(string-cluster_name)-_aliases"],"/api/indices/(string:cluster_name)/_reindex":[4,2,1,"post--api-indices-(string-cluster_name)-_reindex"],"/api/indices/(string:cluster_name)/_shards":[4,0,1,"get--api-indices-(string-cluster_name)-_shards"],"/api/indices/(string:cluster_name)/_stats":[4,0,1,"get--api-indices-(string-cluster_name)-_stats"],"/api/indices/(string:cluster_name)/_summary":[4,0,1,"get--api-indices-(string-cluster_name)-_summary"],"/api/indices/(string:cluster_name)/action/(string:action)":[4,3,1,"put--api-indices-(string-cluster_name)-action-(string-action)"],"/api/nodes/(string:cluster_name)/(string:node_ids)/_info":[4,0,1,"get--api-nodes-(string-cluster_name)-(string-node_ids)-_info"],"/api/nodes/(string:cluster_name)/(string:node_ids)/_stats":[4,0,1,"get--api-nodes-(string-cluster_name)-(string-node_ids)-_stats"],"/api/nodes/(string:cluster_name)/(string:node_ids)/_summary":[4,0,1,"get--api-nodes-(string-cluster_name)-(string-node_ids)-_summary"],"/api/nodes/(string:cluster_name)/_info":[4,0,1,"get--api-nodes-(string-cluster_name)-_info"],"/api/nodes/(string:cluster_name)/_stats":[4,0,1,"get--api-nodes-(string-cluster_name)-_stats"],"/api/nodes/(string:cluster_name)/_summary":[4,0,1,"get--api-nodes-(string-cluster_name)-_summary"],"/api/repositories/(string:cluster_name)":[4,0,1,"get--api-repositories-(string-cluster_name)"],"/api/rest/(string:cluster_name)/(string:command)":[4,0,1,"get--api-rest-(string-cluster_name)-(string-command)"],"/api/routes":[4,0,1,"get--api-routes"],"/api/snapshots/(string:cluster_name)/repository/(string:repository_name)":[4,0,1,"get--api-snapshots-(string-cluster_name)-repository-(string-repository_name)"],"/api/status":[4,0,1,"get--api-status"]}},objnames:{"0":["http","get","HTTP get"],"1":["http","delete","HTTP delete"],"2":["http","post","HTTP post"],"3":["http","put","HTTP put"]},objtypes:{"0":"http:get","1":"http:delete","2":"http:post","3":"http:put"},terms:{"boolean":4,"byte":[],"case":0,"class":3,"default":[0,3],"delete":[0,4],"final":0,"long":3,"new":[0,1,4],"null":4,"return":[0,4],"static":0,"true":[],"while":0,_alias:4,_cach:4,_close:4,_cluster:3,_connect:4,_expunge_delet:4,_flush:4,_force_merg:4,_health:4,_info:4,_map:4,_open:4,_optim:4,_refresh:4,_reindex:4,_shard:4,_sqlalchemy_database_uri:3,_stat:4,_state:4,_summari:4,about:[1,4],accept:[3,4],access:[0,1,2,3],accomplish:0,across:[],action:4,activ:4,active_primary_shard:4,active_shard:4,active_shards_percent_as_numb:4,actual:4,add:4,address:4,adher:3,adjust:3,admin:3,advanc:3,advis:3,again:0,against:[0,3],age:0,agre:3,alias:[2,4],alias_nam:4,all:[0,4],allow:[0,3],along:3,alreadi:4,also:4,alter:3,altern:3,alwai:3,ani:[0,2,3],any:3,apach:[2,3],api:[],appear:0,applic:[0,2,3,4],applicaiton:0,arg:3,argument:3,around:4,asked:1,assum:3,attempt:3,attent:0,auth:3,authent:[1,3],author:3,automat:0,avail:[2,3,4],awsaccesskeyid:[],bad:4,base:3,basepath:3,basic:3,basis:3,been:3,befor:0,below:0,between:3,bin:[],binari:[],blob:[],block:3,body:4,both:4,branch:[0,3],bring:0,broadcast:3,browser:3,bucket:[],built:0,bundl:0,bundleid:[],bundletask:[],bundletaskerror:[],cacert:[],cach:4,call:[3,4],can:[0,1,2,3,4],candid:3,caus:[0,3],ccelastichq:[],cert:[],certif:3,certificate_verify_failed:3,chang:[0,3],check:3,clean:3,click:2,clone:3,close:4,cluster:[],cluster_connect:4,cluster_health:4,cluster_host:4,cluster_ip:4,cluster_nam:4,cluster_name:4,cluster_port:4,cluster_schem:4,cluster_vers:4,code:[0,3,4],collect:4,com:3,come:3,comma:4,command:[],comment:3,commonli:2,commun:[3,4],complet:4,complianc:3,compos:0,condens:4,conditions:3,conf:3,config:3,confirm:3,connect:[],consider:3,consol:3,contain:[],control:[0,3],copi:[3,4],copyright:3,cover:[],coverag:0,creat:[0,4],credenti:[0,3],crt:3,curl:3,current:[3,4],current_stable_vers:4,custom:0,cycl:0,dai:3,data:[3,4],date:0,datetim:[],db_name:3,debug:[],definit:3,delayed_unassigned_shard:4,delet:[3,4],delimit:4,deploi:3,depth:[],destin:4,destination_index:4,destination_index_nam:4,detach:3,detail:4,dev:[],dict:4,did:3,differ:0,direct:2,directli:[1,3,4],directori:[],directory:3,disabl:3,disk:4,displai:3,doc:[0,3,4],dockerhub:[],doe:4,doesn:4,domain:3,down:0,download:3,easi:3,easier:0,edit:[],effect:0,either:[3,4],elast:[3,4],elastichq:[],elasticsearch:[0,2,3,4],enabl:3,end:0,endpoint:[2,4],enough:3,enter:3,entir:0,entri:1,environ:[],error:[],es_v2:4,esv:0,etc:3,even:4,event:[0,3],eventlet:3,everyth:3,evil:3,exampl:[],except:3,exec:3,execut:4,exist:4,expect:3,expir:3,expirat:3,expos:3,express:3,fail:3,failur:3,fals:[3,4],featur:[],feel:1,field:3,file:[0,3],find:3,first:0,fix:0,flag:3,flask:[0,3,4],flush:4,follow:3,foo:[],footer:3,forc:4,form:[0,3],format:[0,3],formerli:4,forum:[1,2],found:[3,4],free:1,freeli:2,frequent:1,from:[],further:3,futur:3,gener:[0,4],get:[],gitflow:3,github:[0,1,3,4],given:4,gmt:0,govern:3,guarante:0,guidelin:0,gunicorn:3,handler:[],happen:3,hasn:3,have:[0,1,3],help:1,here:3,homepag:2,host:[3,4],hq_ca_certs:3,hq_debug:3,hq_default_url:3,hq_enable_ssl:3,hq_verify_certs:3,html:[0,4],htmlcov:0,htmlout11:[],htmlout:0,https:4,imag:3,immedi:0,implemen:[],implement:3,impli:3,includ:[0,2],index:[],index_nam:4,indic:[2,4],individu:0,info:[],inform:[3,4],informat:3,initi:3,initializing_shard:4,input:3,instal:[0,3],installed_vers:4,instanc:3,instanceid:[],instruct:1,integr:[0,3],integrat:[],interfac:4,internal:4,issu:3,itself:3,jan:0,join:3,json:[0,3,4],just:4,kept:3,kill_es_vers:0,kind:3,known:4,languag:3,larg:4,law:3,left:[],length:0,level:3,librari:0,licens:[],license:3,like:3,limit:3,line:[],list:[],load:3,local:0,localhost:[0,1,3,4],locat:3,logfil:3,logger:3,made:3,mai:[3,4],major:[0,3],major_version:0,manag:[0,2,3],mani:[2,4],manual:[],mapping_nam:4,mapping_onli:4,master:[3,4],match:3,max:0,merg:4,messag:4,meta:3,method:[0,4],methodolog:3,metric:3,millisecond:0,modifi:[],monitor:2,most:3,multithread:3,must:3,name:[0,3,4],navig:[0,3],necessari:3,need:0,net:3,network:3,next:3,node:[],node_id:4,normal:0,npm:0,number:3,number_of_data_nod:4,number_of_in_flight_fetch:4,number_of_nod:4,number_of_pending_task:4,number_of_replica:4,number_of_shard:4,obtain:3,offer:3,onc:0,once:0,one:[2,4],onli:4,open:4,option:[3,4],options:0,org:[3,4],organ:3,origin:[0,3],other:[],otherwis:4,our:3,out:[3,4],output:[0,3],over:3,pack:[],param:[],pass:[3,4],password:3,patch:[],path:[0,3],payload:4,pend:[],perform:0,permiss:3,ping:4,pip:[0,3],plain:3,platform:2,pleas:0,pocoo:4,point:3,pool:4,port:[0,3,4],possibl:4,post:[0,4],prefer:[0,3],prefix:[],preserv:[],pretti:3,prioriti:0,process:3,progress:[],project:[],proper:3,prune:0,pull:[],purchas:3,put:[0,4],pytest:0,python3:3,python:[0,3],question:[1,3],reach:3,reachabl:3,read:[0,3],readme:[],realiz:3,reason:[0,3],receiv:0,recommend:3,reconnect:3,recreat:3,refer:[],refresh:[0,4],reindex_opt:4,reload:3,relocating_shard:4,rememb:[],remov:[],repo:0,report:0,repositori:[],repository_nam:4,request:[0,4],requir:[],respect:[],response_tim:4,rest:[],retriev:3,right:[],roadmap:2,roi:3,root:[0,3],royrusso:[],rule:4,run_es_vers:0,run_test:[],runserv:3,russo:3,same:[2,3],save:[2,4],scheme:3,screen:3,script:[0,3],sdsd:[],searchabl:4,section:3,secur:3,sed:3,see:[1,3],segment:4,self:3,semant:3,separ:0,serv:[0,2],server:[0,3,4],set:[],sever:[3,4],shard:[],ship:3,should:[0,3],shutdown:[],sign:3,signer:3,silent:3,simpli:[3,4],sinc:2,singl:3,site:0,slate:3,snippet:4,softwar:[2,3],some:3,sourc:[],source_index:4,source_index_nam:4,specif:[0,3],specifi:3,sphinx:0,sqlalchemy_database_uri:3,sqlite:3,sqllite:3,src:3,ssl:[],stabl:3,standard:[0,3],standard_handl:[],start:[],start_clust:[],starttim:[],status_cod:4,still:0,stop:0,storag:[],store:3,string:4,success:4,suggest:1,suit:0,supervisor:3,supervisord:3,support:3,tag:[],take:[0,3],taken:4,task_max_waiting_in_queue_milli:4,templat:0,termin:3,text:3,thank:3,thei:[],them:0,thi:[0,1,3,4],those:3,thread:3,through:0,thru:4,time:[0,2,3,4],timed_out:4,todo:[],took:0,trigger:4,trust:3,txt:[0,3],type:[0,4],typic:0,unassigned_shard:4,under:[0,1,2,3],uninstal:3,unless:3,unstabl:[0,3],until:0,updatetim:[],upgrad:3,uploadpolici:[],uploadpolicysignatur:[],url:[3,4],usag:3,use_ssl:4,user:[],usernam:3,username:3,v5_docker:[],valid:3,validate_cert:3,valu:3,vari:4,veri:0,verif:3,verifi:3,verify_cert:3,version:[],via:[3,4],view:[],virtual:[],volum:3,wait:[],want:3,warn:[],warning:4,warranties:3,websit:3,websocket:3,wed:0,welcom:0,well:3,werkzeug:0,when:[3,4],where:3,whether:[3,4],which:0,window:3,wish:[0,3],within:3,without:3,work:[],worker:3,working:3,wrapper:4,write:[3,4],wsgi:3,www:[3,4],xget:3,yellow:4,yml:[],you:[0,1,3,4],your:[3,4]},titles:["For Developers","FAQ","ElasticHQ Documentation","Getting Started","REST API"],titleterms:{"true":0,across:3,alia:4,api:4,bug:0,build:0,cert:3,cluster:4,command:[3,4],configur:3,connect:[3,4],contain:3,content:[0,1,3,4],contribut:0,dashboard:[],databas:3,debug:0,develop:0,diagnos:3,diagnost:4,directori:[],distribut:0,docker:3,dockerhub:0,document:[0,2],elastichq:[1,2,3],environ:[0,3],error:3,exampl:3,external:3,faq:1,featur:2,from:[0,3],get:3,guid:3,header:0,health:4,how:1,http:0,image:[],index:4,indice:4,info:4,initial:3,install:[0,3],installat:[],integrat:3,issue:0,kei:2,latest:3,licens:3,line:3,list:4,log:3,login:3,main:[],manual:0,map:4,minor:3,node:4,note:0,openshift:3,other:[],overview:2,pack:3,paramet:3,patch:3,pre:[0,3],preserv:3,product:3,project:2,pull:0,quick:3,refer:[],reindex:4,releas:[0,3],remov:[],repositori:4,requir:3,resourc:[],respons:0,rest:4,restart:3,rout:4,run:[0,3],set:0,shard:4,snapshot:4,sourc:3,ssl:3,start:3,startup:[],stat:4,state:4,statu:[0,4],structur:[],summari:4,tabl:[0,1,3,4],tag:0,test:0,troubleshoot:3,upgrade:3,user:[],using:1,variabl:3,version:3,view:3,work:3}}) \ No newline at end of file diff --git a/docs/source/_templates/globaltoc.html b/docs/source/_templates/globaltoc.html new file mode 100644 index 00000000..b908e355 --- /dev/null +++ b/docs/source/_templates/globaltoc.html @@ -0,0 +1,14 @@ + +
+
+

{{ _('Table Of Contents') }}

+
+
+ {% set toctree = toctree(maxdepth=3, collapse=True, includehidden=True) %} + {% if toctree %} + {{ toctree }} + {% else %} + {{ toc }} + {% endif %} +
+
diff --git a/docs/source/conf.py b/docs/source/conf.py index bd99b45c..ec1c4757 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -1,18 +1,19 @@ -import sys import os +import sys # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. sys.path.insert(0, os.path.abspath(".")) -print(os.path.split(os.path.split(os.path.split(os.path.realpath(__file__))[0])[0])[0]+os.sep+'') -sys.path.insert(0, os.path.split(os.path.split(os.path.split(os.path.realpath(__file__))[0])[0])[0]+os.sep+'') -sys.path.insert(0, os.path.split(os.path.split(os.path.split(os.path.realpath(__file__))[0])[0])[0]+os.sep+'elastichq') +print(os.path.split(os.path.split(os.path.split(os.path.realpath(__file__))[0])[0])[0] + os.sep + '') +sys.path.insert(0, os.path.split(os.path.split(os.path.split(os.path.realpath(__file__))[0])[0])[0] + os.sep + '') +sys.path.insert(0, + os.path.split(os.path.split(os.path.split(os.path.realpath(__file__))[0])[0])[0] + os.sep + 'elastichq') # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. -#needs_sphinx = '1.0' +# needs_sphinx = '1.0' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom @@ -24,11 +25,11 @@ 'sphinxcontrib.httpdomain', 'sphinxcontrib.autohttp.flask', 'sphinxcontrib.autohttp.flaskqref' - #'sphinxcontrib.fulltoc' + # 'sphinxcontrib.fulltoc' ] # http://sphinxcontrib-httpdomain.readthedocs.io/en/stable/#module-sphinxcontrib.httpdomain - + # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -36,7 +37,7 @@ source_suffix = '.rst' # The encoding of source files. -#source_encoding = 'utf-8-sig' +# source_encoding = 'utf-8-sig' # The master toctree document. master_doc = 'index' @@ -44,7 +45,7 @@ # General information about the project. project = 'ElasticHQ' copyright = '2018, ElasticHQ' -author= 'Roy Russo' +author = 'Roy Russo' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -61,9 +62,9 @@ # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: -#today = '' +# today = '' # Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' +# today_fmt = '%B %d, %Y' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. @@ -71,7 +72,7 @@ # The reST default role (used for this markup: `text`) to use for all # documents. -#default_role = None +# default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. add_function_parentheses = True @@ -88,10 +89,10 @@ pygments_style = 'sphinx' # A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] +# modindex_common_prefix = [] # If true, keep warnings as "system message" paragraphs in the built documents. -#keep_warnings = False +# keep_warnings = False # -- Options for HTML output ---------------------------------------------- @@ -100,9 +101,6 @@ # otherwise, readthedocs.org uses their theme by default, so no need to specify it import guzzle_sphinx_theme -# Register the theme as an extension to generate a sitemap.xml -extensions.append("guzzle_sphinx_theme") - # Guzzle theme options (see theme.conf for more information) html_theme_path = guzzle_sphinx_theme.html_theme_path() html_theme = 'guzzle_sphinx_theme' @@ -114,29 +112,29 @@ html_theme_options = { # Set the path to a special layout to include for the homepage - #"index_template": "special_index.html", + # "index_template": "special_index.html", # Set the name of the project to appear in the left sidebar. "project_nav_name": "ElasticHQ", # Set your Disqus short name to enable comments - #"disqus_comments_shortname": "my_disqus_comments_short_name", + # "disqus_comments_shortname": "my_disqus_comments_short_name", # Set you GA account ID to enable tracking "google_analytics_account": "UA-40876494-1", # Path to a touch icon - #"touch_icon": "", + # "touch_icon": "", # Specify a base_url used to generate sitemap.xml links. If not # specified, then no sitemap will be built. "base_url": "", # Allow a separate homepage from the master_doc - #"homepage": "index", + # "homepage": "index", # Allow the project link to be overriden to a custom URL. - #"projectlink": "http://myproject.url", + # "projectlink": "http://myproject.url", } # on_rtd = os.environ.get('READTHEDOCS', None) == 'True' @@ -147,31 +145,31 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -#html_theme = 'sphinx_rtd_theme' +# html_theme = 'sphinx_rtd_theme' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. -#html_theme_options = {} +# html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] +# html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". -#html_title = None +# html_title = None # A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None +# html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. -#html_logo = None +# html_logo = None # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. -#html_favicon = None +# html_favicon = None # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, @@ -181,93 +179,95 @@ # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied # directly to the root of the documentation. -#html_extra_path = [] +# html_extra_path = [] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' +# html_last_updated_fmt = '%b %d, %Y' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. -#html_use_smartypants = True +# html_use_smartypants = True # Custom sidebar templates, maps document names to template names. -#html_sidebars = {} +# html_sidebars = {} +html_sidebars = { + '**': ['logo-text.html', 'globaltoc.html', 'searchbox.html'] +} # Additional templates that should be rendered to pages, maps page names to # template names. -#html_additional_pages = {} +# html_additional_pages = {} # If false, no module index is generated. -#html_domain_indices = True +# html_domain_indices = True # If false, no index is generated. -#html_use_index = True +# html_use_index = True # If true, the index is split into individual pages for each letter. -#html_split_index = False +# html_split_index = False # If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True +# html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True +# html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True +# html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. -#html_use_opensearch = '' +# html_use_opensearch = '' # This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None +# html_file_suffix = None # Output file base name for HTML help builder. htmlhelp_basename = 'elastichq' - # -- Options for LaTeX output --------------------------------------------- latex_elements = { -# The paper size ('letterpaper' or 'a4paper'). -#'papersize': 'letterpaper', + # The paper size ('letterpaper' or 'a4paper'). + # 'papersize': 'letterpaper', -# The font size ('10pt', '11pt' or '12pt'). -#'pointsize': '10pt', + # The font size ('10pt', '11pt' or '12pt'). + # 'pointsize': '10pt', -# Additional stuff for the LaTeX preamble. -#'preamble': '', + # Additional stuff for the LaTeX preamble. + # 'preamble': '', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - ('index', 'elastichq.tex', 'ElasticHQ Documentation', - 'Roy Russo', 'manual'), + ('index', 'elastichq.tex', 'ElasticHQ Documentation', + 'Roy Russo', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of # the title page. -#latex_logo = None +# latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. -#latex_use_parts = False +# latex_use_parts = False # If true, show page references after internal links. -#latex_show_pagerefs = False +# latex_show_pagerefs = False # If true, show URL addresses after external links. -#latex_show_urls = False +# latex_show_urls = False # Documents to append as an appendix to all manuals. -#latex_appendices = [] +# latex_appendices = [] # If false, no module index is generated. -#latex_domain_indices = True +# latex_domain_indices = True # -- Options for manual page output --------------------------------------- @@ -280,7 +280,7 @@ ] # If true, show URL addresses after external links. -#man_show_urls = False +# man_show_urls = False # -- Options for Texinfo output ------------------------------------------- @@ -289,19 +289,19 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - ('index', 'elastichq', 'ElasticHQ Documentation', - 'Roy Russo', 'elastichq', 'Managament and monitoring for Elasticsearch clusters', - 'Miscellaneous'), + ('index', 'elastichq', 'ElasticHQ Documentation', + 'Roy Russo', 'elastichq', 'Managament and monitoring for Elasticsearch clusters', + 'Miscellaneous'), ] # Documents to append as an appendix to all manuals. -#texinfo_appendices = [] +# texinfo_appendices = [] # If false, no module index is generated. -#texinfo_domain_indices = True +# texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. -#texinfo_show_urls = 'footnote' +# texinfo_show_urls = 'footnote' # If true, do not generate a @detailmenu in the "Top" node's menu. -#texinfo_no_detailmenu = False +# texinfo_no_detailmenu = False diff --git a/docs/source/installation.rst b/docs/source/installation.rst index 833b57b5..8c1ccfc2 100644 --- a/docs/source/installation.rst +++ b/docs/source/installation.rst @@ -3,23 +3,46 @@ Getting Started =============== .. contents:: Table of Contents - :depth: 3 + :depth: 2 :local: - - Quick-Start Guide ----------------- +1. :any:`docker images` +2. :any:`run from source` + +.. _docker images: + +Running with Docker +------------------- + +Docker images are offered on the `ElasticHQ Dockerhub `_. + +Run with: + +.. code-block:: bash + + docker run -p 5000:5000 elastichq/elasticsearch-hq + +Access HQ with: http://localhost:5000 + +When starting with Docker, see :any:`environment variables` for passing startup args. Environment variables are passed to docker using the `-e` flag. + +ie. ``-e HQ_DEFAULT_URL='http://aa.com:1212'`` + +.. note:: The ``latest`` tag deploys the latest stable release. Where ``develop`` is the latest unstable working branch. -Installation ------------- +.. _run from source: + +Install from Source +------------------- Requirements ^^^^^^^^^^^^ * Python 3.4+ -* Elasticsearch. Supported versions: 2.x, 5.x, 6.x +* Elasticsearch. Supported versions: 2.x, 5.x, 6.x, 7.x Install ElasticHQ ^^^^^^^^^^^^^^^^^ @@ -31,24 +54,6 @@ Install ElasticHQ .. note:: Alternatively, you can start the server with ``python manage.py runserver`` -.. _docker images: - -Docker Images -^^^^^^^^^^^^^ - -Docker images are offered on the `ElasticHQ Dockerhub `_. - -The ``latest`` tag deploys the latest stable release. Where ``develop`` is the latest unstable working branch. - -When starting with Docker, see :any:`environment variables` for passing startup args. Environment variables are passed to docker using the `-e` flag. - -ie. ``-e HQ_DEFAULT_URL='http://aa.com:1212'`` - -To run/install container: - -``docker run -p 5000:5000 elastichq/elasticsearch-hq`` - -Access HQ with: http://localhost:5000 Pre-Releases ^^^^^^^^^^^^ @@ -103,6 +108,15 @@ The ``application.py`` start script takes parameters passed in as arguments from ``--verify_certs`` True Whether HQ should attempt to validate certs. Set to False for self-signed certs. ================== ========================= ================================================================================ +Example: +======== + +.. code-block:: bash + + python -m application + --enable-ssl + --ca-certs /path/to/your/ca.crt + .. _environment variables: Environment Variables @@ -118,6 +132,14 @@ Environment Variables ``HQ_DEBUG`` False If True, enables debug level on logging. =================== ========================= ================================================================================ +Example: +======== + +.. code-block:: bash + + docker run -p 5000:5000 elastichq/elasticsearch-hq + -e HQ_DEFAULT_URL='http://aa.com:1212' + -e HQ_ENABLE_SSL=False Logging ^^^^^^^ diff --git a/elastichq/api/nodes.py b/elastichq/api/nodes.py index f2faa160..723f8af1 100644 --- a/elastichq/api/nodes.py +++ b/elastichq/api/nodes.py @@ -17,7 +17,7 @@ def get(self, cluster_name, node_ids=None): both the info and stats APIs. """ - response = NodeService().get_node_summary(cluster_name, node_ids) + response = NodeService().get_node_summary(cluster_name) return APIResponse(response, HTTP_Status.OK, None) diff --git a/elastichq/config/settings.py b/elastichq/config/settings.py index 1f5c2775..1a4064bf 100644 --- a/elastichq/config/settings.py +++ b/elastichq/config/settings.py @@ -62,7 +62,7 @@ class TestSettings(BaseSettings): # static HQ_SITE_URL = 'http://elastichq.org' HQ_GH_URL = 'https://github.com/ElasticHQ/elasticsearch-HQ' - API_VERSION = 'v3.5.2' + API_VERSION = 'v3.5.3' ES_TEST_INDEX_NAME = 'cars' @@ -105,7 +105,7 @@ class ProdSettings(BaseSettings): # static HQ_SITE_URL = 'http://elastichq.org' HQ_GH_URL = 'https://github.com/ElasticHQ/elasticsearch-HQ' - API_VERSION = '3.5.2' + API_VERSION = '3.5.3' SERVER_NAME = None # cluster settings: specific settings for each cluster and how HQ should handle it. diff --git a/sphinx-requirements.txt b/sphinx-requirements.txt index d669885f..dd55413e 100644 --- a/sphinx-requirements.txt +++ b/sphinx-requirements.txt @@ -1,6 +1,6 @@ # Docs Sphinx>=1.3.0,<1.5.0 -guzzle_sphinx_theme>=0.7.8,<0.8.0 +guzzle_sphinx_theme sphinxcontrib-httpdomain==1.6.0 ### Removed fulltoc - not working with py3.6
Parameters:
  • cluster_name –
  • index_name –
    • -
  • alias_name (string) – Alias to delete