opendev/system-config
Code Issues Proposed changes

Rename config => system-config in docs

Browse Source 
We are renaming the openstack-infra/config repo to
openstack-infra/system-config. This patch edits the docs files.

Change-Id: Ic594f1b5438a400fb6c1071c3045adb7a0b7e441
This commit is contained in:
Anita Kuno 2014-10-03 16:36:18 -04:00
parent 864d6a4e89
commit 8549f5d29e
11 changed files with 50 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -18,7 +18,7 @@ Documentation
============== ==============
The documentation presented at http://ci.openstack.org comes from The documentation presented at http://ci.openstack.org comes from
git://git.openstack.org/openstack-infra/config repo's docs/source. To git://git.openstack.org/openstack-infra/system-config repo's docs/source. To
build the documentation use build the documentation use
$ tox -evenv python setup.py build_sphinx $ tox -evenv python setup.py build_sphinx

3
doc/source/conf.py
View File

@ -51,7 +51,8 @@ master_doc = 'index'
project = u'OpenStack Project Infrastructure' project = u'OpenStack Project Infrastructure'
copyright = Markup(u'2012-2014, OpenStack Infastructure Team' copyright = Markup(u'2012-2014, OpenStack Infastructure Team'
u' - see the <a href="https://git.openstack.org/cgit/' u' - see the <a href="https://git.openstack.org/cgit/'
u'openstack-infra/config/">config git repo</a> for details') u'openstack-infra/system-config/">system-config git repo'
u'</a> for details')
# The version info for the project you're documenting, acts as replacement for # The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the # |version| and |release|, also used in various other places throughout the

6
doc/source/custom_roles.py
View File

@ -39,9 +39,9 @@ def file_role(name, rawtext, text, lineno, inliner,
:param content: The directive content for customization. :param content: The directive content for customization.
""" """
ref = ('https://git.openstack.org/cgit/openstack-infra/config/tree/%s' ref = ('https://git.openstack.org/cgit/openstack-infra/'
% text) 'system-config/tree/%s' % text)
linktext = 'config: %s' % text linktext = 'system-config: %s' % text
node = nodes.reference(rawtext, linktext, refuri=ref, **options) node = nodes.reference(rawtext, linktext, refuri=ref, **options)
return [node], [] return [node], []

2
doc/source/gerrit.rst
View File

@ -171,7 +171,7 @@ New Project Creation
==================== ====================
Gerrit project creation is now managed through changes to the Gerrit project creation is now managed through changes to the
openstack-infra/config repository. :ref:`jeepyb` handles openstack-infra/system-config repository. :ref:`jeepyb` handles
automatically creating any new projects defined in the configuration automatically creating any new projects defined in the configuration
files. files.

12
doc/source/jenkins.rst
View File

@ -20,7 +20,7 @@ At a Glance
* :file:`modules/openstack_project/manifests/jenkins.pp` * :file:`modules/openstack_project/manifests/jenkins.pp`
* :file:`modules/openstack_project/manifests/jenkins_dev.pp` * :file:`modules/openstack_project/manifests/jenkins_dev.pp`
:Configuration: :Configuration:
* :file:`modules/openstack_project/files/jenkins_job_builder/config/` * :config:`jenkins/jobs`
:Projects: :Projects:
* http://jenkins-ci.org/ * http://jenkins-ci.org/
* :ref:`zuul` * :ref:`zuul`
@ -37,13 +37,13 @@ Overview
A large number and variety of jobs are defined in Jenkins. The A large number and variety of jobs are defined in Jenkins. The
configuration of all of those jobs is stored in git in the configuration of all of those jobs is stored in git in the
openstack-infra/config repository. They are defined in YAML files openstack-infra/project-config repository. They are defined in YAML
that are read by :ref:`jjb` which configures the actual jobs in files that are read by :ref:`jjb` which configures the actual jobs in
Jenkins. Jenkins.
Anyone may submit a change to the openstack-infra/config repository Anyone may submit a change to the openstack-infra/project-config
that defines a new job or alters an existing job by editing the repository that defines a new job or alters an existing job by editing
appropriate YAML files. See :ref:`jjb` for more information. the appropriate YAML files. See :ref:`jjb` for more information.
Because of the large number of builds that Jenkins executes, the Because of the large number of builds that Jenkins executes, the
OpenStack project favors the following approach in configuring Jenkins OpenStack project favors the following approach in configuring Jenkins

2
doc/source/lists.rst
View File

@ -28,7 +28,7 @@ At a Glance
Adding a List Adding a List
============= =============
A list may be added by adding it to the ``openstack-infra/config`` A list may be added by adding it to the ``openstack-infra/system-config``
repository in ``modules/openstack_project/manifests/lists.pp``. For repository in ``modules/openstack_project/manifests/lists.pp``. For
example: example:

8
doc/source/puppet.rst
View File

@ -36,9 +36,9 @@ apply`` but first some bootstrapping needs to be done.
First want to install these from puppetlabs' apt repo. We have not yet migrated First want to install these from puppetlabs' apt repo. We have not yet migrated
to puppet 3, so we pin puppet to 2.x. There is a script in the root of the to puppet 3, so we pin puppet to 2.x. There is a script in the root of the
config repository that will setup appropriate pinning and install the puppet system-config repository that will setup appropriate pinning and install the
client. After that installing the puppetmaster and hiera (used to maintain puppet client. After that installing the puppetmaster and hiera (used to
secrets on the puppet master). maintain secrets on the puppet master).
Please note: Fedora F19 and Ubuntu Raring and above cannot successfully run an Please note: Fedora F19 and Ubuntu Raring and above cannot successfully run an
OpenStack-CI puppetmaster due to new Ruby and older Puppet not being OpenStack-CI puppetmaster due to new Ruby and older Puppet not being
@ -47,7 +47,7 @@ compatible, so be sure to use an older release - e.g. Ubuntu Precise.
.. code-block:: bash .. code-block:: bash
sudo su - sudo su -
git clone https://git.openstack.org/openstack-infra/config /opt/config/production git clone https://git.openstack.org/openstack-infra/system-config /opt/config/production
/opt/config/production/install_puppet.sh /opt/config/production/install_puppet.sh
apt-get install puppetmaster-passenger hiera hiera-puppet apt-get install puppetmaster-passenger hiera hiera-puppet

13
doc/source/storyboard.rst
View File

@ -24,7 +24,7 @@ At a Glance
* https://git.openstack.org/cgit/openstack-infra/storyboard-webclient * https://git.openstack.org/cgit/openstack-infra/storyboard-webclient
* https://git.openstack.org/cgit/openstack-infra/puppet-storyboard * https://git.openstack.org/cgit/openstack-infra/puppet-storyboard
:Configuration: :Configuration:
* :file:`modules/openstack_project/files/review.projects.yaml` * :config:`gerrit/projects.yaml`
* :file:`modules/openstack_project/files/storyboard/superusers.yaml` * :file:`modules/openstack_project/files/storyboard/superusers.yaml`
:Bugs: :Bugs:
* https://storyboard.openstack.org/#!/project/456 * https://storyboard.openstack.org/#!/project/456
@ -43,9 +43,10 @@ manage OpenStack infrastructure systems.
Configuration Configuration
============= =============
Much of StoryBoard's default configuration is managed from within infra/config The default superusers configuration of StoryBoard is managed from within
itself. To add a project, admin, or modify a team, please follow the infra/system-config. The rest of the configuration is on projects-config.
instructions below. To add a project, admin, or modify a team, please follow the instructions
below.
Adding a Project to StoryBoard Adding a Project to StoryBoard
------------------------------ ------------------------------
@ -59,7 +60,7 @@ Projects loaded into StoryBoard are handled from the same file that drives our
gerrit projects. Adding a new project is as simple as modifying a single gerrit projects. Adding a new project is as simple as modifying a single
file and adding the line ``use-storyboard: true``: file and adding the line ``use-storyboard: true``:
``/modules/openstack_project/files/review.projects.yaml``:: ``:config:`gerrit/projects.yaml```::
- project: openstack-infra/storyboard - project: openstack-infra/storyboard
description: OpenStack Task Tracking API description: OpenStack Task Tracking API
@ -73,7 +74,7 @@ StoryBoard administrators are handled from a single configuration file, and
are identified by OpenID. To add a new administator, simply add their are identified by OpenID. To add a new administator, simply add their
Launchpad OpenID string and email as follows: Launchpad OpenID string and email as follows:
``/modules/openstack_project/files/review.projects.yaml``:: ``:config:`gerrit/projects.yaml```::
- openid: https://login.launchpad.net/+id/LOLPONIES - openid: https://login.launchpad.net/+id/LOLPONIES
email: pinkie.pie@example.com email: pinkie.pie@example.com

44
doc/source/sysadmin.rst
View File

@ -14,7 +14,7 @@ collaborate on code reviews.
The configuration of every system operated by the infrastructure team The configuration of every system operated by the infrastructure team
is managed by Puppet in a single Git repository: is managed by Puppet in a single Git repository:
https://git.openstack.org/cgit/openstack-infra/config https://git.openstack.org/cgit/openstack-infra/system-config
All system configuration should be encoded in that repository so that All system configuration should be encoded in that repository so that
anyone may propose a change in the running configuration to Gerrit. anyone may propose a change in the running configuration to Gerrit.
@ -24,19 +24,19 @@ Making a Change in Puppet
Many changes to the Puppet configuration can safely be made while only Many changes to the Puppet configuration can safely be made while only
performing syntax checks. Some more complicated changes merit local performing syntax checks. Some more complicated changes merit local
testing and an interactive development cycle. The config repo is testing and an interactive development cycle. The system-config repo
structured to facilitate local testing before proposing a change for is structured to facilitate local testing before proposing a change
review. This is accomplished by separating the puppet configuration for review. This is accomplished by separating the puppet
into several layers with increasing specificity about site configuration into several layers with increasing specificity about
configuration higher in the stack. site configuration higher in the stack.
The `modules/` directory holds puppet modules that abstractly describe The `modules/` directory holds puppet modules that abstractly describe
the configuration of a service. Ideally, these should have no the configuration of a service. Ideally, these should have no
OpenStack-specific information in them, and eventually they should all OpenStack-specific information in them, and eventually they should all
become modules that are directly consumed from PuppetForge, only become modules that are directly consumed from PuppetForge, only
existing in the config repo during an initial incubation period. This existing in the system-config repo during an initial incubation period.
is not yet the case, so you may find OpenStack-specific configuration This is not yet the case, so you may find OpenStack-specific
in these modules, though we are working to reduce it. configuration in these modules, though we are working to reduce it.
The `modules/openstack_project/manifests/` directory holds The `modules/openstack_project/manifests/` directory holds
configuration for each of the servers that the OpenStack project runs. configuration for each of the servers that the OpenStack project runs.
@ -60,13 +60,13 @@ simply by providing a different manifest file instead of site.pp.
the root user. the root user.
As an example, to run the etherpad configuration on your own server, As an example, to run the etherpad configuration on your own server,
start by ensuring git is installed and then cloning the config Git start by ensuring git is installed and then cloning the system-config
repo:: Git repo::
sudo su - sudo su -
apt-get install git apt-get install git
git clone https://git.openstack.org/openstack-infra/config git clone https://git.openstack.org/openstack-infra/system-config
cd config cd system-config
Then copy the etherpad node definition from manifests/site.pp to a new Then copy the etherpad node definition from manifests/site.pp to a new
file (be sure to specify the FQDN of the host you are working with in file (be sure to specify the FQDN of the host you are working with in
@ -83,8 +83,8 @@ the node specifier). It might look something like this::
since it is not installed yet. You should be able to comment out the logic since it is not installed yet. You should be able to comment out the logic
safely. safely.
Then to apply that configuration, run the following from the root of the config Then to apply that configuration, run the following from the root of the
repository:: system-config repository::
./install_puppet.sh ./install_puppet.sh
./install_modules.sh ./install_modules.sh
@ -92,9 +92,9 @@ repository::
That should turn the system you are logged into into an etherpad That should turn the system you are logged into into an etherpad
server with the same configuration as that used by the OpenStack server with the same configuration as that used by the OpenStack
project. You can edit the contents of the config repo and iterate as project. You can edit the contents of the system-config repo and
needed. When you're ready to propose the change for review, you can iterate as needed. When you're ready to propose the change for review,
propose the change with git-review. See the `Gerrit Workflow wiki you can propose the change with git-review. See the `Gerrit Workflow wiki
article <https://wiki.openstack.org/wiki/GerritWorkflow>`_ for more article <https://wiki.openstack.org/wiki/GerritWorkflow>`_ for more
information. information.
@ -156,7 +156,7 @@ following practices must be observed for SSH access:
OpenStack machines should be kept to a minimum. OpenStack machines should be kept to a minimum.
* OpenStack Infrastructure machines must use puppet to centrally manage and * OpenStack Infrastructure machines must use puppet to centrally manage and
configure user accounts, and the SSH authorized_keys files from the configure user accounts, and the SSH authorized_keys files from the
openstack-infra/config repository. openstack-infra/system-config repository.
* SSH keys should be periodically rotated (at least once per year). * SSH keys should be periodically rotated (at least once per year).
During rotation, a new key can be added to puppet for a time, and During rotation, a new key can be added to puppet for a time, and
then the old one removed. Be sure to run puppet on the backup then the old one removed. Be sure to run puppet on the backup
@ -270,9 +270,9 @@ Launching New Servers
===================== =====================
New servers are launched using the ``launch/launch-node.py`` tool from the git New servers are launched using the ``launch/launch-node.py`` tool from the git
repository ``https://git.openstack.org/openstack-infra/config``. This tool is repository ``https://git.openstack.org/openstack-infra/system-config``. This
run from a checkout on the puppetmaster - please see :file:`launch/README` for tool is run from a checkout on the puppetmaster - please see :file:`launch/README`
detailed instructions. for detailed instructions.
.. _cinder: .. _cinder:

2
doc/source/third_party.rst
View File

@ -139,7 +139,7 @@ advisable during the initial testing of the setup.
There are several triggers that gerrit will match to alter the There are several triggers that gerrit will match to alter the
formatting of comments. The raw regular expressions can be seen in formatting of comments. The raw regular expressions can be seen in
`gerrit.pp <https://git.openstack.org/cgit/openstack-infra/config/tree/modules/openstack_project/manifests/gerrit.pp>`_. `gerrit.pp <https://git.openstack.org/cgit/openstack-infra/system-config/tree/modules/openstack_project/manifests/gerrit.pp>`_.
For example, to have your test results formatted in the same manner as For example, to have your test results formatted in the same manner as
the upstream Jenkins results, use a template for each result matching:: the upstream Jenkins results, use a template for each result matching::

4
doc/source/wiki.rst
View File

@ -27,8 +27,8 @@ wiki.openstack.org runs off of Wikmedia Foundation deployment branches.
This was done to ease the pain of managing Mediawiki extensions. The This was done to ease the pain of managing Mediawiki extensions. The
foundation branches come with git submodules that refer to known good foundation branches come with git submodules that refer to known good
versions of extensions. Much (but not all) of the configuration is in versions of extensions. Much (but not all) of the configuration is in
puppet in the ``openstack-infra/config`` repository. Mediawiki upgrades puppet in the ``openstack-infra/system-config`` repository. Mediawiki
are currently performed manually. upgrades are currently performed manually.
Mediawiki Upgrades Mediawiki Upgrades
================== ==================