opendev/system-config
Code Issues Proposed changes

Rename cgit_file to git_file

Browse Source 
In sphinx, we have a :cgit_file: directive that makes links to files.
Thing is - we're not using cgit anymore. So just rename it to git_file.

Change-Id: I80aca5fb3cc84281e29843944fea33e6f4d9fe6f
This commit is contained in:
Monty Taylor 2019-04-20 20:29:30 +00:00
parent e3bf7f2591
commit d500651367
30 changed files with 65 additions and 65 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/source/afs.rst
View File

@ -28,8 +28,8 @@ At a Glance
* afs01.ord.openstack.org (a fileserver in ORD)
:Puppet:
* https://opendev.org/opendev/puppet-openafs
* :cgit_file:`modules/openstack_project/manifests/afsdb.pp`
* :cgit_file:`modules/openstack_project/manifests/afsfs.pp`
* :git_file:`modules/openstack_project/manifests/afsdb.pp`
* :git_file:`modules/openstack_project/manifests/afsfs.pp`
:Projects:
* http://openafs.org/
:Bugs:

12
doc/source/askbot.rst
View File

@ -16,8 +16,8 @@ At a Glance
:Puppet:
* https://opendev.org/opendev/puppet-askbot
* https://github.com/vamsee/puppet-solr
* :cgit_file:`modules/openstack_project/manifests/ask.pp`
* :cgit_file:`modules/openstack_project/manifests/ask-staging.pp`
* :git_file:`modules/openstack_project/manifests/ask.pp`
* :git_file:`modules/openstack_project/manifests/ask-staging.pp`
:Projects:
* https://askbot.com
* http://lucene.apache.org/solr
@ -80,8 +80,8 @@ Application management tool can be found under /srv/askbot-sites/slot0/config:
Configuration files:
* :cgit_file:`modules/askbot/templates/askbot.vhost.erb`
* :cgit_file:`modules/askbot/templates/settings.py.erb`
* :git_file:`modules/askbot/templates/askbot.vhost.erb`
* :git_file:`modules/askbot/templates/settings.py.erb`
In addition to the file-based configuration, Askbot provides a web interface
to tweak its own settings. Toggles and fields for reputation thresholds,
@ -122,8 +122,8 @@ the English (en) and Chinese (zh) languages are supported.
Solr schema templates can be found at:
* :cgit_file:`modules/askbot/templates/solr/schema.en.xml.erb`
* :cgit_file:`modules/askbot/templates/solr/schema.cn.xml.erb`
* :git_file:`modules/askbot/templates/solr/schema.en.xml.erb`
* :git_file:`modules/askbot/templates/solr/schema.cn.xml.erb`
Operational notes
=================

2
doc/source/asterisk.rst
View File

@ -14,7 +14,7 @@ At a Glance
* sip://pbx.opendev.org
:Puppet:
* https://opendev.org/opendev/puppet-asterisk
* :cgit_file:`modules/openstack_project/manifests/pbx.pp`
* :git_file:`modules/openstack_project/manifests/pbx.pp`
:Projects:
* http://www.asterisk.org
:Documentation:

4
doc/source/cacti.rst
View File

@ -14,7 +14,7 @@ At a Glance
:Hosts:
* http://cacti.openstack.org
:Puppet:
* :cgit_file:`modules/openstack_project/manifests/cacti.pp`
* :git_file:`modules/openstack_project/manifests/cacti.pp`
:Projects:
* http://www.cacti.net
:Bugs:
@ -31,4 +31,4 @@ Cacti is accessible via the web here:
http://cacti.openstack.org/cacti/graph_view.php
New servers are added to our cacti instance by adding the host to the
:cgit_file:`modules/openstack_project/manifests/cacti.pp` file.
:git_file:`modules/openstack_project/manifests/cacti.pp` file.

2
doc/source/codesearch.rst
View File

@ -15,7 +15,7 @@ At a Glance
* http://codesearch.openstack.org
:Puppet:
* https://opendev.org/opendev/puppet-hound
* :cgit_file:`modules/openstack_project/manifests/codesearch.pp`
* :git_file:`modules/openstack_project/manifests/codesearch.pp`
:Projects:
* https://github.com/etsy/Hound
:Bugs:

4
doc/source/custom_roles.py
View File

@ -22,7 +22,7 @@
from docutils import nodes
def cgit_file_role(name, rawtext, text, lineno, inliner,
def git_file_role(name, rawtext, text, lineno, inliner,
options={}, content=[]):
"""Link a local path to a cgit file view.
@ -75,6 +75,6 @@ def setup(app):
:param app: Sphinx application context.
"""
app.add_role('cgit_file', cgit_file_role)
app.add_role('git_file', git_file_role)
app.add_role('config', config_role)
return

4
doc/source/dns.rst
View File

@ -17,7 +17,7 @@ At a Glance
* ns1.opendev.org
* ns2.opendev.org
:Ansible:
* :cgit_file:`playbooks/group_vars/dns.yaml`
* :git_file:`playbooks/group_vars/dns.yaml`
:Projects:
* https://www.nlnetlabs.nl/projects/nsd/
* https://www.isc.org/downloads/bind/doc/
@ -27,7 +27,7 @@ Adding a Zone
To add a new zone, identify an existing git repository or create a new
one to hold the contents of the zone, then update
:cgit_file:`playbooks/group_vars/dns.yaml`.
:git_file:`playbooks/group_vars/dns.yaml`.
Run::

2
doc/source/elastic-recheck.rst
View File

@ -14,7 +14,7 @@ At a Glance
* http://status.openstack.org
:Puppet:
* https://opendev.org/opendev/puppet-elastic_recheck
* :cgit_file:`modules/openstack_project/manifests/status.pp`
* :git_file:`modules/openstack_project/manifests/status.pp`
:Projects:
* https://opendev.org/opendev/elastic-recheck
:Bugs:

4
doc/source/etherpad.rst
View File

@ -17,8 +17,8 @@ At a Glance
* http://etherpad.openstack.org
:Puppet:
* https://opendev.org/opendev/puppet-etherpad_lite/tree/
* :cgit_file:`modules/openstack_project/manifests/etherpad.pp`
* :cgit_file:`modules/openstack_project/manifests/etherpad_dev.pp`
* :git_file:`modules/openstack_project/manifests/etherpad.pp`
* :git_file:`modules/openstack_project/manifests/etherpad_dev.pp`
:Projects:
* http://etherpad.org/
* https://github.com/ether/etherpad-lite

2
doc/source/firehose.rst
View File

@ -16,7 +16,7 @@ At a Glance
* https://opendev.org/opendev/puppet-mosquitto
* https://opendev.org/opendev/puppet-germqtt
* https://opendev.org/opendev/puppet-lpmqtt
* :cgit_file:`modules/openstack_project/manifests/firehose.pp`
* :git_file:`modules/openstack_project/manifests/firehose.pp`
:Projects:
* https://mosquitto.org/
* http://opendev.org/opendev/germqtt/

8
doc/source/gerrit.rst
View File

@ -21,10 +21,10 @@ At a Glance
* http://review-dev.openstack.org
:Puppet:
* https://opendev.org/opendev/puppet-gerrit
* :cgit_file:`modules/openstack_project/manifests/review.pp`
* :cgit_file:`modules/openstack_project/manifests/review_dev.pp`
* :git_file:`modules/openstack_project/manifests/review.pp`
* :git_file:`modules/openstack_project/manifests/review_dev.pp`
:Configuration:
* :cgit_file:`modules/openstack_project/templates/review.projects.ini.erb`
* :git_file:`modules/openstack_project/templates/review.projects.ini.erb`
* :config:`gerrit/projects.yaml`
:Projects:
* http://code.google.com/p/gerrit/
@ -103,7 +103,7 @@ account name and add ssh keys - you'll need those.
Once you've created your groups you should create the
``openstack-project-creator`` account by hand (the account name is
referenced from
:cgit_file:`modules/openstack_project/templates/review.projects.ini.erb`)
:git_file:`modules/openstack_project/templates/review.projects.ini.erb`)
using::
cat $pubkey | ssh -p 29418 $USER@$HOST gerrit create-account \

4
doc/source/github.rst
View File

@ -16,8 +16,8 @@ At a Glance
* review.opendev.org
:Puppet:
* https://opendev.org/opendev/system-config
* :cgit_file:`modules/openstack_project/manifests/gerrit.pp`
* :cgit_file:`hiera/group/zuul-scheduler.yaml`
* :git_file:`modules/openstack_project/manifests/gerrit.pp`
* :git_file:`hiera/group/zuul-scheduler.yaml`
:Projects:
* https://opendev.org/zuul/zuul
* https://opendev.org/opendev/jeepyb

2
doc/source/grafana.rst
View File

@ -16,7 +16,7 @@ At a Glance
* http://grafana.openstack.org
:Puppet:
* https://github.com/bfraser/puppet-grafana
* :cgit_file:`modules/openstack_project/manifests/grafana.pp`
* :git_file:`modules/openstack_project/manifests/grafana.pp`
:Projects:
* http://grafana.org
:Bugs:

8
doc/source/irc.rst
View File

@ -21,8 +21,8 @@ At a Glance
* https://opendev.org/opendev/puppet-statusbot
* https://opendev.org/opendev/puppet-gerritbot
* https://opendev.org/opendev/puppet-ptgbot
* :cgit_file:`modules/openstack_project/manifests/eavesdrop.pp`
* :cgit_file:`modules/openstack_project/manifests/review.pp`
* :git_file:`modules/openstack_project/manifests/eavesdrop.pp`
* :git_file:`modules/openstack_project/manifests/review.pp`
:Configuration:
* :config:`gerritbot/channels.yaml`
* :config:`accessbot/channels.yaml`
@ -172,7 +172,7 @@ of logging channel activity, not just meetings. Standard channel logs
are sent to http://eavesdrop.openstack.org/irclogs/
The configuration for specific channel logging can be found in the
public Hiera data file, :cgit_file:`hiera/common.yaml`.
public Hiera data file, :git_file:`hiera/common.yaml`.
.. _statusbot:
@ -214,7 +214,7 @@ the channels the bot is listening to:
in OpenStack development.
A channel can be added to statusbot by editing the public Hiera data
file, :cgit_file:`hiera/common.yaml`.
file, :git_file:`hiera/common.yaml`.
The wiki password for the StatusBot account can be (re)set using the
`ChangePassword.php <https://www.mediawiki.org/wiki/Manual:ChangePassword.php>`_

8
doc/source/jeepyb.rst
View File

@ -17,10 +17,10 @@ At a Glance
* http://review-dev.openstack.org
:Puppet:
* https://opendev.org/opendev/puppet-jeepyb
* :cgit_file:`modules/openstack_project/manifests/review.pp`
* :cgit_file:`modules/openstack_project/manifests/review_dev.pp`
* :git_file:`modules/openstack_project/manifests/review.pp`
* :git_file:`modules/openstack_project/manifests/review_dev.pp`
:Configuration:
* :cgit_file:`modules/openstack_project/templates/review.projects.ini.erb`
* :git_file:`modules/openstack_project/templates/review.projects.ini.erb`
* :config:`gerrit/projects.yaml`
:Projects:
* https://opendev.org/opendev/jeepyb
@ -38,7 +38,7 @@ and create new groups in Gerrit.
The global configuration data needed for ``manage-projects`` to know how to
connect to things or how to operate is in
:cgit_file:`modules/openstack_project/templates/review.projects.ini.erb`.
:git_file:`modules/openstack_project/templates/review.projects.ini.erb`.
#. Config values::

2
doc/source/kerberos.rst
View File

@ -17,7 +17,7 @@ At a Glance
* kdc*.openstack.org
:Puppet:
* https://opendev.org/opendev/puppet-kerberos
* :cgit_file:`modules/openstack_project/manifests/kdc.pp`
* :git_file:`modules/openstack_project/manifests/kdc.pp`
:Projects:
* http://web.mit.edu/kerberos
:Bugs:

2
doc/source/lists.rst
View File

@ -16,7 +16,7 @@ At a Glance
* http://lists.openstack.org
:Puppet:
* https://opendev.org/opendev/puppet-mailman
* :cgit_file:`modules/openstack_project/manifests/lists.pp`
* :git_file:`modules/openstack_project/manifests/lists.pp`
:Projects:
* http://www.gnu.org/software/mailman/
:Bugs:

10
doc/source/logstash.rst
View File

@ -16,12 +16,12 @@ At a Glance
* elasticsearch\*.openstack.org
:Puppet:
* https://opendev.org/opendev/puppet-logstash
* :cgit_file:`modules/openstack_project/manifests/logstash.pp`
* :cgit_file:`modules/openstack_project/manifests/logstash_worker.pp`
* :cgit_file:`modules/openstack_project/manifests/elasticsearch.pp`
* :git_file:`modules/openstack_project/manifests/logstash.pp`
* :git_file:`modules/openstack_project/manifests/logstash_worker.pp`
* :git_file:`modules/openstack_project/manifests/elasticsearch.pp`
:Configuration:
* :cgit_file:`modules/openstack_project/files/logstash`
* :cgit_file:`modules/openstack_project/templates/logstash`
* :git_file:`modules/openstack_project/files/logstash`
* :git_file:`modules/openstack_project/templates/logstash`
* `submit-logstash-jobs defaults`_
:Projects:
* http://logstash.net/

6
doc/source/openstack-health.rst
View File

@ -13,10 +13,10 @@ At a Glance
* Frontend: http://status.openstack.org/openstack-health
:Puppet:
* https://opendev.org/opendev/puppet-openstack_health/tree/
* :cgit_file:`modules/openstack_project/manifests/openstack_health_api.pp`
* :cgit_file:`modules/openstack_project/manifests/status.pp`
* :git_file:`modules/openstack_project/manifests/openstack_health_api.pp`
* :git_file:`modules/openstack_project/manifests/status.pp`
:Configuration:
* :cgit_file:`modules/openstack_project/files/git/cgitrc`
* :git_file:`modules/openstack_project/files/git/cgitrc`
:Projects:
* https://opendev.org/openstack/openstack-health

2
doc/source/openstackid.rst
View File

@ -16,7 +16,7 @@ At a Glance
* https://openstackid.org
:Puppet:
* https://opendev.org/opendev/puppet-openstackid
* :cgit_file:`modules/openstack_project/manifests/openstackid_dev.pp`
* :git_file:`modules/openstack_project/manifests/openstackid_dev.pp`
:Projects:
* http://opendev.org/osf/openstackid/
:Bugs:

2
doc/source/paste.rst
View File

@ -17,7 +17,7 @@ At a Glance
* http://paste.openstack.org
:Puppet:
* https://opendev.org/opendev/puppet-lodgeit
* :cgit_file:`modules/openstack_project/manifests/paste.pp`
* :git_file:`modules/openstack_project/manifests/paste.pp`
:Projects:
* https://opendev.org/opendev/lodgeit
* https://bitbucket.org/dcolish/lodgeit-main

2
doc/source/planet.rst
View File

@ -17,7 +17,7 @@ At a Glance
* http://planet.openstack.org
:Puppet:
* https://opendev.org/opendev/puppet-planet/tree/
* :cgit_file:`modules/openstack_project/manifests/planet.pp`
* :git_file:`modules/openstack_project/manifests/planet.pp`
:Configuration:
* https://opendev.org/openstack/openstack-planet/src/branch/master/planet.ini
:Projects:

4
doc/source/puppet.rst
View File

@ -33,7 +33,7 @@ The cron jobs, current configuration files and more can be done with ``puppet
apply`` but first some bootstrapping needs to be done.
You want to install these from puppetlabs' apt repo. There is a script,
:cgit_file:`install_puppet.sh` in the root of the system-config repository that
:git_file:`install_puppet.sh` in the root of the system-config repository that
will setup and install the puppet client. After that you must install the
ansible playbooks and hiera config (used to maintain secrets).
@ -79,7 +79,7 @@ Adding a node
For adding a new node to your puppet master, you can either use the
``/opt/system-config/launch/launch-node.py`` script
(see :cgit_file:`launch/README` for full details) or bootstrap puppet manually.
(see :git_file:`launch/README` for full details) or bootstrap puppet manually.
For manual bootstrap, you need to run on the new server connecting
(for example, review.opendev.org) to the puppet master:

2
doc/source/reprepro.rst
View File

@ -13,7 +13,7 @@ At a Glance
:Hosts:
* http://mirror-update.openstack.org
:Puppet:
* :cgit_file:`modules/openstack_project/manifests/mirror_update.pp`
* :git_file:`modules/openstack_project/manifests/mirror_update.pp`
:Projects:
* https://mirrorer.alioth.debian.org
:Documentation:

2
doc/source/static.rst
View File

@ -17,7 +17,7 @@ At a Glance
* http://mirror.openstack.org
* http://specs.openstack.org
:Puppet:
* :cgit_file:`modules/openstack_project/manifests/static.pp`
* :git_file:`modules/openstack_project/manifests/static.pp`
:Configuration:
* :config:`specs/index.html`
:Projects:

4
doc/source/storyboard.rst
View File

@ -19,14 +19,14 @@ At a Glance
* https://storyboard.openstack.org
:Puppet:
* https://opendev.org/opendev/puppet-storyboard/tree/
* :cgit_file:`modules/openstack_project/manifests/storyboard.pp`
* :git_file:`modules/openstack_project/manifests/storyboard.pp`
:Projects:
* https://opendev.org/opendev/storyboard
* https://opendev.org/opendev/storyboard-webclient
* https://opendev.org/opendev/puppet-storyboard
:Configuration:
* :config:`gerrit/projects.yaml`
* :cgit_file:`modules/openstack_project/files/storyboard/superusers.yaml`
* :git_file:`modules/openstack_project/files/storyboard/superusers.yaml`
:Bugs:
* https://storyboard.openstack.org/#!/project/456
:Resources:

12
doc/source/sysadmin.rst
View File

@ -120,10 +120,10 @@ Adding a New Server
To create a new server, do the following:
* Add a file in :cgit_file:`modules/openstack_project/manifests/` that defines a
* Add a file in :git_file:`modules/openstack_project/manifests/` that defines a
class which specifies the configuration of the server.
* Add a node pattern entry in :cgit_file:`manifests/site.pp` for the server
* Add a node pattern entry in :git_file:`manifests/site.pp` for the server
that uses that class. Make sure it supports an ordinal naming pattern
(e.g., fooserver01.openstack.org not just fooserver.openstack.org, even
if you're replacing an existing server) and that another server with the
@ -135,13 +135,13 @@ To create a new server, do the following:
* You should be able to install and configure most software only with
ansible or puppet. Nonetheless, if you need SSH access to the host,
add your public key to :cgit_file:`playbooks/group_vars/all.yaml` and
add your public key to :git_file:`playbooks/group_vars/all.yaml` and
include a stanza like this in your server class::
extra_users:
- your_user_name
* Add an RST file with documentation about the server in :cgit_file:`doc/source`
* Add an RST file with documentation about the server in :git_file:`doc/source`
and add it to the index in that directory.
SSH Access
@ -436,7 +436,7 @@ Launching New Servers
New servers are launched using the ``launch/launch-node.py`` tool from the git
repository ``https://opendev.org/opendev/system-config``. This
tool is run from a checkout on the bridge - please see :cgit_file:`launch/README`
tool is run from a checkout on the bridge - please see :git_file:`launch/README`
for detailed instructions.
.. _disable-enable-puppet:
@ -462,7 +462,7 @@ to take.
In the case of needing to disable the running of puppet on a node, it's a
simple matter of adding an entry to the ansible inventory "disabled" group
in :cgit_file:`inventory/groups.yaml`. The
in :git_file:`inventory/groups.yaml`. The
disabled entry is an input to `ansible --list-hosts` so you can check your
entry simply by running it with `ansible $hostlist --list-hosts` as root
on the bridge host and ensuring that the list of hosts returned is as

4
doc/source/translate.rst
View File

@ -16,8 +16,8 @@ At a Glance
* https://translate-dev.openstack.org
:Puppet:
* https://opendev.org/opendev/puppet-zanata/tree/
* :cgit_file:`modules/openstack_project/manifests/translate.pp`
* :cgit_file:`modules/openstack_project/manifests/translate-dev.pp`
* :git_file:`modules/openstack_project/manifests/translate.pp`
* :git_file:`modules/openstack_project/manifests/translate-dev.pp`
:Projects:
* http://zanata.org/
* https://github.com/zanata/

2
doc/source/wiki.rst
View File

@ -15,7 +15,7 @@ At a Glance
* https://wiki.openstack.org
:Puppet:
* https://opendev.org/opendev/puppet-mediawiki
* :cgit_file:`modules/openstack_project/manifests/wiki.pp`
* :git_file:`modules/openstack_project/manifests/wiki.pp`
:Projects:
* http://www.mediawiki.org/wiki/MediaWiki
:Bugs:

4
doc/source/zuul.rst
View File

@ -17,8 +17,8 @@ At a Glance
* zm*.openstack.org
:Puppet:
* https://opendev.org/opendev/puppet-zuul
* :cgit_file:`modules/openstack_project/manifests/zuul_prod.pp`
* :cgit_file:`modules/openstack_project/manifests/zuul_dev.pp`
* :git_file:`modules/openstack_project/manifests/zuul_prod.pp`
* :git_file:`modules/openstack_project/manifests/zuul_dev.pp`
:Configuration:
* :config:`zuul/`
* :config:`zuul.d/`