882b730fdf
This modernises the openstack-infra documentation by switching to openstackdocstheme. Update dependencies as required. To remove non-relevant stuff from conf.py, I have just taken the demo file from openstackdocstheme and lightly modified it. It seems later sphinx has included it's own ":file:" role which now conflicts. Change it it ":cgit_file:" in our documentation. Remove the custom header template which no longer applies. Add the post-2.0-pbr sphinx-based warning-as-error, which fixes the original problem that I actually noticed that errors could slip through the gate tests :) Change-Id: Ic7bec57b971bb4c75fc839e7269d1f69a576b85c
45 lines
1.3 KiB
ReStructuredText
45 lines
1.3 KiB
ReStructuredText
:title: Code Search
|
|
|
|
.. _codesearch:
|
|
|
|
Code Search
|
|
###########
|
|
|
|
The `Hound <https://github.com/etsy/Hound>`_ code search engine is deployed in
|
|
our infrastructure to service all OpenStack repositories.
|
|
|
|
At a Glance
|
|
===========
|
|
|
|
:Hosts:
|
|
* http://codesearch.openstack.org
|
|
:Puppet:
|
|
* https://git.openstack.org/cgit/openstack-infra/puppet-hound/tree/
|
|
* :cgit_file:`modules/openstack_project/manifests/codesearch.pp`
|
|
:Projects:
|
|
* https://github.com/etsy/Hound
|
|
:Bugs:
|
|
* https://storyboard.openstack.org/#!/project/748
|
|
* https://github.com/etsy/Hound/issues
|
|
:Resources:
|
|
* `Hound README <https://github.com/etsy/hound/blob/master/README.md>`_
|
|
|
|
Overview
|
|
========
|
|
|
|
Hound is configured to read projects from a config.json file that is
|
|
automatically generated from the Gerrit projects.yaml, defined in the
|
|
$::project_config::jeepyb_project_file variable in Puppet.
|
|
|
|
|
|
Maintenance
|
|
===========
|
|
|
|
Hound uses 'git pull' to keep repos in sync. If a force push is ever used to
|
|
correct an issue in a repo, then hound will not be able to pull or index those
|
|
changes. The only way to detect this is to look in /var/log/hound.log. The
|
|
error message looks like hound attempting to update the repo and getting a
|
|
'remote host hung up' message. The issue can be corrected by an infra-root
|
|
removing the relevant hound data directory. Hound will re-clone with the new
|
|
history.
|