openstack
/
sahara
Code Issues Proposed changes

Merge "doc: point to the main git repository and update links" into stable/pike

This commit is contained in:
Jenkins 2017-08-23 13:31:11 +00:00 committed by Gerrit Code Review
parent 590e9f0973 83c2f01a09
commit 30a3b8b588
15 changed files with 27 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/admin/advanced-configuration-guide.rst
View File

@ -517,7 +517,7 @@ installed. The sources for this plugin can be found in the
integration see the sahara documentation sections
:ref:`diskimage-builder-label` and :ref:`swift-integration-label`.
.. _Sahara extra repository: http://github.com/openstack/sahara-extra
.. _Sahara extra repository: http://git.openstack.org/cgit/openstack/sahara-extra
.. _volume_instance_locality_configuration:

2
doc/source/contributor/apiv2.rst
View File

@ -79,7 +79,7 @@ project identifier in a header named ``OpenStack-Project-ID``::
X-Auth-Token: {valid auth token}
OpenStack-Project-ID: 12345678-1234-1234-1234-123456789ABC
Using a tool like `HTTPie <https://github.com/jkbrzt/httpie>`_, the
Using a tool like `HTTPie <https://httpie.org/>`_, the
same request could be made like this::
$ httpie http://{sahara service ip:port}/v2/clusters \

2
doc/source/contributor/development-environment.rst
View File

@ -52,7 +52,7 @@ On openSUSE-based distributions (SLES 12, openSUSE, Factory or Tumbleweed):
.. sourcecode:: console
$ git clone git://github.com/openstack/sahara.git
$ git clone git://git.openstack.org/openstack/sahara.git
$ cd sahara
3. Generate Sahara sample using tox

2
doc/source/contributor/development-guidelines.rst
View File

@ -125,7 +125,7 @@ running ``tox -e docs`` first time):
.. _PEP 8: http://www.python.org/dev/peps/pep-0008/
.. _bashate: https://github.com/openstack-dev/bashate
.. _bashate: https://git.openstack.org/cgit/openstack-dev/bashate
.. _PEP 257: http://www.python.org/dev/peps/pep-0257/
.. _Tox: http://tox.testrun.org/
.. _Sphinx: http://sphinx.pocoo.org/markup/index.html

9
doc/source/contributor/how-to-participate.rst
View File

@ -4,11 +4,8 @@ How to Participate
Getting started
---------------
* Create an account on `Github <https://github.com/openstack/sahara>`_
(if you don't have one)
* Make sure that your local git is properly configured by executing
``git config --list``. If not, configure ``user.name``, ``user.email``
* Make sure that your local git is properly configured by executing
``git config --list``. If not, configure ``user.name``, ``user.email``
* Create account on `Launchpad <https://launchpad.net/sahara>`_
(if you don't have one)
@ -54,7 +51,7 @@ How to stay in touch with the community
How to post your first patch for review
---------------------------------------
* Checkout Sahara code from `Github <https://github.com/openstack/sahara>`_
* Checkout Sahara code from `its repository <https://git.openstack.org/cgit/openstack/sahara>`_
* Carefully read http://docs.openstack.org/infra/manual/developers.html#development-workflow

4
doc/source/install/dashboard-guide.rst
View File

@ -5,7 +5,7 @@ After installing the Sahara dashboard, there are a few extra configurations
that can be made.
Dashboard configurations are applied through Horizon's local_settings.py file.
The sample configuration file is available `here. <https://github.com/openstack/horizon/blob/master/openstack_dashboard/local/local_settings.py.example>`_
The sample configuration file is available `from the Horizon repository. <https://git.openstack.org/cgit/openstack/horizon/tree/openstack_dashboard/local/local_settings.py.example>`_
1. Networking
-------------
@ -54,7 +54,7 @@ Local endpoint example:
..
Then the endpoint name should be changed in ``sahara.py`` under the module of
`sahara-dashboard/sahara_dashboard/api/sahara.py. <https://github.com/openstack/sahara-dashboard/blob/master/sahara_dashboard/api/sahara.py>`_
`sahara-dashboard/sahara_dashboard/api/sahara.py. <https://git.openstack.org/cgit/openstack/sahara-dashboard/tree/sahara_dashboard/api/sahara.py>`_
.. sourcecode:: python

2
doc/source/user/ambari-plugin.rst
View File

@ -26,7 +26,7 @@ Images
The sahara Ambari plugin is using minimal (operating system only) images.
For more information about Ambari images, refer to
https://github.com/openstack/sahara-image-elements.
`<https://git.openstack.org/cgi/openstack/sahara-image-elements>`_.
You could download well tested and up-to-date prepared images from
http://sahara-files.mirantis.com/images/upstream/

8
doc/source/user/cdh-imagebuilder.rst
View File

@ -8,14 +8,14 @@ images with Cloudera Express (now only versions {5.0.0, 5.3.0 5.4.0, 5.5.0,
5.7.x, 5.9.x} are supported).
To simplify the task of building such images we use
`Disk Image Builder <https://github.com/openstack/diskimage-builder>`_.
`Disk Image Builder <https://git.openstack.org/cgit/openstack/diskimage-builder>`_.
`Disk Image Builder` builds disk images using elements. An element is a
particular set of code that alters how the image is built, or runs within the
chroot to prepare the image.
Elements for building Cloudera images are stored in
`Sahara extra repository <https://github.com/openstack/sahara-image-elements>`_
`Sahara extra repository <https://git.openstack.org/cgit/openstack/sahara-image-elements>`_
.. note::
@ -27,7 +27,7 @@ Elements for building Cloudera images are stored in
To create cloudera images follow these steps:
1. Clone repository "https://github.com/openstack/sahara-image-elements" locally.
1. Clone repository "https://git.openstack.org/cgit/openstack/sahara-image-elements" locally.
2. Use tox to build images.
@ -86,4 +86,4 @@ To create cloudera images follow these steps:
For finer control of diskimage-create.sh see the `official documentation
<https://github.com/openstack/sahara-image-elements/blob/master/diskimage-create/README.rst>`_
<https://git.openstack.org/cgit/openstack/sahara-image-elements/tree/diskimage-create/README.rst>`_

2
doc/source/user/edp.rst
View File

@ -482,7 +482,7 @@ If configuration values are specified, they must be added to the job's
Hadoop configuration at runtime. There are two methods of doing this. The
simplest way is to use the **edp.java.adapt_for_oozie** option described
below. The other method is to use the code from
`this example <https://github.com/openstack/sahara/blob/master/etc/edp-examples/edp-java/README.rst>`_
`this example <https://git.openstack.org/cgit/openstack/sahara-tests/tree/sahara_tests/scenario/defaults/edp-examples/edp-java/README.rst>`_
to explicitly load the values.
The following special configuration values are read by sahara and affect how

2
doc/source/user/hadoop-swift.rst
View File

@ -12,7 +12,7 @@ the most current features enabled.
https://issues.apache.org/jira/browse/HADOOP-8545
* The most current Sahara maintained version of this patch can be found in the
Sahara Extra repository https://github.com/openstack/sahara-extra
`Sahara Extra repository <https://git.openstack.org/cgit/openstack/sahara-extra>`_
* The latest compiled version of the jar for this component can be downloaded
from http://tarballs.openstack.org/sahara/dist/hadoop-openstack/master/

2
doc/source/user/mapr-plugin.rst
View File

@ -31,7 +31,7 @@ put a burden on the network as packages for all nodes need to be downloaded
from the package repository.
For more information about MapR images, refer to
https://github.com/openstack/sahara-image-elements.
`<https://git.openstack.org/cgit/openstack/sahara-image-elements>`_.
There are VM images provided for use with the MapR Plugin, that can also be
built using the tools available in sahara-image-elements:

4
doc/source/user/quickstart.rst
View File

@ -89,7 +89,7 @@ Upload the image downloaded above into the OpenStack Image service:
OR
* Build the image using: `diskimage-builder script <https://github.com/openstack/sahara-image-elements/blob/master/diskimage-create/README.rst>`_
* Build the image using: `diskimage-builder script <https://git.openstack.org/cgit/openstack/sahara-image-elements/tree/diskimage-create/README.rst>`_
Remember the image name or save the image ID. This will be used during the
image registration with sahara. You can get the image ID using the
@ -259,7 +259,7 @@ the template below.
Sample templates can be found here:
`Sample Templates <https://github.com/openstack/sahara/tree/master/sahara/plugins/default_templates/>`_
`Sample Templates <https://git.openstack.org/cgit/openstack/sahara/tree/sahara/plugins/default_templates/>`_
Create a file named ``my_master_template_create.json`` with the following
content:

2
doc/source/user/sahara-on-ironic.rst
View File

@ -20,7 +20,7 @@ from the bare metal performance with self-service resource provisioning.
4. Build the Sahara image and prepare it for uploading to Glance:
- Build an image for Sahara plugin with the ``-b`` flag. Use sahara image elements
when building the image. See `<https://github.com/openstack/sahara-image-elements>`_
when building the image. See `<https://git.openstack.org/cgit/openstack/sahara-image-elements>`_
- Convert the qcow2 image format to the raw format. For example:

2
doc/source/user/spark-plugin.rst
View File

@ -14,7 +14,7 @@ For cluster provisioning, prepared images should be used. The Spark plugin
has been developed and tested with the images generated by
sahara-image-elements:
* https://github.com/openstack/sahara-image-elements
* https://git.openstack.org/cgit/openstack/sahara-image-elements
The latest Ubuntu images generated by sahara-image-elements have Cloudera
CDH 5.4.0 HDFS and Apache Spark installed. A prepared image for Spark can be

12
doc/source/user/vanilla-imagebuilder.rst
View File

@ -8,14 +8,14 @@ CentOS images with Apache Hadoop version 2.x.x.
As of now the vanilla plugin works with images with pre-installed versions of
Apache Hadoop. To simplify the task of building such images we use
`Disk Image Builder <https://github.com/openstack/diskimage-builder>`_.
`Disk Image Builder <https://git.openstack.org/cgit/openstack/diskimage-builder>`_.
`Disk Image Builder` builds disk images using elements. An element is a
particular set of code that alters how the image is built, or runs within the
chroot to prepare the image.
Elements for building vanilla images are stored in the
`Sahara image elements repository <https://github.com/openstack/sahara-image-elements>`_
`Sahara image elements repository <https://git.openstack.org/cgit/openstack/sahara-image-elements>`_
.. note::
@ -28,7 +28,7 @@ Elements for building vanilla images are stored in the
To create vanilla images follow these steps:
1. Clone repository "https://github.com/openstack/sahara-image-elements"
1. Clone repository "https://git.openstack.org/cgit/openstack/sahara-image-elements"
locally.
2. Use tox to build images.
@ -49,8 +49,8 @@ To create vanilla images follow these steps:
tox -e venv -- sahara-image-create -p vanilla -v 2.7.1 -i centos7
Tox will create a virtualenv and install required python packages in it,
clone the repositories "https://github.com/openstack/diskimage-builder" and
"https://github.com/openstack/sahara-image-elements" and export necessary
clone the repositories "https://git.openstack.org/cgit/openstack/diskimage-builder" and
"https://git.openstack.org/cgit/openstack/sahara-image-elements" and export necessary
parameters.
* ``DIB_HADOOP_VERSION`` - version of Hadoop to install
@ -92,4 +92,4 @@ To create vanilla images follow these steps:
For finer control of diskimage-create.sh see the `official documentation
<https://github.com/openstack/sahara-image-elements/blob/master/diskimage-create/README.rst>`_
<https://git.openstack.org/cgit/openstack/sahara-image-elements/tree/diskimage-create/README.rst>`_