Remove links to github for OpenStack things

Github is not the official reference for OpenStack code repositories,
and as such should not be used in documentation.

Update links that are meant to be links to a project as a whole with
links to the project's documentation.

Update links directly to code to git.openstack.org.

Remove link to tripleo-incubator script for DIB dependencies, as it does
way more than we need to, and the dependencies needed differ between DIB
elements. Instead we leave this as an exercise to the user (this is
documented in the DIB docs).

Change-Id: Iee09b6b86628e46dc5e9436bd0f98a40c50244b7
This commit is contained in:
Jim Rollenhagen 2016-05-26 07:44:37 -04:00
parent 51bb801820
commit abc77b1567
7 changed files with 20 additions and 27 deletions

View File

@ -67,9 +67,9 @@ additional functionality:
- bifrost_; a set of Ansible playbooks that automates the task of deploying a - bifrost_; a set of Ansible playbooks that automates the task of deploying a
base image onto a set of known hardware using ironic. base image onto a set of known hardware using ironic.
.. _ironic-inspector: https://github.com/openstack/ironic-inspector .. _ironic-inspector: http://docs.openstack.org/developer/ironic-inspector/
.. _diskimage-builder: https://github.com/openstack/diskimage-builder .. _diskimage-builder: http://docs.openstack.org/developer/diskimage-builder/
.. _bifrost: https://github.com/openstack/bifrost .. _bifrost: http://docs.openstack.org/developer/bifrost/
.. todo: include coreos-image-builder reference here, once the split is done .. todo: include coreos-image-builder reference here, once the split is done
@ -682,14 +682,7 @@ them to the Image service:
1. The `disk-image-builder`_ can be used to create images required for 1. The `disk-image-builder`_ can be used to create images required for
deployment and the actual OS which the user is going to run. deployment and the actual OS which the user is going to run.
.. _disk-image-builder: https://github.com/openstack/diskimage-builder .. _disk-image-builder: http://docs.openstack.org/developer/diskimage-builder/
*Note:* `tripleo-incubator`_ provides a `script`_ to install all the
dependencies for the disk-image-builder.
.. _tripleo-incubator: https://github.com/openstack/tripleo-incubator
.. _script: https://github.com/openstack/tripleo-incubator/blob/master/scripts/install-dependencies
- Install diskimage-builder package (use virtualenv, if you don't - Install diskimage-builder package (use virtualenv, if you don't
want to install anything globally):: want to install anything globally)::
@ -2231,7 +2224,7 @@ and provide the file or HTTP URL to the Bare Metal service.
For the format of the configuration drive, Bare Metal service expects a For the format of the configuration drive, Bare Metal service expects a
``gzipped`` and ``base64`` encoded ISO 9660 [*]_ file with a ``config-2`` ``gzipped`` and ``base64`` encoded ISO 9660 [*]_ file with a ``config-2``
label. The label. The
`ironic client <https://github.com/openstack/python-ironicclient>`_ `ironic client <http://docs.openstack.org/developer/python-ironicclient/>`_
can generate a configuration drive in the `expected format`_. Just pass a can generate a configuration drive in the `expected format`_. Just pass a
directory path containing the files that will be injected into it via the directory path containing the files that will be injected into it via the
``--config-drive`` parameter of the ``node-set-provision-state`` command, ``--config-drive`` parameter of the ``node-set-provision-state`` command,
@ -2323,7 +2316,7 @@ CoreOS tools
#. Clone the ironic-python-agent_ project:: #. Clone the ironic-python-agent_ project::
git clone https://github.com/openstack/ironic-python-agent git clone https://git.openstack.org/openstack/ironic-python-agent
#. Install the requirements:: #. Install the requirements::
@ -2586,5 +2579,5 @@ following command.
$ ironic node-set-maintenance $NODE_UUID off $ ironic node-set-maintenance $NODE_UUID off
.. _diskimage-builder: https://github.com/openstack/diskimage-builder .. _diskimage-builder: http://docs.openstack.org/developer/diskimage-builder/
.. _ironic-python-agent: https://github.com/openstack/ironic-python-agent .. _ironic-python-agent: http://docs.openstack.org/developer/ironic-python-agent/

View File

@ -23,8 +23,8 @@ client module for in-band inspection service, which was previously part of
**ironic-discoverd** package. Ironic Liberty supports **ironic-discoverd** **ironic-discoverd** package. Ironic Liberty supports **ironic-discoverd**
service, but does not support its in-tree client module. Please refer to service, but does not support its in-tree client module. Please refer to
`ironic-inspector version support matrix `ironic-inspector version support matrix
<https://github.com/openstack/ironic-inspector#version-support-matrix>`_ for <http://docs.openstack.org/developer/ironic-inspector/install.html#version-support-matrix>`_
details on which Ironic version can work with which for details on which Ironic version can work with which
**ironic-inspector**/**ironic-discoverd** version. **ironic-inspector**/**ironic-discoverd** version.
It's also highly recommended that you switch to using **ironic-inspector**, It's also highly recommended that you switch to using **ironic-inspector**,
@ -38,7 +38,7 @@ The discoverd to inspector upgrade procedure:
#. (Recommended) update the **ironic-inspector** configuration file to stop #. (Recommended) update the **ironic-inspector** configuration file to stop
using deprecated configuration options, as marked by the comments in the using deprecated configuration options, as marked by the comments in the
`example.conf `example.conf
<https://github.com/openstack/ironic-inspector/blob/master/example.conf>`_. <https://git.openstack.org/cgit/openstack/ironic-inspector/tree/example.conf>`_.
The file name is provided on command line when starting The file name is provided on command line when starting
**ironic-discoverd**, and the previously recommended default was **ironic-discoverd**, and the previously recommended default was

View File

@ -122,6 +122,6 @@ driver actions such as take-over or clean-up.
.. _BaseDriver: ../api/ironic.drivers.base.html#ironic.drivers.base.BaseDriver .. _BaseDriver: ../api/ironic.drivers.base.html#ironic.drivers.base.BaseDriver
.. _Conductor service: ../api/ironic.conductor.manager.html .. _Conductor service: ../api/ironic.conductor.manager.html
.. _DB API: ../api/ironic.db.api.html .. _DB API: ../api/ironic.db.api.html
.. _diskimage-builder: https://github.com/openstack/diskimage-builder .. _diskimage-builder: http://docs.openstack.org/developer/diskimage-builder/
.. _consistent hashing algorithm: ../api/ironic.common.hash_ring.html .. _consistent hashing algorithm: ../api/ironic.common.hash_ring.html
.. _periodic: http://docs.openstack.org/developer/futurist/api.html#futurist.periodics.periodic .. _periodic: http://docs.openstack.org/developer/futurist/api.html#futurist.periodics.periodic

View File

@ -53,7 +53,7 @@ Wiki
http://wiki.openstack.org/Ironic http://wiki.openstack.org/Ironic
Code Hosting Code Hosting
https://github.com/openstack/ironic https://git.openstack.org/cgit/openstack/ironic
Code Review Code Review
https://review.openstack.org/#/q/status:open+project:openstack/ironic,n,z https://review.openstack.org/#/q/status:open+project:openstack/ironic,n,z

View File

@ -348,13 +348,13 @@ station. Deploying Ironic with DevStack requires a machine running Ubuntu
Devstack will no longer create the user 'stack' with the desired Devstack will no longer create the user 'stack' with the desired
permissions, but does provide a script to perform the task:: permissions, but does provide a script to perform the task::
git clone https://github.com/openstack-dev/devstack.git devstack git clone https://git.openstack.org/openstack-dev/devstack.git devstack
sudo ./devstack/tools/create-stack-user.sh sudo ./devstack/tools/create-stack-user.sh
Switch to the stack user and clone DevStack:: Switch to the stack user and clone DevStack::
sudo su - stack sudo su - stack
git clone https://github.com/openstack-dev/devstack.git devstack git clone https://git.openstack.org/openstack-dev/devstack.git devstack
Create devstack/local.conf with minimal settings required to enable Ironic. Create devstack/local.conf with minimal settings required to enable Ironic.
You can use either of two drivers for deploy: pxe_* or agent_*, see :ref:`IPA` You can use either of two drivers for deploy: pxe_* or agent_*, see :ref:`IPA`
@ -560,7 +560,7 @@ First, navigate to Tempest directory::
cd /opt/stack/tempest cd /opt/stack/tempest
To run all tests from the `Ironic plugin To run all tests from the `Ironic plugin
<https://github.com/openstack/ironic/tree/master/ironic_tempest_plugin>`_, <https://git.openstack.org/cgit/openstack/ironic/tree/ironic_tempest_plugin?h=master>`_,
execute the following command:: execute the following command::
tox -e all-plugin -- ironic tox -e all-plugin -- ironic

View File

@ -112,4 +112,4 @@ boot an instance on it:
References References
========== ==========
.. [1] Python-seamicroclient - https://pypi.python.org/pypi/python-seamicroclient .. [1] Python-seamicroclient - https://pypi.python.org/pypi/python-seamicroclient
.. [2] DiskImage-Builder - https://github.com/openstack/diskimage-builder .. [2] DiskImage-Builder - http://docs.openstack.org/developer/diskimage-builder/

View File

@ -301,9 +301,9 @@ class GlanceImageService(base_image_service.BaseImageService,
def _get_swift_container(self, image_id): def _get_swift_container(self, image_id):
"""Get the Swift container the image is stored in. """Get the Swift container the image is stored in.
Code based on: https://github.com/openstack/glance_store/blob/3cd690b3 Code based on: http://git.openstack.org/cgit/openstack/glance_store/
7dc9d935445aca0998e8aec34a3e3530/glance_store/ tree/glance_store/_drivers/swift/
_drivers/swift/store.py#L725 store.py?id=3cd690b37dc9d935445aca0998e8aec34a3e3530#n725
Returns appropriate container name depending upon value of Returns appropriate container name depending upon value of
``swift_store_multiple_containers_seed``. In single-container mode, ``swift_store_multiple_containers_seed``. In single-container mode,