Skip to content

Commit 1730251

Browse files
royrussoroyrusso
committed
Merge branch 'release/v3.5.2'
2 parents 4822a6b + b142c9a commit 1730251

File tree

14 files changed

+258
-109
lines changed

14 files changed

+258
-109
lines changed

‎application.py‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
default_debug = False
1313
default_enable_ssl = False
1414
default_ca_certs = None
15+
default_verify_certs = True
1516
default_url = 'http://localhost:9200'
1617
is_gunicorn = "gunicorn" in os.environ.get("SERVER_SOFTWARE", "")
1718

@@ -21,6 +22,7 @@
2122
application.config['DEFAULT_URL'] = os.environ.get('HQ_DEFAULT_URL', default_url)
2223
application.config['ENABLE_SSL'] = os.environ.get('HQ_ENABLE_SSL', default_enable_ssl)
2324
application.config['CA_CERTS'] = os.environ.get('HQ_CA_CERTS', default_ca_certs)
25+
application.config['HQ_VERIFY_CERTS'] = os.environ.get('HQ_VERIFY_CERTS', default_verify_certs)
2426
application.config['DEBUG'] = os.environ.get('HQ_DEBUG', default_debug)
2527

2628
if os.environ.get('HQ_DEBUG') == 'True':
@@ -47,13 +49,15 @@
4749
parser.add_option("-c", "--ca-certs", default=default_ca_certs,
4850
help='Required when --use-ssl is set. ' + \
4951
'Path to CA file or directory [default %s]' % default_ca_certs)
52+
parser.add_option("-v", "--verify_certs", default=default_verify_certs,
53+
help='Set to False when using self-signed certs.')
5054

5155
options, _ = parser.parse_args()
5256

53-
# set default url, override with env for docker
5457
application.config['DEFAULT_URL'] = os.environ.get('HQ_DEFAULT_URL', options.url)
5558
application.config['ENABLE_SSL'] = os.environ.get('HQ_ENABLE_SSL', options.enable_ssl)
5659
application.config['CA_CERTS'] = os.environ.get('HQ_CA_CERTS', options.ca_certs)
60+
application.config['VERIFY_CERTS'] = os.environ.get('HQ_VERIFY_CERTS', options.verify_certs)
5761

5862
if is_gunicorn:
5963
if options.debug:

‎docs/.doctrees/environment.pickle‎

96 Bytes
Binary file not shown.

‎docs/.doctrees/index.doctree‎

0 Bytes
Binary file not shown.

‎docs/.doctrees/installation.doctree‎

4.98 KB
Binary file not shown.

‎docs/_sources/index.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ ElasticHQ Documentation
44

55

66
.. toctree::
7-
:hidden:
7+
:includehidden:
88

99
installation
1010
rest-api

‎docs/_sources/installation.txt‎

Lines changed: 25 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -84,35 +84,39 @@ The input field takes a url in the form of: ``http://DOMAIN:PORT``
8484
Configuration
8585
-------------
8686

87+
.. _command line parameters:
88+
8789
Command line Parameters
8890
^^^^^^^^^^^^^^^^^^^^^^^
8991

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

92-
================ ========================= ====================================================================
93-
Arg Default Value Definition
94-
================ ========================= ====================================================================
95-
``--host`` 127.0.0.1 Host the HQ server should be reachable on.
96-
``--port`` 5000 Port to reach HQ server.
97-
``--debug`` False If True, exposes debug data to UI and causes reload on code changes.
98-
``--url`` ``http://localhost:9200`` Default URL displayed on the initial connection screen.
99-
``--enable-ssl`` False If flag is passed, assumes ssl cert will be used.
100-
``--ca-certs`` /path/to/your/ca.crt Path to your CA Certificate. Required if enable-ssl is passed.
101-
================ ========================= ====================================================================
94+
================== ========================= ================================================================================
95+
Arg Default Value Definition
96+
================== ========================= ================================================================================
97+
``--host`` 127.0.0.1 Host the HQ server should be reachable on.
98+
``--port`` 5000 Port to reach HQ server.
99+
``--debug`` False If True, exposes debug data to UI and causes reload on code changes.
100+
``--url`` ``http://localhost:9200`` Default URL displayed on the initial connection screen.
101+
``--enable-ssl`` False If flag is passed, assumes ssl cert will be used.
102+
``--ca-certs`` /path/to/your/ca.crt Path to your CA Certificate. Required if enable-ssl is passed.
103+
``--verify_certs`` True Whether HQ should attempt to validate certs. Set to False for self-signed certs.
104+
================== ========================= ================================================================================
102105

103106
.. _environment variables:
104107

105108
Environment Variables
106109
^^^^^^^^^^^^^^^^^^^^^
107110

108-
================== ========================= ====================================================================
109-
Arg Default Value Definition
110-
================== ========================= ====================================================================
111-
``HQ_DEFAULT_URL`` ``http://localhost:9200`` Default URL displayed on the initial connection screen.
112-
``HQ_ENABLE_SSL`` False If flag is passed, assumes ssl cert will be used.
113-
``HQ_CA_CERTS`` /path/to/your/ca.crt Path to your CA Certificate. Required if enable-ssl is passed.
114-
``HQ_DEBUG`` False If True, enables debug level on logging.
115-
================== ========================= ====================================================================
111+
=================== ========================= ================================================================================
112+
Arg Default Value Definition
113+
=================== ========================= ================================================================================
114+
``HQ_DEFAULT_URL`` ``http://localhost:9200`` Default URL displayed on the initial connection screen.
115+
``HQ_ENABLE_SSL`` False If flag is passed, assumes ssl cert will be used.
116+
``HQ_CA_CERTS`` /path/to/your/ca.crt Path to your CA Certificate. Required if enable-ssl is passed.
117+
``HQ_VERIFY_CERTS`` True Whether HQ should attempt to validate certs. Set to False for self-signed certs.
118+
``HQ_DEBUG`` False If True, enables debug level on logging.
119+
=================== ========================= ================================================================================
116120

117121

118122
Logging
@@ -132,7 +136,8 @@ Thanks to a community contribution, SSL Cert support has been added: `SSL Suppor
132136
Enable SSL Cert support by starting HQ as so:
133137

134138
``python -m application --enable-ssl --ca-certs /path/to/your/ca.crt``
135-
139+
140+
.. note:: When using self-signed certs, you must disable certificate verification. See: :any:`command line parameters` or :any:`environment variables`
136141

137142
Database
138143
^^^^^^^^
@@ -236,7 +241,7 @@ Failure in connecting initially to an Elasticsearch cluster, can happen for seve
236241
* **Basic Authentication:** If you did not enter in the security credentials in the connection URL, HQ will fail to connect. The proper format is ``http://USERNAME:PASSWORD@DOMAIN:PORT``
237242
* **X-Pack License Expiration:** X-Pack comes with a #-day license that will silently expire. Expiration of the license may cause connectivity issues, so it is advised to either purchase an X-Pack license or uninstall X-Pack.
238243
* **No Route to ES cluster:** Confirm that the server running HQ has access to ES via network. You can do this by calling ES from within a terminal window on the HQ server, with a ``curl -XGET http://DOMAIN:PORT``.
239-
244+
* **CERTIFICATE_VERIFY_FAILED:** If you see this error in the log, you are most likely using a self-signed cert and did not set validate_certs variable to false. See: :any:`command line parameters` or :any:`environment variables`
240245

241246
.. _xpack integration:
242247

‎docs/index.html‎

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,122 @@ <h2>Table Of Contents</h2>
114114
<div class="section" id="elastichq-documentation">
115115
<h1>ElasticHQ Documentation<a class="headerlink" href="#elastichq-documentation" title="Permalink to this headline"></a></h1>
116116
<div class="toctree-wrapper compound">
117+
<ul>
118+
<li class="toctree-l1"><a class="reference internal" href="installation.html">Getting Started</a><ul>
119+
<li class="toctree-l2"><a class="reference internal" href="installation.html#quick-start-guide">Quick-Start Guide</a></li>
120+
<li class="toctree-l2"><a class="reference internal" href="installation.html#installation">Installation</a><ul>
121+
<li class="toctree-l3"><a class="reference internal" href="installation.html#requirements">Requirements</a></li>
122+
<li class="toctree-l3"><a class="reference internal" href="installation.html#install-elastichq">Install ElasticHQ</a></li>
123+
<li class="toctree-l3"><a class="reference internal" href="installation.html#docker-images">Docker Images</a></li>
124+
<li class="toctree-l3"><a class="reference internal" href="installation.html#pre-releases">Pre-Releases</a></li>
125+
<li class="toctree-l3"><a class="reference internal" href="installation.html#openshift">OpenShift</a></li>
126+
</ul>
127+
</li>
128+
<li class="toctree-l2"><a class="reference internal" href="installation.html#initial-login">Initial Login</a></li>
129+
<li class="toctree-l2"><a class="reference internal" href="installation.html#configuration">Configuration</a><ul>
130+
<li class="toctree-l3"><a class="reference internal" href="installation.html#command-line-parameters">Command line Parameters</a></li>
131+
<li class="toctree-l3"><a class="reference internal" href="installation.html#environment-variables">Environment Variables</a></li>
132+
<li class="toctree-l3"><a class="reference internal" href="installation.html#logging">Logging</a></li>
133+
<li class="toctree-l3"><a class="reference internal" href="installation.html#connecting-with-ssl">Connecting with SSL</a></li>
134+
<li class="toctree-l3"><a class="reference internal" href="installation.html#database">Database</a></li>
135+
<li class="toctree-l3"><a class="reference internal" href="installation.html#external-configuration">External Configuration</a></li>
136+
</ul>
137+
</li>
138+
<li class="toctree-l2"><a class="reference internal" href="installation.html#upgrading">Upgrading</a><ul>
139+
<li class="toctree-l3"><a class="reference internal" href="installation.html#latest-version">Latest Version</a></li>
140+
<li class="toctree-l3"><a class="reference internal" href="installation.html#upgrading-minor-and-patch-versions">Upgrading Minor and Patch versions</a></li>
141+
</ul>
142+
</li>
143+
<li class="toctree-l2"><a class="reference internal" href="installation.html#running-in-production">Running in Production</a></li>
144+
<li class="toctree-l2"><a class="reference internal" href="installation.html#troubleshooting">Troubleshooting</a><ul>
145+
<li class="toctree-l3"><a class="reference internal" href="installation.html#diagnosing-connection-errors">Diagnosing connection errors</a></li>
146+
<li class="toctree-l3"><a class="reference internal" href="installation.html#x-pack-integration">X-Pack Integration</a></li>
147+
<li class="toctree-l3"><a class="reference internal" href="installation.html#viewing-logs">Viewing Logs</a></li>
148+
<li class="toctree-l3"><a class="reference internal" href="installation.html#ssl-cert-not-working">SSL Cert not working</a></li>
149+
<li class="toctree-l3"><a class="reference internal" href="installation.html#preserving-database-across-docker-container-restarts">Preserving Database across Docker container restarts</a></li>
150+
</ul>
151+
</li>
152+
<li class="toctree-l2"><a class="reference internal" href="installation.html#license">License</a></li>
153+
</ul>
154+
</li>
155+
<li class="toctree-l1"><a class="reference internal" href="rest-api.html">REST API</a><ul>
156+
<li class="toctree-l2"><a class="reference internal" href="rest-api.html#connection-apis">Connection APIs</a><ul>
157+
<li class="toctree-l3"><a class="reference internal" href="rest-api.html#connections">Connections</a></li>
158+
</ul>
159+
</li>
160+
<li class="toctree-l2"><a class="reference internal" href="rest-api.html#cluster-apis">Cluster APIs</a><ul>
161+
<li class="toctree-l3"><a class="reference internal" href="rest-api.html#cluster-list">Cluster List</a></li>
162+
<li class="toctree-l3"><a class="reference internal" href="rest-api.html#cluster-health">Cluster Health</a></li>
163+
<li class="toctree-l3"><a class="reference internal" href="rest-api.html#cluster-summary">Cluster Summary</a></li>
164+
<li class="toctree-l3"><a class="reference internal" href="rest-api.html#cluster-state">Cluster State</a></li>
165+
</ul>
166+
</li>
167+
<li class="toctree-l2"><a class="reference internal" href="rest-api.html#node-apis">Node APIs</a><ul>
168+
<li class="toctree-l3"><a class="reference internal" href="rest-api.html#nodes-summary">Nodes Summary</a></li>
169+
<li class="toctree-l3"><a class="reference internal" href="rest-api.html#node-info">Node Info</a></li>
170+
<li class="toctree-l3"><a class="reference internal" href="rest-api.html#nodes-stats">Nodes Stats</a></li>
171+
</ul>
172+
</li>
173+
<li class="toctree-l2"><a class="reference internal" href="rest-api.html#index-apis">Index APIs</a><ul>
174+
<li class="toctree-l3"><a class="reference internal" href="rest-api.html#indices">Indices</a></li>
175+
<li class="toctree-l3"><a class="reference internal" href="rest-api.html#indices-summary">Indices Summary</a></li>
176+
<li class="toctree-l3"><a class="reference internal" href="rest-api.html#index-stats">Index Stats</a></li>
177+
<li class="toctree-l3"><a class="reference internal" href="rest-api.html#index-command">Index Command</a></li>
178+
<li class="toctree-l3"><a class="reference internal" href="rest-api.html#index-shards">Index Shards</a></li>
179+
<li class="toctree-l3"><a class="reference internal" href="rest-api.html#index-alias">Index Alias</a></li>
180+
<li class="toctree-l3"><a class="reference internal" href="rest-api.html#index-mapping">Index Mapping</a></li>
181+
<li class="toctree-l3"><a class="reference internal" href="rest-api.html#reindex">Reindex</a></li>
182+
</ul>
183+
</li>
184+
<li class="toctree-l2"><a class="reference internal" href="rest-api.html#diagnostics">Diagnostics</a><ul>
185+
<li class="toctree-l3"><a class="reference internal" href="rest-api.html#cluster-diagnostics">Cluster Diagnostics</a></li>
186+
</ul>
187+
</li>
188+
<li class="toctree-l2"><a class="reference internal" href="rest-api.html#snapshots-repositories">Snapshots &amp; Repositories</a><ul>
189+
<li class="toctree-l3"><a class="reference internal" href="rest-api.html#repositories">Repositories</a></li>
190+
<li class="toctree-l3"><a class="reference internal" href="rest-api.html#snapshots">Snapshots</a></li>
191+
</ul>
192+
</li>
193+
<li class="toctree-l2"><a class="reference internal" href="rest-api.html#hq-apis">HQ APIs</a><ul>
194+
<li class="toctree-l3"><a class="reference internal" href="rest-api.html#hq-status">HQ Status</a></li>
195+
<li class="toctree-l3"><a class="reference internal" href="rest-api.html#hq-routes">HQ Routes</a></li>
196+
<li class="toctree-l3"><a class="reference internal" href="rest-api.html#es-rest">ES REST</a></li>
197+
</ul>
198+
</li>
199+
</ul>
200+
</li>
201+
<li class="toctree-l1"><a class="reference internal" href="developer-guide.html">For Developers</a><ul>
202+
<li class="toctree-l2"><a class="reference internal" href="developer-guide.html#contributing">Contributing</a></li>
203+
<li class="toctree-l2"><a class="reference internal" href="developer-guide.html#developer-environment">Developer Environment</a><ul>
204+
<li class="toctree-l3"><a class="reference internal" href="developer-guide.html#set-debug-to-true">Set Debug to True</a></li>
205+
</ul>
206+
</li>
207+
<li class="toctree-l2"><a class="reference internal" href="developer-guide.html#building-pre-releases">Building Pre-Releases</a><ul>
208+
<li class="toctree-l3"><a class="reference internal" href="developer-guide.html#install-build-the-ui">Install/Build the UI</a></li>
209+
<li class="toctree-l3"><a class="reference internal" href="developer-guide.html#building-a-distribution">Building a Distribution</a></li>
210+
<li class="toctree-l3"><a class="reference internal" href="developer-guide.html#pulling-a-tag-from-dockerhub">Pulling a tag from DockerHub</a></li>
211+
</ul>
212+
</li>
213+
<li class="toctree-l2"><a class="reference internal" href="developer-guide.html#running-tests">Running Tests</a></li>
214+
<li class="toctree-l2"><a class="reference internal" href="developer-guide.html#manual-testing">Manual Testing</a><ul>
215+
<li class="toctree-l3"><a class="reference internal" href="developer-guide.html#notes">Notes</a></li>
216+
</ul>
217+
</li>
218+
<li class="toctree-l2"><a class="reference internal" href="developer-guide.html#building-documentation">Building Documentation</a></li>
219+
<li class="toctree-l2"><a class="reference internal" href="developer-guide.html#http-responses">HTTP Responses</a><ul>
220+
<li class="toctree-l3"><a class="reference internal" href="developer-guide.html#http-status">HTTP Status</a></li>
221+
<li class="toctree-l3"><a class="reference internal" href="developer-guide.html#response-headers">Response Headers</a></li>
222+
</ul>
223+
</li>
224+
<li class="toctree-l2"><a class="reference internal" href="developer-guide.html#issues-bugs">Issues/Bugs</a></li>
225+
</ul>
226+
</li>
227+
<li class="toctree-l1"><a class="reference internal" href="faq.html">FAQ</a><ul>
228+
<li class="toctree-l2"><a class="reference internal" href="faq.html#how-do-i">How do I...</a></li>
229+
<li class="toctree-l2"><a class="reference internal" href="faq.html#using-elastichq-with">Using ElasticHQ with...</a></li>
230+
</ul>
231+
</li>
232+
</ul>
117233
</div>
118234
<div class="section" id="overview">
119235
<h2>Overview<a class="headerlink" href="#overview" title="Permalink to this headline"></a></h2>

0 commit comments

Comments
 (0)