mirror of
https://github.com/clearlinux/clear-linux-documentation.git
synced 2026-09-04 04:41:36 +00:00
cleanup table views add detail to index
This commit is contained in:
Leona
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
@@ -1,4 +0,0 @@
|
||||
# Sphinx build info version 1
|
||||
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
|
||||
config: a4b5d0b7716605b8ac63fc8c986b086d
|
||||
tags: 645f666f9bcd5a90fca523b33c5a78b7
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 113 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 42 KiB |
@@ -1,7 +0,0 @@
|
||||
List of bundles
|
||||
############################################################
|
||||
|
||||
This is a list of the basic bundles in Clear Linux* OS for Intel® Architecture:
|
||||
|
||||
|
||||
.. include:: bundles_in_clr_html.rst
|
||||
@@ -1,25 +0,0 @@
|
||||
Bundle overview
|
||||
############################################################
|
||||
|
||||
Linux-based operating systems contain the code of several hundred, if
|
||||
not thousands, of open source projects. To make this manageable,
|
||||
distributions use a concept called "packages" to configure and compile
|
||||
the source code of these projects into binaries.
|
||||
|
||||
Many distributions then split the content of these compiled packages
|
||||
into so-called sub-packages, which are the granularity at which these
|
||||
distributions deploy their software. With those kinds of distributions,
|
||||
system administrators can then install and update sub-packages
|
||||
individually or as a set, using tools such as "yum" and "apt-get."
|
||||
|
||||
The Clear Linux* OS for Intel® Architecture does things a bit differently. While we also use the
|
||||
concept of packages to manage compiling source code into binaries, we do
|
||||
not use the package concept to deploy software. Instead, we provide
|
||||
"bundles" that provide a set of functionality to the system
|
||||
administrator, independent of how many and which pieces of the upstream
|
||||
open source projects are needed for this functionality. The diagram
|
||||
below gives an overall picture of it.
|
||||
|
||||
.. image:: _static/images/bundles_overview.png
|
||||
:align: center
|
||||
:alt: confirmation
|
||||
@@ -1,10 +0,0 @@
|
||||
.. _disclaimers:
|
||||
|
||||
|
||||
.. rubric:: Disclaimer
|
||||
|
||||
.. important::
|
||||
This documentation is a work in progress and is being provided for
|
||||
informative purposes only. Because it is a work in progress, there are
|
||||
parts that are either missing or will be revised as code development
|
||||
continues.
|
||||
@@ -1,12 +0,0 @@
|
||||
Copyright © 2015 Intel Corporation
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<a rel="license"
|
||||
href="http://creativecommons.org/licenses/by/4.0/"><img
|
||||
alt="Creative Commons License" style="border-width:0"
|
||||
src="https://i.creativecommons.org/l/by/4.0/88x31.png" /></a><br
|
||||
/>This work is licensed under a <a rel="license"
|
||||
href="http://creativecommons.org/licenses/by/4.0/">Creative Commons
|
||||
Attribution 4.0 International License</a>
|
||||
|
||||
@@ -1,75 +0,0 @@
|
||||
.. _gs-clear-containers-gettting-started:
|
||||
|
||||
Clear Containers getting started guide
|
||||
######################################
|
||||
|
||||
Clear Containers for Docker* Engine is now available on multiple
|
||||
operating systems. This enables executing existing Docker applications
|
||||
in the secure and fast Clear Containers environment.
|
||||
|
||||
Binary packages
|
||||
===============
|
||||
|
||||
The primary host platform is Clear Linux* Project for Intel® Architecture, version 4000
|
||||
or better. However, binaries for a range of operating systems are available from:
|
||||
|
||||
- https://software.opensuse.org/download.html?project=home%3Aclearlinux%3Apreview&package=clear-containers-docker
|
||||
|
||||
Currently experimental builds are available for:
|
||||
|
||||
- CentOS*, Scientific Linux* 7
|
||||
- Fedora* 21, 22
|
||||
- openSUSE* 13.1, 13.2, Tumbleweed
|
||||
- SUSE* Linux Enterprise 12
|
||||
- Debian* 8.0
|
||||
- Ubuntu* 15.04
|
||||
|
||||
If you have any feedback, please mail it to the dev@lists.clearlinux.org mailing list.
|
||||
Subscription to this list is available at: https://lists.clearlinux.org/mailman/listinfo/dev.
|
||||
|
||||
Installation instructions
|
||||
=========================
|
||||
|
||||
Using hosts other than Clear Linux OS for Intel Architecture
|
||||
------------------------------------------------------------
|
||||
|
||||
If you are *not* using Clear Linux OS for Intel Architecture, follow the instructions below:
|
||||
|
||||
#. Visit the link below, and select your operating system by clicking the appropriate icon:
|
||||
https://software.opensuse.org/download.html?project=home%3Aclearlinux%3Apreview&package=clear-containers-docker
|
||||
|
||||
#. Follow the brief instructions shown.
|
||||
|
||||
#. Reload your systemd configuration::
|
||||
|
||||
$ sudo systemctl daemon-reload
|
||||
|
||||
#. Start the Docker service::
|
||||
|
||||
$ systemctl restart docker
|
||||
|
||||
Using Clear Linux OS for Intel Architecture as Host
|
||||
---------------------------------------------------
|
||||
|
||||
If you are running Clear Linux OS for Intel Architecture on your host system, follow the
|
||||
instructions below:
|
||||
|
||||
#. Enable the repository by running the following as the ``root`` user::
|
||||
|
||||
# clr_bundle_add containers-basic
|
||||
|
||||
#. Reload your systemd configuration::
|
||||
|
||||
$ sudo systemctl daemon-reload
|
||||
|
||||
#. Start the Docker service::
|
||||
|
||||
$ systemctl restart docker
|
||||
|
||||
Source Code
|
||||
===========
|
||||
|
||||
The experimental source code is based on the Docker version 1.8.1 upstream release and is available at:
|
||||
|
||||
- https://github.com/clearlinux/docker
|
||||
|
||||
@@ -1,69 +0,0 @@
|
||||
.. _gs_creating_bootable_usb:
|
||||
|
||||
Creating a bootable USB to install the OS
|
||||
##########################################
|
||||
|
||||
Here's how to create a USB drive that initiates the process for
|
||||
:ref:`gs_installing_clr_as_host`. Alternatively, you can test the
|
||||
OS by :ref:`gs_running_clr_virtual`.
|
||||
|
||||
|
||||
What you need
|
||||
=============
|
||||
|
||||
* A USB stick, formatted as ``ext4``. Remember that the process of flashing
|
||||
data to a USB completely deletes the contents of the drive; as always, run
|
||||
``dd`` with caution.
|
||||
* A ClearLinux OS image; the most current version can be found here:
|
||||
`https://download.clearlinux.org/image <https://download.clearlinux.org/image>`_
|
||||
|
||||
.. tip::
|
||||
|
||||
For older versions, see our `downloads page <https://download.clearlinux.org/>`_.
|
||||
|
||||
|
||||
Download and checksum
|
||||
=====================
|
||||
|
||||
::
|
||||
|
||||
$ wget https://download.clearlinux.org/image/clear-[release_number]-installer.img.xz
|
||||
$ sha512sum clear-[release_number]-installer.img.xz`
|
||||
|
||||
Confirm the mount point on the USB drive
|
||||
========================================
|
||||
|
||||
Using ``$ lsblk`` is helpful to show the block-level devices; a USB drive
|
||||
usually shows up under ``/sdb`` or ``/sdc`` (almost never ``/sda``), and should
|
||||
indicate disk space approximately the size of the USB drive::
|
||||
|
||||
$ lsblk /dev/sdb
|
||||
NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT
|
||||
?? sdb 8:16 1 14.9G 0
|
||||
?? sdb1 8:17 1 14.9G 0 part
|
||||
|
||||
and make sure the drive isn't already mounted. The easiest way is with::
|
||||
|
||||
# df
|
||||
|
||||
Flash the image to the USB
|
||||
==========================
|
||||
|
||||
Flash the image with the following command, adding the ``-v`` option for verbose mode
|
||||
(recommended), as the image file may be large, and the process can take a while. This
|
||||
may need to be done as root::
|
||||
|
||||
$ xzcat -v clear-[release_number]-installer.img.xz | dd of=/dev/sdb bs=4M
|
||||
|
||||
Wait for the final confirmation
|
||||
===============================
|
||||
|
||||
This example shows ``clear-2190-installer.img.xz`` flashed to a 16GB USB drive
|
||||
mounted on ``/sdc``.
|
||||
|
||||
.. image:: _static/images/gs_confirmation_screen.png
|
||||
:align: center
|
||||
:alt: confirmation
|
||||
|
||||
Success! Your USB stick is now ready to boot and initiate the process for
|
||||
:ref:`gs_installing_clr_as_host`.
|
||||
@@ -1,11 +0,0 @@
|
||||
.. _gs_getting_started:
|
||||
|
||||
Getting started with Clear Linux* OS for Intel® Architecture
|
||||
############################################################
|
||||
|
||||
The easiest way to give Clear Linux OS for Intel Architecture a spin is to download a
|
||||
recent KVM image from the `image directory <http://download.clearlinux.org/image/>`_
|
||||
on our download page. This directory contains a current image, the UEFI firmware
|
||||
helper and the KVM start helper script. See :ref:`gs_running_clr_virtual` for details.
|
||||
|
||||
You can also :ref:`gs_installing_clr_as_host` on a target computer.
|
||||
@@ -1,38 +0,0 @@
|
||||
.. _gs_installing_clr_as_host:
|
||||
|
||||
Installing the OS as host
|
||||
##########################################################
|
||||
|
||||
Running Clear Linux* OS for Intel® Architecture natively on a system is easy
|
||||
with the simple installer image. To get started you'll need the following:
|
||||
|
||||
* A USB stick flashed with the `installer image <http://download.clearlinux.org/image/>`_.
|
||||
For instructions on how to do this, see :ref:`gs_creating_bootable_usb`.
|
||||
* Host machine running :ref:`gs_supported_hardware`.
|
||||
* Network access via DHCP.
|
||||
|
||||
Installing Clear Linux OS for Intel Architecture to a target system
|
||||
===================================================================
|
||||
|
||||
1. Configure the BIOS; this may involve changing the boot device order
|
||||
to boot first from the USB device.
|
||||
2. Insert the USB device that is flashed with the
|
||||
`installer image <http://download.clearlinux.org/image/>`_ into the
|
||||
target system, then reboot. As the system boots, you'll see::
|
||||
|
||||
Clear Linux OS for Intel Architecture installation in progress... Your
|
||||
computer will power off once installation completes successfully.
|
||||
|
||||
The entire installation should take no more than a few minutes. If you run into
|
||||
any trouble, log in as root during the installation phase and check the status
|
||||
of the install with::
|
||||
|
||||
$ systemctl status ister
|
||||
|
||||
You might need to switch to another TTY.
|
||||
|
||||
For feedback on installation or other topics, please feel free to write in to our
|
||||
`mailing list <https://lists.clearlinux.org/mailman/listinfo/dev>`_.
|
||||
|
||||
Note: You can also :ref:`gs_running_clr_virtual`.
|
||||
|
||||
@@ -1,67 +0,0 @@
|
||||
.. _gs_running_clr_virtual:
|
||||
|
||||
Running in a virtualized environment
|
||||
##########################################################################
|
||||
|
||||
The easiest way to get started running Clear Linux* OS for Intel® Architecture in a virtualized
|
||||
environment is to download a recent KVM image from the `image
|
||||
directory <http://download.clearlinux.org/image/>`_. This directory
|
||||
contains an image file, the UEFI firmware helper and the KVM start
|
||||
helper script.
|
||||
|
||||
Starter script
|
||||
==============
|
||||
|
||||
To start the image, run the ``start_qemu.sh`` script from
|
||||
`here <http://download.clearlinux.org/image/start_qemu.sh>`_, or modify
|
||||
the following script for your needs and run it from the command line
|
||||
with ``$ script clr_image``::
|
||||
|
||||
#!/bin/bash
|
||||
if [ $# -eq 0 ] ; then
|
||||
echo "Please provide an image to emulate as first argument"
|
||||
exit 1
|
||||
fi
|
||||
image=$1
|
||||
shift
|
||||
# FIXME: Add a proper MAC address
|
||||
macaddr=XX:XX:XX:XX:XX:XX
|
||||
qemu-system-x86_64 \
|
||||
-usb -device usb-kbd \
|
||||
-cpu qemu64,+vmx \
|
||||
-enable-kvm \
|
||||
-m 512m -bios OVMF.fd \
|
||||
-drive file="$image",index=0,if=ide \
|
||||
-net nic,model=e1000,macaddr=$macaddr \
|
||||
-net user,hostfwd=tcp::2223-:22 \
|
||||
-monitor stdio "$@"
|
||||
|
||||
To run this script, connect from host via SSH. Take note that SSH is not
|
||||
enabled by default. To enable it, log in through serial console with the
|
||||
username ``root``. After setting the password, enable root login via SSH
|
||||
by configuring ``/etc/ssh/sshd_config`` with this content::
|
||||
|
||||
PermitRootLogin yes
|
||||
|
||||
Now you may connect from host via SSH through 2223::
|
||||
|
||||
$ ssh -p 2223 root@localhost
|
||||
|
||||
Alternately, there are a few other ways to approach this.
|
||||
|
||||
- To run the script without modifying its permissions::
|
||||
|
||||
$ bash start_qemu.sh clr_image
|
||||
|
||||
- To run it as a background process::
|
||||
|
||||
$ `bash start_qemu.sh clr_image` &
|
||||
|
||||
- If you'd like to run the script with execute permission::
|
||||
|
||||
$ chmod +x start_qemu.sh
|
||||
$ ./start_qemu.sh clr_image
|
||||
|
||||
- And to run it as a background process::
|
||||
|
||||
$ `./start_qemu.sh clr_image` &
|
||||
@@ -1,11 +0,0 @@
|
||||
.. _gs_supported_hardware:
|
||||
|
||||
Supported hardware
|
||||
##################
|
||||
|
||||
The following processors have been tested with Clear Linux* OS for Intel® Architecture:
|
||||
|
||||
- 4th Generation Intel® Core™ processor family on the system of
|
||||
your choice.
|
||||
- Intel® Xeon® Processor E5 v3 processor family on the server of
|
||||
your choice.
|
||||
@@ -1,100 +0,0 @@
|
||||
.. ClearLinux Documentation documentation master file, created by
|
||||
sphinx-quickstart on Fri Nov 13 12:23:35 2015.
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
|
||||
Welcome to ClearLinux Documentation
|
||||
===================================
|
||||
|
||||
Contents:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
..
|
||||
Clear Linux Project documentation master file
|
||||
|
||||
|
||||
.. include:: documentation_license.rst
|
||||
|
||||
|
||||
Getting started
|
||||
###############
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
gs_getting_started
|
||||
gs_supported_hardware
|
||||
gs_creating_bootable_usb
|
||||
gs_installing_clr_as_host
|
||||
gs_running_clr_virtual
|
||||
gs-clear-containers-gettting-started
|
||||
|
||||
Software update
|
||||
###############
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
swupdate_about_sw_update
|
||||
swupdate_how_to_run_the_updater
|
||||
|
||||
Bundles
|
||||
#######
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
bundles_overview
|
||||
bundles_in_clr
|
||||
bundles_in_clr_html
|
||||
|
||||
|
||||
OpenStack``*`` implementation
|
||||
#############################
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
openstack_use_cases
|
||||
openstack_bundle_and_service_summary
|
||||
openstack_sys_req_and_pw_summary
|
||||
openstack_installing_bundles
|
||||
openstack_environment-database
|
||||
openstack_environment-messaging
|
||||
openstack_identity
|
||||
openstack_identity-openrc
|
||||
openstack_image
|
||||
openstack_compute
|
||||
openstack_block_storage
|
||||
openstack_dashboard
|
||||
openstack_networking
|
||||
openstack_orchestration
|
||||
openstack_telemetry
|
||||
openstack_object_storage
|
||||
openstack_supporting-database
|
||||
openstack_supporting-messaging
|
||||
|
||||
|
||||
Disclaimers
|
||||
===========
|
||||
disclaimers
|
||||
|
||||
|
||||
Index and search
|
||||
################
|
||||
|
||||
* :ref:`genindex`
|
||||
|
||||
* :ref:`search`
|
||||
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
|
||||
@@ -1,479 +0,0 @@
|
||||
.. _openstack_block_storage:
|
||||
|
||||
Block Storage
|
||||
########################
|
||||
|
||||
The OpenStack Block Storage service (cinder) adds persistent storage to
|
||||
a virtual machine. Block Storage provides an infrastructure for managing
|
||||
volumes, and interacts with OpenStack Compute to provide volumes for
|
||||
instances. The service also enables management of volume snapshots, and
|
||||
volume types.
|
||||
|
||||
Install and configure controller node
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
This section describes how to install and configure the Block
|
||||
Storage service, code-named cinder, on the controller node. This
|
||||
service requires at least one additional storage node that provides
|
||||
volumes to instances.
|
||||
|
||||
Prerequisites:
|
||||
--------------
|
||||
|
||||
Before you install and configure the Block Storage service, you
|
||||
|
||||
#. To create the database, complete these steps:
|
||||
|
||||
* Use the database access client to connect to the database
|
||||
server as the ``root`` user::
|
||||
|
||||
$ mysql -u root -p
|
||||
|
||||
* Create the ``cinder`` database::
|
||||
|
||||
CREATE DATABASE cinder;
|
||||
|
||||
* Grant proper access to the ``cinder`` database::
|
||||
|
||||
GRANT ALL PRIVILEGES ON cinder.* TO 'cinder'@'localhost' \
|
||||
IDENTIFIED BY 'CINDER_DBPASS';
|
||||
GRANT ALL PRIVILEGES ON cinder.* TO 'cinder'@'%' \
|
||||
IDENTIFIED BY 'CINDER_DBPASS';
|
||||
|
||||
Replace ``CINDER_DBPASS`` with a suitable password.
|
||||
|
||||
* Exit the database access client.
|
||||
|
||||
#. Source the ``admin`` credentials to gain access to admin-only
|
||||
CLI commands::
|
||||
|
||||
$ source admin-openrc.sh
|
||||
|
||||
#. To create the service credentials, complete these steps:
|
||||
|
||||
* Create a ``cinder`` user::
|
||||
|
||||
$ openstack user create --domain default --password-prompt cinder
|
||||
User Password:
|
||||
Repeat User Password:
|
||||
+-----------+----------------------------------+
|
||||
| Field | Value |
|
||||
+-----------+----------------------------------+
|
||||
| domain_id | default |
|
||||
| enabled | True |
|
||||
| id | bb279f8ffc444637af38811a5e1f0562 |
|
||||
| name | cinder |
|
||||
+-----------+----------------------------------+
|
||||
|
||||
* Add the ``admin`` role to the ``cinder`` user::
|
||||
|
||||
$ openstack role add --project service --user cinder admin
|
||||
|
||||
* Create the ``cinder`` and ``cinderv2`` service entities::
|
||||
|
||||
$ openstack service create --name cinder \
|
||||
--description "OpenStack Block Storage" volume
|
||||
+-------------+----------------------------------+
|
||||
| Field | Value |
|
||||
+-------------+----------------------------------+
|
||||
| description | OpenStack Block Storage |
|
||||
| enabled | True |
|
||||
| id | ab3bbbef780845a1a283490d281e7fda |
|
||||
| name | cinder |
|
||||
| type | volume |
|
||||
+-------------+----------------------------------+
|
||||
|
||||
$ openstack service create --name cinderv2 \
|
||||
--description "OpenStack Block Storage" volumev2
|
||||
+-------------+----------------------------------+
|
||||
| Field | Value |
|
||||
+-------------+----------------------------------+
|
||||
| description | OpenStack Block Storage |
|
||||
| enabled | True |
|
||||
| id | eb9fd245bdbc414695952e93f29fe3ac |
|
||||
| name | cinderv2 |
|
||||
| type | volumev2 |
|
||||
+-------------+----------------------------------+
|
||||
|
||||
.. note::
|
||||
|
||||
The Block Storage services requires two service entities.
|
||||
|
||||
#. Create the Block Storage service API endpoints::
|
||||
|
||||
$ openstack endpoint create --region RegionOne \
|
||||
volume public http://controller:8776/v1/%\(tenant_id\)s
|
||||
+--------------+-----------------------------------------+
|
||||
| Field | Value |
|
||||
+--------------+-----------------------------------------+
|
||||
| enabled | True |
|
||||
| id | 03fa2c90153546c295bf30ca86b1344b |
|
||||
| interface | public |
|
||||
| region | RegionOne |
|
||||
| region_id | RegionOne |
|
||||
| service_id | ab3bbbef780845a1a283490d281e7fda |
|
||||
| service_name | cinder |
|
||||
| service_type | volume |
|
||||
| url | http://controller:8776/v1/%(tenant_id)s |
|
||||
+--------------+-----------------------------------------+
|
||||
|
||||
$ openstack endpoint create --region RegionOne \
|
||||
volume internal http://controller:8776/v1/%\(tenant_id\)s
|
||||
+--------------+-----------------------------------------+
|
||||
| Field | Value |
|
||||
+--------------+-----------------------------------------+
|
||||
| enabled | True |
|
||||
| id | 94f684395d1b41068c70e4ecb11364b2 |
|
||||
| interface | internal |
|
||||
| region | RegionOne |
|
||||
| region_id | RegionOne |
|
||||
| service_id | ab3bbbef780845a1a283490d281e7fda |
|
||||
| service_name | cinder |
|
||||
| service_type | volume |
|
||||
| url | http://controller:8776/v1/%(tenant_id)s |
|
||||
+--------------+-----------------------------------------+
|
||||
|
||||
$ openstack endpoint create --region RegionOne \
|
||||
volume admin http://controller:8776/v1/%\(tenant_id\)s
|
||||
+--------------+-----------------------------------------+
|
||||
| Field | Value |
|
||||
+--------------+-----------------------------------------+
|
||||
| enabled | True |
|
||||
| id | 4511c28a0f9840c78bacb25f10f62c98 |
|
||||
| interface | admin |
|
||||
| region | RegionOne |
|
||||
| region_id | RegionOne |
|
||||
| service_id | ab3bbbef780845a1a283490d281e7fda |
|
||||
| service_name | cinder |
|
||||
| service_type | volume |
|
||||
| url | http://controller:8776/v1/%(tenant_id)s |
|
||||
+--------------+-----------------------------------------+
|
||||
|
||||
$ openstack endpoint create --region RegionOne \
|
||||
volumev2 public http://controller:8776/v2/%\(tenant_id\)s
|
||||
+--------------+-----------------------------------------+
|
||||
| Field | Value |
|
||||
+--------------+-----------------------------------------+
|
||||
| enabled | True |
|
||||
| id | 513e73819e14460fb904163f41ef3759 |
|
||||
| interface | public |
|
||||
| region | RegionOne |
|
||||
| region_id | RegionOne |
|
||||
| service_id | eb9fd245bdbc414695952e93f29fe3ac |
|
||||
| service_name | cinderv2 |
|
||||
| service_type | volumev2 |
|
||||
| url | http://controller:8776/v2/%(tenant_id)s |
|
||||
+--------------+-----------------------------------------+
|
||||
|
||||
$ openstack endpoint create --region RegionOne \
|
||||
volumev2 internal http://controller:8776/v2/%\(tenant_id\)s
|
||||
+--------------+-----------------------------------------+
|
||||
| Field | Value |
|
||||
+--------------+-----------------------------------------+
|
||||
| enabled | True |
|
||||
| id | 6436a8a23d014cfdb69c586eff146a32 |
|
||||
| interface | internal |
|
||||
| region | RegionOne |
|
||||
| region_id | RegionOne |
|
||||
| service_id | eb9fd245bdbc414695952e93f29fe3ac |
|
||||
| service_name | cinderv2 |
|
||||
| service_type | volumev2 |
|
||||
| url | http://controller:8776/v2/%(tenant_id)s |
|
||||
+--------------+-----------------------------------------+
|
||||
|
||||
$ openstack endpoint create --region RegionOne \
|
||||
volumev2 admin http://controller:8776/v2/%\(tenant_id\)s
|
||||
+--------------+-----------------------------------------+
|
||||
| Field | Value |
|
||||
+--------------+-----------------------------------------+
|
||||
| enabled | True |
|
||||
| id | e652cf84dd334f359ae9b045a2c91d96 |
|
||||
| interface | admin |
|
||||
| region | RegionOne |
|
||||
| region_id | RegionOne |
|
||||
| service_id | eb9fd245bdbc414695952e93f29fe3ac |
|
||||
| service_name | cinderv2 |
|
||||
| service_type | volumev2 |
|
||||
| url | http://controller:8776/v2/%(tenant_id)s |
|
||||
+--------------+-----------------------------------------+
|
||||
|
||||
.. note::
|
||||
|
||||
The Block Storage services requires endpoints for each service
|
||||
entity.
|
||||
|
||||
Install and configure components
|
||||
--------------------------------
|
||||
|
||||
#. Install OpenStack Block Storage Controller bundle::
|
||||
|
||||
# swupd bundle-add openstack-block-storage-controller
|
||||
# swupd verify --fix
|
||||
|
||||
#. Custom configurations will be located at ``/etc/cinder``.
|
||||
|
||||
* Create ``/etc/cinder`` directory::
|
||||
|
||||
mkdir /etc/cinder
|
||||
|
||||
* Create empty cinder configuration file in
|
||||
``/etc/cinder/cinder.conf``::
|
||||
|
||||
touch /etc/cinder/cinder.conf
|
||||
|
||||
#. Edit the ``/etc/cinder/cinder.conf`` file and complete the following
|
||||
actions:
|
||||
|
||||
* In the ``[database]`` section, configure database access. Replace
|
||||
``CINDER_DBPASS`` with the password you chose for the
|
||||
database::
|
||||
|
||||
[database]
|
||||
...
|
||||
connection=mysql://cinder:CINDER_DBPASS@controller/cinder
|
||||
|
||||
* In the ``[DEFAULT]`` and ``[oslo_messaging_rabbit]`` section,
|
||||
configure RabbitMQ message queue access. Replace ``RABBIT_PASS``
|
||||
with the password you chose for the account in
|
||||
RabbitMQ::
|
||||
|
||||
[DEFAULT]
|
||||
...
|
||||
rpc_backend = rabbit
|
||||
|
||||
[oslo_messaging_rabbit]
|
||||
...
|
||||
rabbit_host = controller
|
||||
rabbit_userid = openstack
|
||||
rabbit_password = RABBIT_PASS
|
||||
|
||||
* In the ``[DEFAULT]`` and ``[keystone_authtoken]`` sections, configure
|
||||
Identity service access. Replace ``CINDER_PASS`` with the password you
|
||||
chose for the ``cinder`` user in the Identity service.::
|
||||
|
||||
[DEFAULT]
|
||||
...
|
||||
auth_strategy = keystone
|
||||
|
||||
[keystone_authtoken]
|
||||
...
|
||||
auth_uri = http://controller:5000
|
||||
auth_url = http://controller:35357
|
||||
auth_plugin = password
|
||||
project_domain_id = default
|
||||
user_domain_id = default
|
||||
project_name = service
|
||||
username = cinder
|
||||
password = CINDER_PASS
|
||||
|
||||
* In the ``[DEFAULT]`` section, configure the ``my_ip`` option to
|
||||
use the management interface IP address of the controller node::
|
||||
|
||||
[DEFAULT]
|
||||
...
|
||||
my_ip = 10.0.0.11
|
||||
|
||||
#. Populate the Block Storage database::
|
||||
|
||||
# su -s /bin/sh -c "cinder-manage db sync" cinder
|
||||
|
||||
Configure Compute to use Block Storage
|
||||
--------------------------------------
|
||||
|
||||
* Edit the ``/etc/nova/nova.conf`` file and add the following
|
||||
to it::
|
||||
|
||||
[cinder]
|
||||
os_region_name = RegionOne
|
||||
|
||||
Finalize installation
|
||||
---------------------
|
||||
|
||||
#. Restart the Compute API service::
|
||||
|
||||
# systemctl restart uwsgi@nova-api.service
|
||||
|
||||
#. Start the Block Storage services and configure them to start when
|
||||
the system boots::
|
||||
|
||||
# systemctl enable cinder-api cinder-scheduler
|
||||
# systemctl start cinder-api cinder-scheduler
|
||||
|
||||
Install and configure a storage node
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
This section describes how to install and configure storage nodes
|
||||
for the Block Storage service. For simplicity, this configuration
|
||||
references one storage node with an empty local block storage device.
|
||||
The instructions use ``/dev/sdb``, but you can substitute a different
|
||||
value for your particular node.
|
||||
|
||||
The service provisions logical volumes on this device using the
|
||||
LVM driver and provides them to instances via iSCSI transport.
|
||||
You can follow these instructions with minor modifications to
|
||||
horizontally scale your environment with additional storage nodes.
|
||||
|
||||
Prerequisites
|
||||
-------------
|
||||
|
||||
#. Install the openstack block storage bundle::
|
||||
|
||||
# swupd bundle-add openstack-block-storage
|
||||
# swupd verify --fix
|
||||
|
||||
#. Create the LVM physical volume: ``/dev/sdb1`` If your system uses a
|
||||
different device name, adjust these steps accordingly::
|
||||
|
||||
# pvcreate /dev/sdb1
|
||||
Physical volume "/dev/sdb1" successfully created
|
||||
|
||||
#. Create the LVM volume group ``cinder-volumes``::
|
||||
|
||||
# vgcreate cinder-volumes /dev/sdb1
|
||||
Volume group "cinder-volumes" successfully created
|
||||
|
||||
The Block Storage service creates logical volumes in this volume
|
||||
group.
|
||||
|
||||
#. Only instances can access Block Storage volumes. However, the
|
||||
underlying operating system manages the devices associated with the
|
||||
volumes. By default, the LVM volume scanning tool scans the ``/dev``
|
||||
directory for block storage devices that contain volumes. If projects
|
||||
use LVM on their volumes, the scanning tool detects these volumes and
|
||||
attempts to cache them which can cause a variety of problems with
|
||||
both the underlying operating system and project volumes. You must
|
||||
reconfigure LVM to scan only the devices that contain the
|
||||
``cinder-volume`` volume group. Edit the ``/etc/lvm/lvm.conf`` file
|
||||
and complete the following action:
|
||||
|
||||
* In the ``devices`` section, add a filter that accepts the
|
||||
``/dev/sdb`` device and rejects all other devices::
|
||||
|
||||
devices {
|
||||
filter = [ "a/sdb/", "r/.*/"]
|
||||
}
|
||||
|
||||
Install and configure components
|
||||
--------------------------------
|
||||
|
||||
#. Edit the ``/etc/cinder/cinder.conf`` file and complete the following
|
||||
actions:
|
||||
|
||||
* In the ``[database]`` section, configure database access. Replace
|
||||
``CINDER_DBPASS`` with the password you chose for the Block Storage
|
||||
database::
|
||||
|
||||
[database]
|
||||
...
|
||||
connection = mysql://cinder:CINDER_DBPASS@controller/cinder
|
||||
|
||||
* In the ``[DEFAULT]`` and ``[oslo_messaging_rabbit]`` sections,
|
||||
configure ``RabbitMQ`` message queue access. Replace ``RABBIT_PASS``
|
||||
with the password you chose for the openstack account in
|
||||
``RabbitMQ``::
|
||||
|
||||
[DEFAULT]
|
||||
...
|
||||
rpc_backend = rabbit
|
||||
|
||||
[oslo_messaging_rabbit]
|
||||
...
|
||||
rabbit_host = controller
|
||||
rabbit_userid = openstack
|
||||
rabbit_password = RABBIT_PASS
|
||||
|
||||
* In the ``[DEFAULT]`` and ``[keystone_authtoken]`` sections,
|
||||
configure Identity service access. Replace ``CINDER_PASS`` with the
|
||||
password you chose for the cinder user in the Identity service::
|
||||
|
||||
[DEFAULT]
|
||||
...
|
||||
auth_strategy = keystone
|
||||
|
||||
[keystone_authtoken]
|
||||
...
|
||||
auth_uri = http://controller:5000
|
||||
auth_url = http://controller:35357
|
||||
auth_plugin = password
|
||||
project_domain_id = default
|
||||
user_domain_id = default
|
||||
project_name = service
|
||||
username = cinder
|
||||
password = CINDER_PASS
|
||||
|
||||
* In the ``[DEFAULT]`` section, configure the ``my_ip`` option.
|
||||
Replace ``MANAGEMENT_INTERFACE_IP_ADDRESS`` with the IP address
|
||||
of the management network interface on your storage node,
|
||||
typically 10.0.0.41 for the first node in the example
|
||||
architecture::
|
||||
|
||||
[DEFAULT]
|
||||
...
|
||||
my_ip = MANAGEMENT_INTERFACE_IP_ADDRESS
|
||||
|
||||
* In the ``[lvm]`` section, configure the LVM back end with the LVM
|
||||
driver, ``cinder-volumes`` volume group, iSCSI protocol, and
|
||||
appropriate iSCSI service::
|
||||
|
||||
[lvm]
|
||||
...
|
||||
volume_driver = cinder.volume.drivers.lvm.LVMVolumeDriver
|
||||
volume_group = cinder-volumes
|
||||
iscsi_protocol = iscsi
|
||||
iscsi_helper = tgtadm
|
||||
|
||||
* In the ``[DEFAULT]`` section, enable the LVM back end::
|
||||
|
||||
[DEFAULT]
|
||||
...
|
||||
enabled_backends = lvm
|
||||
|
||||
* In the ``[DEFAULT]`` section, configure the location of the Image
|
||||
service::
|
||||
|
||||
[DEFAULT]
|
||||
...
|
||||
glance_host = controller
|
||||
|
||||
#. Let systemd set the correct permissions for files in ``/etc/cinder``::
|
||||
|
||||
# systemctl restart update-triggers.target
|
||||
|
||||
Finalize installation
|
||||
---------------------
|
||||
|
||||
#. Start the Block Storage volume service including its dependencies
|
||||
and configure them to start when the system boots::
|
||||
|
||||
# systemctl enable iscsid tgtd cinder-volume
|
||||
# systemctl start iscsid tgtd cinder-volume
|
||||
|
||||
Configuring a compute node to use Block Storage
|
||||
-----------------------------------------------
|
||||
|
||||
#. Perform the following steps to enable a compute node to work with
|
||||
block storage::
|
||||
|
||||
# systemctl enable iscsid
|
||||
# systemctl start iscsi-gen-initiatorname iscsid
|
||||
|
||||
Verify operation
|
||||
~~~~~~~~~~~~~~~~
|
||||
Verify operation of the Block Storage service.
|
||||
|
||||
#. Source the ``admin`` credentials to gain access to
|
||||
admin-only CLI commands::
|
||||
|
||||
$ source admin-openrc.sh
|
||||
|
||||
#. List service components to verify successful launch of each process::
|
||||
|
||||
$ cinder service-list
|
||||
+------------------+------------+------+---------+-------+----------------------------+-----------------+
|
||||
| Binary | Host | Zone | Status | State | Updated_at | Disabled Reason |
|
||||
+------------------+------------+------+---------+-------+----------------------------+-----------------+
|
||||
| cinder-scheduler | controller | nova | enabled | up | 2014-10-18T01:30:54.000000 | None |
|
||||
| cinder-volume | block1@lvm | nova | enabled | up | 2014-10-18T01:30:57.000000 | None |
|
||||
+------------------+------------+------+---------+-------+----------------------------+-----------------+
|
||||
|
||||
Next topic: :ref:`openstack_dashboard`.
|
||||
@@ -1,51 +0,0 @@
|
||||
.. _openstack_bundle_and_service_summary:
|
||||
|
||||
OpenStack* bundle and service summary
|
||||
############################################################
|
||||
|
||||
OpenStack provides an Infrastructure-as-a-Service (IaaS) solution
|
||||
through a variety of complementary services. Each service offers an
|
||||
application programming interface (API) that facilitates this
|
||||
integration. The following table provides a list of OpenStack MVP
|
||||
services:
|
||||
|
||||
.. csv-table:: OpenStack MVP services
|
||||
:header: "Bundle Name (service)", "Project Name", "Description"
|
||||
:widths: 90, 90, 300
|
||||
|
||||
"openstack-compute-controller", "Nova", "Manages the lifecycle of compute instances in an OpenStack environment. Responsibilities include spawning, scheduling and decommissioning of virtual machines on demand."
|
||||
"openstack-identity", "Keystone", "Provides an authentication and authorization service for other OpenStack services. Provides a catalog of endpoints for all OpenStack services."
|
||||
"openstack-image", "Glance", "Stores and retrieves virtual machine disk images. OpenStack Compute makes use of this during instance provisioning."
|
||||
"openstack-dashboard", "Horizon", "Provides a web-based self-service portal to interact with underlying OpenStack services."
|
||||
"openstack-network", "Neutron", "Enables Network-Connectivity-as-a-Service for some OpenStack services. Besides, it provides an API for users to define networks and the attachments into them."
|
||||
"openstack-object-storage", "Swift", "Stores and retrieves arbitrary unstructured data objects. It is highly fault tolerant with its data replication and scale-out architecture."
|
||||
"openstack-block-storage/openstack-block-storage-controller", "Cinder", "Provides persistent block storage to running instances."
|
||||
"openstack-telemetry-controller", "Ceilometer", "Monitors and meters the OpenStack cloud for billing, benchmarking, scalability, and statistical purposes."
|
||||
"openstack-orchestration", "Heat", "Orchestrates multiple composite cloud applications by using either the native Heat Orchestration Template (HOT) template format or the AWS CloudFormation template format."
|
||||
|
||||
OpenStack is highly configurable to meet different needs. This guide
|
||||
uses two-node architecture with legacy networking (Nova-network).
|
||||
|
||||
- The controller node runs the Identity Service, Image Service,
|
||||
management portion of Compute, and the Dashboard. It also includes
|
||||
supporting services such as a SQL database and message queue.
|
||||
Optionally, the controller node runs management portions of Block
|
||||
Storage services.
|
||||
- The compute node runs the hypervisor portion of Compute that operates
|
||||
project virtual machines or instances. By default, Compute uses KVM
|
||||
as the hypervisor. Compute also provisions project networks and
|
||||
provides firewalling (security groups) services. You can run more
|
||||
than one compute node.
|
||||
- (Optional) Block Storage node contains the disks that the Block
|
||||
Storage service provisions for instances. You can deploy more than
|
||||
one block storage node.
|
||||
- (Optional) Object Storage node contain the disks that the Object
|
||||
Storage service uses for storing accounts, containers, and objects.
|
||||
This service requires two nodes. Each node requires a minimum of one
|
||||
network interface. You can deploy more than two object storage nodes.
|
||||
- The self-service networks option augments the provider networks option
|
||||
with layer-3 (routing) services that enable self-service networks
|
||||
using overlay segmentation methods. Additionally, this option provides
|
||||
the foundation for advanced services such as LBaaS and FWaaS.
|
||||
|
||||
Next topic: :ref:`openstack_sys_req_and_pw_summary`.
|
||||
@@ -1,528 +0,0 @@
|
||||
.. _openstack_compute:
|
||||
|
||||
Compute
|
||||
##################
|
||||
|
||||
Use OpenStack Compute to host and manage cloud computing systems.
|
||||
OpenStack Compute interacts with OpenStack Identity for authentication,
|
||||
OpenStack Image Service for disk and server images, and OpenStack
|
||||
Dashboard for the user and administrative interface. Image access is
|
||||
limited by projects, and by users; quotas are limited per project (the
|
||||
number of instances, for example). OpenStack Compute can scale
|
||||
horizontally on standard hardware and download images to launch
|
||||
instances.
|
||||
|
||||
Install and configure controller node
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
This section describes how to install and configure the
|
||||
Compute service, code-named nova, on the controller node.
|
||||
|
||||
Prerequisites
|
||||
-------------
|
||||
|
||||
Before you install and configure the Compute service, you must
|
||||
create a database, service credentials, and API endpoints.
|
||||
|
||||
#. To create the database, complete these steps:
|
||||
|
||||
* Use the database access client to connect to the database server
|
||||
as the root user::
|
||||
|
||||
$ mysql -u root -p
|
||||
|
||||
* Create the ``nova`` database::
|
||||
|
||||
CREATE DATABASE nova;
|
||||
|
||||
* Grant proper access to the nova database. Replace ``NOVA_DBPASS``
|
||||
with a suitable password::
|
||||
|
||||
GRANT ALL PRIVILEGES ON nova.* TO 'nova'@'localhost' \
|
||||
IDENTIFIED BY 'NOVA_DBPASS';
|
||||
GRANT ALL PRIVILEGES ON nova.* TO 'nova'@'%' \
|
||||
IDENTIFIED BY 'NOVA_DBPASS';
|
||||
|
||||
* Exit the database access client.
|
||||
|
||||
#. Source the admin credentials to gain access to admin-only CLI
|
||||
commands::
|
||||
|
||||
$ source admin-openrc.sh
|
||||
|
||||
#. To create the service credentials, complete these steps:
|
||||
|
||||
* Create the ``nova`` user::
|
||||
|
||||
$ openstack user create --domain default --password-prompt nova
|
||||
User Password:
|
||||
Repeat User Password:
|
||||
+-----------+----------------------------------+
|
||||
| Field | Value |
|
||||
+-----------+----------------------------------+
|
||||
| domain_id | default |
|
||||
| enabled | True |
|
||||
| id | 8c46e4760902464b889293a74a0c90a8 |
|
||||
| name | nova |
|
||||
+-----------+----------------------------------+
|
||||
|
||||
* Add the ``admin`` role to the ``nova`` user::
|
||||
|
||||
$ openstack role add --project service --user nova admin
|
||||
|
||||
* Create the ``nova`` service entity::
|
||||
|
||||
$ openstack service create --name nova \
|
||||
--description "OpenStack Compute" compute
|
||||
+-------------+----------------------------------+
|
||||
| Field | Value |
|
||||
+-------------+----------------------------------+
|
||||
| description | OpenStack Compute |
|
||||
| enabled | True |
|
||||
| id | 060d59eac51b4594815603d75a00aba2 |
|
||||
| name | nova |
|
||||
| type | compute |
|
||||
+-------------+----------------------------------+
|
||||
|
||||
#. Create the Compute service API endpoints::
|
||||
|
||||
$ openstack endpoint create --region RegionOne \
|
||||
compute public http://controller:8774/v2/%\(tenant_id\)s
|
||||
+--------------+-----------------------------------------+
|
||||
| Field | Value |
|
||||
+--------------+-----------------------------------------+
|
||||
| enabled | True |
|
||||
| id | 3c1caa473bfe4390a11e7177894bcc7b |
|
||||
| interface | public |
|
||||
| region | RegionOne |
|
||||
| region_id | RegionOne |
|
||||
| service_id | e702f6f497ed42e6a8ae3ba2e5871c78 |
|
||||
| service_name | nova |
|
||||
| service_type | compute |
|
||||
| url | http://controller:8774/v2/%(tenant_id)s |
|
||||
+--------------+-----------------------------------------+
|
||||
|
||||
$ openstack endpoint create --region RegionOne \
|
||||
compute internal http://controller:8774/v2/%\(tenant_id\)s
|
||||
+--------------+-----------------------------------------+
|
||||
| Field | Value |
|
||||
+--------------+-----------------------------------------+
|
||||
| enabled | True |
|
||||
| id | e3c918de680746a586eac1f2d9bc10ab |
|
||||
| interface | internal |
|
||||
| region | RegionOne |
|
||||
| region_id | RegionOne |
|
||||
| service_id | e702f6f497ed42e6a8ae3ba2e5871c78 |
|
||||
| service_name | nova |
|
||||
| service_type | compute |
|
||||
| url | http://controller:8774/v2/%(tenant_id)s |
|
||||
+--------------+-----------------------------------------+
|
||||
|
||||
$ openstack endpoint create --region RegionOne \
|
||||
compute admin http://controller:8774/v2/%\(tenant_id\)s
|
||||
+--------------+-----------------------------------------+
|
||||
| Field | Value |
|
||||
+--------------+-----------------------------------------+
|
||||
| enabled | True |
|
||||
| id | 38f7af91666a47cfb97b4dc790b94424 |
|
||||
| interface | admin |
|
||||
| region | RegionOne |
|
||||
| region_id | RegionOne |
|
||||
| service_id | e702f6f497ed42e6a8ae3ba2e5871c78 |
|
||||
| service_name | nova |
|
||||
| service_type | compute |
|
||||
| url | http://controller:8774/v2/%(tenant_id)s |
|
||||
+--------------+-----------------------------------------+
|
||||
|
||||
Installing and configuring the Compute controller components
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
To install and configure the Compute controller components:
|
||||
|
||||
#. Install OpenStack Compute Controller bundle::
|
||||
|
||||
# swupd bundle-add openstack-compute-controller
|
||||
# swupd verify --fix
|
||||
|
||||
#. Custom configurations will be located at ``/etc/nova``.
|
||||
|
||||
* Create ``/etc/nova directory``::
|
||||
|
||||
# mkdir /etc/nova
|
||||
|
||||
* Create empty nova configuration file ``/etc/nova/nova.conf``::
|
||||
|
||||
# touch /etc/nova/nova.conf
|
||||
|
||||
#. Edit the ``/etc/nova/nova.conf`` file and complete the following
|
||||
actions:
|
||||
|
||||
* In the ``[database]`` section, configure database access. Replace
|
||||
``NOVA_DBPASS`` with the password you chose for the Compute database::
|
||||
|
||||
[database]
|
||||
...
|
||||
connection=mysql://nova:NOVA_DBPASS@controller/nova
|
||||
|
||||
* In the ``[DEFAULT]`` and ``[oslo_messaging_rabbit]`` sections,
|
||||
configure ``RabbitMQ`` message queue access. Replace ``RABBIT_PASS``
|
||||
with the password you chose for the guest account in RabbitMQ::
|
||||
|
||||
[DEFAULT]
|
||||
...
|
||||
rpc_backend = rabbit
|
||||
|
||||
[oslo_messaging_rabbit]
|
||||
...
|
||||
rabbit_host = controller
|
||||
rabbit_userid = openstack
|
||||
rabbit_password = RABBIT_PASS
|
||||
|
||||
* In the ``[DEFAULT]`` and ``[keystone_authtoken]`` sections,
|
||||
configure Identity service access. Replace ``NOVA_PASS`` with the
|
||||
password you chose for the nova user in the Identity service::
|
||||
|
||||
[DEFAULT]
|
||||
...
|
||||
auth_strategy = keystone
|
||||
|
||||
[keystone_authtoken]
|
||||
...
|
||||
auth_uri = http://controller:5000
|
||||
auth_url = http://controller:35357
|
||||
auth_plugin = password
|
||||
project_domain_id = default
|
||||
user_domain_id = default
|
||||
project_name = service
|
||||
username = nova
|
||||
password = NOVA_PASS
|
||||
|
||||
|
||||
* In the ``[DEFAULT]`` section, configure the ``my_ip`` option to
|
||||
use the management interface IP address of the controller node::
|
||||
|
||||
[DEFAULT]
|
||||
...
|
||||
my_ip = 10.0.0.11
|
||||
|
||||
* In the ``[DEFAULT]`` section, enable support for the Networking service::
|
||||
|
||||
[DEFAULT]
|
||||
...
|
||||
network_api_class = nova.network.neutronv2.api.API
|
||||
security_group_api = neutron
|
||||
linuxnet_interface_driver = nova.network.linux_net.NeutronLinuxBridgeInterfaceDriver
|
||||
firewall_driver = nova.virt.firewall.NoopFirewallDriver
|
||||
|
||||
* In the ``[vnc]`` section, configure the VNC proxy to use the
|
||||
management interface IP address of the controller node::
|
||||
|
||||
[vnc]
|
||||
...
|
||||
vncserver_listen = 10.0.0.11
|
||||
vncserver_proxyclient_address = 10.0.0.11
|
||||
|
||||
* In the ``[glance]`` section, configure the location of the
|
||||
Image Service::
|
||||
|
||||
[glance]
|
||||
...
|
||||
host = controller
|
||||
|
||||
#. Ensure files have proper ownership by running the following command::
|
||||
|
||||
# systemctl restart update-triggers.target
|
||||
|
||||
#. Populate the Compute database::
|
||||
|
||||
su -s /bin/sh -c "nova-manage db sync" nova
|
||||
|
||||
Finalizing Compute installation
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Complete the following steps to finalize Compute installation:
|
||||
|
||||
#. Create the ``/etc/nginx`` directory if doesn't exists and setup nova-api
|
||||
and nova-metadata to start with the Nginx http server::
|
||||
|
||||
# mkdir -p /etc/nginx
|
||||
# ln -s /usr/share/nginx/conf.d/nova-api.template /etc/nginx/nova-api.conf
|
||||
|
||||
#. Restart the Nginx server to reload new configurations::
|
||||
|
||||
# systemctl restart nginx
|
||||
|
||||
#. Start the Compute Service services and configure them to start
|
||||
when the system boots::
|
||||
|
||||
# systemctl enable uwsgi@nova-api.socket \
|
||||
uwsgi@nova-metadata.socket nova-cert.service \
|
||||
nova-consoleauth.service nova-scheduler.service \
|
||||
nova-conductor.service nova-novncproxy.service
|
||||
# systemctl start uwsgi@nova-api.socket \
|
||||
uwsgi@nova-metadata.socket nova-cert.service \
|
||||
nova-consoleauth.service nova-scheduler.service \
|
||||
nova-conductor.service nova-novncproxy.service
|
||||
|
||||
Install and configure a compute note
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
This section describes how to install and configure the Compute service
|
||||
on a compute node. This configuration uses the QEMU hypervisor with the
|
||||
KVM extension on compute nodes that support hardware acceleration for
|
||||
virtual machines.
|
||||
|
||||
Install and configure components
|
||||
--------------------------------
|
||||
|
||||
#. Install OpenStack Compute bundle::
|
||||
|
||||
# clr_bundle_add openstack-compute
|
||||
|
||||
#. Custom configurations will be located at ``/etc/nova``.
|
||||
|
||||
* Create ``/etc/nova`` directory::
|
||||
|
||||
# mkdir /etc/nova
|
||||
|
||||
* Create empty nova configuration file ``/etc/nova/nova.conf``::
|
||||
|
||||
# touch /etc/nova/nova.conf
|
||||
|
||||
#. Edit the ``/etc/nova/nova.conf`` file and complete the following
|
||||
actions:
|
||||
|
||||
* In the ``[DEFAULT]`` and ``[oslo_messaging_rabbit]`` sections,
|
||||
configure RabbitMQ message broker access. Replace ``RABBIT_PASS``
|
||||
with the password you chose for the ``openstack`` account in ``RabbitMQ``::
|
||||
|
||||
[DEFAULT]
|
||||
...
|
||||
rpc_backend = rabbit
|
||||
|
||||
[oslo_messaging_rabbit]
|
||||
...
|
||||
rabbit_host = controller
|
||||
rabbit_userid = openstack
|
||||
rabbit_password = RABBIT_PASS
|
||||
|
||||
* In the ``[DEFAULT]`` and ``[keystone_authtoken]`` sections,
|
||||
configure Identity service access. Replace ``NOVA_PASS`` with the
|
||||
password you chose for the nova user in the Identity service::
|
||||
|
||||
[DEFAULT]
|
||||
...
|
||||
auth_strategy = keystone
|
||||
|
||||
[keystone_authtoken]
|
||||
...
|
||||
auth_uri = http://controller:5000
|
||||
auth_url = http://controller:35357
|
||||
auth_plugin = password
|
||||
project_domain_id = default
|
||||
user_domain_id = default
|
||||
project_name = service
|
||||
username = nova
|
||||
password = NOVA_PASS
|
||||
|
||||
* In the ``[DEFAULT]`` section, configure the ``my_ip`` option.
|
||||
Replace ``MANAGEMENT_INTERFACE_IP_ADDRESS`` with the IP address of
|
||||
the management network interface on your compute node, typically
|
||||
``10.0.0.31`` for the first node in the example architecture::
|
||||
|
||||
[DEFAULT]
|
||||
...
|
||||
my_ip = MANAGEMENT_INTERFACE_IP_ADDRESS
|
||||
|
||||
* In the ``[DEFAULT]`` section, enable support for the Networking service::
|
||||
|
||||
[DEFAULT]
|
||||
...
|
||||
network_api_class = nova.network.neutronv2.api.API
|
||||
security_group_api = neutron
|
||||
linuxnet_interface_driver = nova.network.linux_net.NeutronLinuxBridgeInterfaceDriver
|
||||
firewall_driver = nova.virt.firewall.NoopFirewallDriver
|
||||
|
||||
* In the ``[vnc]`` section, enable and configure remote console access::
|
||||
|
||||
[vnc]
|
||||
...
|
||||
enabled = True
|
||||
vncserver_listen = 0.0.0.0
|
||||
vncserver_proxyclient_address = MANAGEMENT_INTERFACE_IP_ADDRESS
|
||||
novncproxy_base_url = http://controller:6080/vnc_auto.html
|
||||
|
||||
The server component listens on all IP addresses and the proxy
|
||||
component only listens on the management interface IP address of
|
||||
the compute node. The base URL indicates the location where you
|
||||
can use a web browser to access remote consoles of instances on
|
||||
this compute node.
|
||||
|
||||
* In the ``[glance]`` section, configure the location of the
|
||||
Image Service::
|
||||
|
||||
[glance]
|
||||
...
|
||||
host = controller
|
||||
|
||||
Finalize compute node installation
|
||||
----------------------------------
|
||||
|
||||
#. Determine whether your compute node supports hardware acceleration
|
||||
for virtual machines::
|
||||
|
||||
$ egrep -c '(vmx|svm)' /proc/cpuinfo
|
||||
|
||||
If this command returns a value of ``one or greater``, your compute
|
||||
node supports hardware acceleration which typically requires no
|
||||
additional configuration.
|
||||
|
||||
If this command returns a value of ``zero`` , your compute node does
|
||||
not support hardware acceleration and you must configure ``libvirt``
|
||||
to use QEMU instead of KVM.
|
||||
|
||||
* Edit the ``[libvirt]`` section in the ``/etc/nova/nova.conf`` file
|
||||
as follows::
|
||||
|
||||
[libvirt]
|
||||
...
|
||||
virt_type = qemu
|
||||
|
||||
#. Ensure files have proper ownership by running the following command::
|
||||
|
||||
# systemctl restart update-triggers.target
|
||||
|
||||
#. Start the Compute service including its dependencies and configure
|
||||
them to start automatically when the system boots::
|
||||
|
||||
# systemctl enable libvirtd.service \
|
||||
nova-compute.service
|
||||
# systemctl start libvirtd.service \
|
||||
nova-compute.service
|
||||
|
||||
Verify operation
|
||||
~~~~~~~~~~~~~~~~
|
||||
Verify operation of the Compute service.
|
||||
|
||||
*Note:* Perform these commands on the controller node.
|
||||
|
||||
#. Source the ``admin`` credentials to gain access to
|
||||
admin-only CLI commands::
|
||||
|
||||
$ source admin-openrc.sh
|
||||
|
||||
#. List service components to verify successful launch and
|
||||
registration of each process::
|
||||
|
||||
$ nova service-list
|
||||
+----+------------------+------------+----------+---------+-------+--------------+-----------------+
|
||||
| Id | Binary | Host | Zone | Status | State | Updated_at | Disabled Reason |
|
||||
+----+------------------+------------+----------+---------+-------+--------------+-----------------+
|
||||
| 1 | nova-conductor | controller | internal | enabled | up | 2014-09-16.. | - |
|
||||
| 2 | nova-consoleauth | controller | internal | enabled | up | 2014-09-16.. | - |
|
||||
| 3 | nova-scheduler | controller | internal | enabled | up | 2014-09-16.. | - |
|
||||
| 4 | nova-cert | controller | internal | enabled | up | 2014-09-16.. | - |
|
||||
| 5 | nova-compute | compute1 | nova | enabled | up | 2014-09-16.. | - |
|
||||
+----+------------------+------------+----------+---------+-------+--------------+-----------------+
|
||||
|
||||
#. List API endpoints in the Identity service to verify connectivity
|
||||
with the Identity service::
|
||||
|
||||
$ nova endpoints
|
||||
+-----------+------------------------------------------------------------+
|
||||
| nova | Value |
|
||||
+-----------+------------------------------------------------------------+
|
||||
| id | 1fb997666b79463fb68db4ccfe4e6a71 |
|
||||
| interface | public |
|
||||
| region | RegionOne |
|
||||
| region_id | RegionOne |
|
||||
| url | http://controller:8774/v2/ae7a98326b9c455588edd2656d723b9d |
|
||||
+-----------+------------------------------------------------------------+
|
||||
+-----------+------------------------------------------------------------+
|
||||
| nova | Value |
|
||||
+-----------+------------------------------------------------------------+
|
||||
| id | bac365db1ff34f08a31d4ae98b056924 |
|
||||
| interface | admin |
|
||||
| region | RegionOne |
|
||||
| region_id | RegionOne |
|
||||
| url | http://controller:8774/v2/ae7a98326b9c455588edd2656d723b9d |
|
||||
+-----------+------------------------------------------------------------+
|
||||
+-----------+------------------------------------------------------------+
|
||||
| nova | Value |
|
||||
+-----------+------------------------------------------------------------+
|
||||
| id | e37186d38b8e4b81a54de34e73b43f34 |
|
||||
| interface | internal |
|
||||
| region | RegionOne |
|
||||
| region_id | RegionOne |
|
||||
| url | http://controller:8774/v2/ae7a98326b9c455588edd2656d723b9d |
|
||||
+-----------+------------------------------------------------------------+
|
||||
|
||||
+-----------+----------------------------------+
|
||||
| glance | Value |
|
||||
+-----------+----------------------------------+
|
||||
| id | 41ad39f6c6444b7d8fd8318c18ae0043 |
|
||||
| interface | admin |
|
||||
| region | RegionOne |
|
||||
| region_id | RegionOne |
|
||||
| url | http://controller:9292 |
|
||||
+-----------+----------------------------------+
|
||||
+-----------+----------------------------------+
|
||||
| glance | Value |
|
||||
+-----------+----------------------------------+
|
||||
| id | 50ecc4ce62724e319f4fae3861e50f7d |
|
||||
| interface | internal |
|
||||
| region | RegionOne |
|
||||
| region_id | RegionOne |
|
||||
| url | http://controller:9292 |
|
||||
+-----------+----------------------------------+
|
||||
+-----------+----------------------------------+
|
||||
| glance | Value |
|
||||
+-----------+----------------------------------+
|
||||
| id | 7d3df077a20b4461a372269f603b7516 |
|
||||
| interface | public |
|
||||
| region | RegionOne |
|
||||
| region_id | RegionOne |
|
||||
| url | http://controller:9292 |
|
||||
+-----------+----------------------------------+
|
||||
|
||||
+-----------+----------------------------------+
|
||||
| keystone | Value |
|
||||
+-----------+----------------------------------+
|
||||
| id | 88150c2fdc9d406c9b25113701248192 |
|
||||
| interface | internal |
|
||||
| region | RegionOne |
|
||||
| region_id | RegionOne |
|
||||
| url | http://controller:5000/v2.0 |
|
||||
+-----------+----------------------------------+
|
||||
+-----------+----------------------------------+
|
||||
| keystone | Value |
|
||||
+-----------+----------------------------------+
|
||||
| id | cecab58c0f024d95b36a4ffa3e8d81e1 |
|
||||
| interface | public |
|
||||
| region | RegionOne |
|
||||
| region_id | RegionOne |
|
||||
| url | http://controller:5000/v2.0 |
|
||||
+-----------+----------------------------------+
|
||||
+-----------+----------------------------------+
|
||||
| keystone | Value |
|
||||
+-----------+----------------------------------+
|
||||
| id | fc90391ae7cd4216aca070042654e424 |
|
||||
| interface | admin |
|
||||
| region | RegionOne |
|
||||
| region_id | RegionOne |
|
||||
| url | http://controller:35357/v2.0 |
|
||||
+-----------+----------------------------------+
|
||||
|
||||
*Note:* Ignore any warnings in this output.
|
||||
|
||||
#. List images in the Image service catalog to verify connectivity
|
||||
with the Image service::
|
||||
|
||||
$ nova image-list
|
||||
+--------------------------------------+--------+--------+--------+
|
||||
| ID | Name | Status | Server |
|
||||
+--------------------------------------+--------+--------+--------+
|
||||
| 38047887-61a7-41ea-9b49-27987d5e8bb9 | cirros | ACTIVE | |
|
||||
+--------------------------------------+--------+--------+--------+
|
||||
|
||||
Next topic: :ref:`openstack_block_storage`.
|
||||
@@ -1,34 +0,0 @@
|
||||
.. _openstack_dashboard:
|
||||
|
||||
Dashboard
|
||||
####################
|
||||
|
||||
The OpenStack Dashboard, also known as Horizon, is a web-based interface
|
||||
for cloud administrators and users to manage various OpenStack resources
|
||||
and services.
|
||||
|
||||
The Dashboard enables web-based interactions with the
|
||||
OpenStack Compute cloud controller through the OpenStack APIs.
|
||||
|
||||
Installation and configuration
|
||||
------------------------------
|
||||
|
||||
The dashboard relies on functional core services including
|
||||
Identity, Image service, Compute, and either Networking (neutron)
|
||||
or legacy networking (nova-network). Environments with
|
||||
stand-alone services such as Object Storage cannot use the
|
||||
dashboard.
|
||||
|
||||
To get started with OpenStack Dashboard services:
|
||||
|
||||
#. Install the OpenStack Dashboard bundle::
|
||||
|
||||
# swupd bundle-add openstack-dashboard
|
||||
# swupd verify --fix
|
||||
|
||||
#. Enable and start the dashboard socket and the Nginx server::
|
||||
|
||||
# systemctl enable nginx uwsgi@horizon.socket
|
||||
# systemctl restart nginx uwsgi@horizon.socket
|
||||
|
||||
Next topic: :ref:`openstack_networking`.
|
||||
@@ -1,58 +0,0 @@
|
||||
.. openstack_environment-database:
|
||||
|
||||
Database
|
||||
~~~~~~~~
|
||||
Most OpenStack services use an SQL database to store information. The
|
||||
database typically runs on the controller node. The procedures in this
|
||||
guide use MariaDB.
|
||||
|
||||
Install and configure the database server
|
||||
-----------------------------------------
|
||||
|
||||
#. Install MariaDB bundle:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# clr_bundle_add database-mariadb
|
||||
|
||||
#. Create the ``/etc/mariadb/`` folder and the ``/etc/mariadb/openstack.cnf`` file.
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# mkdir /etc/mariadb
|
||||
# touch /etc/mariadb/openstack.cnf
|
||||
|
||||
#. Add the ``[mysqld]`` section, set the bind-address key to the
|
||||
management IP address of the controller node to enable access by
|
||||
other nodes via the management network and enable useful options for
|
||||
UTF-8 character set:
|
||||
|
||||
.. code:: console
|
||||
|
||||
[mysqld]
|
||||
bind-address = 10.0.0.11
|
||||
default-storage-engine = innodb
|
||||
innodb_file_per_table
|
||||
collation-server = utf8_general_ci
|
||||
init-connect = 'SET NAMES utf8'
|
||||
character-set-server = utf8
|
||||
|
||||
Finalizing database installation
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Complete the following steps to finalize database installation:
|
||||
|
||||
#. Start the database service and configure it to start when the system
|
||||
boots:
|
||||
|
||||
.. code:: console
|
||||
|
||||
# systemctl enable mariadb.service
|
||||
# systemctl start mariadb.service
|
||||
|
||||
2. Secure the database service including choosing a suitable password
|
||||
for the root account:
|
||||
|
||||
.. code:: console
|
||||
|
||||
# mysql_secure_installation
|
||||
@@ -1,59 +0,0 @@
|
||||
.. openstack_environment-messaging:
|
||||
|
||||
Message queue
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
OpenStack uses a ``message queue`` to coordinate operations and
|
||||
status details among services. The message queue service typically
|
||||
runs on the controller node. OpenStack supports several message queue
|
||||
services. This guide implements the ``RabbitMQ`` message queue service.
|
||||
|
||||
Install the message queue service
|
||||
---------------------------------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# clr_bundle_add message-broker-rabbitmq
|
||||
|
||||
|
||||
Configuring the message broker service
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Complete the following steps to configure the message broker service:
|
||||
|
||||
1. Message broker service needs to be able to resolve to itself. Add the
|
||||
following line to :file:`/etc/hosts`
|
||||
|
||||
.. code-block:: literal
|
||||
|
||||
127.0.0.1 controller
|
||||
|
||||
|
||||
2. Start the message broker service and configure it to start when the
|
||||
system boots:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# systemctl enable rabbitmq-server.service
|
||||
# systemctl start rabbitmq-server.service
|
||||
|
||||
|
||||
3. Add the OpenStack user:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# rabbitmqctl add_user openstack RABBIT_PASS
|
||||
Creating user openstack ...
|
||||
...done.
|
||||
|
||||
Replace ``RABBIT_PASS`` with a suitable password.
|
||||
|
||||
|
||||
4. Permit configuration, write, and read access for the OpenStack user:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# rabbitmqctl set_permissions openstack ".*" ".*" ".*"
|
||||
|
||||
Setting permissions for user "openstack" in vhost "/" ...
|
||||
...done.
|
||||
@@ -1,75 +0,0 @@
|
||||
.. _openstack_identity-openrc:
|
||||
|
||||
Create OpenStack* client environment scripts
|
||||
############################################
|
||||
|
||||
The previous section used a combination of environment variables and
|
||||
command options to interact with the Identity service via the
|
||||
``openstack`` client. To increase efficiency of client operations,
|
||||
OpenStack supports simple client environment scripts also known as
|
||||
OpenRC files. These scripts typically contain common options for
|
||||
all clients but also support unique options. For more information, see the
|
||||
`OpenStack User Guide <http://docs.openstack.org/user-guide/common/
|
||||
cli_set_environment_variables_using_openstack_rc.html>`__.
|
||||
|
||||
Creating the scripts
|
||||
--------------------
|
||||
|
||||
Create client environment scripts for the ``admin`` and ``demo``
|
||||
projects and users. Future portions of this guide reference these
|
||||
scripts to load appropriate credentials for client operations.
|
||||
|
||||
#. Create the ``admin-openrc.sh`` file and add the following content::
|
||||
|
||||
export OS_PROJECT_DOMAIN_ID=default
|
||||
export OS_USER_DOMAIN_ID=default
|
||||
export OS_PROJECT_NAME=admin
|
||||
export OS_TENANT_NAME=admin
|
||||
export OS_USERNAME=admin
|
||||
export OS_PASSWORD=ADMIN_PASS
|
||||
export OS_AUTH_URL=http://controller:35357/v3
|
||||
export OS_IDENTITY_API_VERSION=3
|
||||
|
||||
Replace ``ADMIN_PASS`` with the password you chose
|
||||
for the ``admin`` user in the Identity service.
|
||||
|
||||
#. Create the ``demo-openrc.sh`` file and add the following content::
|
||||
|
||||
export OS_PROJECT_DOMAIN_ID=default
|
||||
export OS_USER_DOMAIN_ID=default
|
||||
export OS_PROJECT_NAME=demo
|
||||
export OS_TENANT_NAME=demo
|
||||
export OS_USERNAME=demo
|
||||
export OS_PASSWORD=DEMO_PASS
|
||||
export OS_AUTH_URL=http://controller:5000/v3
|
||||
export OS_IDENTITY_API_VERSION=3
|
||||
|
||||
Replace ``DEMO_PASS`` with the password you chose
|
||||
for the ``demo`` user in the Identity service.
|
||||
|
||||
Using the scripts
|
||||
-----------------
|
||||
|
||||
To run clients as a specific project and user, you can simply load
|
||||
the associated client environment script prior to running them.
|
||||
For example:
|
||||
|
||||
#. Load the ``admin-openrc.sh`` file to populate
|
||||
environment variables with the location of the Identity service
|
||||
and the ``admin`` project and user credentials::
|
||||
|
||||
$ source admin-openrc.sh
|
||||
|
||||
#. Request an authentication token::
|
||||
|
||||
$ openstack token issue
|
||||
+------------+----------------------------------+
|
||||
| Field | Value |
|
||||
+------------+----------------------------------+
|
||||
| expires | 2015-03-25T01:45:49.950092Z |
|
||||
| id | cd4110152ac24bdeaa82e1443c910c36 |
|
||||
| project_id | cf12a15c5ea84b019aec3dc45580896b |
|
||||
| user_id | 4d411f2291f34941b30eef9bd797505a |
|
||||
+------------+----------------------------------+
|
||||
|
||||
Next topic: :ref:`openstack_image`.
|
||||
@@ -1,418 +0,0 @@
|
||||
.. _openstack_identity:
|
||||
|
||||
Identity Service
|
||||
###################
|
||||
|
||||
The OpenStack Identity service provides a single point of integration for
|
||||
managing authentication, authorization, and service catalog services.
|
||||
Additionally, it provides information about users but that are not included in
|
||||
OpenStack (such as LDAP services) can be integrated into a pre-existing
|
||||
infrastructure.
|
||||
|
||||
When installing OpenStack Identity service, you must register each
|
||||
service in your OpenStack installation. Identity service can then track
|
||||
which OpenStack services are installed and where they are located on
|
||||
the network.
|
||||
|
||||
Install and configure
|
||||
~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
This section describes how to install and configure the OpenStack
|
||||
Identity service, code-named keystone, on the controller node. For
|
||||
performance, this configuration deploys the Nginx* HTTP server to handle
|
||||
requests.
|
||||
|
||||
Prerequisites
|
||||
-------------
|
||||
|
||||
Before you configure the OpenStack Identity service, you must create a
|
||||
database and an administration token.
|
||||
|
||||
#. To create the database, complete the following actions:
|
||||
|
||||
* Use the database access client to connect to the database server as the
|
||||
``root`` user.::
|
||||
|
||||
$ mysql -u root -p
|
||||
|
||||
* Create the ``keystone`` database.::
|
||||
|
||||
CREATE DATABASE keystone;
|
||||
|
||||
* Grant proper access to the ``keystone`` databaseReplace ``KEYSTONE_DBPASS``
|
||||
with a suitable password.::
|
||||
|
||||
GRANT ALL PRIVILEGES ON keystone.* TO 'keystone'@'localhost' \
|
||||
IDENTIFIED BY 'KEYSTONE_DBPASS';
|
||||
GRANT ALL PRIVILEGES ON keystone.* TO 'keystone'@'%' \
|
||||
IDENTIFIED BY 'KEYSTONE_DBPASS';
|
||||
|
||||
|
||||
* Exit the database access client.
|
||||
|
||||
#. Generate a random value to use as the administration token during
|
||||
initial configuration::
|
||||
|
||||
$ openssl rand -hex 10
|
||||
|
||||
Install and configure components
|
||||
--------------------------------
|
||||
|
||||
#. Run the following command to install the packages.::
|
||||
|
||||
# swupd bundle-add openstack-identity
|
||||
# swupd verify --fix
|
||||
|
||||
#. Custom configurations will be located at ``/etc/keystone/``.
|
||||
|
||||
* Create the ``/etc/keystone`` directory.::
|
||||
|
||||
# mkdir /etc/keystone
|
||||
|
||||
* Create keystone configuration file ``/etc/keystone/keystone.conf``.::
|
||||
|
||||
# touch /etc/keystone/keystone.conf
|
||||
|
||||
#. Edit the ``/etc/keystone/keystone.conf`` file and complete the following
|
||||
actions:
|
||||
|
||||
* In the ``[DEFAULT]`` section, define the value of the initial
|
||||
administration token. Replace ``ADMIN_TOKEN`` with the random value that
|
||||
you generated in a previous step.::
|
||||
|
||||
[DEFAULT]
|
||||
...
|
||||
admin_token = ADMIN_TOKEN
|
||||
|
||||
* In the ``[database]`` section, configure database access. Replace
|
||||
``KEYSTONE_DBPASS`` with the password you chose for the database.::
|
||||
|
||||
[database]
|
||||
...
|
||||
connection = mysql://keystone:KEYSTONE_DBPASS@controller/keystone
|
||||
|
||||
|
||||
#. Ensure files have proper ownership by running the following command::
|
||||
|
||||
# systemctl restart update-triggers.target
|
||||
|
||||
#. Populate the Identity service database::
|
||||
|
||||
# su -s /bin/sh -c "keystone-manage db_sync" keystone
|
||||
|
||||
Finalize the installation
|
||||
-------------------------
|
||||
|
||||
#. Keystone is deployed as a uwsgi module. To start the Identity
|
||||
service, you should enable and start the nginx service.::
|
||||
|
||||
# systemctl enable nginx uwsgi@keystone-admin.socket \
|
||||
uwsgi@keystone-public.socket
|
||||
|
||||
# systemctl start nginx uwsgi@keystone-admin.socket \
|
||||
uwsgi@keystone-public.socket
|
||||
|
||||
|
||||
Create the service entity and API endpoints
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
The Identity service provides a catalog of services and their locations.
|
||||
Each service that you add to your OpenStack environment requires a
|
||||
service entity and several API endpoints in the catalog.
|
||||
|
||||
Prerequisites
|
||||
-------------
|
||||
|
||||
You must pass the value of the authentication token to the `openstack`
|
||||
command with the ``--os-token`` parameter or set the OS_TOKEN
|
||||
environment variable. Similarly, you must also pass the value of the
|
||||
Identity service URL to the `openstack` command with the ``--os-url``
|
||||
parameter or set the OS_URL environment variable. This guide uses
|
||||
environment variables to reduce command length.
|
||||
|
||||
#. Configure the authentication token::
|
||||
|
||||
$ export OS_TOKEN=ADMIN_TOKEN
|
||||
|
||||
Replace ``ADMIN_TOKEN`` with the authentication token that you
|
||||
generated before. For example::
|
||||
|
||||
$ export OS_TOKEN=294a4c8a8a475f9b9836
|
||||
|
||||
#. Configure the endpoint URL::
|
||||
|
||||
$ export OS_URL=http://controller:35357/v3
|
||||
|
||||
#. Configure the Identity API version::
|
||||
|
||||
$ export OS_IDENTITY_API_VERSION=3
|
||||
|
||||
#. Install the OpenStack Python clients bundle::
|
||||
|
||||
# swupd bundle-add openstack-python-clients
|
||||
# swupd verify --fix
|
||||
|
||||
|
||||
Create the service entity and API endpoints
|
||||
-------------------------------------------
|
||||
|
||||
|
||||
#. The Identity service manages a catalog of services in your OpenStack
|
||||
environment. Services use this catalog to determine the other services
|
||||
available in your environment.
|
||||
|
||||
Create the service entity for the Identity service::
|
||||
|
||||
$ openstack service create \
|
||||
--name keystone --description "OpenStack Identity" identity
|
||||
+-------------+----------------------------------+
|
||||
| Field | Value |
|
||||
+-------------+----------------------------------+
|
||||
| description | OpenStack Identity |
|
||||
| enabled | True |
|
||||
| id | 4ddaae90388b4ebc9d252ec2252d8d10 |
|
||||
| name | keystone |
|
||||
| type | identity |
|
||||
+-------------+----------------------------------+
|
||||
|
||||
#. The Identity service manages a catalog of API endpoints associated with
|
||||
the services in your OpenStack environment. Services use this catalog to
|
||||
determine how to communicate with other services in your environment.
|
||||
|
||||
OpenStack uses three API endpoint variants for each service: admin,
|
||||
internal, and public. The admin API endpoint allows modifying users and
|
||||
tenants by default, while the public and internal APIs do not allow these
|
||||
operations. In a production environment, the variants might reside on
|
||||
separate networks that service different types of users for security
|
||||
reasons. For instance, the public API network might be visible from the
|
||||
Internet so customers can manage their clouds. The admin API network
|
||||
might be restricted to operators within the organization that manages
|
||||
cloud infrastructure. The internal API network might be restricted to
|
||||
the hosts that contain OpenStack services. Also, OpenStack supports
|
||||
multiple regions for scalability. For simplicity, this guide uses the
|
||||
management network for all endpoint variations and the default
|
||||
``RegionOne`` region.
|
||||
|
||||
Create the Identity service API endpoints::
|
||||
|
||||
$ openstack endpoint create --region RegionOne \
|
||||
identity public http://controller:5000/v3
|
||||
+--------------+----------------------------------+
|
||||
| Field | Value |
|
||||
+--------------+----------------------------------+
|
||||
| enabled | True |
|
||||
| id | 30fff543e7dc4b7d9a0fb13791b78bf4 |
|
||||
| interface | public |
|
||||
| region | RegionOne |
|
||||
| region_id | RegionOne |
|
||||
| service_id | 8c8c0927262a45ad9066cfe70d46892c |
|
||||
| service_name | keystone |
|
||||
| service_type | identity |
|
||||
| url | http://controller:5000/v3 |
|
||||
+--------------+----------------------------------+
|
||||
|
||||
$ openstack endpoint create --region RegionOne \
|
||||
identity internal http://controller:5000/v3
|
||||
+--------------+----------------------------------+
|
||||
| Field | Value |
|
||||
+--------------+----------------------------------+
|
||||
| enabled | True |
|
||||
| id | 57cfa543e7dc4b712c0ab137911bc4fe |
|
||||
| interface | internal |
|
||||
| region | RegionOne |
|
||||
| region_id | RegionOne |
|
||||
| service_id | 6f8de927262ac12f6066cfe70d99ac51 |
|
||||
| service_name | keystone |
|
||||
| service_type | identity |
|
||||
| url | http://controller:5000/v3 |
|
||||
+--------------+----------------------------------+
|
||||
|
||||
$ openstack endpoint create --region RegionOne \
|
||||
identity admin http://controller:35357/v3
|
||||
+--------------+----------------------------------+
|
||||
| Field | Value |
|
||||
+--------------+----------------------------------+
|
||||
| enabled | True |
|
||||
| id | 78c3dfa3e7dc44c98ab1b1379122ecb1 |
|
||||
| interface | admin |
|
||||
| region | RegionOne |
|
||||
| region_id | RegionOne |
|
||||
| service_id | 34ab3d27262ac449cba6cfe704dbc11f |
|
||||
| service_name | keystone |
|
||||
| service_type | identity |
|
||||
| url | http://controller:35357/v3 |
|
||||
+--------------+----------------------------------+
|
||||
|
||||
Creating projects, users and roles
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Complete the following steps to create projects, users and roles:
|
||||
|
||||
#. Create an administrative project, user, and role for administrative
|
||||
operations in your environment:
|
||||
|
||||
* Create the ``admin`` project::
|
||||
|
||||
$ openstack project create --domain default \
|
||||
--description "Admin Project" admin
|
||||
+-------------+----------------------------------+
|
||||
| Field | Value |
|
||||
+-------------+----------------------------------+
|
||||
| description | Admin Project |
|
||||
| domain_id | default |
|
||||
| enabled | True |
|
||||
| id | 343d245e850143a096806dfaefa9afdc |
|
||||
| is_domain | False |
|
||||
| name | admin |
|
||||
| parent_id | None |
|
||||
+-------------+----------------------------------+
|
||||
|
||||
* Create the ``admin`` user::
|
||||
|
||||
$ openstack user create --domain default \
|
||||
--password-prompt admin
|
||||
User Password:
|
||||
Repeat User Password:
|
||||
+-----------+----------------------------------+
|
||||
| Field | Value |
|
||||
+-----------+----------------------------------+
|
||||
| domain_id | default |
|
||||
| email | admin@example.com |
|
||||
| enabled | True |
|
||||
| id | ac3377633149401296f6c0d92d79dc16 |
|
||||
| name | admin |
|
||||
+-----------+----------------------------------+
|
||||
|
||||
* Create the ``admin`` role::
|
||||
|
||||
$ openstack role create admin
|
||||
+-------+----------------------------------+
|
||||
| Field | Value |
|
||||
+-------+----------------------------------+
|
||||
| id | cd2cb9a39e874ea69e5d4b896eb16128 |
|
||||
| name | admin |
|
||||
+-------+----------------------------------+
|
||||
|
||||
* Add the ``admin`` role to the ``admin`` project and user::
|
||||
|
||||
$ openstack role add --project admin --user admin admin
|
||||
|
||||
#. This guide uses a service project that contains a unique user for each
|
||||
service that you add to your environment. Create the ``service``
|
||||
project::
|
||||
|
||||
$ openstack project create --domain default \
|
||||
--description "Service Project" service
|
||||
+-------------+----------------------------------+
|
||||
| Field | Value |
|
||||
+-------------+----------------------------------+
|
||||
| description | Service Project |
|
||||
| domain_id | default |
|
||||
| enabled | True |
|
||||
| id | 894cdfa366d34e9d835d3de01e752262 |
|
||||
| is_domain | False |
|
||||
| name | service |
|
||||
| parent_id | None |
|
||||
+-------------+----------------------------------+
|
||||
|
||||
#. Regular (non-admin) tasks should use an unprivileged project and user.
|
||||
As an example, this guide creates the ``demo`` project and user.
|
||||
|
||||
* Create the ``demo`` project::
|
||||
|
||||
$ openstack project create --domain default \
|
||||
--description "Demo Project" demo
|
||||
+-------------+----------------------------------+
|
||||
| Field | Value |
|
||||
+-------------+----------------------------------+
|
||||
| description | Demo Project |
|
||||
| domain_id | default |
|
||||
| enabled | True |
|
||||
| id | ed0b60bf607743088218b0a533d5943f |
|
||||
| is_domain | False |
|
||||
| name | demo |
|
||||
| parent_id | None |
|
||||
+-------------+----------------------------------+
|
||||
|
||||
* Create the ``demo`` user::
|
||||
|
||||
$ openstack user create --domain default \
|
||||
--password-prompt demo
|
||||
User Password:
|
||||
Repeat User Password:
|
||||
+-----------+----------------------------------+
|
||||
| Field | Value |
|
||||
+-----------+----------------------------------+
|
||||
| domain_id | default |
|
||||
| email | demo@example.com |
|
||||
| enabled | True |
|
||||
| id | 58126687cbcc4888bfa9ab73a2256f27 |
|
||||
| name | demo |
|
||||
+-----------+----------------------------------+
|
||||
|
||||
* Create the ``user`` role::
|
||||
|
||||
$ openstack role create user
|
||||
+-------+----------------------------------+
|
||||
| Field | Value |
|
||||
+-------+----------------------------------+
|
||||
| id | 997ce8d05fc143ac97d83fdfb5998552 |
|
||||
| name | user |
|
||||
+-------+----------------------------------+
|
||||
|
||||
* Add the ``user`` role to the ``demo`` project and user::
|
||||
|
||||
$ openstack role add --project demo --user demo user
|
||||
|
||||
Verify operation
|
||||
~~~~~~~~~~~~~~~~
|
||||
|
||||
Verify operation of the Identity service before installing other
|
||||
services.
|
||||
|
||||
#. For security reasons, remove admin_token from
|
||||
``/etc/keystone/keystone.conf``:
|
||||
|
||||
Edit the ``[DEFAULT]`` section and remove ``admin_token``.
|
||||
|
||||
#. Restart the keystone-admin service to reload the changes::
|
||||
|
||||
# systemctl restart uwsgi@keystone-admin.service
|
||||
|
||||
#. Unset the temporary ``OS_TOKEN`` and ``OS_URL`` environment variables::
|
||||
|
||||
$ unset OS_TOKEN OS_URL
|
||||
|
||||
#. As the ``admin`` user, request an authentication token::
|
||||
|
||||
$ openstack --os-auth-url http://controller:35357/v3 \
|
||||
--os-project-domain-id default --os-user-domain-id default \
|
||||
--os-project-name admin --os-username admin --os-auth-type password \
|
||||
token issue
|
||||
Password:
|
||||
+------------+----------------------------------+
|
||||
| Field | Value |
|
||||
+------------+----------------------------------+
|
||||
| expires | 2015-03-24T18:55:01Z |
|
||||
| id | ff5ed908984c4a4190f584d826d75fed |
|
||||
| project_id | cf12a15c5ea84b019aec3dc45580896b |
|
||||
| user_id | 4d411f2291f34941b30eef9bd797505a |
|
||||
+------------+----------------------------------+
|
||||
|
||||
#. As the ``demo`` user, request an authentication token::
|
||||
|
||||
$ openstack --os-auth-url http://controller:5000/v3 \
|
||||
--os-project-domain-id default --os-user-domain-id default \
|
||||
--os-project-name demo --os-username demo --os-auth-type password \
|
||||
token issue
|
||||
Password:
|
||||
+------------+----------------------------------+
|
||||
| Field | Value |
|
||||
+------------+----------------------------------+
|
||||
| expires | 2014-10-10T12:51:33Z |
|
||||
| id | 1b87ceae9e08411ba4a16e4dada04802 |
|
||||
| project_id | 4aa51bb942be4dd0ac0555d7591f80a6 |
|
||||
| user_id | 7004dfa0dda84d63aef81cf7f100af01 |
|
||||
+------------+----------------------------------+
|
||||
|
||||
Next topic: :ref:`openstack_identity-openrc`.
|
||||
@@ -1,278 +0,0 @@
|
||||
.. _openstack_image:
|
||||
|
||||
Image Service
|
||||
################
|
||||
|
||||
The OpenStack Image service (glance) enables users to discover, register, and
|
||||
retrieve virtual machine images.
|
||||
|
||||
Install and configure the Image Service
|
||||
---------------------------------------
|
||||
|
||||
This section describes how to install and configure the Image service,
|
||||
code-named glance, on the controller node. For simplicity, this configuration
|
||||
stores images on the local file system. By default, this directory is
|
||||
``/var/lib/glance/images/``.
|
||||
|
||||
Prerequisites
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
Before you install and configure the Image service, you must create a database,
|
||||
service credentials, and API endpoints.
|
||||
|
||||
#. To create the database, complete these steps:
|
||||
|
||||
* Use the database access client to connect to the database
|
||||
server as the ``root`` user.::
|
||||
|
||||
$ mysql -u root -p
|
||||
|
||||
* Create the ``glance`` database::
|
||||
|
||||
CREATE DATABASE glance;
|
||||
|
||||
* Grant proper access to the ``glance`` database. Replace ``GLANCE_DBPASS``
|
||||
with a suitable password.::
|
||||
|
||||
GRANT ALL PRIVILEGES ON glance.* TO 'glance'@'localhost' \
|
||||
IDENTIFIED BY 'GLANCE_DBPASS';
|
||||
GRANT ALL PRIVILEGES ON glance.* TO 'glance'@'%' \
|
||||
IDENTIFIED BY 'GLANCE_DBPASS';
|
||||
|
||||
* Exit the database access client.
|
||||
|
||||
#. Source the ``admin`` credentials to gain access to admin-only CLI commands.::
|
||||
|
||||
$ source admin-openrc.sh
|
||||
|
||||
#. To create the service credentials, complete these steps:
|
||||
|
||||
* Create the ``glance`` user::
|
||||
|
||||
$ openstack user create --domain default --password-prompt glance
|
||||
User Password:
|
||||
Repeat User Password:
|
||||
+-----------+----------------------------------+
|
||||
| Field | Value |
|
||||
+-----------+----------------------------------+
|
||||
| domain_id | default |
|
||||
| enabled | True |
|
||||
| id | e38230eeff474607805b596c91fa15d9 |
|
||||
| name | glance |
|
||||
+-----------+----------------------------------+
|
||||
|
||||
* Add the ``admin`` role to the ``glance`` user and ``service`` project.::
|
||||
|
||||
$ openstack role add --project service --user glance admin
|
||||
|
||||
* Create the ``glance`` service entity.::
|
||||
|
||||
$ openstack service create --name glance \
|
||||
--description "OpenStack Image service" image
|
||||
+-------------+----------------------------------+
|
||||
| Field | Value |
|
||||
+-------------+----------------------------------+
|
||||
| description | OpenStack Image service |
|
||||
| enabled | True |
|
||||
| id | 8c2c7f1b9b5049ea9e63757b5533e6d2 |
|
||||
| name | glance |
|
||||
| type | image |
|
||||
+-------------+----------------------------------+
|
||||
|
||||
#. Create the Image service API endpoints.::
|
||||
|
||||
$ openstack endpoint create --region RegionOne \
|
||||
image public http://controller:9292
|
||||
+--------------+----------------------------------+
|
||||
| Field | Value |
|
||||
+--------------+----------------------------------+
|
||||
| enabled | True |
|
||||
| id | 340be3625e9b4239a6415d034e98aace |
|
||||
| interface | public |
|
||||
| region | RegionOne |
|
||||
| region_id | RegionOne |
|
||||
| service_id | 8c2c7f1b9b5049ea9e63757b5533e6d2 |
|
||||
| service_name | glance |
|
||||
| service_type | image |
|
||||
| url | http://controller:9292 |
|
||||
+--------------+----------------------------------+
|
||||
|
||||
$ openstack endpoint create --region RegionOne \
|
||||
image internal http://controller:9292
|
||||
+--------------+----------------------------------+
|
||||
| Field | Value |
|
||||
+--------------+----------------------------------+
|
||||
| enabled | True |
|
||||
| id | a6e4b153c2ae4c919eccfdbb7dceb5d2 |
|
||||
| interface | internal |
|
||||
| region | RegionOne |
|
||||
| region_id | RegionOne |
|
||||
| service_id | 8c2c7f1b9b5049ea9e63757b5533e6d2 |
|
||||
| service_name | glance |
|
||||
| service_type | image |
|
||||
| url | http://controller:9292 |
|
||||
+--------------+----------------------------------+
|
||||
|
||||
$ openstack endpoint create --region RegionOne \
|
||||
image admin http://controller:9292
|
||||
+--------------+----------------------------------+
|
||||
| Field | Value |
|
||||
+--------------+----------------------------------+
|
||||
| enabled | True |
|
||||
| id | 0c37ed58103f4300a84ff125a539032d |
|
||||
| interface | admin |
|
||||
| region | RegionOne |
|
||||
| region_id | RegionOne |
|
||||
| service_id | 8c2c7f1b9b5049ea9e63757b5533e6d2 |
|
||||
| service_name | glance |
|
||||
| service_type | image |
|
||||
| url | http://controller:9292 |
|
||||
+--------------+----------------------------------+
|
||||
|
||||
Install and configure components
|
||||
--------------------------------
|
||||
|
||||
#. Install OpenStack Image bundle.::
|
||||
|
||||
# swupd bundle-add openstack-image
|
||||
# swupd verify --fix
|
||||
|
||||
#. Configurations will be located at ``/etc/glance``.
|
||||
|
||||
* Create ``/etc/glance`` directory.::
|
||||
|
||||
# mkdir /etc/glance
|
||||
|
||||
* Create ``/etc/glance/glance-api.conf`` and
|
||||
``/etc/glance/glance-registry.conf`` configuration files.::
|
||||
|
||||
# touch /etc/glance/glance-{api,registry}.conf
|
||||
|
||||
#. Edit the ``/etc/glance/glance-api.conf`` file and complete the following
|
||||
actions:
|
||||
|
||||
* In the ``[database]`` section, configure database access. Replace
|
||||
``GLANCE_DBPASS`` with the password you chose for the Image service
|
||||
database.::
|
||||
|
||||
[database]
|
||||
...
|
||||
connection = mysql://glance:GLANCE_DBPASS@controller/glance
|
||||
|
||||
* In the ``[keystone_authtoken]`` section, configure Identity service access.
|
||||
Replace ``GLANCE_PASS`` with the password you chose for the ``glance`` user
|
||||
in the Identity service.::
|
||||
|
||||
[keystone_authtoken]
|
||||
...
|
||||
auth_uri = http://controller:5000
|
||||
auth_url = http://controller:35357
|
||||
auth_plugin = password
|
||||
project_domain_id = default
|
||||
user_domain_id = default
|
||||
project_name = service
|
||||
username = glance
|
||||
password = GLANCE_PASS
|
||||
|
||||
#. Edit the ``/etc/glance/glance-registry.conf`` file and complete the following
|
||||
actions:
|
||||
|
||||
* In the ``[database]`` section, configure database access. Replace
|
||||
``GLANCE_DBPASS`` with the password you chose for the Image service
|
||||
database.::
|
||||
|
||||
[database]
|
||||
...
|
||||
connection = mysql://glance:GLANCE_DBPASS@controller/glance
|
||||
|
||||
* In the ``[keystone_authtoken]`` section, configure Identity service
|
||||
access. Replace ``GLANCE_PASS`` with the password you chose for the
|
||||
``glance`` user in the Identity service.::
|
||||
|
||||
[keystone_authtoken]
|
||||
...
|
||||
auth_uri = http://controller:5000
|
||||
auth_url = http://controller:35357
|
||||
auth_plugin = password
|
||||
project_domain_id = default
|
||||
user_domain_id = default
|
||||
project_name = service
|
||||
username = glance
|
||||
password = GLANCE_PASS
|
||||
|
||||
#. Ensure files have proper ownership by running the following command::
|
||||
|
||||
# systemctl restart update-triggers.target
|
||||
|
||||
#. Populate the Image Service database::
|
||||
|
||||
# su -s /bin/sh -c "glance-manage db_sync" glance
|
||||
|
||||
Finalize installation
|
||||
---------------------
|
||||
|
||||
#. Start the Image Service services and configure them to start when the
|
||||
system boots::
|
||||
|
||||
# systemctl enable glance-api.service glance-registry.service
|
||||
# systemctl start glance-api.service glance-registry.service
|
||||
|
||||
Verify operation
|
||||
~~~~~~~~~~~~~~~~
|
||||
|
||||
Verify operation of the Image service using
|
||||
`CirrOS <http://launchpad.net/cirros>`__, a small
|
||||
Linux image that helps you test your OpenStack deployment.
|
||||
|
||||
#. In each client environment script, configure the Image service
|
||||
client to use API version 2.0::
|
||||
|
||||
$ echo "export OS_IMAGE_API_VERSION=2" \
|
||||
| tee -a admin-openrc.sh demo-openrc.sh
|
||||
|
||||
#. Source the ``admin`` credentials to gain access to admin-only CLI commands::
|
||||
|
||||
$ source admin-openrc.sh
|
||||
|
||||
#. Download the source image::
|
||||
|
||||
$ curl -Ok http://download.cirros-cloud.net/0.3.4/cirros-0.3.4-x86_64-disk.img
|
||||
|
||||
#. Upload the image to the Image service using the `QCOW2` disk format, `bare`
|
||||
container format, and public visibility so all projects can access it::
|
||||
|
||||
$ openstack image create cirros --file cirros-0.3.4-x86_64-disk.img \
|
||||
--disk-format qcow2 --container-format bare --public
|
||||
+------------------+------------------------------------------------------+
|
||||
| Field | Value |
|
||||
+------------------+------------------------------------------------------+
|
||||
| checksum | ee1eca47dc88f4879d8a229cc70a07c6 |
|
||||
| container_format | bare |
|
||||
| created_at | 2015-10-26T23:40:03Z |
|
||||
| disk_format | qcow2 |
|
||||
| file | /v2/images/fcf6fa55-56e9-4402-8137-3e9315c84905/file |
|
||||
| id | fcf6fa55-56e9-4402-8137-3e9315c84905 |
|
||||
| min_disk | 0 |
|
||||
| min_ram | 0 |
|
||||
| name | cirros |
|
||||
| owner | 2e3093872ebf4143a122e2cc01a50d13 |
|
||||
| protected | False |
|
||||
| schema | /v2/schemas/image |
|
||||
| size | 13287936 |
|
||||
| status | active |
|
||||
| tags | |
|
||||
| updated_at | 2015-10-26T23:40:03Z |
|
||||
| virtual_size | None |
|
||||
| visibility | public |
|
||||
+------------------+------------------------------------------------------+
|
||||
|
||||
#. Confirm upload of the image and validate attributes::
|
||||
|
||||
$ openstack image list
|
||||
+--------------------------------------+--------+
|
||||
| ID | Name |
|
||||
+--------------------------------------+--------+
|
||||
| 38047887-61a7-41ea-9b49-27987d5e8bb9 | cirros |
|
||||
+--------------------------------------+--------+
|
||||
|
||||
Next topic: :ref:`openstack_compute`.
|
||||
@@ -1,26 +0,0 @@
|
||||
.. _openstack_installing_bundles:
|
||||
|
||||
Installing OpenStack* MVP bundles
|
||||
############################################################
|
||||
|
||||
Note: This article walks through an OpenStack MVP installation by using
|
||||
bundles available for Clear Linux* OS for Intel® Architecture. The sample
|
||||
configuration files that are included would likely require modification
|
||||
for your environment.
|
||||
|
||||
To install, continue with the following topics:
|
||||
|
||||
* `Database <openstack_supporting-database.html>`_
|
||||
* `Message queue <openstack_supporting-messaging.html>`_
|
||||
* `OpenStack Identity <openstack_identity.html>`_
|
||||
* `Create OpenStack client environment scripts <openstack_identity-openrc.html>`_
|
||||
* `OpenStack Image <openstack_image.html>`_
|
||||
* `OpenStack Compute <openstack_compute.html>`_
|
||||
* `OpenStack Block Storage <openstack_block_storage.html>`_
|
||||
* `OpenStack Dashboard <openstack_dashboard.html>`_
|
||||
* `OpenStack Networking <openstack_networking.html>`_
|
||||
* `OpenStack Orchestration <openstack_orchestration.html>`_
|
||||
* `OpenStack Telemetry <openstack_telemetry.html>`_
|
||||
* `OpenStack Object Storage <openstack_object_storage.html>`_
|
||||
|
||||
Next topic: :ref:`openstack_supporting-database`.
|
||||
@@ -1,309 +0,0 @@
|
||||
.. _openstack_networking:
|
||||
|
||||
Networking
|
||||
############################################################
|
||||
|
||||
OpenStack* Networking allows you to create and attach interface devices
|
||||
managed by other OpenStack services to networks. Plug-ins can be
|
||||
implemented to accommodate different networking equipment and software,
|
||||
providing flexibility to OpenStack architecture and deployment.
|
||||
|
||||
Installing and configuring the controller node
|
||||
-------------------------------------------------
|
||||
|
||||
Prerequisites
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
Before configuring the OpenStack Networking (neutron) service, create a
|
||||
database, service credentials, and an API endpoint.
|
||||
|
||||
#. Create the database:
|
||||
|
||||
* Use the database access client to connect to the database server
|
||||
as the ``root`` user::
|
||||
|
||||
$ mysql -u root -p
|
||||
|
||||
* Create the ``neutron`` database::
|
||||
|
||||
CREATE DATABASE neutron;
|
||||
|
||||
* Grant proper access to the ``neutron`` database. Replace
|
||||
*``NEUTRON_DBPASS``* with a suitable password::
|
||||
|
||||
GRANT ALL PRIVILEGES ON neutron.* TO 'neutron'@'localhost' \
|
||||
IDENTIFIED BY 'NEUTRON_DBPASS';
|
||||
GRANT ALL PRIVILEGES ON neutron.* TO 'neutron'@'%' \
|
||||
IDENTIFIED BY 'NEUTRON_DBPASS';
|
||||
|
||||
* Exit the database access client.
|
||||
|
||||
#. Source the ``admin`` credentials to gain access to admin-only CLI
|
||||
commands::
|
||||
|
||||
$ source admin-openrc.sh
|
||||
|
||||
#. To create the service credentials, complete these steps:
|
||||
|
||||
* Create the ``neutron`` user::
|
||||
|
||||
$ openstack user create --password-prompt neutron
|
||||
User Password:
|
||||
Repeat User Password:
|
||||
+----------+----------------------------------+
|
||||
| Field | Value |
|
||||
+----------+----------------------------------+
|
||||
| email | None |
|
||||
| enabled | True |
|
||||
| id | ab67f043d9304017aaa73d692eeb4945 |
|
||||
| name | neutron |
|
||||
| username | neutron |
|
||||
+----------+----------------------------------+
|
||||
|
||||
* Add the ``admin`` role to the ``neutron`` user::
|
||||
|
||||
+-------+----------------------------------+
|
||||
| Field | Value |
|
||||
+-------+----------------------------------+
|
||||
| id | cd2cb9a39e874ea69e5d4b896eb16128 |
|
||||
| name | admin |
|
||||
+-------+----------------------------------+
|
||||
|
||||
* Create the ``neutron`` service entity::
|
||||
|
||||
$ openstack service create --name neutron \
|
||||
--description "OpenStack Networking" network
|
||||
+-------------+----------------------------------+
|
||||
| Field | Value |
|
||||
+-------------+----------------------------------+
|
||||
| description | OpenStack Networking |
|
||||
| enabled | True |
|
||||
| id | f71529314dab4a4d8eca427e701d209e |
|
||||
| name | neutron |
|
||||
| type | network |
|
||||
+-------------+----------------------------------+
|
||||
|
||||
#. Create the Networking service API endpoint::
|
||||
|
||||
--publicurl http://controller:9696 \
|
||||
--adminurl http://controller:9696 \
|
||||
--internalurl http://controller:9696 \
|
||||
--region RegionOne \
|
||||
network
|
||||
+--------------+----------------------------------+
|
||||
| Field | Value |
|
||||
+--------------+----------------------------------+
|
||||
| adminurl | http://controller:9696 |
|
||||
| id | 04a7d3c1de784099aaba83a8a74100b3 |
|
||||
| internalurl | http://controller:9696 |
|
||||
| publicurl | http://controller:9696 |
|
||||
| region | RegionOne |
|
||||
| service_id | f71529314dab4a4d8eca427e701d209e |
|
||||
| service_name | neutron |
|
||||
| service_type | network |
|
||||
+--------------+----------------------------------+
|
||||
|
||||
Installing the Networking components
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Complete the following step to install the Networking components:
|
||||
|
||||
- Install OpenStack networking bundle::
|
||||
|
||||
# clr_bundle_add openstack-network
|
||||
|
||||
Configuring the Networking server component
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Complete the following steps to configure the Networking server component:
|
||||
|
||||
The Networking server component configuration includes the database,
|
||||
authentication mechanism, message queue, topology change notifications,
|
||||
and plug-in.
|
||||
|
||||
Edit the ``/etc/neutron/neutron.conf `` file:
|
||||
|
||||
#. Custom configurations will be located at ``/etc/neutron``.
|
||||
|
||||
* Create /etc/neutron directory::
|
||||
|
||||
$ mkdir /etc/neutron
|
||||
|
||||
* Create empty neutron configuration
|
||||
file::
|
||||
|
||||
$ touch /etc/neutron/neutron.conf
|
||||
|
||||
#. In the ``[database]`` section, configure database access. Replace
|
||||
*NEUTRON_DBPASS* with the password you chose for the database::
|
||||
|
||||
[database]
|
||||
...
|
||||
connection = mysql://neutron:NEUTRON_DBPASS@controller/neutron
|
||||
|
||||
#. In the ``[DEFAULT]`` and ``[oslo_messaging_rabbit]`` sections,
|
||||
configure RabbitMQ message queue access. Replace *``RABBIT_PASS``*
|
||||
with the password you chose for the ``openstack`` account in
|
||||
RabbitMQ::
|
||||
|
||||
[DEFAULT]
|
||||
...
|
||||
rpc_backend = rabbit
|
||||
[oslo_messaging_rabbit]
|
||||
...
|
||||
rabbit_host = controller
|
||||
rabbit_userid = openstack
|
||||
rabbit_password = RABBIT_PASS
|
||||
|
||||
#. In the ``[DEFAULT]`` and ``[keystone_authtoken]`` sections, configure
|
||||
Identity service access. Replace *``NEUTRON_PASS``* with the password
|
||||
you chose for the ``neutron`` user in the Identity service::
|
||||
|
||||
[DEFAULT]
|
||||
...
|
||||
auth_strategy = keystone
|
||||
[keystone_authtoken]
|
||||
...
|
||||
auth_uri = http://controller:5000
|
||||
auth_url = http://controller:35357
|
||||
auth_plugin = password
|
||||
project_domain_id = default
|
||||
user_domain_id = default
|
||||
project_name = service
|
||||
username = neutron
|
||||
password = NEUTRON_PASS
|
||||
|
||||
#. In the ``[DEFAULT]`` section, enable the Modular Layer 2 (ML2)
|
||||
plug-in, router service, and overlapping IP addresses::
|
||||
|
||||
[DEFAULT]
|
||||
...
|
||||
core_plugin = ml2
|
||||
service_plugins = router
|
||||
allow_overlapping_ips = True
|
||||
|
||||
#. In the ``[DEFAULT]`` and ``[nova]`` sections, configure Networking to
|
||||
notify Compute of network topology changes. Replace ``NOVA_PASS``
|
||||
with the password you chose for the ``nova`` user in the Identity
|
||||
service::
|
||||
|
||||
[DEFAULT]
|
||||
...
|
||||
notify_nova_on_port_status_changes = True
|
||||
notify_nova_on_port_data_changes = True
|
||||
nova_url = http://controller:8774/v2
|
||||
[nova]
|
||||
...
|
||||
auth_url = http://controller:35357
|
||||
auth_plugin = password
|
||||
project_domain_id = default
|
||||
user_domain_id = default
|
||||
region_name = RegionOne
|
||||
project_name = service
|
||||
username = nova
|
||||
password = NOVA_PASS
|
||||
|
||||
Configuring the Modular Layer 2 (ML2) plug-in
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
The ML2 plug-in uses the Open vSwitch (OVS) mechanism (agent) to build
|
||||
the virtual networking framework for instances. However, the controller
|
||||
node does not need the OVS components because it does not handle
|
||||
instance network traffic.
|
||||
|
||||
#. Custom configuration for ML2 plug-in will be stored in ``/etc/neutron/plugins/ml2``::
|
||||
|
||||
mkdir -p /etc/neutron/plugins/ml2
|
||||
touch /etc/neutron.plugins/ml2/ml2_conf.ini
|
||||
|
||||
#. Edit the ``/etc/neutron/plugins/ml2/ml2_conf.ini`` file as follows:
|
||||
|
||||
* In the ``[ml2]`` section, enable the flat, VLAN, generic routing
|
||||
encapsulation (GRE), and virtual extensible LAN (VXLAN) network
|
||||
type drivers, GRE tenant networks, and the OVS mechanism driver::
|
||||
|
||||
[ml2]
|
||||
...
|
||||
type_drivers = flat,vlan,gre,vxlan
|
||||
tenant_network_types = gre
|
||||
mechanism_drivers = openvswitch
|
||||
|
||||
* In the ``[ml2_type_gre]`` section, configure the tunnel identifier
|
||||
(id) range::
|
||||
|
||||
[ml2_type_gre]
|
||||
...
|
||||
tunnel_id_ranges = 1:1000
|
||||
|
||||
* In the ``[securitygroup]`` section, enable security groups, enable
|
||||
ipset, and configure the OVS iptables firewall driver::
|
||||
|
||||
[securitygroup]
|
||||
...
|
||||
enable_security_group = True
|
||||
enable_ipset = True
|
||||
firewall_driver = neutron.agent.linux.iptables_firewall.OVSHybridIptablesFirewallDriver
|
||||
|
||||
Configuring Compute to use Networking
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
By default, distribution packages configure Compute to use legacy
|
||||
networking. You must reconfigure Compute to manage networks through
|
||||
Networking.
|
||||
|
||||
#. Edit the ``/etc/nova/nova.conf`` file on the controller node as
|
||||
follows:
|
||||
|
||||
* In the ``[DEFAULT]`` section, configure the APIs and drivers::
|
||||
|
||||
[DEFAULT]
|
||||
...
|
||||
network_api_class = nova.network.neutronv2.api.API
|
||||
security_group_api = neutron
|
||||
linuxnet_interface_driver = nova.network.linux_net.LinuxOVSInterfaceDriver
|
||||
firewall_driver = nova.virt.firewall.NoopFirewallDriver
|
||||
|
||||
* In the ``[neutron]`` section, configure access
|
||||
parameters. Replace *NEUTRON_PASS* with the password you
|
||||
chose for the ``neutron`` user in the Identity service::
|
||||
|
||||
[neutron]
|
||||
...
|
||||
url = http://controller:9696
|
||||
auth_strategy = keystone
|
||||
admin_auth_url = http://controller:35357/v2.0
|
||||
admin_tenant_name = service
|
||||
admin_username = neutron
|
||||
admin_password = NEUTRON_PASS
|
||||
|
||||
Finalizing installation
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
#. The Networking service initialization scripts expect a symbolic link
|
||||
``/etc/neutron/plugin.ini`` pointing to the ML2 plug-in configuration
|
||||
file, ``/etc/neutron/plugins/ml2/ml2_conf.ini``. If this symbolic
|
||||
link does not exist, create it using the following command::
|
||||
|
||||
# ln -s /etc/neutron/plugins/ml2/ml2_conf.ini /etc/neutron/plugin.ini
|
||||
|
||||
#. Populate the database::
|
||||
|
||||
# su -s /bin/sh -c "neutron-db-manage --config-file /etc/neutron/neutron.conf \
|
||||
--config-file /etc/neutron/plugins/ml2/ml2_conf.ini upgrade head" neutron
|
||||
|
||||
#. Let ``systemd`` set the correct permissions for files in ``/etc/neutron``::
|
||||
|
||||
# systemctl restart update-triggers.target
|
||||
|
||||
#. Restart the Compute services::
|
||||
|
||||
# systemctl restart nova-api.service nova-scheduler.service \
|
||||
nova-conductor.service
|
||||
|
||||
#. Start the Networking service and configure it to start when the
|
||||
system boots::
|
||||
|
||||
# systemctl enable neutron-server.service
|
||||
# systemctl start neutron-server.service
|
||||
|
||||
Next topic: :ref:`openstack_orchestration`.
|
||||
@@ -1,626 +0,0 @@
|
||||
.. _openstack_object_storage:
|
||||
|
||||
Object Storage
|
||||
#########################
|
||||
|
||||
Install and configure the controller node
|
||||
-----------------------------------------
|
||||
|
||||
This section describes how to install and configure the proxy service
|
||||
that handles requests for the account, container, and object services
|
||||
operating on the storage nodes. For simplicity, this guide installs and
|
||||
configures the proxy service on the controller node. However, you can
|
||||
run the proxy service on any node with network connectivity to the
|
||||
storage nodes. Additionally, you can install and configure the proxy
|
||||
service on multiple nodes to increase performance and redundancy.
|
||||
|
||||
To configure prerequisites
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
The proxy service relies on an authentication and authorization
|
||||
mechanism such as the Identity service. However, unlike other services,
|
||||
it also offers an internal mechanism that allows it to operate without
|
||||
any other OpenStack* services. However, for simplicity, this guide
|
||||
references the Identity service OpenStack Identity Service. Before you
|
||||
configure the Object Storage service, you must create service
|
||||
credentials and an API endpoint.
|
||||
|
||||
#. Source the ``admin`` credentials to gain access to admin-only CLI
|
||||
commands::
|
||||
|
||||
$ source admin-openrc.sh
|
||||
|
||||
#. To create the Identity service credentials, complete these steps:
|
||||
|
||||
* Create the swift user::
|
||||
|
||||
$ openstack user create --password-prompt swift
|
||||
User Password:
|
||||
Repeat User Password:
|
||||
+----------+----------------------------------+
|
||||
| Field | Value |
|
||||
+----------+----------------------------------+
|
||||
| email | None |
|
||||
| enabled | True |
|
||||
| id | d535e5cbd2b74ac7bfb97db9cced3ed6 |
|
||||
| name | swift |
|
||||
| username | swift |
|
||||
+----------+----------------------------------+
|
||||
|
||||
* Add the admin role to the swift user::
|
||||
|
||||
$ openstack role add --project service --user swift admin
|
||||
+-------+----------------------------------+
|
||||
| Field | Value |
|
||||
+-------+----------------------------------+
|
||||
| id | cd2cb9a39e874ea69e5d4b896eb16128 |
|
||||
| name | admin |
|
||||
+-------+----------------------------------+
|
||||
|
||||
* Create the swift service entity::
|
||||
|
||||
$ openstack service create --name swift \
|
||||
--description "OpenStack Object Storage" object-store
|
||||
+-------------+----------------------------------+
|
||||
| Field | Value |
|
||||
+-------------+----------------------------------+
|
||||
| description | OpenStack Object Storage |
|
||||
| enabled | True |
|
||||
| id | 75ef509da2c340499d454ae96a2c5c34 |
|
||||
| name | swift |
|
||||
| type | object-store |
|
||||
+-------------+----------------------------------+
|
||||
|
||||
#. Create the Object Storage service API endpoint::
|
||||
|
||||
$ openstack endpoint create \
|
||||
--publicurl 'http://controller:8080/v1/AUTH_%(tenant_id)s' \
|
||||
--internalurl 'http://controller:8080/v1/AUTH_%(tenant_id)s' \
|
||||
--adminurl http://controller:8080 \
|
||||
--region RegionOne \
|
||||
object-store
|
||||
+--------------+----------------------------------------------+
|
||||
| Field | Value |
|
||||
+--------------+----------------------------------------------+
|
||||
| adminurl | http://controller:8080/ |
|
||||
| id | af534fb8b7ff40a6acf725437c586ebe |
|
||||
| internalurl | http://controller:8080/v1/AUTH_%(tenant_id)s |
|
||||
| publicurl | http://controller:8080/v1/AUTH_%(tenant_id)s |
|
||||
| region | RegionOne |
|
||||
| service_id | 75ef509da2c340499d454ae96a2c5c34 |
|
||||
| service_name | swift |
|
||||
| service_type | object-store |
|
||||
+--------------+----------------------------------------------+
|
||||
|
||||
To install and configure the controller node components
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
#. Install the bundle::
|
||||
|
||||
# clr_bundle_add openstack-object-storage
|
||||
|
||||
#. Create the directory ``/etc/swift`` if does not exist::
|
||||
|
||||
# mkdir /etc/swift
|
||||
|
||||
#. Copy the sample proxy-server config file to the configuration
|
||||
directory::
|
||||
|
||||
# cp /usr/share/defaults/swift/proxy-server.conf /etc/swift
|
||||
|
||||
#. Edit the ``/etc/swift/proxy-server.conf`` file and complete the
|
||||
following actions:
|
||||
|
||||
* In the ``[pipeline:main]`` section, enable the appropriate
|
||||
modules::
|
||||
|
||||
[pipeline:main]
|
||||
pipeline = catch_errors gatekeeper healthcheck proxy-logging cache container_sync bulk ratelimit authtoken keystoneauth container-quotas account-quotas slo dlo proxy-logging proxy-server
|
||||
|
||||
* In the ``[app:proxy-server]`` section, enable automatic account
|
||||
creation::
|
||||
|
||||
[app:proxy-server]
|
||||
...
|
||||
account_autocreate = true
|
||||
|
||||
* In the ``[filter:keystoneauth]`` section, configure the operator
|
||||
roles::
|
||||
|
||||
[filter:keystoneauth]
|
||||
use = egg:swift#keystoneauth
|
||||
...
|
||||
operator_roles = admin,user
|
||||
|
||||
* In the ``[filter:authtoken]`` section, configure Identity service
|
||||
access. Replace SWIFT\_PASS with the password you chose for the
|
||||
swift user in the Identity service::
|
||||
|
||||
[filter:authtoken]
|
||||
paste.filter_factory = keystonemiddleware.auth_token:filter_factory
|
||||
...
|
||||
auth_uri = http://controller:5000
|
||||
auth_url = http://controller:35357
|
||||
auth_plugin = password
|
||||
project_domain_id = default
|
||||
user_domain_id = default
|
||||
project_name = service
|
||||
username = swift
|
||||
password = SWIFT_PASS
|
||||
delay_auth_decision = true
|
||||
|
||||
* In the ``[filter:cache]`` section, configure the memcached
|
||||
location::
|
||||
|
||||
[filter:cache]
|
||||
...
|
||||
memcache_servers = 127.0.0.1:11211
|
||||
|
||||
Install and configure the storage nodes
|
||||
---------------------------------------
|
||||
|
||||
This section describes how to install and configure storage nodes that
|
||||
operate the account, container, and object services. For simplicity,
|
||||
this configuration references two storage nodes, each containing two
|
||||
empty local block storage devices. Each of the devices, ``/dev/sdb`` and
|
||||
``/dev/sdc``, must contain a suitable partition table with one partition
|
||||
occupying the entire device. Although the Object Storage service
|
||||
supports any file system with extended attributes (xattr), testing and
|
||||
benchmarking indicate the best performance and reliability on XFS.
|
||||
|
||||
To configure prerequisites
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
You must configure each storage node before you install and configure
|
||||
the Object Storage service on it. Similar to the controller node, each
|
||||
storage node contains one network interface on the management network.
|
||||
Optionally, each storage node can contain a second network interface on
|
||||
a separate network for replication.
|
||||
|
||||
#. Configure unique items on the first storage node:
|
||||
|
||||
* Configure the management interface::
|
||||
|
||||
IP address: 10.0.0.51
|
||||
Network mask: 255.255.255.0 (or /24)
|
||||
Default gateway: 10.0.0.1
|
||||
|
||||
* Set the hostname of the node to ``object1``.
|
||||
|
||||
#. Configure unique items on the second storage node:
|
||||
|
||||
* Configure the management interface::
|
||||
|
||||
IP address: 10.0.0.52
|
||||
Network mask: 255.255.255.0 (or /24)
|
||||
Default gateway: 10.0.0.1
|
||||
|
||||
* Set the hostname of the node to ``object2``.
|
||||
|
||||
#. Configure shared items on both storage nodes:
|
||||
|
||||
* Copy the contents of the ``/etc/hosts`` file from the controller
|
||||
node and add the following to it::
|
||||
|
||||
# object1
|
||||
10.0.0.51 object1
|
||||
# object2
|
||||
10.0.0.52 object2
|
||||
|
||||
Also add this content to the ``/etc/hosts`` file on all other nodes in your environment.
|
||||
|
||||
* Install the OpenStack Object Storage bundle::
|
||||
|
||||
# clr\_bundle\_add openstack-object-storage
|
||||
|
||||
* Format the ``/dev/sdb1`` and ``/dev/sdc1`` partitions as XFS::
|
||||
|
||||
# mkfs.xfs /dev/sdb1
|
||||
# mkfs.xfs /dev/sdc1
|
||||
|
||||
* Create the mount point directory structure::
|
||||
|
||||
# mkdir -p /srv/node/sdb1
|
||||
# mkdir -p /srv/node/sdc1
|
||||
|
||||
* Edit the ``/etc/fstab`` file and add the following to it::
|
||||
|
||||
/dev/sdb1 /srv/node/sdb1 xfs noatime,nodiratime,nobarrier,logbufs=8 0 2
|
||||
/dev/sdc1 /srv/node/sdc1 xfs noatime,nodiratime,nobarrier,logbufs=8 0 2
|
||||
|
||||
* Mount the devices::
|
||||
|
||||
# mount /srv/node/sdb1
|
||||
# mount /srv/node/sdc1
|
||||
|
||||
#. Edit the ``/etc/rsyncd.conf`` file and add the following to it::
|
||||
|
||||
uid = swift
|
||||
gid = swift
|
||||
log file = /var/log/rsyncd.log
|
||||
pid file = /var/run/rsyncd.pid
|
||||
address = MANAGEMENT\_INTERFACE\_IP\_ADDRESS
|
||||
[account]
|
||||
max connections = 2
|
||||
path = /srv/node/
|
||||
read only = false
|
||||
lock file = /var/lock/account.lock
|
||||
[container]
|
||||
max connections = 2
|
||||
path = /srv/node/
|
||||
read only = false
|
||||
lock file = /var/lock/container.lock
|
||||
[object]
|
||||
max connections = 2
|
||||
path = /srv/node/
|
||||
read only = false
|
||||
lock file = /var/lock/object.lock
|
||||
|
||||
Replace ``MANAGEMENT_INTERFACE_IP_ADDRESS`` with the IP address of
|
||||
the management network on the storage node.
|
||||
|
||||
Note: The ``rsync`` service requires no authentication, so consider
|
||||
running it on a private network.
|
||||
|
||||
#. Start the ``rsyncd`` service and configure it to start when the
|
||||
system boots::
|
||||
|
||||
# systemctl enable rsyncd.service
|
||||
# systemctl start rsyncd.service
|
||||
|
||||
Install and configure storage node components
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
#. Copy the accounting, container, object, container-reconciler, and
|
||||
object-expirer service configuration files to the configuration
|
||||
directory::
|
||||
|
||||
# cp /usr/share/defaults/swift/account-server.conf /etc/swift
|
||||
# cp /usr/share/defaults/swift/container-server.conf /etc/swift
|
||||
# cp /usr/share/defaults/swift/object-server.conf /etc/swift
|
||||
# cp /usr/share/defaults/swift/container-reconciler.conf/etc/swift
|
||||
# cp /usr/share/defaults/swift/object-expirer.conf /etc/swift
|
||||
|
||||
#. Edit the ``/etc/swift/account-server.conf`` file and complete the
|
||||
following actions:
|
||||
|
||||
* In the ``[DEFAULT]`` section, configure the bind IP address and
|
||||
mount point directory::
|
||||
|
||||
[DEFAULT]
|
||||
...
|
||||
bind\_ip = MANAGEMENT\_INTERFACE\_IP\_ADDRESS
|
||||
devices = /srv/node
|
||||
|
||||
Replace ``MANAGEMENT_INTERFACE_IP_ADDRESS`` with the IP
|
||||
address of the management network on the storage node.
|
||||
|
||||
* In the ``[pipeline:main]`` section, enable the appropriate
|
||||
modules::
|
||||
|
||||
[pipeline:main]
|
||||
pipeline = healthcheck recon account-server
|
||||
|
||||
* In the ``[filter:recon]`` section, configure the recon (metrics)
|
||||
cache directory::
|
||||
|
||||
[filter:recon]
|
||||
...
|
||||
recon\_cache\_path = /var/cache/swift
|
||||
|
||||
#. Edit the ``/etc/swift/container-server.conf`` file and complete the
|
||||
following actions:
|
||||
|
||||
* In the ``[DEFAULT]`` section, configure the bind IP address and
|
||||
mount point directory::
|
||||
|
||||
[DEFAULT]
|
||||
...
|
||||
bind\_ip = MANAGEMENT\_INTERFACE\_IP\_ADDRESS
|
||||
devices = /srv/node
|
||||
|
||||
Replace ``MANAGEMENT_INTERFACE_IP_ADDRESS`` with the IP
|
||||
address of the management network on the storage node.
|
||||
|
||||
* modules::
|
||||
|
||||
[pipeline:main]
|
||||
pipeline = healthcheck recon container-server
|
||||
|
||||
* In the ``[filter:recon]`` section, configure the recon (metrics)
|
||||
cache directory::
|
||||
|
||||
[filter:recon]
|
||||
...
|
||||
recon\_cache\_path = /var/cache/swift
|
||||
|
||||
#. Edit the ``/etc/swift/object-server.conf`` file and complete the
|
||||
following actions:
|
||||
|
||||
* In the ``[DEFAULT]`` section, configure the bind IP address and
|
||||
mount point directory::
|
||||
|
||||
[DEFAULT]
|
||||
...
|
||||
bind\_ip = MANAGEMENT\_INTERFACE\_IP\_ADDRESS
|
||||
devices = /srv/node
|
||||
|
||||
Replace ``MANAGEMENT_INTERFACE_IP_ADDRESS`` with the IP
|
||||
address of the management network on the storage node.
|
||||
|
||||
* In the ``[pipeline:main]`` section, enable the appropriate
|
||||
modules::
|
||||
|
||||
[pipeline:main]
|
||||
pipeline = healthcheck recon object-server
|
||||
|
||||
* In the ``[filter:recon]`` section, configure the recon (metrics)
|
||||
cache and lock directories::
|
||||
|
||||
[filter:recon]
|
||||
...
|
||||
recon\_cache\_path = /var/cache/swift
|
||||
recon\_lock\_path = /var/lock
|
||||
|
||||
#. Ensure proper ownership of the mount point directory structure::
|
||||
|
||||
# systemctl restart update-triggers.target
|
||||
|
||||
About Creating initial rings
|
||||
----------------------------
|
||||
|
||||
Before starting the Object Storage services, you must create the initial
|
||||
account, container, and object rings. The ring builder creates
|
||||
configuration files that each node uses to determine and deploy the
|
||||
storage architecture. For simplicity, this guide uses one region and
|
||||
zone with 2^10 (1024) maximum partitions, 3 replicas of each object, and
|
||||
1 hour minimum time between moving a partition more than once. For
|
||||
Object Storage, a partition indicates a directory on a storage device
|
||||
rather than a conventional partition table.
|
||||
|
||||
Create Account Ring
|
||||
-------------------
|
||||
|
||||
The account server uses the account ring to maintain lists of
|
||||
containers.
|
||||
|
||||
To create the ring
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
#. Change to the /etc/swift directory.
|
||||
#. Create the base account.builder file::
|
||||
|
||||
# swift-ring-builder account.builder create 10 3 1
|
||||
|
||||
#. Add each storage node to the ring::
|
||||
|
||||
# swift-ring-builder account.builder \
|
||||
add r1z1-STORAGE_NODE_MANAGEMENT_INTERFACE_IP_ADDRESS:6002/DEVICE_NAME DEVICE_WEIGHT
|
||||
|
||||
Replace *STORAGE_NODE_MANAGEMENT_INTERFACE_IP_ADDRESS* with the
|
||||
IP address of the management network on the storage node. Replace
|
||||
*DEVICE_NAME* with a storage device name on the same storage node.
|
||||
For example, using the first storage node with the ``/dev/sdb1`` storage
|
||||
device and weight of 100::
|
||||
|
||||
# swift-ring-builder account.builder add r1z1-10.0.0.51:6002/sdb1 100
|
||||
|
||||
Repeat this command for each storage device on each storage node. In
|
||||
the example architecture, use the command in four variations::
|
||||
|
||||
# swift-ring-builder account.builder add r1z1-10.0.0.51:6002/sdb1 100
|
||||
Device d0r1z1-10.0.0.51:6002R10.0.0.51:6002/sdb1_"" with 100.0 weight got id 0
|
||||
# swift-ring-builder account.builder add r1z2-10.0.0.51:6002/sdc1 100
|
||||
Device d1r1z2-10.0.0.51:6002R10.0.0.51:6002/sdc1_"" with 100.0 weight got id 1
|
||||
# swift-ring-builder account.builder add r1z3-10.0.0.52:6002/sdb1 100
|
||||
Device d2r1z3-10.0.0.52:6002R10.0.0.52:6002/sdb1_"" with 100.0 weight got id 2
|
||||
# swift-ring-builder account.builder add r1z4-10.0.0.52:6002/sdc1 100
|
||||
Device d3r1z4-10.0.0.52:6002R10.0.0.52:6002/sdc1_"" with 100.0 weight got id 3
|
||||
|
||||
#. Verify the ring contents::
|
||||
|
||||
# swift-ring-builder account.builder account.builder, build version 4
|
||||
1024 partitions, 3.000000 replicas, 1 regions, 4 zones, 4 devices, 100.00 balance, 0.00 dispersion
|
||||
The minimum number of hours before a partition can be reassigned is 1
|
||||
The overload factor is 0.00% (0.000000)
|
||||
Devices: id region zone ip address port replication ip replication port name weight partitions balance meta
|
||||
0 1 1 10.0.0.51 6002 10.0.0.51 6002 sdb1 100.00 0 -100.00
|
||||
1 1 2 10.0.0.51 6002 10.0.0.51 6002 sdc1 100.00 0 -100.00
|
||||
2 1 3 10.0.0.52 6002 10.0.0.52 6002 sdb1 100.00 0 -100.00
|
||||
3 1 4 10.0.0.52 6002 10.0.0.52 6002 sdc1 100.00 0 -100.00
|
||||
|
||||
#. Rebalance the ring::
|
||||
|
||||
# swift-ring-builder account.builder rebalance
|
||||
Reassigned 1024 (100.00%) partitions. Balance is now 0.00. Dispersion is now 0.00
|
||||
|
||||
Create Container Ring
|
||||
---------------------
|
||||
|
||||
The container server uses the container ring to maintain lists of
|
||||
objects. However, it does not track object locations.
|
||||
|
||||
To create the ring
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
#. Change to the ``/etc/swift`` directory.
|
||||
#. Create the base container.builder file::
|
||||
|
||||
# swift-ring-builder container.builder create 10 3 1
|
||||
|
||||
#. Add each storage node to the ring::
|
||||
|
||||
# swift-ring-builder container.builder \
|
||||
add r1z1-STORAGE_NODE_MANAGEMENT_INTERFACE_IP_ADDRESS:6001/DEVICE_NAME DEVICE_WEIGHT
|
||||
|
||||
Replace *STORAGE_NODE_MANAGEMENT_INTERFACE_IP_ADDRESS* with the
|
||||
IP address of the management network on the storage node. Replace
|
||||
*DEVICE_NAME* with a storage device name on the same storage node.
|
||||
For example, using the first storage node with the /dev/sdb1 storage
|
||||
device and weight of 100::
|
||||
|
||||
# swift-ring-builder container.builder add r1z1-10.0.0.51:6001/sdb1 100
|
||||
|
||||
Repeat this command for each storage device on each storage node. In
|
||||
the example architecture, use the command in four variations::
|
||||
|
||||
# swift-ring-builder container.builder add r1z1-10.0.0.51:6001/sdb1 100
|
||||
Device d0r1z1-10.0.0.51:6002R10.0.0.51:6002/sdb1_"" with 100.0 weight got id 0
|
||||
# swift-ring-builder container.builder add r1z2-10.0.0.51:6001/sdc1 100
|
||||
Device d1r1z2-10.0.0.51:6002R10.0.0.51:6002/sdc1_"" with 100.0 weight got id 1
|
||||
# swift-ring-builder container.builder add r1z3-10.0.0.52:6001/sdb1 100
|
||||
Device d2r1z3-10.0.0.52:6002R10.0.0.52:6002/sdb1_"" with 100.0 weight got id 2
|
||||
# swift-ring-builder container.builder add r1z4-10.0.0.52:6001/sdc1 100
|
||||
Device d3r1z4-10.0.0.52:6002R10.0.0.52:6002/sdc1_"" with 100.0 weight got id 3
|
||||
|
||||
#. Verify the ring contents::
|
||||
|
||||
# swift-ring-builder container.builder
|
||||
container.builder, build version 4
|
||||
1024 partitions, 3.000000 replicas, 1 regions, 4 zones, 4 devices, 100.00 balance, 0.00 dispersion
|
||||
The minimum number of hours before a partition can be reassigned is 1
|
||||
The overload factor is 0.00% (0.000000)
|
||||
Devices: id region zone ip address port replication ip replication port name weight partitions balance meta
|
||||
0 1 1 10.0.0.51 6001 10.0.0.51 6001 sdb1 100.00 0 -100.00
|
||||
1 1 2 10.0.0.51 6001 10.0.0.51 6001 sdc1 100.00 0 -100.00
|
||||
2 1 3 10.0.0.52 6001 10.0.0.52 6001 sdb1 100.00 0 -100.00
|
||||
3 1 4 10.0.0.52 6001 10.0.0.52 6001 sdc1 100.00 0 -100.00
|
||||
|
||||
#. Rebalance the ring::
|
||||
|
||||
# swift-ring-builder container.builder rebalance
|
||||
Reassigned 1024 (100.00%) partitions. Balance is now 0.00. Dispersion is now 0.00
|
||||
|
||||
Create Object Ring
|
||||
------------------
|
||||
|
||||
The object server uses the object ring to maintain lists of object
|
||||
locations on local devices.
|
||||
|
||||
To create the ring
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
#. Change to the ``/etc/swift`` directory.
|
||||
#. Create the base ``object.builder`` file::
|
||||
|
||||
# swift-ring-builder object.builder create 10 3 1
|
||||
|
||||
#. Add each storage node to the ring::
|
||||
|
||||
# swift-ring-builder object.builder \
|
||||
add r1z1-STORAGE_NODE_MANAGEMENT_INTERFACE_IP_ADDRESS:6000/DEVICE_NAME DEVICE_WEIGHT
|
||||
|
||||
Replace *STORAGE_NODE_MANAGEMENT_INTERFACE_IP_ADDRESS* with the
|
||||
IP address of the management network on the storage node. Replace
|
||||
*DEVICE_NAME* with a storage device name on the same storage node.
|
||||
For example, using the first storage node with the /dev/sdb1 storage
|
||||
device and weight of 100::
|
||||
|
||||
# swift-ring-builder object.builder add r1z1-10.0.0.51:6000/sdb1 100
|
||||
|
||||
Repeat this command for each storage device on each storage node. In
|
||||
the example architecture, use the command in four variations::
|
||||
|
||||
# swift-ring-builder object.builder add r1z1-10.0.0.51:6000/sdb1 100
|
||||
Device d0r1z1-10.0.0.51:6002R10.0.0.51:6002/sdb1_"" with 100.0 weight got id 0
|
||||
# swift-ring-builder object.builder add r1z2-10.0.0.51:6000/sdc1 100
|
||||
Device d1r1z2-10.0.0.51:6002R10.0.0.51:6002/sdc1_"" with 100.0 weight got id 1
|
||||
# swift-ring-builder object.builder add r1z3-10.0.0.52:6000/sdb1 100
|
||||
Device d2r1z3-10.0.0.52:6002R10.0.0.52:6002/sdb1_"" with 100.0 weight got id 2
|
||||
# swift-ring-builder object.builder add r1z4-10.0.0.52:6000/sdc1 100
|
||||
Device d3r1z4-10.0.0.52:6002R10.0.0.52:6002/sdc1_"" with 100.0 weight got id 3
|
||||
|
||||
#. Verify the ring contents::
|
||||
|
||||
# swift-ring-builder object.builder
|
||||
object.builder, build version 4
|
||||
1024 partitions, 3.000000 replicas, 1 regions, 4 zones, 4 devices, 100.00 balance, 0.00 dispersion
|
||||
The minimum number of hours before a partition can be reassigned is 1
|
||||
The overload factor is 0.00% (0.000000)
|
||||
Devices: id region zone ip address port replication ip replication port name weight partitions balance meta
|
||||
0 1 1 10.0.0.51 6000 10.0.0.51 6000 sdb1 100.00 0 -100.00
|
||||
1 1 2 10.0.0.51 6000 10.0.0.51 6000 sdc1 100.00 0 -100.00
|
||||
2 1 3 10.0.0.52 6000 10.0.0.52 6000 sdb1 100.00 0 -100.00
|
||||
3 1 4 10.0.0.52 6000 10.0.0.52 6000 sdc1 100.00 0 -100.00
|
||||
|
||||
#. Rebalance the ring::
|
||||
|
||||
# swift-ring-builder object.builder rebalance
|
||||
Reassigned 1024 (100.00%) partitions. Balance is now 0.00. Dispersion is now 0.00
|
||||
|
||||
Distribute ring configuration files
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Copy the account.ring.gz, container.ring.gz, and object.ring.gz files to
|
||||
the /etc/swift directory on each storage node and any additional nodes
|
||||
running the proxy service.
|
||||
|
||||
Finalize installation
|
||||
---------------------
|
||||
|
||||
Configure hashes and default storage policy
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
#. Copy the swift service configuration file to the configuration directory::
|
||||
|
||||
# cp /usr/share/defaults/swift/swift.conf /etc/swift
|
||||
|
||||
#. Edit the ``/etc/swift/swift.conf`` file and complete the following
|
||||
actions:
|
||||
|
||||
* In the ``[swift-hash]`` section, configure the hash path prefix and
|
||||
suffix for your environment::
|
||||
|
||||
[swift-hash]
|
||||
...
|
||||
swift_hash_path_suffix = HASH_PATH_PREFIX
|
||||
swift_hash_path_prefix = HASH_PATH_SUFFIX
|
||||
|
||||
* In the ``[storage-policy:0]`` section, configure the default storage
|
||||
policy::
|
||||
|
||||
[storage-policy:0]
|
||||
...
|
||||
name = Policy-0
|
||||
default = yes
|
||||
|
||||
#. Copy the swift.conf file to the ``/etc/swift`` directory on each storage
|
||||
node and any additional nodes running the proxy service.
|
||||
#. On all nodes, ensure proper ownership of the configuration directory::
|
||||
|
||||
# systemctl restart update-triggers.target
|
||||
|
||||
#. On the controller node and any other nodes running the proxy service,
|
||||
start the Object Storage proxy service including its dependencies and
|
||||
configure them to start when the system boots::
|
||||
|
||||
# systemctl enable swift-proxy.service memcached.service
|
||||
# systemctl start swift-proxy.service memcached.service
|
||||
|
||||
#. On the storage nodes, start the Object Storage services and configure
|
||||
them to start when the system boots::
|
||||
|
||||
# systemctl enable swift-account.service \
|
||||
swift-account-auditor.service \
|
||||
swift-account-reaper.service \
|
||||
swift-account-replicator.service \
|
||||
swift-container.service \
|
||||
swift-container-auditor.service \
|
||||
swift-container-replicator.service \
|
||||
swift-container-updater.service \
|
||||
swift-object.service \
|
||||
swift-object-auditor.service \
|
||||
swift-object-replicator.service \
|
||||
swift-object-updater.service
|
||||
# systemctl start swift-account.service \
|
||||
swift-account-auditor.service \
|
||||
swift-account-reaper.service \
|
||||
swift-account-replicator.service \
|
||||
swift-container.service \
|
||||
swift-container-auditor.service \
|
||||
swift-container-replicator.service \
|
||||
swift-container-updater.service \
|
||||
swift-object.service \
|
||||
swift-object-auditor.service \
|
||||
swift-object-replicator.service \
|
||||
swift-object-updater.service
|
||||
@@ -1,290 +0,0 @@
|
||||
.. _openstack_orchestration:
|
||||
|
||||
Orchestration
|
||||
############################################################
|
||||
|
||||
The Orchestration module provides template-based OpenStack* API calls
|
||||
on a cloud application. It integrates core components of OpenStack into
|
||||
a one-file template system that allows you to create most OpenStack
|
||||
resource types, including: instances, floating IPs, volumes, security
|
||||
groups, and users. The module also provides advanced functionality:
|
||||
instance high availability, instance auto-scaling, and nested stacks,
|
||||
all of which allow OpenStack core projects to accommodate a larger user
|
||||
base.
|
||||
|
||||
The service enables deployers to integrate with the Orchestration module
|
||||
directly, or through custom plugins.
|
||||
|
||||
Installing and configuring controller node
|
||||
-----------------------------------------------
|
||||
|
||||
This section describes how to install and configure the Orchestration
|
||||
module, codenamed heat, on the controller node.
|
||||
|
||||
Configuring prerequisites
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Before you install and configure Orchestration, you must create a
|
||||
database, service credentials, and API endpoints.
|
||||
|
||||
#. To create the database, complete these steps:
|
||||
|
||||
* Use the database access client to connect to the database server
|
||||
as the ``root`` user::
|
||||
|
||||
$ mysql -u root -p
|
||||
|
||||
* Create the ``heat`` database::
|
||||
|
||||
CREATE DATABASE heat;
|
||||
|
||||
* Grant proper access to the ``heat`` database.
|
||||
Replace *HEAT_DBPASS* with a suitable password::
|
||||
|
||||
GRANT ALL PRIVILEGES ON heat.* TO 'heat'@'localhost' \
|
||||
IDENTIFIED BY 'HEAT_DBPASS';
|
||||
GRANT ALL PRIVILEGES ON heat.* TO 'heat'@'%' \
|
||||
IDENTIFIED BY 'HEAT_DBPASS';
|
||||
|
||||
* Exit the database access client.
|
||||
|
||||
#. Source the ``admin`` credentials to gain access to admin-only CLI
|
||||
commands::
|
||||
|
||||
$ source admin-openrc.sh
|
||||
|
||||
#. To create the service credentials, complete these steps:
|
||||
|
||||
* Create the ``heat`` user::
|
||||
|
||||
$ openstack user create --password-prompt heat
|
||||
User Password:
|
||||
Repeat User Password:
|
||||
+----------+----------------------------------+
|
||||
| Field | Value |
|
||||
+----------+----------------------------------+
|
||||
| email | None |
|
||||
| enabled | True |
|
||||
| id | 7fd67878dcd04d0393469ef825a7e005 |
|
||||
| name | heat |
|
||||
| username | heat |
|
||||
+----------+----------------------------------+
|
||||
|
||||
* Add the ``admin`` role to the ``heat`` user::
|
||||
|
||||
$ openstack role add --project service --user heat admin
|
||||
+-------+----------------------------------+
|
||||
| Field | Value |
|
||||
+-------+----------------------------------+
|
||||
| id | cd2cb9a39e874ea69e5d4b896eb16128 |
|
||||
| name | admin |
|
||||
+-------+----------------------------------+
|
||||
|
||||
* Create the ``heat_stack_owner`` role::
|
||||
|
||||
$ openstack role create heat_stack_owner
|
||||
+-------+----------------------------------+
|
||||
| Field | Value |
|
||||
+-------+----------------------------------+
|
||||
| id | c0a1cbee7261446abc873392f616de87 |
|
||||
| name | heat_stack_owner |
|
||||
+-------+----------------------------------+
|
||||
|
||||
* Add the ``heat_stack_owner`` role to the ``demo`` tenant and
|
||||
user.
|
||||
|
||||
Note: You must add the ``heat_stack_owner`` role to users that
|
||||
manage stacks::
|
||||
|
||||
$ openstack role add --project demo --user demo heat_stack_owner
|
||||
+-------+----------------------------------+
|
||||
| Field | Value |
|
||||
+-------+----------------------------------+
|
||||
| id | c0a1cbee7261446abc873392f616de87 |
|
||||
| name | heat_stack_owner |
|
||||
+-------+----------------------------------+
|
||||
|
||||
* Create the ``heat_stack_user`` role.
|
||||
|
||||
Note: The Orchestration service automatically assigns the ``heat_stack_user`` role
|
||||
to users that it creates during stack deployment. By default, this role restricts
|
||||
API operations. To avoid conflicts, do not add this role to users with the
|
||||
heat_stack_owner role::
|
||||
|
||||
$ openstack role create heat_stack_user
|
||||
+-------+----------------------------------+
|
||||
| Field | Value |
|
||||
+-------+----------------------------------+
|
||||
| id | e01546b1a81c4e32a6d14a9259e60154 |
|
||||
| name | heat_stack_user |
|
||||
+-------+----------------------------------+
|
||||
|
||||
* Create the ``heat`` and ``heat-cfn`` service entities::
|
||||
|
||||
+-------------+----------------------------------+
|
||||
| Field | Value |
|
||||
+-------------+----------------------------------+
|
||||
| description | Orchestration |
|
||||
| enabled | True |
|
||||
| id | 031112165cad4c2bb23e84603957de29 |
|
||||
| name | heat |
|
||||
| type | orchestration |
|
||||
+-------------+----------------------------------+
|
||||
$ openstack service create --name heat-cfn \
|
||||
--description "Orchestration" cloudformation
|
||||
+-------------+----------------------------------+
|
||||
| Field | Value |
|
||||
+-------------+----------------------------------+
|
||||
| description | Orchestration |
|
||||
| enabled | True |
|
||||
| id | 297740d74c0a446bbff867acdccb33fa |
|
||||
| name | heat-cfn |
|
||||
| type | cloudformation |
|
||||
+-------------+----------------------------------+
|
||||
|
||||
#. Create the Orchestration service API endpoints::
|
||||
|
||||
$ openstack endpoint create \
|
||||
--publicurl http://controller:8004/v1/%\(tenant_id\)s \
|
||||
--internalurl http://controller:8004/v1/%\(tenant_id\)s \
|
||||
--adminurl http://controller:8004/v1/%\(tenant_id\)s \
|
||||
--region RegionOne \
|
||||
orchestration
|
||||
+--------------+-----------------------------------------+
|
||||
| Field | Value |
|
||||
+--------------+-----------------------------------------+
|
||||
| adminurl | http://controller:8004/v1/%(tenant_id)s |
|
||||
| id | f41225f665694b95a46448e8676b0dc2 |
|
||||
| internalurl | http://controller:8004/v1/%(tenant_id)s |
|
||||
| publicurl | http://controller:8004/v1/%(tenant_id)s |
|
||||
| region | RegionOne |
|
||||
| service_id | 031112165cad4c2bb23e84603957de29 |
|
||||
| service_name | heat |
|
||||
| service_type | orchestration |
|
||||
+--------------+-----------------------------------------+
|
||||
$ openstack endpoint create \
|
||||
--publicurl http://controller:8000/v1 \
|
||||
--internalurl http://controller:8000/v1 \
|
||||
--adminurl http://controller:8000/v1 \
|
||||
--region RegionOne \
|
||||
cloudformation
|
||||
+--------------+----------------------------------+
|
||||
| Field | Value |
|
||||
+--------------+----------------------------------+
|
||||
| adminurl | http://controller:8000/v1 |
|
||||
| id | f41225f665694b95a46448e8676b0dc2 |
|
||||
| internalurl | http://controller:8000/v1 |
|
||||
| publicurl | http://controller:8000/v1 |
|
||||
| region | RegionOne |
|
||||
| service_id | 297740d74c0a446bbff867acdccb33fa |
|
||||
| service_name | heat-cfn |
|
||||
| service_type | cloudformation |
|
||||
+--------------+----------------------------------+
|
||||
|
||||
Installing and configuring the Orchestration components
|
||||
----------------------------------------------------------
|
||||
|
||||
To install and configure the Orchestration components:
|
||||
|
||||
#. Install OpenStack Orchestration bundle::
|
||||
|
||||
# clr_bundle_add openstack-orchestration
|
||||
|
||||
#. Create the ``/etc/heat/heat.conf file``::
|
||||
|
||||
# mkdir /etc/heat # touch /etc/heat/heat.conf
|
||||
|
||||
#. Edit the ``/etc/heat/heat.conf`` file and complete the following
|
||||
actions:
|
||||
|
||||
* In the ``[database]`` section, configure database access.
|
||||
Replace *HEAT_DBPASS* with the password you chose for the
|
||||
Orchestration database::
|
||||
|
||||
[database]
|
||||
...
|
||||
connection = mysql://heat:HEAT_DBPASS@controller/heat
|
||||
|
||||
* In the ``[DEFAULT]`` and ``[oslo_messaging_rabbit]`` sections,
|
||||
configure RabbitMQ message queue access.
|
||||
Replace *``RABBIT_PASS``* with the password you chose for
|
||||
the ``openstack`` account in RabbitMQ::
|
||||
|
||||
[DEFAULT]
|
||||
...
|
||||
rpc_backend = rabbit
|
||||
[oslo_messaging_rabbit]
|
||||
...
|
||||
rabbit_host = controller
|
||||
rabbit_userid = openstack
|
||||
rabbit_password = RABBIT_PASS
|
||||
|
||||
* In the ``[keystone_authtoken]`` and ``[ec2authtoken]`` sections,
|
||||
configure Identity service access. Replace *HEAT_PASS* with
|
||||
the password you chose for the ``heat`` user in the Identity
|
||||
service::
|
||||
|
||||
[keystone_authtoken]
|
||||
...
|
||||
auth_uri = http://controller:5000/v2.0
|
||||
identity_uri = http://controller:35357
|
||||
admin_tenant_name = service
|
||||
admin_user = heat
|
||||
admin_password = HEAT_PASS
|
||||
[ec2authtoken]
|
||||
...
|
||||
auth_uri = http://controller:5000/v2.0
|
||||
|
||||
* In the ``[DEFAULT]`` section, configure the metadata and wait
|
||||
condition URLs::
|
||||
|
||||
[DEFAULT]
|
||||
...
|
||||
heat_metadata_server_url = http://controller:8000
|
||||
heat_waitcondition_server_url = http://controller:8000/v1/waitcondition
|
||||
|
||||
* In the ``[DEFAULT]`` section, configure information about the
|
||||
heat Identity service domain. Replace *``HEAT_DOMAIN_PASS``*
|
||||
with the password you chose for the admin user of
|
||||
the ``heat`` user domain in the Identity service::
|
||||
|
||||
[DEFAULT]
|
||||
...
|
||||
stack_domain_admin = heat_domain_admin
|
||||
stack_domain_admin_password = HEAT_DOMAIN_PASS
|
||||
stack_user_domain_name = heat_user_domain
|
||||
|
||||
#. Source the ``admin`` credentials to gain access to admin-only CLI
|
||||
commands::
|
||||
|
||||
$ source admin-openrc.sh
|
||||
|
||||
#. Create the heat domain in Identity service.
|
||||
Replace *``HEAT_DOMAIN_PASS``* with a suitable
|
||||
password::
|
||||
|
||||
$ heat-keystone-setup-domain \
|
||||
--stack-user-domain-name heat_user_domain \
|
||||
--stack-domain-admin heat_domain_admin \
|
||||
--stack-domain-admin-password HEAT_DOMAIN_PASS
|
||||
|
||||
#. Let systemd set the correct permissions for files in ``/etc/heat``::
|
||||
|
||||
# systemctl restart update-triggers.target
|
||||
|
||||
#. Populate the Orchestration database::
|
||||
|
||||
# su -s /bin/sh -c "heat-manage db_sync" heat``
|
||||
|
||||
Finalizing installation
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Complete this step to finalize the installation:
|
||||
|
||||
* Start the Orchestration services and configure them to start when the
|
||||
system boots::
|
||||
|
||||
# systemctl enable heat-api.service heat-api-cfn.service heat-engine.service
|
||||
# systemctl start heat-api.service heat-api-cfn.service heat-engine.service``
|
||||
|
||||
Next topic: :ref:`openstack_telemetry`.
|
||||
@@ -1,53 +0,0 @@
|
||||
.. _openstack_supporting-database:
|
||||
|
||||
Database
|
||||
########
|
||||
|
||||
Most OpenStack* services use an SQL database to store information. The
|
||||
database typically runs on the controller node. The procedures in this
|
||||
guide use MariaDB.
|
||||
|
||||
Install and configure the database server
|
||||
-----------------------------------------
|
||||
|
||||
#. Install MariaDB bundle::
|
||||
|
||||
# swupd bundle-add database-mariadb
|
||||
# swupd verify --fix
|
||||
|
||||
#. Create the ``/etc/mariadb/`` folder and the ``/etc/mariadb/openstack.cnf``
|
||||
file::
|
||||
|
||||
# mkdir /etc/mariadb
|
||||
# touch /etc/mariadb/openstack.cnf
|
||||
|
||||
#. Add the ``[mysqld]`` section, set the bind-address key to the
|
||||
management IP address of the controller node to enable access by
|
||||
other nodes via the management network and enable useful options for
|
||||
UTF-8 character set::
|
||||
|
||||
[mysqld]
|
||||
bind-address = 10.0.0.11
|
||||
default-storage-engine = innodb
|
||||
innodb_file_per_table
|
||||
collation-server = utf8_general_ci
|
||||
init-connect = 'SET NAMES utf8'
|
||||
character-set-server = utf8
|
||||
|
||||
Finalizing database installation
|
||||
--------------------------------
|
||||
|
||||
Complete the following steps to finalize database installation:
|
||||
|
||||
#. Start the database service and configure it to start when the system
|
||||
boots::
|
||||
|
||||
# systemctl enable mariadb.service
|
||||
# systemctl start mariadb.service
|
||||
|
||||
#. Secure the database service including choosing a suitable password
|
||||
for the root account::
|
||||
|
||||
# mysql_secure_installation
|
||||
|
||||
Next topic: :ref:`openstack_supporting-messaging`.
|
||||
@@ -1,48 +0,0 @@
|
||||
.. _openstack_supporting-messaging:
|
||||
|
||||
Message queue
|
||||
#############
|
||||
|
||||
OpenStack* uses a `message queue` to coordinate operations and
|
||||
status information among services. The message queue service typically
|
||||
runs on the controller node. OpenStack supports several message queue
|
||||
services. This guide implements the RabbitMQ message queue service.
|
||||
|
||||
Install the message queue service
|
||||
---------------------------------
|
||||
|
||||
#. Install the message queue bundle.::
|
||||
|
||||
# swupd bundle-add message-broker-rabbitmq
|
||||
# swupd verify --fix
|
||||
|
||||
Configuring the message broker service
|
||||
--------------------------------------
|
||||
|
||||
Complete the following steps to configure the message broker service:
|
||||
|
||||
#. Message broker service needs to be able to resolve to itself. Add the
|
||||
following line to ``/etc/hosts``.::
|
||||
|
||||
127.0.0.1 controller
|
||||
|
||||
#. Start the message broker service and configure it to start when the
|
||||
system boots.::
|
||||
|
||||
# systemctl enable rabbitmq-server.service
|
||||
# systemctl start rabbitmq-server.service
|
||||
|
||||
#. Add the OpenStack user. Replace ``RABBIT_PASS`` with a suitable password.::
|
||||
|
||||
# rabbitmqctl add_user openstack RABBIT_PASS
|
||||
Creating user openstack ...
|
||||
...done.
|
||||
|
||||
|
||||
#. Permit configuration, write, and read access for the OpenStack user.::
|
||||
|
||||
# rabbitmqctl set_permissions openstack ".*" ".*" ".*"
|
||||
Setting permissions for user "openstack" in vhost "/" ...
|
||||
...done.
|
||||
|
||||
Next topic: :ref:`openstack_identity`.
|
||||
@@ -1,78 +0,0 @@
|
||||
.. _openstack_sys_req_and_pw_summary:
|
||||
|
||||
System requirements and password summary
|
||||
############################################################
|
||||
|
||||
System requirements
|
||||
----------------------------
|
||||
|
||||
For best performance, we recommend that your environment meets or
|
||||
exceeds the following hardware requirements:
|
||||
|
||||
- Controller Node: 1 processor, 2 GB memory, and 5 GB storage.
|
||||
- Compute Node: 1 processor, 2 GB memory, and 10 GB storage.
|
||||
|
||||
For OpenStack* services, this guide uses \ ``SERVICE_PASS``\ to reference
|
||||
service account passwords and ``SERVICE_DBPASS`` to reference database
|
||||
passwords.
|
||||
|
||||
Prerequisites
|
||||
---------------------
|
||||
|
||||
All nodes require Internet access to install OpenStack bundles and
|
||||
perform maintenance tasks such as periodic updates.
|
||||
|
||||
OpenStack and supporting services require administrative privileges
|
||||
during installation and operation.
|
||||
|
||||
You must also configure networking so that each node can resolve the
|
||||
other nodes by name in addition to IP address. For example, the
|
||||
``controller`` name must resolve to ``10.0.0.11``, the IP address of the
|
||||
management interface on the controller node.
|
||||
|
||||
To configure name resolution:
|
||||
|
||||
#. Set the hostname of the node to ``controller``::
|
||||
|
||||
# hostnamectl set-hostname controller
|
||||
|
||||
#. Edit the ``/etc/hosts`` file to contain the following::
|
||||
|
||||
# controller 10.0.0.11 controller
|
||||
# compute1 10.0.0.31 compute1
|
||||
|
||||
Password summary
|
||||
------------------------
|
||||
|
||||
The following table provides a list of services that require passwords
|
||||
and their associated references in the guide:
|
||||
|
||||
+----------------------------------------+--------------------------------------------------+
|
||||
| **Password name** | **Description** |
|
||||
+----------------------------------------+--------------------------------------------------+
|
||||
| Database password (no variable used) | Root password for the database |
|
||||
+----------------------------------------+--------------------------------------------------+
|
||||
| RABBIT_PASS | Password of user guest of RabbitMQ |
|
||||
+----------------------------------------+--------------------------------------------------+
|
||||
| KEYSTONE_DBPASS | Database password of Identity service |
|
||||
+----------------------------------------+--------------------------------------------------+
|
||||
| DEMO_PASS | Password of user demo |
|
||||
+----------------------------------------+--------------------------------------------------+
|
||||
| ADMIN_PASS | Password of user admin |
|
||||
+----------------------------------------+--------------------------------------------------+
|
||||
| GLANCE_DBPASS | Database password for Image Service |
|
||||
+----------------------------------------+--------------------------------------------------+
|
||||
| GLANCE_PASS | Password of Image Service user glance |
|
||||
+----------------------------------------+--------------------------------------------------+
|
||||
| NOVA_DBPASS | Database password for Compute service |
|
||||
+----------------------------------------+--------------------------------------------------+
|
||||
| NOVA_PASS | Password of Compute service user nova |
|
||||
+----------------------------------------+--------------------------------------------------+
|
||||
| DASH_DBPASS | Database password for the dashboard |
|
||||
+----------------------------------------+--------------------------------------------------+
|
||||
| CINDER_DBPASS | Database password for the Block Storage service |
|
||||
+----------------------------------------+--------------------------------------------------+
|
||||
| CINDER_PASS | Password of Block Storage service user cinder |
|
||||
+----------------------------------------+--------------------------------------------------+
|
||||
|
||||
Next topic: :ref:`openstack_installing_bundles`.
|
||||
@@ -1,224 +0,0 @@
|
||||
.. _openstack_telemetry:
|
||||
|
||||
Telemetry
|
||||
############################################################
|
||||
|
||||
Overview
|
||||
---------
|
||||
|
||||
The Telemetry module performs the following functions:
|
||||
|
||||
- Efficiently polls metering data related to OpenStack services;
|
||||
- Collects event and metering data by monitoring notifications sent
|
||||
from services;
|
||||
- Publishes collected data to various targets, including data stores
|
||||
and message queues; and
|
||||
- Creates alarms when collected data breaks defined rules.
|
||||
|
||||
Installing and configuring controller node
|
||||
-----------------------------------------------
|
||||
|
||||
This section describes how to install and configure the Telemetry
|
||||
module, code-named ceilometer, on the controller node. The Telemetry
|
||||
module uses separate agents to collect measurements from each OpenStack
|
||||
service in your environment.
|
||||
|
||||
Prerequisites
|
||||
~~~~~~~~~~~~~~~
|
||||
|
||||
Before installing and configuring the ``telemetry`` module, install
|
||||
MongoDB* and create a MongoDB database, service credentials, and API
|
||||
endpoint.
|
||||
|
||||
#. Install the MongoDB bundle::
|
||||
|
||||
# clr_bundle_add database-mongodb
|
||||
|
||||
#. Create the ``/etc/mongodb/`` folder and the
|
||||
``/etc/mongodb/openstack.cnf`` file.
|
||||
#. Configure the ``bind_ip`` key to use the management interface IP
|
||||
address of the controller node::
|
||||
|
||||
bind_ip = 10.0.0.11
|
||||
|
||||
#. Start the database service and configure it to start when the system
|
||||
boots with the following commands::
|
||||
|
||||
# systemctl enable mongodb.service
|
||||
# systemctl start mongodb.service
|
||||
|
||||
#. Create the ``ceilometer`` database. Replace *CEILOMETER_DBPASS*
|
||||
with a suitable password::
|
||||
|
||||
# mongo --host controller --eval '
|
||||
db = db.getSiblingDB("ceilometer");
|
||||
db.createUser({user: "ceilometer",
|
||||
pwd: "CEILOMETER_DBPASS",
|
||||
roles: [ "readWrite", "dbAdmin" ]})'
|
||||
|
||||
MongoDB shell version: 2.6.x
|
||||
connecting to: controller:27017/test
|
||||
Successfully added user: { "user" : "ceilometer", "roles" : [ "readWrite", "dbAdmin" ] }
|
||||
|
||||
#. Source the ``admin`` credentials to gain access to admin-only CLI
|
||||
commands::
|
||||
|
||||
$ source admin-openrc.sh
|
||||
|
||||
#. To create the service credentials, complete these steps:
|
||||
|
||||
* Create the ``ceilometer`` user::
|
||||
|
||||
$ openstack user create --password-prompt ceilometer
|
||||
User Password:
|
||||
Repeat User Password:
|
||||
+----------+----------------------------------+
|
||||
| Field | Value |
|
||||
+----------+----------------------------------+
|
||||
| email | None |
|
||||
| enabled | True |
|
||||
| id | b7657c9ea07a4556aef5d34cf70713a3 |
|
||||
| name | ceilometer |
|
||||
| username | ceilometer |
|
||||
+----------+----------------------------------+
|
||||
|
||||
* Add the ``admin`` role to the ``ceilometer`` user::
|
||||
|
||||
$ openstack role add --project service --user ceilometer admin
|
||||
+-------+----------------------------------+
|
||||
| Field | Value |
|
||||
+-------+----------------------------------+
|
||||
| id | cd2cb9a39e874ea69e5d4b896eb16128 |
|
||||
| name | admin |
|
||||
+-------+----------------------------------+
|
||||
|
||||
* Create the ``ceilometer`` service entity::
|
||||
|
||||
$ openstack service create --name ceilometer \
|
||||
--description "Telemetry" metering
|
||||
+-------------+----------------------------------+
|
||||
| Field | Value |
|
||||
+-------------+----------------------------------+
|
||||
| description | Telemetry |
|
||||
| enabled | True |
|
||||
| id | 3405453b14da441ebb258edfeba96d83 |
|
||||
| name | ceilometer |
|
||||
| type | metering |
|
||||
+-------------+----------------------------------+
|
||||
|
||||
#. Create the Telemetry module API endpoint::
|
||||
|
||||
$ openstack endpoint create \
|
||||
--publicurl http://controller:8777 \
|
||||
--internalurl http://controller:8777 \
|
||||
--adminurl http://controller:8777 \
|
||||
--region RegionOne \
|
||||
metering
|
||||
+--------------+----------------------------------+
|
||||
| Field | Value |
|
||||
+--------------+----------------------------------+
|
||||
| adminurl | http://controller:8777 |
|
||||
| id | d3716d85b10d4e60a67a52c6af0068cd |
|
||||
| internalurl | http://controller:8777 |
|
||||
| publicurl | http://controller:8777 |
|
||||
| region | RegionOne |
|
||||
| service_id | 3405453b14da441ebb258edfeba96d83 |
|
||||
| service_name | ceilometer |
|
||||
| service_type | metering |
|
||||
+--------------+----------------------------------+
|
||||
|
||||
Installing and configuring the Telemetry module components
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
#. Install the OpenStack Telemetry Controller bundle::
|
||||
|
||||
# clr_bundle_add openstack-telemetry-controller
|
||||
|
||||
#. Generate a random value to use as the telemetry secret::
|
||||
|
||||
$ openssl rand -hex 10
|
||||
|
||||
#. Custom configurations will be located at ``/etc/ceilometer``.
|
||||
|
||||
* Create ``/etc/ceilometer`` directory::
|
||||
|
||||
mkdir /etc/ceilometer
|
||||
|
||||
* Create the empty ceilometer configuration file::
|
||||
|
||||
/etc/ceilometer/ceilometer.conf
|
||||
touch /etc/ceilometer/ceilometer.conf
|
||||
|
||||
#. Edit the following file:\ ``/etc/ceilometer/ceilometer.conf``\ Then
|
||||
complete the following actions:
|
||||
|
||||
* In the ``[database]`` section, configure database access. Replace
|
||||
*``CEILOMETER_DBPASS``* with the password you chose for the
|
||||
Telemetry module database. You must escape special characters such
|
||||
as ':', '/', '+', and '@' in the connection string in accordance
|
||||
with RFC2396::
|
||||
|
||||
[database]
|
||||
...
|
||||
connection = mongodb://ceilometer:CEILOMETER_DBPASS@controller:27017/ceilometer
|
||||
|
||||
* In the ``[DEFAULT]`` and ``[oslo_messaging_rabbit]`` sections,
|
||||
configure RabbitMQ message queue access. Replace *``RABBIT_PASS``*
|
||||
with the password you chose for the ``openstack`` account in
|
||||
RabbitMQ::
|
||||
|
||||
[DEFAULT]
|
||||
...
|
||||
rpc_backend = rabbit
|
||||
[oslo_messaging_rabbit]
|
||||
rabbit_host = controller
|
||||
rabbit_userid = openstack
|
||||
rabbit_password = RABBIT_PASS
|
||||
|
||||
* In the ``[DEFAULT]`` and ``[keystone_authtoken]`` sections,
|
||||
configure Identity service access. Replace *``CEILOMETER_PASS``*
|
||||
with the password you chose for the ``celiometer`` user in the
|
||||
Identity service::
|
||||
|
||||
[DEFAULT]
|
||||
...
|
||||
auth_strategy = keystone
|
||||
[keystone_authtoken]
|
||||
auth_uri = http://controller:5000/v2.0
|
||||
identity_uri = http://controller:35357
|
||||
admin_tenant_name = service
|
||||
admin_user = ceilometer
|
||||
admin_password = CEILOMETER_PASS
|
||||
|
||||
* In the ``[service_credentials]`` section, configure service
|
||||
credentials. Replace *``CEILOMETER_PASS``* with the password you
|
||||
chose for the ``ceilometer`` user in the Identity service::
|
||||
|
||||
[service_credentials]
|
||||
...
|
||||
os_auth_url = http://controller:5000/v2.0
|
||||
os_username = ceilometer
|
||||
os_tenant_name = service
|
||||
os_password = CEILOMETER_PASS
|
||||
os_endpoint_type = internalURL
|
||||
os_region_name = RegionOne
|
||||
|
||||
* In the ``[publisher]`` section, configure the telemetry secret.
|
||||
Replace *``TELEMETRY_SECRET``* with the telemetry secret that you
|
||||
generated in a previous step::
|
||||
|
||||
[publisher]
|
||||
...
|
||||
telemetry_secret = TELEMETRY_SECRET
|
||||
|
||||
Finalizing installation
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
* Start the Telemetry services and configure them to start when the system boots::
|
||||
|
||||
# systemctl enable ceilometer-api.service ceilometer-agent-notification.service ceilometer-agent-central.service ceilometer-collector.service \
|
||||
ceilometer-alarm-evaluator.service ceilometer-alarm-notifier.service
|
||||
# systemctl start ceilometer-api.service ceilometer-agent-notification.service ceilometer-agent-central.service ceilometer-collector.service \
|
||||
ceilometer-alarm-evaluator.service ceilometer-alarm-notifier.service
|
||||
|
||||
Next topic: :ref:`openstack_object_storage`.
|
||||
@@ -1,27 +0,0 @@
|
||||
.. _openstack_use_cases:
|
||||
|
||||
OpenStack* use cases with Clear Linux* OS for Intel® Architecture
|
||||
###################################################################
|
||||
|
||||
The installation and configuration of a Cloud Management Platform
|
||||
depends on use cases and associated architectural choices.
|
||||
|
||||
OpenStack supports the following use cases:
|
||||
|
||||
- *General purpose* -- A cloud built with common components that should
|
||||
address about 80 percent of common use cases.
|
||||
|
||||
- *Compute-focused* -- A cloud designed to address compute-intensive
|
||||
workloads such as high performance computing (HPC).
|
||||
|
||||
- *Storage-focused* -- A cloud focused on storage intensive workloads
|
||||
such as data analytics with parallel file systems.
|
||||
|
||||
- *Network-focused* -- A cloud depending on high performance and
|
||||
reliable networking, such as a Content Delivery Network (CDN).
|
||||
|
||||
Clear Linux OS for Intel Architecture is designed with all of these use
|
||||
cases in mind, but the initial target is to enable only those services
|
||||
required for Cloud.
|
||||
|
||||
Next topic: :ref:`openstack_bundle_and_service_summary`.
|
||||
@@ -1,5 +0,0 @@
|
||||
.. |codename| replace:: Zephyr Kernel
|
||||
|
||||
.. |PM| replace:: Hirally Rodriguez Santiago
|
||||
|
||||
.. |project| replace:: Zephyr Project
|
||||
@@ -1,105 +0,0 @@
|
||||
About software update
|
||||
################################################################
|
||||
|
||||
Linux*-based operating systems contain the code of several hundred, if
|
||||
not thousands, of open source projects. To make this manageable,
|
||||
distributions use a concept called "packages" to configure and compile
|
||||
the source code of these projects into binaries, which can then be
|
||||
logically installed.
|
||||
|
||||
Many distributions then combine these compiled binaries into so-called
|
||||
packages, resolving dependencies and providing everything needed to
|
||||
install. This is the granularity at which typical distributions deploy
|
||||
their software, enabling system administrators to install and update
|
||||
each package individually or as a set, using tools such as "yum" and
|
||||
"apt-get."
|
||||
|
||||
The Clear way
|
||||
-------------
|
||||
|
||||
The Clear Linux OS for Intel® Architecture does things a bit
|
||||
differently. While we use the concept of packages to manage compiling
|
||||
source code into installable binaries, we do not deploy software through
|
||||
packages as many distributions do. Instead, we provide "bundles" that
|
||||
each contain a set of functionality for the system
|
||||
administrator--functionality that is enabled by composing all the
|
||||
required upstream open source projects into one logical unit: a bundle.
|
||||
|
||||
There is another notable difference between package-based distributions
|
||||
and the Clear Linux OS for Intel Architecture. On a package-based OS, a
|
||||
system administrator can update each individual package or piece of
|
||||
software to a newer (or older!) version. In the Clear Linux OS for Intel
|
||||
Architecture, an update translates to an entirely new OS version,
|
||||
containing one or many updates; it is not possible to update a piece of
|
||||
the system while remaining on the same version of Clear Linux.
|
||||
|
||||
Why would you want this? This may sound like a huge restriction or
|
||||
limitation at first, but we consider this a great feature. Imagine a
|
||||
cloud environment with many machines. In this case, it is desirable and
|
||||
more advantageous to have a homogeneous set of software.
|
||||
|
||||
With traditional distributions, to describe what version of software a
|
||||
server is running, one might need to:
|
||||
|
||||
- List and keep track of the current OS release (generally
|
||||
uninformative about any singular packages or functionality)
|
||||
|
||||
- Keep track of all packages and repositories used, updating those as
|
||||
required to keep up to date
|
||||
|
||||
- List and keep track of every package available and installed on the
|
||||
system, none of which are directly tied to the current OS release
|
||||
|
||||
This is done very well, but given the nearly endless combinations of
|
||||
packages and versions of packages a server may have, it quickly becomes
|
||||
non-trivial to define what "version" the system is and what software it
|
||||
is running without explicitly going through each system and inspecting
|
||||
every package.
|
||||
|
||||
With the Clear Linux OS for Intel Architecture, we must keep track of:
|
||||
|
||||
- One single number
|
||||
|
||||
That number represents the current OS release, and it is sufficient to
|
||||
describe the versions of all the software on the OS. Each build is
|
||||
composed of a specific set of bundles made from a particular version of
|
||||
packages. This matters on a daily basis to system administrators, who
|
||||
need to determine which of their systems do not have the latest security
|
||||
fixes, or which combinations of software have been tested with which
|
||||
other pieces. Every release of the same number is guaranteed to contain
|
||||
the same versions of software, so there is no ambiguity between two
|
||||
systems running the same Clear Linux OS for Intel Architecture.
|
||||
|
||||
Incredible update speeds
|
||||
------------------------
|
||||
|
||||
Software updates with Clear Linux OS for Intel Architecture are also
|
||||
efficient; bundles are only describing a set of files, and the update
|
||||
technology only updates files that actually changed, using so-called
|
||||
binary-delta technology for efficiency. Updating using this method is
|
||||
different from operating systems that use packages as the unit of
|
||||
deployment. In those operating systems, the entire package gets updated
|
||||
when needed, even if only one small file in that package has changed.
|
||||
|
||||
It is quite common for a full OS update fixing a security hole to be
|
||||
only 15 kilobytes in total update size. If only several kilobytes need
|
||||
to be changed, it does not make sense to re-download and reinstall an
|
||||
entire package or suite of programs just to incorporate a miniscule (yet
|
||||
important) update. Through binary deltas, the OS is able to update only
|
||||
those bits that changed, yielding very small update content (deltas)
|
||||
that can be applied exceedingly fast. One can then expect a major
|
||||
security patch or core update to take seconds.
|
||||
|
||||
We realize that while our definition of bundles makes sense to us, each
|
||||
data center operator may have special needs and ideas. For that reason
|
||||
we are working on completing a "mixer" tool, which would allow users of
|
||||
Clear Linux OS for Intel Architecture to customize and add bundles and
|
||||
their own software while still using the content of the operating
|
||||
system, and its updates, as the base. This way system administrators can
|
||||
focus on the pieces of their OS deployment that are custom to their
|
||||
environment, while continuing to stay on a controlled update stream.
|
||||
|
||||
Note: The software update technology for Clear Linux OS for Intel Architecture
|
||||
was first presented at the Linux Plumbers conference in 2012.
|
||||
|
||||
|
||||
@@ -1,39 +0,0 @@
|
||||
How to run the updater
|
||||
############################################################
|
||||
|
||||
This section describes how to manually trigger the software update code in Clear Linux* OS for Intel® Architecture.
|
||||
|
||||
Prerequisites
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
- System is up and running a Clear Linux OS for Intel
|
||||
Architecture official build 300 or later.
|
||||
|
||||
- Device is on a well-connected network.
|
||||
|
||||
- Device is able to connect to release infrastructure. For example:
|
||||
http://update.clearlinux.org/update/300/
|
||||
|
||||
Running the updater
|
||||
~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
#. Open a Terminal Emulator.
|
||||
|
||||
#. Become root and trigger update by typing ``# swupd_update``
|
||||
|
||||
#. If the updater console output indicates a kernel update occurred,
|
||||
then at your convenience reboot to begin using the new OS version.
|
||||
|
||||
Updater options
|
||||
~~~~~~~~~~~~~~~
|
||||
|
||||
Help options:
|
||||
|
||||
- ``-h, --help`` Display help options.
|
||||
|
||||
Application options:
|
||||
|
||||
- ``-d, --download`` Download all content, but do not actually install
|
||||
the update.
|
||||
|
||||
- ``-v, --verbose`` Increase verbosity of log and console messages.
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 673 B |
@@ -1,585 +0,0 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@import url("basic.css");
|
||||
|
||||
/* -- page layout ----------------------------------------------------------- */
|
||||
|
||||
body {
|
||||
font-family: 'goudy old style', 'minion pro', 'bell mt', Georgia, 'Hiragino Mincho Pro', serif;
|
||||
font-size: 17px;
|
||||
background-color: white;
|
||||
color: #000;
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
div.document {
|
||||
width: 940px;
|
||||
margin: 30px auto 0 auto;
|
||||
}
|
||||
|
||||
div.documentwrapper {
|
||||
float: left;
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
div.bodywrapper {
|
||||
margin: 0 0 0 220px;
|
||||
}
|
||||
|
||||
div.sphinxsidebar {
|
||||
width: 220px;
|
||||
}
|
||||
|
||||
hr {
|
||||
border: 1px solid #B1B4B6;
|
||||
}
|
||||
|
||||
div.body {
|
||||
background-color: #ffffff;
|
||||
color: #3E4349;
|
||||
padding: 0 30px 0 30px;
|
||||
}
|
||||
|
||||
div.footer {
|
||||
width: 940px;
|
||||
margin: 20px auto 30px auto;
|
||||
font-size: 14px;
|
||||
color: #888;
|
||||
text-align: right;
|
||||
}
|
||||
|
||||
div.footer a {
|
||||
color: #888;
|
||||
}
|
||||
|
||||
|
||||
div.relations {
|
||||
display: none;
|
||||
}
|
||||
|
||||
|
||||
div.sphinxsidebar a {
|
||||
color: #444;
|
||||
text-decoration: none;
|
||||
border-bottom: 1px dotted #999;
|
||||
}
|
||||
|
||||
div.sphinxsidebar a:hover {
|
||||
border-bottom: 1px solid #999;
|
||||
}
|
||||
|
||||
div.sphinxsidebar {
|
||||
font-size: 14px;
|
||||
line-height: 1.5;
|
||||
}
|
||||
|
||||
div.sphinxsidebarwrapper {
|
||||
padding: 18px 10px;
|
||||
}
|
||||
|
||||
div.sphinxsidebarwrapper p.logo {
|
||||
padding: 0;
|
||||
margin: -10px 0 0 0px;
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
div.sphinxsidebarwrapper h1.logo {
|
||||
margin-top: -10px;
|
||||
text-align: center;
|
||||
margin-bottom: 5px;
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
div.sphinxsidebarwrapper h1.logo-name {
|
||||
margin-top: 0px;
|
||||
}
|
||||
|
||||
div.sphinxsidebarwrapper p.blurb {
|
||||
margin-top: 0;
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
div.sphinxsidebar h3,
|
||||
div.sphinxsidebar h4 {
|
||||
font-family: 'Garamond', 'Georgia', serif;
|
||||
color: #444;
|
||||
font-size: 24px;
|
||||
font-weight: normal;
|
||||
margin: 0 0 5px 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
div.sphinxsidebar h4 {
|
||||
font-size: 20px;
|
||||
}
|
||||
|
||||
div.sphinxsidebar h3 a {
|
||||
color: #444;
|
||||
}
|
||||
|
||||
div.sphinxsidebar p.logo a,
|
||||
div.sphinxsidebar h3 a,
|
||||
div.sphinxsidebar p.logo a:hover,
|
||||
div.sphinxsidebar h3 a:hover {
|
||||
border: none;
|
||||
}
|
||||
|
||||
div.sphinxsidebar p {
|
||||
color: #555;
|
||||
margin: 10px 0;
|
||||
}
|
||||
|
||||
div.sphinxsidebar ul {
|
||||
margin: 10px 0;
|
||||
padding: 0;
|
||||
color: #000;
|
||||
}
|
||||
|
||||
div.sphinxsidebar ul li.toctree-l1 > a {
|
||||
font-size: 120%;
|
||||
}
|
||||
|
||||
div.sphinxsidebar ul li.toctree-l2 > a {
|
||||
font-size: 110%;
|
||||
}
|
||||
|
||||
div.sphinxsidebar input {
|
||||
border: 1px solid #CCC;
|
||||
font-family: 'goudy old style', 'minion pro', 'bell mt', Georgia, 'Hiragino Mincho Pro', serif;
|
||||
font-size: 1em;
|
||||
}
|
||||
|
||||
div.sphinxsidebar hr {
|
||||
border: none;
|
||||
height: 1px;
|
||||
color: #999;
|
||||
background: #999;
|
||||
|
||||
text-align: left;
|
||||
margin-left: 0;
|
||||
width: 50%;
|
||||
}
|
||||
|
||||
/* -- body styles ----------------------------------------------------------- */
|
||||
|
||||
a {
|
||||
color: #004B6B;
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
a:hover {
|
||||
color: #6D4100;
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
div.body h1,
|
||||
div.body h2,
|
||||
div.body h3,
|
||||
div.body h4,
|
||||
div.body h5,
|
||||
div.body h6 {
|
||||
font-family: 'Garamond', 'Georgia', serif;
|
||||
font-weight: normal;
|
||||
margin: 30px 0px 10px 0px;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
div.body h1 { margin-top: 0; padding-top: 0; font-size: 240%; }
|
||||
div.body h2 { font-size: 180%; }
|
||||
div.body h3 { font-size: 150%; }
|
||||
div.body h4 { font-size: 130%; }
|
||||
div.body h5 { font-size: 100%; }
|
||||
div.body h6 { font-size: 100%; }
|
||||
|
||||
a.headerlink {
|
||||
color: #DDD;
|
||||
padding: 0 4px;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
a.headerlink:hover {
|
||||
color: #444;
|
||||
background: #EAEAEA;
|
||||
}
|
||||
|
||||
div.body p, div.body dd, div.body li {
|
||||
line-height: 1.4em;
|
||||
}
|
||||
|
||||
div.admonition {
|
||||
margin: 20px 0px;
|
||||
padding: 10px 30px;
|
||||
background-color: #FCC;
|
||||
border: 1px solid #FAA;
|
||||
}
|
||||
|
||||
div.admonition tt.xref, div.admonition a tt {
|
||||
border-bottom: 1px solid #fafafa;
|
||||
}
|
||||
|
||||
dd div.admonition {
|
||||
margin-left: -60px;
|
||||
padding-left: 60px;
|
||||
}
|
||||
|
||||
div.admonition p.admonition-title {
|
||||
font-family: 'Garamond', 'Georgia', serif;
|
||||
font-weight: normal;
|
||||
font-size: 24px;
|
||||
margin: 0 0 10px 0;
|
||||
padding: 0;
|
||||
line-height: 1;
|
||||
}
|
||||
|
||||
div.admonition p.last {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
div.highlight {
|
||||
background-color: white;
|
||||
}
|
||||
|
||||
dt:target, .highlight {
|
||||
background: #FAF3E8;
|
||||
}
|
||||
|
||||
div.note {
|
||||
background-color: #EEE;
|
||||
border: 1px solid #CCC;
|
||||
}
|
||||
|
||||
div.seealso {
|
||||
background-color: #EEE;
|
||||
border: 1px solid #CCC;
|
||||
}
|
||||
|
||||
div.topic {
|
||||
background-color: #eee;
|
||||
}
|
||||
|
||||
p.admonition-title {
|
||||
display: inline;
|
||||
}
|
||||
|
||||
p.admonition-title:after {
|
||||
content: ":";
|
||||
}
|
||||
|
||||
pre, tt, code {
|
||||
font-family: 'Consolas', 'Menlo', 'Deja Vu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
|
||||
font-size: 0.9em;
|
||||
}
|
||||
|
||||
.hll {
|
||||
background-color: #FFC;
|
||||
margin: 0 -12px;
|
||||
padding: 0 12px;
|
||||
display: block;
|
||||
}
|
||||
|
||||
img.screenshot {
|
||||
}
|
||||
|
||||
tt.descname, tt.descclassname, code.descname, code.descclassname {
|
||||
font-size: 0.95em;
|
||||
}
|
||||
|
||||
tt.descname, code.descname {
|
||||
padding-right: 0.08em;
|
||||
}
|
||||
|
||||
img.screenshot {
|
||||
-moz-box-shadow: 2px 2px 4px #eee;
|
||||
-webkit-box-shadow: 2px 2px 4px #eee;
|
||||
box-shadow: 2px 2px 4px #eee;
|
||||
}
|
||||
|
||||
table.docutils {
|
||||
border: 1px solid #888;
|
||||
-moz-box-shadow: 2px 2px 4px #eee;
|
||||
-webkit-box-shadow: 2px 2px 4px #eee;
|
||||
box-shadow: 2px 2px 4px #eee;
|
||||
}
|
||||
|
||||
table.docutils td, table.docutils th {
|
||||
border: 1px solid #888;
|
||||
padding: 0.25em 0.7em;
|
||||
}
|
||||
|
||||
table.field-list, table.footnote {
|
||||
border: none;
|
||||
-moz-box-shadow: none;
|
||||
-webkit-box-shadow: none;
|
||||
box-shadow: none;
|
||||
}
|
||||
|
||||
table.footnote {
|
||||
margin: 15px 0;
|
||||
width: 100%;
|
||||
border: 1px solid #EEE;
|
||||
background: #FDFDFD;
|
||||
font-size: 0.9em;
|
||||
}
|
||||
|
||||
table.footnote + table.footnote {
|
||||
margin-top: -15px;
|
||||
border-top: none;
|
||||
}
|
||||
|
||||
table.field-list th {
|
||||
padding: 0 0.8em 0 0;
|
||||
}
|
||||
|
||||
table.field-list td {
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
table.footnote td.label {
|
||||
width: 0px;
|
||||
padding: 0.3em 0 0.3em 0.5em;
|
||||
}
|
||||
|
||||
table.footnote td {
|
||||
padding: 0.3em 0.5em;
|
||||
}
|
||||
|
||||
dl {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
dl dd {
|
||||
margin-left: 30px;
|
||||
}
|
||||
|
||||
blockquote {
|
||||
margin: 0 0 0 30px;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
ul, ol {
|
||||
margin: 10px 0 10px 30px;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
pre {
|
||||
background: #EEE;
|
||||
padding: 7px 30px;
|
||||
margin: 15px 0px;
|
||||
line-height: 1.3em;
|
||||
}
|
||||
|
||||
dl pre, blockquote pre, li pre {
|
||||
margin-left: 0;
|
||||
padding-left: 30px;
|
||||
}
|
||||
|
||||
dl dl pre {
|
||||
margin-left: -90px;
|
||||
padding-left: 90px;
|
||||
}
|
||||
|
||||
tt, code {
|
||||
background-color: #ecf0f3;
|
||||
color: #222;
|
||||
/* padding: 1px 2px; */
|
||||
}
|
||||
|
||||
tt.xref, code.xref, a tt {
|
||||
background-color: #FBFBFB;
|
||||
border-bottom: 1px solid white;
|
||||
}
|
||||
|
||||
a.reference {
|
||||
text-decoration: none;
|
||||
border-bottom: 1px dotted #004B6B;
|
||||
}
|
||||
|
||||
a.reference:hover {
|
||||
border-bottom: 1px solid #6D4100;
|
||||
}
|
||||
|
||||
a.footnote-reference {
|
||||
text-decoration: none;
|
||||
font-size: 0.7em;
|
||||
vertical-align: top;
|
||||
border-bottom: 1px dotted #004B6B;
|
||||
}
|
||||
|
||||
a.footnote-reference:hover {
|
||||
border-bottom: 1px solid #6D4100;
|
||||
}
|
||||
|
||||
a:hover tt, a:hover code {
|
||||
background: #EEE;
|
||||
}
|
||||
|
||||
|
||||
@media screen and (max-width: 870px) {
|
||||
|
||||
div.sphinxsidebar {
|
||||
display: none;
|
||||
}
|
||||
|
||||
div.document {
|
||||
width: 100%;
|
||||
|
||||
}
|
||||
|
||||
div.documentwrapper {
|
||||
margin-left: 0;
|
||||
margin-top: 0;
|
||||
margin-right: 0;
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
div.bodywrapper {
|
||||
margin-top: 0;
|
||||
margin-right: 0;
|
||||
margin-bottom: 0;
|
||||
margin-left: 0;
|
||||
}
|
||||
|
||||
ul {
|
||||
margin-left: 0;
|
||||
}
|
||||
|
||||
.document {
|
||||
width: auto;
|
||||
}
|
||||
|
||||
.footer {
|
||||
width: auto;
|
||||
}
|
||||
|
||||
.bodywrapper {
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
.footer {
|
||||
width: auto;
|
||||
}
|
||||
|
||||
.github {
|
||||
display: none;
|
||||
}
|
||||
|
||||
|
||||
|
||||
}
|
||||
|
||||
|
||||
|
||||
@media screen and (max-width: 875px) {
|
||||
|
||||
body {
|
||||
margin: 0;
|
||||
padding: 20px 30px;
|
||||
}
|
||||
|
||||
div.documentwrapper {
|
||||
float: none;
|
||||
background: white;
|
||||
}
|
||||
|
||||
div.sphinxsidebar {
|
||||
display: block;
|
||||
float: none;
|
||||
width: 102.5%;
|
||||
margin: 50px -30px -20px -30px;
|
||||
padding: 10px 20px;
|
||||
background: #333;
|
||||
color: #FFF;
|
||||
}
|
||||
|
||||
div.sphinxsidebar h3, div.sphinxsidebar h4, div.sphinxsidebar p,
|
||||
div.sphinxsidebar h3 a {
|
||||
color: white;
|
||||
}
|
||||
|
||||
div.sphinxsidebar a {
|
||||
color: #AAA;
|
||||
}
|
||||
|
||||
div.sphinxsidebar p.logo {
|
||||
display: none;
|
||||
}
|
||||
|
||||
div.document {
|
||||
width: 100%;
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
div.footer {
|
||||
display: none;
|
||||
}
|
||||
|
||||
div.bodywrapper {
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
div.body {
|
||||
min-height: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
.rtd_doc_footer {
|
||||
display: none;
|
||||
}
|
||||
|
||||
.document {
|
||||
width: auto;
|
||||
}
|
||||
|
||||
.footer {
|
||||
width: auto;
|
||||
}
|
||||
|
||||
.footer {
|
||||
width: auto;
|
||||
}
|
||||
|
||||
.github {
|
||||
display: none;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/* misc. */
|
||||
|
||||
.revsys-inline {
|
||||
display: none!important;
|
||||
}
|
||||
|
||||
/* Make nested-list/multi-paragraph items look better in Releases changelog
|
||||
* pages. Without this, docutils' magical list fuckery causes inconsistent
|
||||
* formatting between different release sub-lists.
|
||||
*/
|
||||
div#changelog > div.section > ul > li > p:only-child {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
/* Hide fugly table cell borders in ..bibliography:: directive output */
|
||||
table.docutils.citation, table.docutils.citation td, table.docutils.citation th {
|
||||
border: none;
|
||||
/* Below needed in some edge cases; if not applied, bottom shadows appear */
|
||||
-moz-box-shadow: none;
|
||||
-webkit-box-shadow: none;
|
||||
box-shadow: none;
|
||||
}
|
||||
@@ -1,599 +0,0 @@
|
||||
/*
|
||||
* basic.css
|
||||
* ~~~~~~~~~
|
||||
*
|
||||
* Sphinx stylesheet -- basic theme.
|
||||
*
|
||||
* :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
||||
/* -- main layout ----------------------------------------------------------- */
|
||||
|
||||
div.clearer {
|
||||
clear: both;
|
||||
}
|
||||
|
||||
/* -- relbar ---------------------------------------------------------------- */
|
||||
|
||||
div.related {
|
||||
width: 100%;
|
||||
font-size: 90%;
|
||||
}
|
||||
|
||||
div.related h3 {
|
||||
display: none;
|
||||
}
|
||||
|
||||
div.related ul {
|
||||
margin: 0;
|
||||
padding: 0 0 0 10px;
|
||||
list-style: none;
|
||||
}
|
||||
|
||||
div.related li {
|
||||
display: inline;
|
||||
}
|
||||
|
||||
div.related li.right {
|
||||
float: right;
|
||||
margin-right: 5px;
|
||||
}
|
||||
|
||||
/* -- sidebar --------------------------------------------------------------- */
|
||||
|
||||
div.sphinxsidebarwrapper {
|
||||
padding: 10px 5px 0 10px;
|
||||
}
|
||||
|
||||
div.sphinxsidebar {
|
||||
float: left;
|
||||
width: 230px;
|
||||
margin-left: -100%;
|
||||
font-size: 90%;
|
||||
}
|
||||
|
||||
div.sphinxsidebar ul {
|
||||
list-style: none;
|
||||
}
|
||||
|
||||
div.sphinxsidebar ul ul,
|
||||
div.sphinxsidebar ul.want-points {
|
||||
margin-left: 20px;
|
||||
list-style: square;
|
||||
}
|
||||
|
||||
div.sphinxsidebar ul ul {
|
||||
margin-top: 0;
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
div.sphinxsidebar form {
|
||||
margin-top: 10px;
|
||||
}
|
||||
|
||||
div.sphinxsidebar input {
|
||||
border: 1px solid #98dbcc;
|
||||
font-family: sans-serif;
|
||||
font-size: 1em;
|
||||
}
|
||||
|
||||
div.sphinxsidebar #searchbox input[type="text"] {
|
||||
width: 170px;
|
||||
}
|
||||
|
||||
div.sphinxsidebar #searchbox input[type="submit"] {
|
||||
width: 30px;
|
||||
}
|
||||
|
||||
img {
|
||||
border: 0;
|
||||
max-width: 100%;
|
||||
}
|
||||
|
||||
/* -- search page ----------------------------------------------------------- */
|
||||
|
||||
ul.search {
|
||||
margin: 10px 0 0 20px;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
ul.search li {
|
||||
padding: 5px 0 5px 20px;
|
||||
background-image: url(file.png);
|
||||
background-repeat: no-repeat;
|
||||
background-position: 0 7px;
|
||||
}
|
||||
|
||||
ul.search li a {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
ul.search li div.context {
|
||||
color: #888;
|
||||
margin: 2px 0 0 30px;
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
ul.keywordmatches li.goodmatch a {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
/* -- index page ------------------------------------------------------------ */
|
||||
|
||||
table.contentstable {
|
||||
width: 90%;
|
||||
}
|
||||
|
||||
table.contentstable p.biglink {
|
||||
line-height: 150%;
|
||||
}
|
||||
|
||||
a.biglink {
|
||||
font-size: 1.3em;
|
||||
}
|
||||
|
||||
span.linkdescr {
|
||||
font-style: italic;
|
||||
padding-top: 5px;
|
||||
font-size: 90%;
|
||||
}
|
||||
|
||||
/* -- general index --------------------------------------------------------- */
|
||||
|
||||
table.indextable {
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
table.indextable td {
|
||||
text-align: left;
|
||||
vertical-align: top;
|
||||
}
|
||||
|
||||
table.indextable dl, table.indextable dd {
|
||||
margin-top: 0;
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
table.indextable tr.pcap {
|
||||
height: 10px;
|
||||
}
|
||||
|
||||
table.indextable tr.cap {
|
||||
margin-top: 10px;
|
||||
background-color: #f2f2f2;
|
||||
}
|
||||
|
||||
img.toggler {
|
||||
margin-right: 3px;
|
||||
margin-top: 3px;
|
||||
cursor: pointer;
|
||||
}
|
||||
|
||||
div.modindex-jumpbox {
|
||||
border-top: 1px solid #ddd;
|
||||
border-bottom: 1px solid #ddd;
|
||||
margin: 1em 0 1em 0;
|
||||
padding: 0.4em;
|
||||
}
|
||||
|
||||
div.genindex-jumpbox {
|
||||
border-top: 1px solid #ddd;
|
||||
border-bottom: 1px solid #ddd;
|
||||
margin: 1em 0 1em 0;
|
||||
padding: 0.4em;
|
||||
}
|
||||
|
||||
/* -- general body styles --------------------------------------------------- */
|
||||
|
||||
a.headerlink {
|
||||
visibility: hidden;
|
||||
}
|
||||
|
||||
h1:hover > a.headerlink,
|
||||
h2:hover > a.headerlink,
|
||||
h3:hover > a.headerlink,
|
||||
h4:hover > a.headerlink,
|
||||
h5:hover > a.headerlink,
|
||||
h6:hover > a.headerlink,
|
||||
dt:hover > a.headerlink,
|
||||
caption:hover > a.headerlink,
|
||||
p.caption:hover > a.headerlink,
|
||||
div.code-block-caption:hover > a.headerlink {
|
||||
visibility: visible;
|
||||
}
|
||||
|
||||
div.body p.caption {
|
||||
text-align: inherit;
|
||||
}
|
||||
|
||||
div.body td {
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
.field-list ul {
|
||||
padding-left: 1em;
|
||||
}
|
||||
|
||||
.first {
|
||||
margin-top: 0 !important;
|
||||
}
|
||||
|
||||
p.rubric {
|
||||
margin-top: 30px;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
img.align-left, .figure.align-left, object.align-left {
|
||||
clear: left;
|
||||
float: left;
|
||||
margin-right: 1em;
|
||||
}
|
||||
|
||||
img.align-right, .figure.align-right, object.align-right {
|
||||
clear: right;
|
||||
float: right;
|
||||
margin-left: 1em;
|
||||
}
|
||||
|
||||
img.align-center, .figure.align-center, object.align-center {
|
||||
display: block;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
.align-left {
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
.align-center {
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
.align-right {
|
||||
text-align: right;
|
||||
}
|
||||
|
||||
/* -- sidebars -------------------------------------------------------------- */
|
||||
|
||||
div.sidebar {
|
||||
margin: 0 0 0.5em 1em;
|
||||
border: 1px solid #ddb;
|
||||
padding: 7px 7px 0 7px;
|
||||
background-color: #ffe;
|
||||
width: 40%;
|
||||
float: right;
|
||||
}
|
||||
|
||||
p.sidebar-title {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
/* -- topics ---------------------------------------------------------------- */
|
||||
|
||||
div.topic {
|
||||
border: 1px solid #ccc;
|
||||
padding: 7px 7px 0 7px;
|
||||
margin: 10px 0 10px 0;
|
||||
}
|
||||
|
||||
p.topic-title {
|
||||
font-size: 1.1em;
|
||||
font-weight: bold;
|
||||
margin-top: 10px;
|
||||
}
|
||||
|
||||
/* -- admonitions ----------------------------------------------------------- */
|
||||
|
||||
div.admonition {
|
||||
margin-top: 10px;
|
||||
margin-bottom: 10px;
|
||||
padding: 7px;
|
||||
}
|
||||
|
||||
div.admonition dt {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
div.admonition dl {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
p.admonition-title {
|
||||
margin: 0px 10px 5px 0px;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
div.body p.centered {
|
||||
text-align: center;
|
||||
margin-top: 25px;
|
||||
}
|
||||
|
||||
/* -- tables ---------------------------------------------------------------- */
|
||||
|
||||
table.docutils {
|
||||
border: 0;
|
||||
border-collapse: collapse;
|
||||
}
|
||||
|
||||
table caption span.caption-number {
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
table caption span.caption-text {
|
||||
}
|
||||
|
||||
table.docutils td, table.docutils th {
|
||||
padding: 1px 8px 1px 5px;
|
||||
border-top: 0;
|
||||
border-left: 0;
|
||||
border-right: 0;
|
||||
border-bottom: 1px solid #aaa;
|
||||
}
|
||||
|
||||
table.field-list td, table.field-list th {
|
||||
border: 0 !important;
|
||||
}
|
||||
|
||||
table.footnote td, table.footnote th {
|
||||
border: 0 !important;
|
||||
}
|
||||
|
||||
th {
|
||||
text-align: left;
|
||||
padding-right: 5px;
|
||||
}
|
||||
|
||||
table.citation {
|
||||
border-left: solid 1px gray;
|
||||
margin-left: 1px;
|
||||
}
|
||||
|
||||
table.citation td {
|
||||
border-bottom: none;
|
||||
}
|
||||
|
||||
/* -- figures --------------------------------------------------------------- */
|
||||
|
||||
div.figure {
|
||||
margin: 0.5em;
|
||||
padding: 0.5em;
|
||||
}
|
||||
|
||||
div.figure p.caption {
|
||||
padding: 0.3em;
|
||||
}
|
||||
|
||||
div.figure p.caption span.caption-number {
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
div.figure p.caption span.caption-text {
|
||||
}
|
||||
|
||||
|
||||
/* -- other body styles ----------------------------------------------------- */
|
||||
|
||||
ol.arabic {
|
||||
list-style: decimal;
|
||||
}
|
||||
|
||||
ol.loweralpha {
|
||||
list-style: lower-alpha;
|
||||
}
|
||||
|
||||
ol.upperalpha {
|
||||
list-style: upper-alpha;
|
||||
}
|
||||
|
||||
ol.lowerroman {
|
||||
list-style: lower-roman;
|
||||
}
|
||||
|
||||
ol.upperroman {
|
||||
list-style: upper-roman;
|
||||
}
|
||||
|
||||
dl {
|
||||
margin-bottom: 15px;
|
||||
}
|
||||
|
||||
dd p {
|
||||
margin-top: 0px;
|
||||
}
|
||||
|
||||
dd ul, dd table {
|
||||
margin-bottom: 10px;
|
||||
}
|
||||
|
||||
dd {
|
||||
margin-top: 3px;
|
||||
margin-bottom: 10px;
|
||||
margin-left: 30px;
|
||||
}
|
||||
|
||||
dt:target, .highlighted {
|
||||
background-color: #fbe54e;
|
||||
}
|
||||
|
||||
dl.glossary dt {
|
||||
font-weight: bold;
|
||||
font-size: 1.1em;
|
||||
}
|
||||
|
||||
.field-list ul {
|
||||
margin: 0;
|
||||
padding-left: 1em;
|
||||
}
|
||||
|
||||
.field-list p {
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
.optional {
|
||||
font-size: 1.3em;
|
||||
}
|
||||
|
||||
.sig-paren {
|
||||
font-size: larger;
|
||||
}
|
||||
|
||||
.versionmodified {
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
.system-message {
|
||||
background-color: #fda;
|
||||
padding: 5px;
|
||||
border: 3px solid red;
|
||||
}
|
||||
|
||||
.footnote:target {
|
||||
background-color: #ffa;
|
||||
}
|
||||
|
||||
.line-block {
|
||||
display: block;
|
||||
margin-top: 1em;
|
||||
margin-bottom: 1em;
|
||||
}
|
||||
|
||||
.line-block .line-block {
|
||||
margin-top: 0;
|
||||
margin-bottom: 0;
|
||||
margin-left: 1.5em;
|
||||
}
|
||||
|
||||
.guilabel, .menuselection {
|
||||
font-family: sans-serif;
|
||||
}
|
||||
|
||||
.accelerator {
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
.classifier {
|
||||
font-style: oblique;
|
||||
}
|
||||
|
||||
abbr, acronym {
|
||||
border-bottom: dotted 1px;
|
||||
cursor: help;
|
||||
}
|
||||
|
||||
/* -- code displays --------------------------------------------------------- */
|
||||
|
||||
pre {
|
||||
overflow: auto;
|
||||
overflow-y: hidden; /* fixes display issues on Chrome browsers */
|
||||
}
|
||||
|
||||
td.linenos pre {
|
||||
padding: 5px 0px;
|
||||
border: 0;
|
||||
background-color: transparent;
|
||||
color: #aaa;
|
||||
}
|
||||
|
||||
table.highlighttable {
|
||||
margin-left: 0.5em;
|
||||
}
|
||||
|
||||
table.highlighttable td {
|
||||
padding: 0 0.5em 0 0.5em;
|
||||
}
|
||||
|
||||
div.code-block-caption {
|
||||
padding: 2px 5px;
|
||||
font-size: small;
|
||||
}
|
||||
|
||||
div.code-block-caption code {
|
||||
background-color: transparent;
|
||||
}
|
||||
|
||||
div.code-block-caption + div > div.highlight > pre {
|
||||
margin-top: 0;
|
||||
}
|
||||
|
||||
div.code-block-caption span.caption-number {
|
||||
padding: 0.1em 0.3em;
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
div.code-block-caption span.caption-text {
|
||||
}
|
||||
|
||||
div.literal-block-wrapper {
|
||||
padding: 1em 1em 0;
|
||||
}
|
||||
|
||||
div.literal-block-wrapper div.highlight {
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
code.descname {
|
||||
background-color: transparent;
|
||||
font-weight: bold;
|
||||
font-size: 1.2em;
|
||||
}
|
||||
|
||||
code.descclassname {
|
||||
background-color: transparent;
|
||||
}
|
||||
|
||||
code.xref, a code {
|
||||
background-color: transparent;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
|
||||
background-color: transparent;
|
||||
}
|
||||
|
||||
.viewcode-link {
|
||||
float: right;
|
||||
}
|
||||
|
||||
.viewcode-back {
|
||||
float: right;
|
||||
font-family: sans-serif;
|
||||
}
|
||||
|
||||
div.viewcode-block:target {
|
||||
margin: -1px -10px;
|
||||
padding: 0 10px;
|
||||
}
|
||||
|
||||
/* -- math display ---------------------------------------------------------- */
|
||||
|
||||
img.math {
|
||||
vertical-align: middle;
|
||||
}
|
||||
|
||||
div.body div.math p {
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
span.eqno {
|
||||
float: right;
|
||||
}
|
||||
|
||||
/* -- printout stylesheet --------------------------------------------------- */
|
||||
|
||||
@media print {
|
||||
div.document,
|
||||
div.documentwrapper,
|
||||
div.bodywrapper {
|
||||
margin: 0 !important;
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
div.sphinxsidebar,
|
||||
div.related,
|
||||
div.footer,
|
||||
#top-link {
|
||||
display: none;
|
||||
}
|
||||
}
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 3.4 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 3.5 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 3.4 KiB |
@@ -1,263 +0,0 @@
|
||||
/*
|
||||
* doctools.js
|
||||
* ~~~~~~~~~~~
|
||||
*
|
||||
* Sphinx JavaScript utilities for all documentation.
|
||||
*
|
||||
* :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
||||
/**
|
||||
* select a different prefix for underscore
|
||||
*/
|
||||
$u = _.noConflict();
|
||||
|
||||
/**
|
||||
* make the code below compatible with browsers without
|
||||
* an installed firebug like debugger
|
||||
if (!window.console || !console.firebug) {
|
||||
var names = ["log", "debug", "info", "warn", "error", "assert", "dir",
|
||||
"dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace",
|
||||
"profile", "profileEnd"];
|
||||
window.console = {};
|
||||
for (var i = 0; i < names.length; ++i)
|
||||
window.console[names[i]] = function() {};
|
||||
}
|
||||
*/
|
||||
|
||||
/**
|
||||
* small helper function to urldecode strings
|
||||
*/
|
||||
jQuery.urldecode = function(x) {
|
||||
return decodeURIComponent(x).replace(/\+/g, ' ');
|
||||
};
|
||||
|
||||
/**
|
||||
* small helper function to urlencode strings
|
||||
*/
|
||||
jQuery.urlencode = encodeURIComponent;
|
||||
|
||||
/**
|
||||
* This function returns the parsed url parameters of the
|
||||
* current request. Multiple values per key are supported,
|
||||
* it will always return arrays of strings for the value parts.
|
||||
*/
|
||||
jQuery.getQueryParameters = function(s) {
|
||||
if (typeof s == 'undefined')
|
||||
s = document.location.search;
|
||||
var parts = s.substr(s.indexOf('?') + 1).split('&');
|
||||
var result = {};
|
||||
for (var i = 0; i < parts.length; i++) {
|
||||
var tmp = parts[i].split('=', 2);
|
||||
var key = jQuery.urldecode(tmp[0]);
|
||||
var value = jQuery.urldecode(tmp[1]);
|
||||
if (key in result)
|
||||
result[key].push(value);
|
||||
else
|
||||
result[key] = [value];
|
||||
}
|
||||
return result;
|
||||
};
|
||||
|
||||
/**
|
||||
* highlight a given string on a jquery object by wrapping it in
|
||||
* span elements with the given class name.
|
||||
*/
|
||||
jQuery.fn.highlightText = function(text, className) {
|
||||
function highlight(node) {
|
||||
if (node.nodeType == 3) {
|
||||
var val = node.nodeValue;
|
||||
var pos = val.toLowerCase().indexOf(text);
|
||||
if (pos >= 0 && !jQuery(node.parentNode).hasClass(className)) {
|
||||
var span = document.createElement("span");
|
||||
span.className = className;
|
||||
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
|
||||
node.parentNode.insertBefore(span, node.parentNode.insertBefore(
|
||||
document.createTextNode(val.substr(pos + text.length)),
|
||||
node.nextSibling));
|
||||
node.nodeValue = val.substr(0, pos);
|
||||
}
|
||||
}
|
||||
else if (!jQuery(node).is("button, select, textarea")) {
|
||||
jQuery.each(node.childNodes, function() {
|
||||
highlight(this);
|
||||
});
|
||||
}
|
||||
}
|
||||
return this.each(function() {
|
||||
highlight(this);
|
||||
});
|
||||
};
|
||||
|
||||
/*
|
||||
* backward compatibility for jQuery.browser
|
||||
* This will be supported until firefox bug is fixed.
|
||||
*/
|
||||
if (!jQuery.browser) {
|
||||
jQuery.uaMatch = function(ua) {
|
||||
ua = ua.toLowerCase();
|
||||
|
||||
var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
|
||||
/(webkit)[ \/]([\w.]+)/.exec(ua) ||
|
||||
/(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
|
||||
/(msie) ([\w.]+)/.exec(ua) ||
|
||||
ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
|
||||
[];
|
||||
|
||||
return {
|
||||
browser: match[ 1 ] || "",
|
||||
version: match[ 2 ] || "0"
|
||||
};
|
||||
};
|
||||
jQuery.browser = {};
|
||||
jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Small JavaScript module for the documentation.
|
||||
*/
|
||||
var Documentation = {
|
||||
|
||||
init : function() {
|
||||
this.fixFirefoxAnchorBug();
|
||||
this.highlightSearchWords();
|
||||
this.initIndexTable();
|
||||
},
|
||||
|
||||
/**
|
||||
* i18n support
|
||||
*/
|
||||
TRANSLATIONS : {},
|
||||
PLURAL_EXPR : function(n) { return n == 1 ? 0 : 1; },
|
||||
LOCALE : 'unknown',
|
||||
|
||||
// gettext and ngettext don't access this so that the functions
|
||||
// can safely bound to a different name (_ = Documentation.gettext)
|
||||
gettext : function(string) {
|
||||
var translated = Documentation.TRANSLATIONS[string];
|
||||
if (typeof translated == 'undefined')
|
||||
return string;
|
||||
return (typeof translated == 'string') ? translated : translated[0];
|
||||
},
|
||||
|
||||
ngettext : function(singular, plural, n) {
|
||||
var translated = Documentation.TRANSLATIONS[singular];
|
||||
if (typeof translated == 'undefined')
|
||||
return (n == 1) ? singular : plural;
|
||||
return translated[Documentation.PLURALEXPR(n)];
|
||||
},
|
||||
|
||||
addTranslations : function(catalog) {
|
||||
for (var key in catalog.messages)
|
||||
this.TRANSLATIONS[key] = catalog.messages[key];
|
||||
this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')');
|
||||
this.LOCALE = catalog.locale;
|
||||
},
|
||||
|
||||
/**
|
||||
* add context elements like header anchor links
|
||||
*/
|
||||
addContextElements : function() {
|
||||
$('div[id] > :header:first').each(function() {
|
||||
$('<a class="headerlink">\u00B6</a>').
|
||||
attr('href', '#' + this.id).
|
||||
attr('title', _('Permalink to this headline')).
|
||||
appendTo(this);
|
||||
});
|
||||
$('dt[id]').each(function() {
|
||||
$('<a class="headerlink">\u00B6</a>').
|
||||
attr('href', '#' + this.id).
|
||||
attr('title', _('Permalink to this definition')).
|
||||
appendTo(this);
|
||||
});
|
||||
},
|
||||
|
||||
/**
|
||||
* workaround a firefox stupidity
|
||||
* see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075
|
||||
*/
|
||||
fixFirefoxAnchorBug : function() {
|
||||
if (document.location.hash)
|
||||
window.setTimeout(function() {
|
||||
document.location.href += '';
|
||||
}, 10);
|
||||
},
|
||||
|
||||
/**
|
||||
* highlight the search words provided in the url in the text
|
||||
*/
|
||||
highlightSearchWords : function() {
|
||||
var params = $.getQueryParameters();
|
||||
var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : [];
|
||||
if (terms.length) {
|
||||
var body = $('div.body');
|
||||
if (!body.length) {
|
||||
body = $('body');
|
||||
}
|
||||
window.setTimeout(function() {
|
||||
$.each(terms, function() {
|
||||
body.highlightText(this.toLowerCase(), 'highlighted');
|
||||
});
|
||||
}, 10);
|
||||
$('<p class="highlight-link"><a href="javascript:Documentation.' +
|
||||
'hideSearchWords()">' + _('Hide Search Matches') + '</a></p>')
|
||||
.appendTo($('#searchbox'));
|
||||
}
|
||||
},
|
||||
|
||||
/**
|
||||
* init the domain index toggle buttons
|
||||
*/
|
||||
initIndexTable : function() {
|
||||
var togglers = $('img.toggler').click(function() {
|
||||
var src = $(this).attr('src');
|
||||
var idnum = $(this).attr('id').substr(7);
|
||||
$('tr.cg-' + idnum).toggle();
|
||||
if (src.substr(-9) == 'minus.png')
|
||||
$(this).attr('src', src.substr(0, src.length-9) + 'plus.png');
|
||||
else
|
||||
$(this).attr('src', src.substr(0, src.length-8) + 'minus.png');
|
||||
}).css('display', '');
|
||||
if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) {
|
||||
togglers.click();
|
||||
}
|
||||
},
|
||||
|
||||
/**
|
||||
* helper function to hide the search marks again
|
||||
*/
|
||||
hideSearchWords : function() {
|
||||
$('#searchbox .highlight-link').fadeOut(300);
|
||||
$('span.highlighted').removeClass('highlighted');
|
||||
},
|
||||
|
||||
/**
|
||||
* make the url absolute
|
||||
*/
|
||||
makeURL : function(relativeURL) {
|
||||
return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL;
|
||||
},
|
||||
|
||||
/**
|
||||
* get the current relative url
|
||||
*/
|
||||
getCurrentURL : function() {
|
||||
var path = document.location.pathname;
|
||||
var parts = path.split(/\//);
|
||||
$.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() {
|
||||
if (this == '..')
|
||||
parts.pop();
|
||||
});
|
||||
var url = parts.join('/');
|
||||
return path.substring(url.lastIndexOf('/') + 1, path.length - 1);
|
||||
}
|
||||
};
|
||||
|
||||
// quick alias for translations
|
||||
_ = Documentation.gettext;
|
||||
|
||||
$(document).ready(function() {
|
||||
Documentation.init();
|
||||
});
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 347 B |
Binary file not shown.
|
Before Width: | Height: | Size: 347 B |
Binary file not shown.
|
Before Width: | Height: | Size: 358 B |
Binary file not shown.
|
Before Width: | Height: | Size: 113 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 42 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 30 KiB |
-10308
File diff suppressed because it is too large
Load Diff
Vendored
-4
File diff suppressed because one or more lines are too long
Binary file not shown.
|
Before Width: | Height: | Size: 173 B |
Binary file not shown.
|
Before Width: | Height: | Size: 173 B |
@@ -1,63 +0,0 @@
|
||||
.highlight .hll { background-color: #ffffcc }
|
||||
.highlight { background: #eeffcc; }
|
||||
.highlight .c { color: #408090; font-style: italic } /* Comment */
|
||||
.highlight .err { border: 1px solid #FF0000 } /* Error */
|
||||
.highlight .k { color: #007020; font-weight: bold } /* Keyword */
|
||||
.highlight .o { color: #666666 } /* Operator */
|
||||
.highlight .cm { color: #408090; font-style: italic } /* Comment.Multiline */
|
||||
.highlight .cp { color: #007020 } /* Comment.Preproc */
|
||||
.highlight .c1 { color: #408090; font-style: italic } /* Comment.Single */
|
||||
.highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */
|
||||
.highlight .gd { color: #A00000 } /* Generic.Deleted */
|
||||
.highlight .ge { font-style: italic } /* Generic.Emph */
|
||||
.highlight .gr { color: #FF0000 } /* Generic.Error */
|
||||
.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
|
||||
.highlight .gi { color: #00A000 } /* Generic.Inserted */
|
||||
.highlight .go { color: #333333 } /* Generic.Output */
|
||||
.highlight .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */
|
||||
.highlight .gs { font-weight: bold } /* Generic.Strong */
|
||||
.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
|
||||
.highlight .gt { color: #0044DD } /* Generic.Traceback */
|
||||
.highlight .kc { color: #007020; font-weight: bold } /* Keyword.Constant */
|
||||
.highlight .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */
|
||||
.highlight .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */
|
||||
.highlight .kp { color: #007020 } /* Keyword.Pseudo */
|
||||
.highlight .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */
|
||||
.highlight .kt { color: #902000 } /* Keyword.Type */
|
||||
.highlight .m { color: #208050 } /* Literal.Number */
|
||||
.highlight .s { color: #4070a0 } /* Literal.String */
|
||||
.highlight .na { color: #4070a0 } /* Name.Attribute */
|
||||
.highlight .nb { color: #007020 } /* Name.Builtin */
|
||||
.highlight .nc { color: #0e84b5; font-weight: bold } /* Name.Class */
|
||||
.highlight .no { color: #60add5 } /* Name.Constant */
|
||||
.highlight .nd { color: #555555; font-weight: bold } /* Name.Decorator */
|
||||
.highlight .ni { color: #d55537; font-weight: bold } /* Name.Entity */
|
||||
.highlight .ne { color: #007020 } /* Name.Exception */
|
||||
.highlight .nf { color: #06287e } /* Name.Function */
|
||||
.highlight .nl { color: #002070; font-weight: bold } /* Name.Label */
|
||||
.highlight .nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */
|
||||
.highlight .nt { color: #062873; font-weight: bold } /* Name.Tag */
|
||||
.highlight .nv { color: #bb60d5 } /* Name.Variable */
|
||||
.highlight .ow { color: #007020; font-weight: bold } /* Operator.Word */
|
||||
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
|
||||
.highlight .mb { color: #208050 } /* Literal.Number.Bin */
|
||||
.highlight .mf { color: #208050 } /* Literal.Number.Float */
|
||||
.highlight .mh { color: #208050 } /* Literal.Number.Hex */
|
||||
.highlight .mi { color: #208050 } /* Literal.Number.Integer */
|
||||
.highlight .mo { color: #208050 } /* Literal.Number.Oct */
|
||||
.highlight .sb { color: #4070a0 } /* Literal.String.Backtick */
|
||||
.highlight .sc { color: #4070a0 } /* Literal.String.Char */
|
||||
.highlight .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */
|
||||
.highlight .s2 { color: #4070a0 } /* Literal.String.Double */
|
||||
.highlight .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */
|
||||
.highlight .sh { color: #4070a0 } /* Literal.String.Heredoc */
|
||||
.highlight .si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */
|
||||
.highlight .sx { color: #c65d09 } /* Literal.String.Other */
|
||||
.highlight .sr { color: #235388 } /* Literal.String.Regex */
|
||||
.highlight .s1 { color: #4070a0 } /* Literal.String.Single */
|
||||
.highlight .ss { color: #517918 } /* Literal.String.Symbol */
|
||||
.highlight .bp { color: #007020 } /* Name.Builtin.Pseudo */
|
||||
.highlight .vc { color: #bb60d5 } /* Name.Variable.Class */
|
||||
.highlight .vg { color: #bb60d5 } /* Name.Variable.Global */
|
||||
.highlight .vi { color: #bb60d5 } /* Name.Variable.Instance */
|
||||
.highlight .il { color: #208050 } /* Literal.Number.Integer.Long */
|
||||
@@ -1,622 +0,0 @@
|
||||
/*
|
||||
* searchtools.js_t
|
||||
* ~~~~~~~~~~~~~~~~
|
||||
*
|
||||
* Sphinx JavaScript utilties for the full-text search.
|
||||
*
|
||||
* :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
/**
|
||||
* Porter Stemmer
|
||||
*/
|
||||
var Stemmer = function() {
|
||||
|
||||
var step2list = {
|
||||
ational: 'ate',
|
||||
tional: 'tion',
|
||||
enci: 'ence',
|
||||
anci: 'ance',
|
||||
izer: 'ize',
|
||||
bli: 'ble',
|
||||
alli: 'al',
|
||||
entli: 'ent',
|
||||
eli: 'e',
|
||||
ousli: 'ous',
|
||||
ization: 'ize',
|
||||
ation: 'ate',
|
||||
ator: 'ate',
|
||||
alism: 'al',
|
||||
iveness: 'ive',
|
||||
fulness: 'ful',
|
||||
ousness: 'ous',
|
||||
aliti: 'al',
|
||||
iviti: 'ive',
|
||||
biliti: 'ble',
|
||||
logi: 'log'
|
||||
};
|
||||
|
||||
var step3list = {
|
||||
icate: 'ic',
|
||||
ative: '',
|
||||
alize: 'al',
|
||||
iciti: 'ic',
|
||||
ical: 'ic',
|
||||
ful: '',
|
||||
ness: ''
|
||||
};
|
||||
|
||||
var c = "[^aeiou]"; // consonant
|
||||
var v = "[aeiouy]"; // vowel
|
||||
var C = c + "[^aeiouy]*"; // consonant sequence
|
||||
var V = v + "[aeiou]*"; // vowel sequence
|
||||
|
||||
var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0
|
||||
var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1
|
||||
var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1
|
||||
var s_v = "^(" + C + ")?" + v; // vowel in stem
|
||||
|
||||
this.stemWord = function (w) {
|
||||
var stem;
|
||||
var suffix;
|
||||
var firstch;
|
||||
var origword = w;
|
||||
|
||||
if (w.length < 3)
|
||||
return w;
|
||||
|
||||
var re;
|
||||
var re2;
|
||||
var re3;
|
||||
var re4;
|
||||
|
||||
firstch = w.substr(0,1);
|
||||
if (firstch == "y")
|
||||
w = firstch.toUpperCase() + w.substr(1);
|
||||
|
||||
// Step 1a
|
||||
re = /^(.+?)(ss|i)es$/;
|
||||
re2 = /^(.+?)([^s])s$/;
|
||||
|
||||
if (re.test(w))
|
||||
w = w.replace(re,"$1$2");
|
||||
else if (re2.test(w))
|
||||
w = w.replace(re2,"$1$2");
|
||||
|
||||
// Step 1b
|
||||
re = /^(.+?)eed$/;
|
||||
re2 = /^(.+?)(ed|ing)$/;
|
||||
if (re.test(w)) {
|
||||
var fp = re.exec(w);
|
||||
re = new RegExp(mgr0);
|
||||
if (re.test(fp[1])) {
|
||||
re = /.$/;
|
||||
w = w.replace(re,"");
|
||||
}
|
||||
}
|
||||
else if (re2.test(w)) {
|
||||
var fp = re2.exec(w);
|
||||
stem = fp[1];
|
||||
re2 = new RegExp(s_v);
|
||||
if (re2.test(stem)) {
|
||||
w = stem;
|
||||
re2 = /(at|bl|iz)$/;
|
||||
re3 = new RegExp("([^aeiouylsz])\\1$");
|
||||
re4 = new RegExp("^" + C + v + "[^aeiouwxy]$");
|
||||
if (re2.test(w))
|
||||
w = w + "e";
|
||||
else if (re3.test(w)) {
|
||||
re = /.$/;
|
||||
w = w.replace(re,"");
|
||||
}
|
||||
else if (re4.test(w))
|
||||
w = w + "e";
|
||||
}
|
||||
}
|
||||
|
||||
// Step 1c
|
||||
re = /^(.+?)y$/;
|
||||
if (re.test(w)) {
|
||||
var fp = re.exec(w);
|
||||
stem = fp[1];
|
||||
re = new RegExp(s_v);
|
||||
if (re.test(stem))
|
||||
w = stem + "i";
|
||||
}
|
||||
|
||||
// Step 2
|
||||
re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;
|
||||
if (re.test(w)) {
|
||||
var fp = re.exec(w);
|
||||
stem = fp[1];
|
||||
suffix = fp[2];
|
||||
re = new RegExp(mgr0);
|
||||
if (re.test(stem))
|
||||
w = stem + step2list[suffix];
|
||||
}
|
||||
|
||||
// Step 3
|
||||
re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;
|
||||
if (re.test(w)) {
|
||||
var fp = re.exec(w);
|
||||
stem = fp[1];
|
||||
suffix = fp[2];
|
||||
re = new RegExp(mgr0);
|
||||
if (re.test(stem))
|
||||
w = stem + step3list[suffix];
|
||||
}
|
||||
|
||||
// Step 4
|
||||
re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;
|
||||
re2 = /^(.+?)(s|t)(ion)$/;
|
||||
if (re.test(w)) {
|
||||
var fp = re.exec(w);
|
||||
stem = fp[1];
|
||||
re = new RegExp(mgr1);
|
||||
if (re.test(stem))
|
||||
w = stem;
|
||||
}
|
||||
else if (re2.test(w)) {
|
||||
var fp = re2.exec(w);
|
||||
stem = fp[1] + fp[2];
|
||||
re2 = new RegExp(mgr1);
|
||||
if (re2.test(stem))
|
||||
w = stem;
|
||||
}
|
||||
|
||||
// Step 5
|
||||
re = /^(.+?)e$/;
|
||||
if (re.test(w)) {
|
||||
var fp = re.exec(w);
|
||||
stem = fp[1];
|
||||
re = new RegExp(mgr1);
|
||||
re2 = new RegExp(meq1);
|
||||
re3 = new RegExp("^" + C + v + "[^aeiouwxy]$");
|
||||
if (re.test(stem) || (re2.test(stem) && !(re3.test(stem))))
|
||||
w = stem;
|
||||
}
|
||||
re = /ll$/;
|
||||
re2 = new RegExp(mgr1);
|
||||
if (re.test(w) && re2.test(w)) {
|
||||
re = /.$/;
|
||||
w = w.replace(re,"");
|
||||
}
|
||||
|
||||
// and turn initial Y back to y
|
||||
if (firstch == "y")
|
||||
w = firstch.toLowerCase() + w.substr(1);
|
||||
return w;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Simple result scoring code.
|
||||
*/
|
||||
var Scorer = {
|
||||
// Implement the following function to further tweak the score for each result
|
||||
// The function takes a result array [filename, title, anchor, descr, score]
|
||||
// and returns the new score.
|
||||
/*
|
||||
score: function(result) {
|
||||
return result[4];
|
||||
},
|
||||
*/
|
||||
|
||||
// query matches the full name of an object
|
||||
objNameMatch: 11,
|
||||
// or matches in the last dotted part of the object name
|
||||
objPartialMatch: 6,
|
||||
// Additive scores depending on the priority of the object
|
||||
objPrio: {0: 15, // used to be importantResults
|
||||
1: 5, // used to be objectResults
|
||||
2: -5}, // used to be unimportantResults
|
||||
// Used when the priority is not in the mapping.
|
||||
objPrioDefault: 0,
|
||||
|
||||
// query found in title
|
||||
title: 15,
|
||||
// query found in terms
|
||||
term: 5
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* Search Module
|
||||
*/
|
||||
var Search = {
|
||||
|
||||
_index : null,
|
||||
_queued_query : null,
|
||||
_pulse_status : -1,
|
||||
|
||||
init : function() {
|
||||
var params = $.getQueryParameters();
|
||||
if (params.q) {
|
||||
var query = params.q[0];
|
||||
$('input[name="q"]')[0].value = query;
|
||||
this.performSearch(query);
|
||||
}
|
||||
},
|
||||
|
||||
loadIndex : function(url) {
|
||||
$.ajax({type: "GET", url: url, data: null,
|
||||
dataType: "script", cache: true,
|
||||
complete: function(jqxhr, textstatus) {
|
||||
if (textstatus != "success") {
|
||||
document.getElementById("searchindexloader").src = url;
|
||||
}
|
||||
}});
|
||||
},
|
||||
|
||||
setIndex : function(index) {
|
||||
var q;
|
||||
this._index = index;
|
||||
if ((q = this._queued_query) !== null) {
|
||||
this._queued_query = null;
|
||||
Search.query(q);
|
||||
}
|
||||
},
|
||||
|
||||
hasIndex : function() {
|
||||
return this._index !== null;
|
||||
},
|
||||
|
||||
deferQuery : function(query) {
|
||||
this._queued_query = query;
|
||||
},
|
||||
|
||||
stopPulse : function() {
|
||||
this._pulse_status = 0;
|
||||
},
|
||||
|
||||
startPulse : function() {
|
||||
if (this._pulse_status >= 0)
|
||||
return;
|
||||
function pulse() {
|
||||
var i;
|
||||
Search._pulse_status = (Search._pulse_status + 1) % 4;
|
||||
var dotString = '';
|
||||
for (i = 0; i < Search._pulse_status; i++)
|
||||
dotString += '.';
|
||||
Search.dots.text(dotString);
|
||||
if (Search._pulse_status > -1)
|
||||
window.setTimeout(pulse, 500);
|
||||
}
|
||||
pulse();
|
||||
},
|
||||
|
||||
/**
|
||||
* perform a search for something (or wait until index is loaded)
|
||||
*/
|
||||
performSearch : function(query) {
|
||||
// create the required interface elements
|
||||
this.out = $('#search-results');
|
||||
this.title = $('<h2>' + _('Searching') + '</h2>').appendTo(this.out);
|
||||
this.dots = $('<span></span>').appendTo(this.title);
|
||||
this.status = $('<p style="display: none"></p>').appendTo(this.out);
|
||||
this.output = $('<ul class="search"/>').appendTo(this.out);
|
||||
|
||||
$('#search-progress').text(_('Preparing search...'));
|
||||
this.startPulse();
|
||||
|
||||
// index already loaded, the browser was quick!
|
||||
if (this.hasIndex())
|
||||
this.query(query);
|
||||
else
|
||||
this.deferQuery(query);
|
||||
},
|
||||
|
||||
/**
|
||||
* execute search (requires search index to be loaded)
|
||||
*/
|
||||
query : function(query) {
|
||||
var i;
|
||||
var stopwords = ["a","and","are","as","at","be","but","by","for","if","in","into","is","it","near","no","not","of","on","or","such","that","the","their","then","there","these","they","this","to","was","will","with"];
|
||||
|
||||
// stem the searchterms and add them to the correct list
|
||||
var stemmer = new Stemmer();
|
||||
var searchterms = [];
|
||||
var excluded = [];
|
||||
var hlterms = [];
|
||||
var tmp = query.split(/\s+/);
|
||||
var objectterms = [];
|
||||
for (i = 0; i < tmp.length; i++) {
|
||||
if (tmp[i] !== "") {
|
||||
objectterms.push(tmp[i].toLowerCase());
|
||||
}
|
||||
|
||||
if ($u.indexOf(stopwords, tmp[i].toLowerCase()) != -1 || tmp[i].match(/^\d+$/) ||
|
||||
tmp[i] === "") {
|
||||
// skip this "word"
|
||||
continue;
|
||||
}
|
||||
// stem the word
|
||||
var word = stemmer.stemWord(tmp[i].toLowerCase());
|
||||
var toAppend;
|
||||
// select the correct list
|
||||
if (word[0] == '-') {
|
||||
toAppend = excluded;
|
||||
word = word.substr(1);
|
||||
}
|
||||
else {
|
||||
toAppend = searchterms;
|
||||
hlterms.push(tmp[i].toLowerCase());
|
||||
}
|
||||
// only add if not already in the list
|
||||
if (!$u.contains(toAppend, word))
|
||||
toAppend.push(word);
|
||||
}
|
||||
var highlightstring = '?highlight=' + $.urlencode(hlterms.join(" "));
|
||||
|
||||
// console.debug('SEARCH: searching for:');
|
||||
// console.info('required: ', searchterms);
|
||||
// console.info('excluded: ', excluded);
|
||||
|
||||
// prepare search
|
||||
var terms = this._index.terms;
|
||||
var titleterms = this._index.titleterms;
|
||||
|
||||
// array of [filename, title, anchor, descr, score]
|
||||
var results = [];
|
||||
$('#search-progress').empty();
|
||||
|
||||
// lookup as object
|
||||
for (i = 0; i < objectterms.length; i++) {
|
||||
var others = [].concat(objectterms.slice(0, i),
|
||||
objectterms.slice(i+1, objectterms.length));
|
||||
results = results.concat(this.performObjectSearch(objectterms[i], others));
|
||||
}
|
||||
|
||||
// lookup as search terms in fulltext
|
||||
results = results.concat(this.performTermsSearch(searchterms, excluded, terms, Scorer.term))
|
||||
.concat(this.performTermsSearch(searchterms, excluded, titleterms, Scorer.title));
|
||||
|
||||
// let the scorer override scores with a custom scoring function
|
||||
if (Scorer.score) {
|
||||
for (i = 0; i < results.length; i++)
|
||||
results[i][4] = Scorer.score(results[i]);
|
||||
}
|
||||
|
||||
// now sort the results by score (in opposite order of appearance, since the
|
||||
// display function below uses pop() to retrieve items) and then
|
||||
// alphabetically
|
||||
results.sort(function(a, b) {
|
||||
var left = a[4];
|
||||
var right = b[4];
|
||||
if (left > right) {
|
||||
return 1;
|
||||
} else if (left < right) {
|
||||
return -1;
|
||||
} else {
|
||||
// same score: sort alphabetically
|
||||
left = a[1].toLowerCase();
|
||||
right = b[1].toLowerCase();
|
||||
return (left > right) ? -1 : ((left < right) ? 1 : 0);
|
||||
}
|
||||
});
|
||||
|
||||
// for debugging
|
||||
//Search.lastresults = results.slice(); // a copy
|
||||
//console.info('search results:', Search.lastresults);
|
||||
|
||||
// print the results
|
||||
var resultCount = results.length;
|
||||
function displayNextItem() {
|
||||
// results left, load the summary and display it
|
||||
if (results.length) {
|
||||
var item = results.pop();
|
||||
var listItem = $('<li style="display:none"></li>');
|
||||
if (DOCUMENTATION_OPTIONS.FILE_SUFFIX === '') {
|
||||
// dirhtml builder
|
||||
var dirname = item[0] + '/';
|
||||
if (dirname.match(/\/index\/$/)) {
|
||||
dirname = dirname.substring(0, dirname.length-6);
|
||||
} else if (dirname == 'index/') {
|
||||
dirname = '';
|
||||
}
|
||||
listItem.append($('<a/>').attr('href',
|
||||
DOCUMENTATION_OPTIONS.URL_ROOT + dirname +
|
||||
highlightstring + item[2]).html(item[1]));
|
||||
} else {
|
||||
// normal html builders
|
||||
listItem.append($('<a/>').attr('href',
|
||||
item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX +
|
||||
highlightstring + item[2]).html(item[1]));
|
||||
}
|
||||
if (item[3]) {
|
||||
listItem.append($('<span> (' + item[3] + ')</span>'));
|
||||
Search.output.append(listItem);
|
||||
listItem.slideDown(5, function() {
|
||||
displayNextItem();
|
||||
});
|
||||
} else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
|
||||
$.ajax({url: DOCUMENTATION_OPTIONS.URL_ROOT + '_sources/' + item[0] + '.txt',
|
||||
dataType: "text",
|
||||
complete: function(jqxhr, textstatus) {
|
||||
var data = jqxhr.responseText;
|
||||
if (data !== '' && data !== undefined) {
|
||||
listItem.append(Search.makeSearchSummary(data, searchterms, hlterms));
|
||||
}
|
||||
Search.output.append(listItem);
|
||||
listItem.slideDown(5, function() {
|
||||
displayNextItem();
|
||||
});
|
||||
}});
|
||||
} else {
|
||||
// no source available, just display title
|
||||
Search.output.append(listItem);
|
||||
listItem.slideDown(5, function() {
|
||||
displayNextItem();
|
||||
});
|
||||
}
|
||||
}
|
||||
// search finished, update title and status message
|
||||
else {
|
||||
Search.stopPulse();
|
||||
Search.title.text(_('Search Results'));
|
||||
if (!resultCount)
|
||||
Search.status.text(_('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.'));
|
||||
else
|
||||
Search.status.text(_('Search finished, found %s page(s) matching the search query.').replace('%s', resultCount));
|
||||
Search.status.fadeIn(500);
|
||||
}
|
||||
}
|
||||
displayNextItem();
|
||||
},
|
||||
|
||||
/**
|
||||
* search for object names
|
||||
*/
|
||||
performObjectSearch : function(object, otherterms) {
|
||||
var filenames = this._index.filenames;
|
||||
var objects = this._index.objects;
|
||||
var objnames = this._index.objnames;
|
||||
var titles = this._index.titles;
|
||||
|
||||
var i;
|
||||
var results = [];
|
||||
|
||||
for (var prefix in objects) {
|
||||
for (var name in objects[prefix]) {
|
||||
var fullname = (prefix ? prefix + '.' : '') + name;
|
||||
if (fullname.toLowerCase().indexOf(object) > -1) {
|
||||
var score = 0;
|
||||
var parts = fullname.split('.');
|
||||
// check for different match types: exact matches of full name or
|
||||
// "last name" (i.e. last dotted part)
|
||||
if (fullname == object || parts[parts.length - 1] == object) {
|
||||
score += Scorer.objNameMatch;
|
||||
// matches in last name
|
||||
} else if (parts[parts.length - 1].indexOf(object) > -1) {
|
||||
score += Scorer.objPartialMatch;
|
||||
}
|
||||
var match = objects[prefix][name];
|
||||
var objname = objnames[match[1]][2];
|
||||
var title = titles[match[0]];
|
||||
// If more than one term searched for, we require other words to be
|
||||
// found in the name/title/description
|
||||
if (otherterms.length > 0) {
|
||||
var haystack = (prefix + ' ' + name + ' ' +
|
||||
objname + ' ' + title).toLowerCase();
|
||||
var allfound = true;
|
||||
for (i = 0; i < otherterms.length; i++) {
|
||||
if (haystack.indexOf(otherterms[i]) == -1) {
|
||||
allfound = false;
|
||||
break;
|
||||
}
|
||||
}
|
||||
if (!allfound) {
|
||||
continue;
|
||||
}
|
||||
}
|
||||
var descr = objname + _(', in ') + title;
|
||||
|
||||
var anchor = match[3];
|
||||
if (anchor === '')
|
||||
anchor = fullname;
|
||||
else if (anchor == '-')
|
||||
anchor = objnames[match[1]][1] + '-' + fullname;
|
||||
// add custom score for some objects according to scorer
|
||||
if (Scorer.objPrio.hasOwnProperty(match[2])) {
|
||||
score += Scorer.objPrio[match[2]];
|
||||
} else {
|
||||
score += Scorer.objPrioDefault;
|
||||
}
|
||||
results.push([filenames[match[0]], fullname, '#'+anchor, descr, score]);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return results;
|
||||
},
|
||||
|
||||
/**
|
||||
* search for full-text terms in the index
|
||||
*/
|
||||
performTermsSearch : function(searchterms, excluded, terms, score) {
|
||||
var filenames = this._index.filenames;
|
||||
var titles = this._index.titles;
|
||||
|
||||
var i, j, file, files;
|
||||
var fileMap = {};
|
||||
var results = [];
|
||||
|
||||
// perform the search on the required terms
|
||||
for (i = 0; i < searchterms.length; i++) {
|
||||
var word = searchterms[i];
|
||||
// no match but word was a required one
|
||||
if ((files = terms[word]) === undefined)
|
||||
break;
|
||||
if (files.length === undefined) {
|
||||
files = [files];
|
||||
}
|
||||
// create the mapping
|
||||
for (j = 0; j < files.length; j++) {
|
||||
file = files[j];
|
||||
if (file in fileMap)
|
||||
fileMap[file].push(word);
|
||||
else
|
||||
fileMap[file] = [word];
|
||||
}
|
||||
}
|
||||
|
||||
// now check if the files don't contain excluded terms
|
||||
for (file in fileMap) {
|
||||
var valid = true;
|
||||
|
||||
// check if all requirements are matched
|
||||
if (fileMap[file].length != searchterms.length)
|
||||
continue;
|
||||
|
||||
// ensure that none of the excluded terms is in the search result
|
||||
for (i = 0; i < excluded.length; i++) {
|
||||
if (terms[excluded[i]] == file ||
|
||||
$u.contains(terms[excluded[i]] || [], file)) {
|
||||
valid = false;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
// if we have still a valid result we can add it to the result list
|
||||
if (valid) {
|
||||
results.push([filenames[file], titles[file], '', null, score]);
|
||||
}
|
||||
}
|
||||
return results;
|
||||
},
|
||||
|
||||
/**
|
||||
* helper function to return a node containing the
|
||||
* search summary for a given text. keywords is a list
|
||||
* of stemmed words, hlwords is the list of normal, unstemmed
|
||||
* words. the first one is used to find the occurance, the
|
||||
* latter for highlighting it.
|
||||
*/
|
||||
makeSearchSummary : function(text, keywords, hlwords) {
|
||||
var textLower = text.toLowerCase();
|
||||
var start = 0;
|
||||
$.each(keywords, function() {
|
||||
var i = textLower.indexOf(this.toLowerCase());
|
||||
if (i > -1)
|
||||
start = i;
|
||||
});
|
||||
start = Math.max(start - 120, 0);
|
||||
var excerpt = ((start > 0) ? '...' : '') +
|
||||
$.trim(text.substr(start, 240)) +
|
||||
((start + 240 - text.length) ? '...' : '');
|
||||
var rv = $('<div class="context"></div>').text(excerpt);
|
||||
$.each(hlwords, function() {
|
||||
rv = rv.highlightText(this, 'highlighted');
|
||||
});
|
||||
return rv;
|
||||
}
|
||||
};
|
||||
|
||||
$(document).ready(function() {
|
||||
Search.init();
|
||||
});
|
||||
@@ -1,999 +0,0 @@
|
||||
// Underscore.js 1.3.1
|
||||
// (c) 2009-2012 Jeremy Ashkenas, DocumentCloud Inc.
|
||||
// Underscore is freely distributable under the MIT license.
|
||||
// Portions of Underscore are inspired or borrowed from Prototype,
|
||||
// Oliver Steele's Functional, and John Resig's Micro-Templating.
|
||||
// For all details and documentation:
|
||||
// http://documentcloud.github.com/underscore
|
||||
|
||||
(function() {
|
||||
|
||||
// Baseline setup
|
||||
// --------------
|
||||
|
||||
// Establish the root object, `window` in the browser, or `global` on the server.
|
||||
var root = this;
|
||||
|
||||
// Save the previous value of the `_` variable.
|
||||
var previousUnderscore = root._;
|
||||
|
||||
// Establish the object that gets returned to break out of a loop iteration.
|
||||
var breaker = {};
|
||||
|
||||
// Save bytes in the minified (but not gzipped) version:
|
||||
var ArrayProto = Array.prototype, ObjProto = Object.prototype, FuncProto = Function.prototype;
|
||||
|
||||
// Create quick reference variables for speed access to core prototypes.
|
||||
var slice = ArrayProto.slice,
|
||||
unshift = ArrayProto.unshift,
|
||||
toString = ObjProto.toString,
|
||||
hasOwnProperty = ObjProto.hasOwnProperty;
|
||||
|
||||
// All **ECMAScript 5** native function implementations that we hope to use
|
||||
// are declared here.
|
||||
var
|
||||
nativeForEach = ArrayProto.forEach,
|
||||
nativeMap = ArrayProto.map,
|
||||
nativeReduce = ArrayProto.reduce,
|
||||
nativeReduceRight = ArrayProto.reduceRight,
|
||||
nativeFilter = ArrayProto.filter,
|
||||
nativeEvery = ArrayProto.every,
|
||||
nativeSome = ArrayProto.some,
|
||||
nativeIndexOf = ArrayProto.indexOf,
|
||||
nativeLastIndexOf = ArrayProto.lastIndexOf,
|
||||
nativeIsArray = Array.isArray,
|
||||
nativeKeys = Object.keys,
|
||||
nativeBind = FuncProto.bind;
|
||||
|
||||
// Create a safe reference to the Underscore object for use below.
|
||||
var _ = function(obj) { return new wrapper(obj); };
|
||||
|
||||
// Export the Underscore object for **Node.js**, with
|
||||
// backwards-compatibility for the old `require()` API. If we're in
|
||||
// the browser, add `_` as a global object via a string identifier,
|
||||
// for Closure Compiler "advanced" mode.
|
||||
if (typeof exports !== 'undefined') {
|
||||
if (typeof module !== 'undefined' && module.exports) {
|
||||
exports = module.exports = _;
|
||||
}
|
||||
exports._ = _;
|
||||
} else {
|
||||
root['_'] = _;
|
||||
}
|
||||
|
||||
// Current version.
|
||||
_.VERSION = '1.3.1';
|
||||
|
||||
// Collection Functions
|
||||
// --------------------
|
||||
|
||||
// The cornerstone, an `each` implementation, aka `forEach`.
|
||||
// Handles objects with the built-in `forEach`, arrays, and raw objects.
|
||||
// Delegates to **ECMAScript 5**'s native `forEach` if available.
|
||||
var each = _.each = _.forEach = function(obj, iterator, context) {
|
||||
if (obj == null) return;
|
||||
if (nativeForEach && obj.forEach === nativeForEach) {
|
||||
obj.forEach(iterator, context);
|
||||
} else if (obj.length === +obj.length) {
|
||||
for (var i = 0, l = obj.length; i < l; i++) {
|
||||
if (i in obj && iterator.call(context, obj[i], i, obj) === breaker) return;
|
||||
}
|
||||
} else {
|
||||
for (var key in obj) {
|
||||
if (_.has(obj, key)) {
|
||||
if (iterator.call(context, obj[key], key, obj) === breaker) return;
|
||||
}
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
// Return the results of applying the iterator to each element.
|
||||
// Delegates to **ECMAScript 5**'s native `map` if available.
|
||||
_.map = _.collect = function(obj, iterator, context) {
|
||||
var results = [];
|
||||
if (obj == null) return results;
|
||||
if (nativeMap && obj.map === nativeMap) return obj.map(iterator, context);
|
||||
each(obj, function(value, index, list) {
|
||||
results[results.length] = iterator.call(context, value, index, list);
|
||||
});
|
||||
if (obj.length === +obj.length) results.length = obj.length;
|
||||
return results;
|
||||
};
|
||||
|
||||
// **Reduce** builds up a single result from a list of values, aka `inject`,
|
||||
// or `foldl`. Delegates to **ECMAScript 5**'s native `reduce` if available.
|
||||
_.reduce = _.foldl = _.inject = function(obj, iterator, memo, context) {
|
||||
var initial = arguments.length > 2;
|
||||
if (obj == null) obj = [];
|
||||
if (nativeReduce && obj.reduce === nativeReduce) {
|
||||
if (context) iterator = _.bind(iterator, context);
|
||||
return initial ? obj.reduce(iterator, memo) : obj.reduce(iterator);
|
||||
}
|
||||
each(obj, function(value, index, list) {
|
||||
if (!initial) {
|
||||
memo = value;
|
||||
initial = true;
|
||||
} else {
|
||||
memo = iterator.call(context, memo, value, index, list);
|
||||
}
|
||||
});
|
||||
if (!initial) throw new TypeError('Reduce of empty array with no initial value');
|
||||
return memo;
|
||||
};
|
||||
|
||||
// The right-associative version of reduce, also known as `foldr`.
|
||||
// Delegates to **ECMAScript 5**'s native `reduceRight` if available.
|
||||
_.reduceRight = _.foldr = function(obj, iterator, memo, context) {
|
||||
var initial = arguments.length > 2;
|
||||
if (obj == null) obj = [];
|
||||
if (nativeReduceRight && obj.reduceRight === nativeReduceRight) {
|
||||
if (context) iterator = _.bind(iterator, context);
|
||||
return initial ? obj.reduceRight(iterator, memo) : obj.reduceRight(iterator);
|
||||
}
|
||||
var reversed = _.toArray(obj).reverse();
|
||||
if (context && !initial) iterator = _.bind(iterator, context);
|
||||
return initial ? _.reduce(reversed, iterator, memo, context) : _.reduce(reversed, iterator);
|
||||
};
|
||||
|
||||
// Return the first value which passes a truth test. Aliased as `detect`.
|
||||
_.find = _.detect = function(obj, iterator, context) {
|
||||
var result;
|
||||
any(obj, function(value, index, list) {
|
||||
if (iterator.call(context, value, index, list)) {
|
||||
result = value;
|
||||
return true;
|
||||
}
|
||||
});
|
||||
return result;
|
||||
};
|
||||
|
||||
// Return all the elements that pass a truth test.
|
||||
// Delegates to **ECMAScript 5**'s native `filter` if available.
|
||||
// Aliased as `select`.
|
||||
_.filter = _.select = function(obj, iterator, context) {
|
||||
var results = [];
|
||||
if (obj == null) return results;
|
||||
if (nativeFilter && obj.filter === nativeFilter) return obj.filter(iterator, context);
|
||||
each(obj, function(value, index, list) {
|
||||
if (iterator.call(context, value, index, list)) results[results.length] = value;
|
||||
});
|
||||
return results;
|
||||
};
|
||||
|
||||
// Return all the elements for which a truth test fails.
|
||||
_.reject = function(obj, iterator, context) {
|
||||
var results = [];
|
||||
if (obj == null) return results;
|
||||
each(obj, function(value, index, list) {
|
||||
if (!iterator.call(context, value, index, list)) results[results.length] = value;
|
||||
});
|
||||
return results;
|
||||
};
|
||||
|
||||
// Determine whether all of the elements match a truth test.
|
||||
// Delegates to **ECMAScript 5**'s native `every` if available.
|
||||
// Aliased as `all`.
|
||||
_.every = _.all = function(obj, iterator, context) {
|
||||
var result = true;
|
||||
if (obj == null) return result;
|
||||
if (nativeEvery && obj.every === nativeEvery) return obj.every(iterator, context);
|
||||
each(obj, function(value, index, list) {
|
||||
if (!(result = result && iterator.call(context, value, index, list))) return breaker;
|
||||
});
|
||||
return result;
|
||||
};
|
||||
|
||||
// Determine if at least one element in the object matches a truth test.
|
||||
// Delegates to **ECMAScript 5**'s native `some` if available.
|
||||
// Aliased as `any`.
|
||||
var any = _.some = _.any = function(obj, iterator, context) {
|
||||
iterator || (iterator = _.identity);
|
||||
var result = false;
|
||||
if (obj == null) return result;
|
||||
if (nativeSome && obj.some === nativeSome) return obj.some(iterator, context);
|
||||
each(obj, function(value, index, list) {
|
||||
if (result || (result = iterator.call(context, value, index, list))) return breaker;
|
||||
});
|
||||
return !!result;
|
||||
};
|
||||
|
||||
// Determine if a given value is included in the array or object using `===`.
|
||||
// Aliased as `contains`.
|
||||
_.include = _.contains = function(obj, target) {
|
||||
var found = false;
|
||||
if (obj == null) return found;
|
||||
if (nativeIndexOf && obj.indexOf === nativeIndexOf) return obj.indexOf(target) != -1;
|
||||
found = any(obj, function(value) {
|
||||
return value === target;
|
||||
});
|
||||
return found;
|
||||
};
|
||||
|
||||
// Invoke a method (with arguments) on every item in a collection.
|
||||
_.invoke = function(obj, method) {
|
||||
var args = slice.call(arguments, 2);
|
||||
return _.map(obj, function(value) {
|
||||
return (_.isFunction(method) ? method || value : value[method]).apply(value, args);
|
||||
});
|
||||
};
|
||||
|
||||
// Convenience version of a common use case of `map`: fetching a property.
|
||||
_.pluck = function(obj, key) {
|
||||
return _.map(obj, function(value){ return value[key]; });
|
||||
};
|
||||
|
||||
// Return the maximum element or (element-based computation).
|
||||
_.max = function(obj, iterator, context) {
|
||||
if (!iterator && _.isArray(obj)) return Math.max.apply(Math, obj);
|
||||
if (!iterator && _.isEmpty(obj)) return -Infinity;
|
||||
var result = {computed : -Infinity};
|
||||
each(obj, function(value, index, list) {
|
||||
var computed = iterator ? iterator.call(context, value, index, list) : value;
|
||||
computed >= result.computed && (result = {value : value, computed : computed});
|
||||
});
|
||||
return result.value;
|
||||
};
|
||||
|
||||
// Return the minimum element (or element-based computation).
|
||||
_.min = function(obj, iterator, context) {
|
||||
if (!iterator && _.isArray(obj)) return Math.min.apply(Math, obj);
|
||||
if (!iterator && _.isEmpty(obj)) return Infinity;
|
||||
var result = {computed : Infinity};
|
||||
each(obj, function(value, index, list) {
|
||||
var computed = iterator ? iterator.call(context, value, index, list) : value;
|
||||
computed < result.computed && (result = {value : value, computed : computed});
|
||||
});
|
||||
return result.value;
|
||||
};
|
||||
|
||||
// Shuffle an array.
|
||||
_.shuffle = function(obj) {
|
||||
var shuffled = [], rand;
|
||||
each(obj, function(value, index, list) {
|
||||
if (index == 0) {
|
||||
shuffled[0] = value;
|
||||
} else {
|
||||
rand = Math.floor(Math.random() * (index + 1));
|
||||
shuffled[index] = shuffled[rand];
|
||||
shuffled[rand] = value;
|
||||
}
|
||||
});
|
||||
return shuffled;
|
||||
};
|
||||
|
||||
// Sort the object's values by a criterion produced by an iterator.
|
||||
_.sortBy = function(obj, iterator, context) {
|
||||
return _.pluck(_.map(obj, function(value, index, list) {
|
||||
return {
|
||||
value : value,
|
||||
criteria : iterator.call(context, value, index, list)
|
||||
};
|
||||
}).sort(function(left, right) {
|
||||
var a = left.criteria, b = right.criteria;
|
||||
return a < b ? -1 : a > b ? 1 : 0;
|
||||
}), 'value');
|
||||
};
|
||||
|
||||
// Groups the object's values by a criterion. Pass either a string attribute
|
||||
// to group by, or a function that returns the criterion.
|
||||
_.groupBy = function(obj, val) {
|
||||
var result = {};
|
||||
var iterator = _.isFunction(val) ? val : function(obj) { return obj[val]; };
|
||||
each(obj, function(value, index) {
|
||||
var key = iterator(value, index);
|
||||
(result[key] || (result[key] = [])).push(value);
|
||||
});
|
||||
return result;
|
||||
};
|
||||
|
||||
// Use a comparator function to figure out at what index an object should
|
||||
// be inserted so as to maintain order. Uses binary search.
|
||||
_.sortedIndex = function(array, obj, iterator) {
|
||||
iterator || (iterator = _.identity);
|
||||
var low = 0, high = array.length;
|
||||
while (low < high) {
|
||||
var mid = (low + high) >> 1;
|
||||
iterator(array[mid]) < iterator(obj) ? low = mid + 1 : high = mid;
|
||||
}
|
||||
return low;
|
||||
};
|
||||
|
||||
// Safely convert anything iterable into a real, live array.
|
||||
_.toArray = function(iterable) {
|
||||
if (!iterable) return [];
|
||||
if (iterable.toArray) return iterable.toArray();
|
||||
if (_.isArray(iterable)) return slice.call(iterable);
|
||||
if (_.isArguments(iterable)) return slice.call(iterable);
|
||||
return _.values(iterable);
|
||||
};
|
||||
|
||||
// Return the number of elements in an object.
|
||||
_.size = function(obj) {
|
||||
return _.toArray(obj).length;
|
||||
};
|
||||
|
||||
// Array Functions
|
||||
// ---------------
|
||||
|
||||
// Get the first element of an array. Passing **n** will return the first N
|
||||
// values in the array. Aliased as `head`. The **guard** check allows it to work
|
||||
// with `_.map`.
|
||||
_.first = _.head = function(array, n, guard) {
|
||||
return (n != null) && !guard ? slice.call(array, 0, n) : array[0];
|
||||
};
|
||||
|
||||
// Returns everything but the last entry of the array. Especcialy useful on
|
||||
// the arguments object. Passing **n** will return all the values in
|
||||
// the array, excluding the last N. The **guard** check allows it to work with
|
||||
// `_.map`.
|
||||
_.initial = function(array, n, guard) {
|
||||
return slice.call(array, 0, array.length - ((n == null) || guard ? 1 : n));
|
||||
};
|
||||
|
||||
// Get the last element of an array. Passing **n** will return the last N
|
||||
// values in the array. The **guard** check allows it to work with `_.map`.
|
||||
_.last = function(array, n, guard) {
|
||||
if ((n != null) && !guard) {
|
||||
return slice.call(array, Math.max(array.length - n, 0));
|
||||
} else {
|
||||
return array[array.length - 1];
|
||||
}
|
||||
};
|
||||
|
||||
// Returns everything but the first entry of the array. Aliased as `tail`.
|
||||
// Especially useful on the arguments object. Passing an **index** will return
|
||||
// the rest of the values in the array from that index onward. The **guard**
|
||||
// check allows it to work with `_.map`.
|
||||
_.rest = _.tail = function(array, index, guard) {
|
||||
return slice.call(array, (index == null) || guard ? 1 : index);
|
||||
};
|
||||
|
||||
// Trim out all falsy values from an array.
|
||||
_.compact = function(array) {
|
||||
return _.filter(array, function(value){ return !!value; });
|
||||
};
|
||||
|
||||
// Return a completely flattened version of an array.
|
||||
_.flatten = function(array, shallow) {
|
||||
return _.reduce(array, function(memo, value) {
|
||||
if (_.isArray(value)) return memo.concat(shallow ? value : _.flatten(value));
|
||||
memo[memo.length] = value;
|
||||
return memo;
|
||||
}, []);
|
||||
};
|
||||
|
||||
// Return a version of the array that does not contain the specified value(s).
|
||||
_.without = function(array) {
|
||||
return _.difference(array, slice.call(arguments, 1));
|
||||
};
|
||||
|
||||
// Produce a duplicate-free version of the array. If the array has already
|
||||
// been sorted, you have the option of using a faster algorithm.
|
||||
// Aliased as `unique`.
|
||||
_.uniq = _.unique = function(array, isSorted, iterator) {
|
||||
var initial = iterator ? _.map(array, iterator) : array;
|
||||
var result = [];
|
||||
_.reduce(initial, function(memo, el, i) {
|
||||
if (0 == i || (isSorted === true ? _.last(memo) != el : !_.include(memo, el))) {
|
||||
memo[memo.length] = el;
|
||||
result[result.length] = array[i];
|
||||
}
|
||||
return memo;
|
||||
}, []);
|
||||
return result;
|
||||
};
|
||||
|
||||
// Produce an array that contains the union: each distinct element from all of
|
||||
// the passed-in arrays.
|
||||
_.union = function() {
|
||||
return _.uniq(_.flatten(arguments, true));
|
||||
};
|
||||
|
||||
// Produce an array that contains every item shared between all the
|
||||
// passed-in arrays. (Aliased as "intersect" for back-compat.)
|
||||
_.intersection = _.intersect = function(array) {
|
||||
var rest = slice.call(arguments, 1);
|
||||
return _.filter(_.uniq(array), function(item) {
|
||||
return _.every(rest, function(other) {
|
||||
return _.indexOf(other, item) >= 0;
|
||||
});
|
||||
});
|
||||
};
|
||||
|
||||
// Take the difference between one array and a number of other arrays.
|
||||
// Only the elements present in just the first array will remain.
|
||||
_.difference = function(array) {
|
||||
var rest = _.flatten(slice.call(arguments, 1));
|
||||
return _.filter(array, function(value){ return !_.include(rest, value); });
|
||||
};
|
||||
|
||||
// Zip together multiple lists into a single array -- elements that share
|
||||
// an index go together.
|
||||
_.zip = function() {
|
||||
var args = slice.call(arguments);
|
||||
var length = _.max(_.pluck(args, 'length'));
|
||||
var results = new Array(length);
|
||||
for (var i = 0; i < length; i++) results[i] = _.pluck(args, "" + i);
|
||||
return results;
|
||||
};
|
||||
|
||||
// If the browser doesn't supply us with indexOf (I'm looking at you, **MSIE**),
|
||||
// we need this function. Return the position of the first occurrence of an
|
||||
// item in an array, or -1 if the item is not included in the array.
|
||||
// Delegates to **ECMAScript 5**'s native `indexOf` if available.
|
||||
// If the array is large and already in sort order, pass `true`
|
||||
// for **isSorted** to use binary search.
|
||||
_.indexOf = function(array, item, isSorted) {
|
||||
if (array == null) return -1;
|
||||
var i, l;
|
||||
if (isSorted) {
|
||||
i = _.sortedIndex(array, item);
|
||||
return array[i] === item ? i : -1;
|
||||
}
|
||||
if (nativeIndexOf && array.indexOf === nativeIndexOf) return array.indexOf(item);
|
||||
for (i = 0, l = array.length; i < l; i++) if (i in array && array[i] === item) return i;
|
||||
return -1;
|
||||
};
|
||||
|
||||
// Delegates to **ECMAScript 5**'s native `lastIndexOf` if available.
|
||||
_.lastIndexOf = function(array, item) {
|
||||
if (array == null) return -1;
|
||||
if (nativeLastIndexOf && array.lastIndexOf === nativeLastIndexOf) return array.lastIndexOf(item);
|
||||
var i = array.length;
|
||||
while (i--) if (i in array && array[i] === item) return i;
|
||||
return -1;
|
||||
};
|
||||
|
||||
// Generate an integer Array containing an arithmetic progression. A port of
|
||||
// the native Python `range()` function. See
|
||||
// [the Python documentation](http://docs.python.org/library/functions.html#range).
|
||||
_.range = function(start, stop, step) {
|
||||
if (arguments.length <= 1) {
|
||||
stop = start || 0;
|
||||
start = 0;
|
||||
}
|
||||
step = arguments[2] || 1;
|
||||
|
||||
var len = Math.max(Math.ceil((stop - start) / step), 0);
|
||||
var idx = 0;
|
||||
var range = new Array(len);
|
||||
|
||||
while(idx < len) {
|
||||
range[idx++] = start;
|
||||
start += step;
|
||||
}
|
||||
|
||||
return range;
|
||||
};
|
||||
|
||||
// Function (ahem) Functions
|
||||
// ------------------
|
||||
|
||||
// Reusable constructor function for prototype setting.
|
||||
var ctor = function(){};
|
||||
|
||||
// Create a function bound to a given object (assigning `this`, and arguments,
|
||||
// optionally). Binding with arguments is also known as `curry`.
|
||||
// Delegates to **ECMAScript 5**'s native `Function.bind` if available.
|
||||
// We check for `func.bind` first, to fail fast when `func` is undefined.
|
||||
_.bind = function bind(func, context) {
|
||||
var bound, args;
|
||||
if (func.bind === nativeBind && nativeBind) return nativeBind.apply(func, slice.call(arguments, 1));
|
||||
if (!_.isFunction(func)) throw new TypeError;
|
||||
args = slice.call(arguments, 2);
|
||||
return bound = function() {
|
||||
if (!(this instanceof bound)) return func.apply(context, args.concat(slice.call(arguments)));
|
||||
ctor.prototype = func.prototype;
|
||||
var self = new ctor;
|
||||
var result = func.apply(self, args.concat(slice.call(arguments)));
|
||||
if (Object(result) === result) return result;
|
||||
return self;
|
||||
};
|
||||
};
|
||||
|
||||
// Bind all of an object's methods to that object. Useful for ensuring that
|
||||
// all callbacks defined on an object belong to it.
|
||||
_.bindAll = function(obj) {
|
||||
var funcs = slice.call(arguments, 1);
|
||||
if (funcs.length == 0) funcs = _.functions(obj);
|
||||
each(funcs, function(f) { obj[f] = _.bind(obj[f], obj); });
|
||||
return obj;
|
||||
};
|
||||
|
||||
// Memoize an expensive function by storing its results.
|
||||
_.memoize = function(func, hasher) {
|
||||
var memo = {};
|
||||
hasher || (hasher = _.identity);
|
||||
return function() {
|
||||
var key = hasher.apply(this, arguments);
|
||||
return _.has(memo, key) ? memo[key] : (memo[key] = func.apply(this, arguments));
|
||||
};
|
||||
};
|
||||
|
||||
// Delays a function for the given number of milliseconds, and then calls
|
||||
// it with the arguments supplied.
|
||||
_.delay = function(func, wait) {
|
||||
var args = slice.call(arguments, 2);
|
||||
return setTimeout(function(){ return func.apply(func, args); }, wait);
|
||||
};
|
||||
|
||||
// Defers a function, scheduling it to run after the current call stack has
|
||||
// cleared.
|
||||
_.defer = function(func) {
|
||||
return _.delay.apply(_, [func, 1].concat(slice.call(arguments, 1)));
|
||||
};
|
||||
|
||||
// Returns a function, that, when invoked, will only be triggered at most once
|
||||
// during a given window of time.
|
||||
_.throttle = function(func, wait) {
|
||||
var context, args, timeout, throttling, more;
|
||||
var whenDone = _.debounce(function(){ more = throttling = false; }, wait);
|
||||
return function() {
|
||||
context = this; args = arguments;
|
||||
var later = function() {
|
||||
timeout = null;
|
||||
if (more) func.apply(context, args);
|
||||
whenDone();
|
||||
};
|
||||
if (!timeout) timeout = setTimeout(later, wait);
|
||||
if (throttling) {
|
||||
more = true;
|
||||
} else {
|
||||
func.apply(context, args);
|
||||
}
|
||||
whenDone();
|
||||
throttling = true;
|
||||
};
|
||||
};
|
||||
|
||||
// Returns a function, that, as long as it continues to be invoked, will not
|
||||
// be triggered. The function will be called after it stops being called for
|
||||
// N milliseconds.
|
||||
_.debounce = function(func, wait) {
|
||||
var timeout;
|
||||
return function() {
|
||||
var context = this, args = arguments;
|
||||
var later = function() {
|
||||
timeout = null;
|
||||
func.apply(context, args);
|
||||
};
|
||||
clearTimeout(timeout);
|
||||
timeout = setTimeout(later, wait);
|
||||
};
|
||||
};
|
||||
|
||||
// Returns a function that will be executed at most one time, no matter how
|
||||
// often you call it. Useful for lazy initialization.
|
||||
_.once = function(func) {
|
||||
var ran = false, memo;
|
||||
return function() {
|
||||
if (ran) return memo;
|
||||
ran = true;
|
||||
return memo = func.apply(this, arguments);
|
||||
};
|
||||
};
|
||||
|
||||
// Returns the first function passed as an argument to the second,
|
||||
// allowing you to adjust arguments, run code before and after, and
|
||||
// conditionally execute the original function.
|
||||
_.wrap = function(func, wrapper) {
|
||||
return function() {
|
||||
var args = [func].concat(slice.call(arguments, 0));
|
||||
return wrapper.apply(this, args);
|
||||
};
|
||||
};
|
||||
|
||||
// Returns a function that is the composition of a list of functions, each
|
||||
// consuming the return value of the function that follows.
|
||||
_.compose = function() {
|
||||
var funcs = arguments;
|
||||
return function() {
|
||||
var args = arguments;
|
||||
for (var i = funcs.length - 1; i >= 0; i--) {
|
||||
args = [funcs[i].apply(this, args)];
|
||||
}
|
||||
return args[0];
|
||||
};
|
||||
};
|
||||
|
||||
// Returns a function that will only be executed after being called N times.
|
||||
_.after = function(times, func) {
|
||||
if (times <= 0) return func();
|
||||
return function() {
|
||||
if (--times < 1) { return func.apply(this, arguments); }
|
||||
};
|
||||
};
|
||||
|
||||
// Object Functions
|
||||
// ----------------
|
||||
|
||||
// Retrieve the names of an object's properties.
|
||||
// Delegates to **ECMAScript 5**'s native `Object.keys`
|
||||
_.keys = nativeKeys || function(obj) {
|
||||
if (obj !== Object(obj)) throw new TypeError('Invalid object');
|
||||
var keys = [];
|
||||
for (var key in obj) if (_.has(obj, key)) keys[keys.length] = key;
|
||||
return keys;
|
||||
};
|
||||
|
||||
// Retrieve the values of an object's properties.
|
||||
_.values = function(obj) {
|
||||
return _.map(obj, _.identity);
|
||||
};
|
||||
|
||||
// Return a sorted list of the function names available on the object.
|
||||
// Aliased as `methods`
|
||||
_.functions = _.methods = function(obj) {
|
||||
var names = [];
|
||||
for (var key in obj) {
|
||||
if (_.isFunction(obj[key])) names.push(key);
|
||||
}
|
||||
return names.sort();
|
||||
};
|
||||
|
||||
// Extend a given object with all the properties in passed-in object(s).
|
||||
_.extend = function(obj) {
|
||||
each(slice.call(arguments, 1), function(source) {
|
||||
for (var prop in source) {
|
||||
obj[prop] = source[prop];
|
||||
}
|
||||
});
|
||||
return obj;
|
||||
};
|
||||
|
||||
// Fill in a given object with default properties.
|
||||
_.defaults = function(obj) {
|
||||
each(slice.call(arguments, 1), function(source) {
|
||||
for (var prop in source) {
|
||||
if (obj[prop] == null) obj[prop] = source[prop];
|
||||
}
|
||||
});
|
||||
return obj;
|
||||
};
|
||||
|
||||
// Create a (shallow-cloned) duplicate of an object.
|
||||
_.clone = function(obj) {
|
||||
if (!_.isObject(obj)) return obj;
|
||||
return _.isArray(obj) ? obj.slice() : _.extend({}, obj);
|
||||
};
|
||||
|
||||
// Invokes interceptor with the obj, and then returns obj.
|
||||
// The primary purpose of this method is to "tap into" a method chain, in
|
||||
// order to perform operations on intermediate results within the chain.
|
||||
_.tap = function(obj, interceptor) {
|
||||
interceptor(obj);
|
||||
return obj;
|
||||
};
|
||||
|
||||
// Internal recursive comparison function.
|
||||
function eq(a, b, stack) {
|
||||
// Identical objects are equal. `0 === -0`, but they aren't identical.
|
||||
// See the Harmony `egal` proposal: http://wiki.ecmascript.org/doku.php?id=harmony:egal.
|
||||
if (a === b) return a !== 0 || 1 / a == 1 / b;
|
||||
// A strict comparison is necessary because `null == undefined`.
|
||||
if (a == null || b == null) return a === b;
|
||||
// Unwrap any wrapped objects.
|
||||
if (a._chain) a = a._wrapped;
|
||||
if (b._chain) b = b._wrapped;
|
||||
// Invoke a custom `isEqual` method if one is provided.
|
||||
if (a.isEqual && _.isFunction(a.isEqual)) return a.isEqual(b);
|
||||
if (b.isEqual && _.isFunction(b.isEqual)) return b.isEqual(a);
|
||||
// Compare `[[Class]]` names.
|
||||
var className = toString.call(a);
|
||||
if (className != toString.call(b)) return false;
|
||||
switch (className) {
|
||||
// Strings, numbers, dates, and booleans are compared by value.
|
||||
case '[object String]':
|
||||
// Primitives and their corresponding object wrappers are equivalent; thus, `"5"` is
|
||||
// equivalent to `new String("5")`.
|
||||
return a == String(b);
|
||||
case '[object Number]':
|
||||
// `NaN`s are equivalent, but non-reflexive. An `egal` comparison is performed for
|
||||
// other numeric values.
|
||||
return a != +a ? b != +b : (a == 0 ? 1 / a == 1 / b : a == +b);
|
||||
case '[object Date]':
|
||||
case '[object Boolean]':
|
||||
// Coerce dates and booleans to numeric primitive values. Dates are compared by their
|
||||
// millisecond representations. Note that invalid dates with millisecond representations
|
||||
// of `NaN` are not equivalent.
|
||||
return +a == +b;
|
||||
// RegExps are compared by their source patterns and flags.
|
||||
case '[object RegExp]':
|
||||
return a.source == b.source &&
|
||||
a.global == b.global &&
|
||||
a.multiline == b.multiline &&
|
||||
a.ignoreCase == b.ignoreCase;
|
||||
}
|
||||
if (typeof a != 'object' || typeof b != 'object') return false;
|
||||
// Assume equality for cyclic structures. The algorithm for detecting cyclic
|
||||
// structures is adapted from ES 5.1 section 15.12.3, abstract operation `JO`.
|
||||
var length = stack.length;
|
||||
while (length--) {
|
||||
// Linear search. Performance is inversely proportional to the number of
|
||||
// unique nested structures.
|
||||
if (stack[length] == a) return true;
|
||||
}
|
||||
// Add the first object to the stack of traversed objects.
|
||||
stack.push(a);
|
||||
var size = 0, result = true;
|
||||
// Recursively compare objects and arrays.
|
||||
if (className == '[object Array]') {
|
||||
// Compare array lengths to determine if a deep comparison is necessary.
|
||||
size = a.length;
|
||||
result = size == b.length;
|
||||
if (result) {
|
||||
// Deep compare the contents, ignoring non-numeric properties.
|
||||
while (size--) {
|
||||
// Ensure commutative equality for sparse arrays.
|
||||
if (!(result = size in a == size in b && eq(a[size], b[size], stack))) break;
|
||||
}
|
||||
}
|
||||
} else {
|
||||
// Objects with different constructors are not equivalent.
|
||||
if ('constructor' in a != 'constructor' in b || a.constructor != b.constructor) return false;
|
||||
// Deep compare objects.
|
||||
for (var key in a) {
|
||||
if (_.has(a, key)) {
|
||||
// Count the expected number of properties.
|
||||
size++;
|
||||
// Deep compare each member.
|
||||
if (!(result = _.has(b, key) && eq(a[key], b[key], stack))) break;
|
||||
}
|
||||
}
|
||||
// Ensure that both objects contain the same number of properties.
|
||||
if (result) {
|
||||
for (key in b) {
|
||||
if (_.has(b, key) && !(size--)) break;
|
||||
}
|
||||
result = !size;
|
||||
}
|
||||
}
|
||||
// Remove the first object from the stack of traversed objects.
|
||||
stack.pop();
|
||||
return result;
|
||||
}
|
||||
|
||||
// Perform a deep comparison to check if two objects are equal.
|
||||
_.isEqual = function(a, b) {
|
||||
return eq(a, b, []);
|
||||
};
|
||||
|
||||
// Is a given array, string, or object empty?
|
||||
// An "empty" object has no enumerable own-properties.
|
||||
_.isEmpty = function(obj) {
|
||||
if (_.isArray(obj) || _.isString(obj)) return obj.length === 0;
|
||||
for (var key in obj) if (_.has(obj, key)) return false;
|
||||
return true;
|
||||
};
|
||||
|
||||
// Is a given value a DOM element?
|
||||
_.isElement = function(obj) {
|
||||
return !!(obj && obj.nodeType == 1);
|
||||
};
|
||||
|
||||
// Is a given value an array?
|
||||
// Delegates to ECMA5's native Array.isArray
|
||||
_.isArray = nativeIsArray || function(obj) {
|
||||
return toString.call(obj) == '[object Array]';
|
||||
};
|
||||
|
||||
// Is a given variable an object?
|
||||
_.isObject = function(obj) {
|
||||
return obj === Object(obj);
|
||||
};
|
||||
|
||||
// Is a given variable an arguments object?
|
||||
_.isArguments = function(obj) {
|
||||
return toString.call(obj) == '[object Arguments]';
|
||||
};
|
||||
if (!_.isArguments(arguments)) {
|
||||
_.isArguments = function(obj) {
|
||||
return !!(obj && _.has(obj, 'callee'));
|
||||
};
|
||||
}
|
||||
|
||||
// Is a given value a function?
|
||||
_.isFunction = function(obj) {
|
||||
return toString.call(obj) == '[object Function]';
|
||||
};
|
||||
|
||||
// Is a given value a string?
|
||||
_.isString = function(obj) {
|
||||
return toString.call(obj) == '[object String]';
|
||||
};
|
||||
|
||||
// Is a given value a number?
|
||||
_.isNumber = function(obj) {
|
||||
return toString.call(obj) == '[object Number]';
|
||||
};
|
||||
|
||||
// Is the given value `NaN`?
|
||||
_.isNaN = function(obj) {
|
||||
// `NaN` is the only value for which `===` is not reflexive.
|
||||
return obj !== obj;
|
||||
};
|
||||
|
||||
// Is a given value a boolean?
|
||||
_.isBoolean = function(obj) {
|
||||
return obj === true || obj === false || toString.call(obj) == '[object Boolean]';
|
||||
};
|
||||
|
||||
// Is a given value a date?
|
||||
_.isDate = function(obj) {
|
||||
return toString.call(obj) == '[object Date]';
|
||||
};
|
||||
|
||||
// Is the given value a regular expression?
|
||||
_.isRegExp = function(obj) {
|
||||
return toString.call(obj) == '[object RegExp]';
|
||||
};
|
||||
|
||||
// Is a given value equal to null?
|
||||
_.isNull = function(obj) {
|
||||
return obj === null;
|
||||
};
|
||||
|
||||
// Is a given variable undefined?
|
||||
_.isUndefined = function(obj) {
|
||||
return obj === void 0;
|
||||
};
|
||||
|
||||
// Has own property?
|
||||
_.has = function(obj, key) {
|
||||
return hasOwnProperty.call(obj, key);
|
||||
};
|
||||
|
||||
// Utility Functions
|
||||
// -----------------
|
||||
|
||||
// Run Underscore.js in *noConflict* mode, returning the `_` variable to its
|
||||
// previous owner. Returns a reference to the Underscore object.
|
||||
_.noConflict = function() {
|
||||
root._ = previousUnderscore;
|
||||
return this;
|
||||
};
|
||||
|
||||
// Keep the identity function around for default iterators.
|
||||
_.identity = function(value) {
|
||||
return value;
|
||||
};
|
||||
|
||||
// Run a function **n** times.
|
||||
_.times = function (n, iterator, context) {
|
||||
for (var i = 0; i < n; i++) iterator.call(context, i);
|
||||
};
|
||||
|
||||
// Escape a string for HTML interpolation.
|
||||
_.escape = function(string) {
|
||||
return (''+string).replace(/&/g, '&').replace(/</g, '<').replace(/>/g, '>').replace(/"/g, '"').replace(/'/g, ''').replace(/\//g,'/');
|
||||
};
|
||||
|
||||
// Add your own custom functions to the Underscore object, ensuring that
|
||||
// they're correctly added to the OOP wrapper as well.
|
||||
_.mixin = function(obj) {
|
||||
each(_.functions(obj), function(name){
|
||||
addToWrapper(name, _[name] = obj[name]);
|
||||
});
|
||||
};
|
||||
|
||||
// Generate a unique integer id (unique within the entire client session).
|
||||
// Useful for temporary DOM ids.
|
||||
var idCounter = 0;
|
||||
_.uniqueId = function(prefix) {
|
||||
var id = idCounter++;
|
||||
return prefix ? prefix + id : id;
|
||||
};
|
||||
|
||||
// By default, Underscore uses ERB-style template delimiters, change the
|
||||
// following template settings to use alternative delimiters.
|
||||
_.templateSettings = {
|
||||
evaluate : /<%([\s\S]+?)%>/g,
|
||||
interpolate : /<%=([\s\S]+?)%>/g,
|
||||
escape : /<%-([\s\S]+?)%>/g
|
||||
};
|
||||
|
||||
// When customizing `templateSettings`, if you don't want to define an
|
||||
// interpolation, evaluation or escaping regex, we need one that is
|
||||
// guaranteed not to match.
|
||||
var noMatch = /.^/;
|
||||
|
||||
// Within an interpolation, evaluation, or escaping, remove HTML escaping
|
||||
// that had been previously added.
|
||||
var unescape = function(code) {
|
||||
return code.replace(/\\\\/g, '\\').replace(/\\'/g, "'");
|
||||
};
|
||||
|
||||
// JavaScript micro-templating, similar to John Resig's implementation.
|
||||
// Underscore templating handles arbitrary delimiters, preserves whitespace,
|
||||
// and correctly escapes quotes within interpolated code.
|
||||
_.template = function(str, data) {
|
||||
var c = _.templateSettings;
|
||||
var tmpl = 'var __p=[],print=function(){__p.push.apply(__p,arguments);};' +
|
||||
'with(obj||{}){__p.push(\'' +
|
||||
str.replace(/\\/g, '\\\\')
|
||||
.replace(/'/g, "\\'")
|
||||
.replace(c.escape || noMatch, function(match, code) {
|
||||
return "',_.escape(" + unescape(code) + "),'";
|
||||
})
|
||||
.replace(c.interpolate || noMatch, function(match, code) {
|
||||
return "'," + unescape(code) + ",'";
|
||||
})
|
||||
.replace(c.evaluate || noMatch, function(match, code) {
|
||||
return "');" + unescape(code).replace(/[\r\n\t]/g, ' ') + ";__p.push('";
|
||||
})
|
||||
.replace(/\r/g, '\\r')
|
||||
.replace(/\n/g, '\\n')
|
||||
.replace(/\t/g, '\\t')
|
||||
+ "');}return __p.join('');";
|
||||
var func = new Function('obj', '_', tmpl);
|
||||
if (data) return func(data, _);
|
||||
return function(data) {
|
||||
return func.call(this, data, _);
|
||||
};
|
||||
};
|
||||
|
||||
// Add a "chain" function, which will delegate to the wrapper.
|
||||
_.chain = function(obj) {
|
||||
return _(obj).chain();
|
||||
};
|
||||
|
||||
// The OOP Wrapper
|
||||
// ---------------
|
||||
|
||||
// If Underscore is called as a function, it returns a wrapped object that
|
||||
// can be used OO-style. This wrapper holds altered versions of all the
|
||||
// underscore functions. Wrapped objects may be chained.
|
||||
var wrapper = function(obj) { this._wrapped = obj; };
|
||||
|
||||
// Expose `wrapper.prototype` as `_.prototype`
|
||||
_.prototype = wrapper.prototype;
|
||||
|
||||
// Helper function to continue chaining intermediate results.
|
||||
var result = function(obj, chain) {
|
||||
return chain ? _(obj).chain() : obj;
|
||||
};
|
||||
|
||||
// A method to easily add functions to the OOP wrapper.
|
||||
var addToWrapper = function(name, func) {
|
||||
wrapper.prototype[name] = function() {
|
||||
var args = slice.call(arguments);
|
||||
unshift.call(args, this._wrapped);
|
||||
return result(func.apply(_, args), this._chain);
|
||||
};
|
||||
};
|
||||
|
||||
// Add all of the Underscore functions to the wrapper object.
|
||||
_.mixin(_);
|
||||
|
||||
// Add all mutator Array functions to the wrapper.
|
||||
each(['pop', 'push', 'reverse', 'shift', 'sort', 'splice', 'unshift'], function(name) {
|
||||
var method = ArrayProto[name];
|
||||
wrapper.prototype[name] = function() {
|
||||
var wrapped = this._wrapped;
|
||||
method.apply(wrapped, arguments);
|
||||
var length = wrapped.length;
|
||||
if ((name == 'shift' || name == 'splice') && length === 0) delete wrapped[0];
|
||||
return result(wrapped, this._chain);
|
||||
};
|
||||
});
|
||||
|
||||
// Add all accessor Array functions to the wrapper.
|
||||
each(['concat', 'join', 'slice'], function(name) {
|
||||
var method = ArrayProto[name];
|
||||
wrapper.prototype[name] = function() {
|
||||
return result(method.apply(this._wrapped, arguments), this._chain);
|
||||
};
|
||||
});
|
||||
|
||||
// Start chaining a wrapped Underscore object.
|
||||
wrapper.prototype.chain = function() {
|
||||
this._chain = true;
|
||||
return this;
|
||||
};
|
||||
|
||||
// Extracts the result from a wrapped and chained object.
|
||||
wrapper.prototype.value = function() {
|
||||
return this._wrapped;
|
||||
};
|
||||
|
||||
}).call(this);
|
||||
@@ -1,31 +0,0 @@
|
||||
// Underscore.js 1.3.1
|
||||
// (c) 2009-2012 Jeremy Ashkenas, DocumentCloud Inc.
|
||||
// Underscore is freely distributable under the MIT license.
|
||||
// Portions of Underscore are inspired or borrowed from Prototype,
|
||||
// Oliver Steele's Functional, and John Resig's Micro-Templating.
|
||||
// For all details and documentation:
|
||||
// http://documentcloud.github.com/underscore
|
||||
(function(){function q(a,c,d){if(a===c)return a!==0||1/a==1/c;if(a==null||c==null)return a===c;if(a._chain)a=a._wrapped;if(c._chain)c=c._wrapped;if(a.isEqual&&b.isFunction(a.isEqual))return a.isEqual(c);if(c.isEqual&&b.isFunction(c.isEqual))return c.isEqual(a);var e=l.call(a);if(e!=l.call(c))return false;switch(e){case "[object String]":return a==String(c);case "[object Number]":return a!=+a?c!=+c:a==0?1/a==1/c:a==+c;case "[object Date]":case "[object Boolean]":return+a==+c;case "[object RegExp]":return a.source==
|
||||
c.source&&a.global==c.global&&a.multiline==c.multiline&&a.ignoreCase==c.ignoreCase}if(typeof a!="object"||typeof c!="object")return false;for(var f=d.length;f--;)if(d[f]==a)return true;d.push(a);var f=0,g=true;if(e=="[object Array]"){if(f=a.length,g=f==c.length)for(;f--;)if(!(g=f in a==f in c&&q(a[f],c[f],d)))break}else{if("constructor"in a!="constructor"in c||a.constructor!=c.constructor)return false;for(var h in a)if(b.has(a,h)&&(f++,!(g=b.has(c,h)&&q(a[h],c[h],d))))break;if(g){for(h in c)if(b.has(c,
|
||||
h)&&!f--)break;g=!f}}d.pop();return g}var r=this,G=r._,n={},k=Array.prototype,o=Object.prototype,i=k.slice,H=k.unshift,l=o.toString,I=o.hasOwnProperty,w=k.forEach,x=k.map,y=k.reduce,z=k.reduceRight,A=k.filter,B=k.every,C=k.some,p=k.indexOf,D=k.lastIndexOf,o=Array.isArray,J=Object.keys,s=Function.prototype.bind,b=function(a){return new m(a)};if(typeof exports!=="undefined"){if(typeof module!=="undefined"&&module.exports)exports=module.exports=b;exports._=b}else r._=b;b.VERSION="1.3.1";var j=b.each=
|
||||
b.forEach=function(a,c,d){if(a!=null)if(w&&a.forEach===w)a.forEach(c,d);else if(a.length===+a.length)for(var e=0,f=a.length;e<f;e++){if(e in a&&c.call(d,a[e],e,a)===n)break}else for(e in a)if(b.has(a,e)&&c.call(d,a[e],e,a)===n)break};b.map=b.collect=function(a,c,b){var e=[];if(a==null)return e;if(x&&a.map===x)return a.map(c,b);j(a,function(a,g,h){e[e.length]=c.call(b,a,g,h)});if(a.length===+a.length)e.length=a.length;return e};b.reduce=b.foldl=b.inject=function(a,c,d,e){var f=arguments.length>2;a==
|
||||
null&&(a=[]);if(y&&a.reduce===y)return e&&(c=b.bind(c,e)),f?a.reduce(c,d):a.reduce(c);j(a,function(a,b,i){f?d=c.call(e,d,a,b,i):(d=a,f=true)});if(!f)throw new TypeError("Reduce of empty array with no initial value");return d};b.reduceRight=b.foldr=function(a,c,d,e){var f=arguments.length>2;a==null&&(a=[]);if(z&&a.reduceRight===z)return e&&(c=b.bind(c,e)),f?a.reduceRight(c,d):a.reduceRight(c);var g=b.toArray(a).reverse();e&&!f&&(c=b.bind(c,e));return f?b.reduce(g,c,d,e):b.reduce(g,c)};b.find=b.detect=
|
||||
function(a,c,b){var e;E(a,function(a,g,h){if(c.call(b,a,g,h))return e=a,true});return e};b.filter=b.select=function(a,c,b){var e=[];if(a==null)return e;if(A&&a.filter===A)return a.filter(c,b);j(a,function(a,g,h){c.call(b,a,g,h)&&(e[e.length]=a)});return e};b.reject=function(a,c,b){var e=[];if(a==null)return e;j(a,function(a,g,h){c.call(b,a,g,h)||(e[e.length]=a)});return e};b.every=b.all=function(a,c,b){var e=true;if(a==null)return e;if(B&&a.every===B)return a.every(c,b);j(a,function(a,g,h){if(!(e=
|
||||
e&&c.call(b,a,g,h)))return n});return e};var E=b.some=b.any=function(a,c,d){c||(c=b.identity);var e=false;if(a==null)return e;if(C&&a.some===C)return a.some(c,d);j(a,function(a,b,h){if(e||(e=c.call(d,a,b,h)))return n});return!!e};b.include=b.contains=function(a,c){var b=false;if(a==null)return b;return p&&a.indexOf===p?a.indexOf(c)!=-1:b=E(a,function(a){return a===c})};b.invoke=function(a,c){var d=i.call(arguments,2);return b.map(a,function(a){return(b.isFunction(c)?c||a:a[c]).apply(a,d)})};b.pluck=
|
||||
function(a,c){return b.map(a,function(a){return a[c]})};b.max=function(a,c,d){if(!c&&b.isArray(a))return Math.max.apply(Math,a);if(!c&&b.isEmpty(a))return-Infinity;var e={computed:-Infinity};j(a,function(a,b,h){b=c?c.call(d,a,b,h):a;b>=e.computed&&(e={value:a,computed:b})});return e.value};b.min=function(a,c,d){if(!c&&b.isArray(a))return Math.min.apply(Math,a);if(!c&&b.isEmpty(a))return Infinity;var e={computed:Infinity};j(a,function(a,b,h){b=c?c.call(d,a,b,h):a;b<e.computed&&(e={value:a,computed:b})});
|
||||
return e.value};b.shuffle=function(a){var b=[],d;j(a,function(a,f){f==0?b[0]=a:(d=Math.floor(Math.random()*(f+1)),b[f]=b[d],b[d]=a)});return b};b.sortBy=function(a,c,d){return b.pluck(b.map(a,function(a,b,g){return{value:a,criteria:c.call(d,a,b,g)}}).sort(function(a,b){var c=a.criteria,d=b.criteria;return c<d?-1:c>d?1:0}),"value")};b.groupBy=function(a,c){var d={},e=b.isFunction(c)?c:function(a){return a[c]};j(a,function(a,b){var c=e(a,b);(d[c]||(d[c]=[])).push(a)});return d};b.sortedIndex=function(a,
|
||||
c,d){d||(d=b.identity);for(var e=0,f=a.length;e<f;){var g=e+f>>1;d(a[g])<d(c)?e=g+1:f=g}return e};b.toArray=function(a){return!a?[]:a.toArray?a.toArray():b.isArray(a)?i.call(a):b.isArguments(a)?i.call(a):b.values(a)};b.size=function(a){return b.toArray(a).length};b.first=b.head=function(a,b,d){return b!=null&&!d?i.call(a,0,b):a[0]};b.initial=function(a,b,d){return i.call(a,0,a.length-(b==null||d?1:b))};b.last=function(a,b,d){return b!=null&&!d?i.call(a,Math.max(a.length-b,0)):a[a.length-1]};b.rest=
|
||||
b.tail=function(a,b,d){return i.call(a,b==null||d?1:b)};b.compact=function(a){return b.filter(a,function(a){return!!a})};b.flatten=function(a,c){return b.reduce(a,function(a,e){if(b.isArray(e))return a.concat(c?e:b.flatten(e));a[a.length]=e;return a},[])};b.without=function(a){return b.difference(a,i.call(arguments,1))};b.uniq=b.unique=function(a,c,d){var d=d?b.map(a,d):a,e=[];b.reduce(d,function(d,g,h){if(0==h||(c===true?b.last(d)!=g:!b.include(d,g)))d[d.length]=g,e[e.length]=a[h];return d},[]);
|
||||
return e};b.union=function(){return b.uniq(b.flatten(arguments,true))};b.intersection=b.intersect=function(a){var c=i.call(arguments,1);return b.filter(b.uniq(a),function(a){return b.every(c,function(c){return b.indexOf(c,a)>=0})})};b.difference=function(a){var c=b.flatten(i.call(arguments,1));return b.filter(a,function(a){return!b.include(c,a)})};b.zip=function(){for(var a=i.call(arguments),c=b.max(b.pluck(a,"length")),d=Array(c),e=0;e<c;e++)d[e]=b.pluck(a,""+e);return d};b.indexOf=function(a,c,
|
||||
d){if(a==null)return-1;var e;if(d)return d=b.sortedIndex(a,c),a[d]===c?d:-1;if(p&&a.indexOf===p)return a.indexOf(c);for(d=0,e=a.length;d<e;d++)if(d in a&&a[d]===c)return d;return-1};b.lastIndexOf=function(a,b){if(a==null)return-1;if(D&&a.lastIndexOf===D)return a.lastIndexOf(b);for(var d=a.length;d--;)if(d in a&&a[d]===b)return d;return-1};b.range=function(a,b,d){arguments.length<=1&&(b=a||0,a=0);for(var d=arguments[2]||1,e=Math.max(Math.ceil((b-a)/d),0),f=0,g=Array(e);f<e;)g[f++]=a,a+=d;return g};
|
||||
var F=function(){};b.bind=function(a,c){var d,e;if(a.bind===s&&s)return s.apply(a,i.call(arguments,1));if(!b.isFunction(a))throw new TypeError;e=i.call(arguments,2);return d=function(){if(!(this instanceof d))return a.apply(c,e.concat(i.call(arguments)));F.prototype=a.prototype;var b=new F,g=a.apply(b,e.concat(i.call(arguments)));return Object(g)===g?g:b}};b.bindAll=function(a){var c=i.call(arguments,1);c.length==0&&(c=b.functions(a));j(c,function(c){a[c]=b.bind(a[c],a)});return a};b.memoize=function(a,
|
||||
c){var d={};c||(c=b.identity);return function(){var e=c.apply(this,arguments);return b.has(d,e)?d[e]:d[e]=a.apply(this,arguments)}};b.delay=function(a,b){var d=i.call(arguments,2);return setTimeout(function(){return a.apply(a,d)},b)};b.defer=function(a){return b.delay.apply(b,[a,1].concat(i.call(arguments,1)))};b.throttle=function(a,c){var d,e,f,g,h,i=b.debounce(function(){h=g=false},c);return function(){d=this;e=arguments;var b;f||(f=setTimeout(function(){f=null;h&&a.apply(d,e);i()},c));g?h=true:
|
||||
a.apply(d,e);i();g=true}};b.debounce=function(a,b){var d;return function(){var e=this,f=arguments;clearTimeout(d);d=setTimeout(function(){d=null;a.apply(e,f)},b)}};b.once=function(a){var b=false,d;return function(){if(b)return d;b=true;return d=a.apply(this,arguments)}};b.wrap=function(a,b){return function(){var d=[a].concat(i.call(arguments,0));return b.apply(this,d)}};b.compose=function(){var a=arguments;return function(){for(var b=arguments,d=a.length-1;d>=0;d--)b=[a[d].apply(this,b)];return b[0]}};
|
||||
b.after=function(a,b){return a<=0?b():function(){if(--a<1)return b.apply(this,arguments)}};b.keys=J||function(a){if(a!==Object(a))throw new TypeError("Invalid object");var c=[],d;for(d in a)b.has(a,d)&&(c[c.length]=d);return c};b.values=function(a){return b.map(a,b.identity)};b.functions=b.methods=function(a){var c=[],d;for(d in a)b.isFunction(a[d])&&c.push(d);return c.sort()};b.extend=function(a){j(i.call(arguments,1),function(b){for(var d in b)a[d]=b[d]});return a};b.defaults=function(a){j(i.call(arguments,
|
||||
1),function(b){for(var d in b)a[d]==null&&(a[d]=b[d])});return a};b.clone=function(a){return!b.isObject(a)?a:b.isArray(a)?a.slice():b.extend({},a)};b.tap=function(a,b){b(a);return a};b.isEqual=function(a,b){return q(a,b,[])};b.isEmpty=function(a){if(b.isArray(a)||b.isString(a))return a.length===0;for(var c in a)if(b.has(a,c))return false;return true};b.isElement=function(a){return!!(a&&a.nodeType==1)};b.isArray=o||function(a){return l.call(a)=="[object Array]"};b.isObject=function(a){return a===Object(a)};
|
||||
b.isArguments=function(a){return l.call(a)=="[object Arguments]"};if(!b.isArguments(arguments))b.isArguments=function(a){return!(!a||!b.has(a,"callee"))};b.isFunction=function(a){return l.call(a)=="[object Function]"};b.isString=function(a){return l.call(a)=="[object String]"};b.isNumber=function(a){return l.call(a)=="[object Number]"};b.isNaN=function(a){return a!==a};b.isBoolean=function(a){return a===true||a===false||l.call(a)=="[object Boolean]"};b.isDate=function(a){return l.call(a)=="[object Date]"};
|
||||
b.isRegExp=function(a){return l.call(a)=="[object RegExp]"};b.isNull=function(a){return a===null};b.isUndefined=function(a){return a===void 0};b.has=function(a,b){return I.call(a,b)};b.noConflict=function(){r._=G;return this};b.identity=function(a){return a};b.times=function(a,b,d){for(var e=0;e<a;e++)b.call(d,e)};b.escape=function(a){return(""+a).replace(/&/g,"&").replace(/</g,"<").replace(/>/g,">").replace(/"/g,""").replace(/'/g,"'").replace(/\//g,"/")};b.mixin=function(a){j(b.functions(a),
|
||||
function(c){K(c,b[c]=a[c])})};var L=0;b.uniqueId=function(a){var b=L++;return a?a+b:b};b.templateSettings={evaluate:/<%([\s\S]+?)%>/g,interpolate:/<%=([\s\S]+?)%>/g,escape:/<%-([\s\S]+?)%>/g};var t=/.^/,u=function(a){return a.replace(/\\\\/g,"\\").replace(/\\'/g,"'")};b.template=function(a,c){var d=b.templateSettings,d="var __p=[],print=function(){__p.push.apply(__p,arguments);};with(obj||{}){__p.push('"+a.replace(/\\/g,"\\\\").replace(/'/g,"\\'").replace(d.escape||t,function(a,b){return"',_.escape("+
|
||||
u(b)+"),'"}).replace(d.interpolate||t,function(a,b){return"',"+u(b)+",'"}).replace(d.evaluate||t,function(a,b){return"');"+u(b).replace(/[\r\n\t]/g," ")+";__p.push('"}).replace(/\r/g,"\\r").replace(/\n/g,"\\n").replace(/\t/g,"\\t")+"');}return __p.join('');",e=new Function("obj","_",d);return c?e(c,b):function(a){return e.call(this,a,b)}};b.chain=function(a){return b(a).chain()};var m=function(a){this._wrapped=a};b.prototype=m.prototype;var v=function(a,c){return c?b(a).chain():a},K=function(a,c){m.prototype[a]=
|
||||
function(){var a=i.call(arguments);H.call(a,this._wrapped);return v(c.apply(b,a),this._chain)}};b.mixin(b);j("pop,push,reverse,shift,sort,splice,unshift".split(","),function(a){var b=k[a];m.prototype[a]=function(){var d=this._wrapped;b.apply(d,arguments);var e=d.length;(a=="shift"||a=="splice")&&e===0&&delete d[0];return v(d,this._chain)}});j(["concat","join","slice"],function(a){var b=k[a];m.prototype[a]=function(){return v(b.apply(this._wrapped,arguments),this._chain)}});m.prototype.chain=function(){this._chain=
|
||||
true;return this};m.prototype.value=function(){return this._wrapped}}).call(this);
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 345 B |
Binary file not shown.
|
Before Width: | Height: | Size: 345 B |
@@ -1,808 +0,0 @@
|
||||
/*
|
||||
* websupport.js
|
||||
* ~~~~~~~~~~~~~
|
||||
*
|
||||
* sphinx.websupport utilties for all documentation.
|
||||
*
|
||||
* :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
||||
(function($) {
|
||||
$.fn.autogrow = function() {
|
||||
return this.each(function() {
|
||||
var textarea = this;
|
||||
|
||||
$.fn.autogrow.resize(textarea);
|
||||
|
||||
$(textarea)
|
||||
.focus(function() {
|
||||
textarea.interval = setInterval(function() {
|
||||
$.fn.autogrow.resize(textarea);
|
||||
}, 500);
|
||||
})
|
||||
.blur(function() {
|
||||
clearInterval(textarea.interval);
|
||||
});
|
||||
});
|
||||
};
|
||||
|
||||
$.fn.autogrow.resize = function(textarea) {
|
||||
var lineHeight = parseInt($(textarea).css('line-height'), 10);
|
||||
var lines = textarea.value.split('\n');
|
||||
var columns = textarea.cols;
|
||||
var lineCount = 0;
|
||||
$.each(lines, function() {
|
||||
lineCount += Math.ceil(this.length / columns) || 1;
|
||||
});
|
||||
var height = lineHeight * (lineCount + 1);
|
||||
$(textarea).css('height', height);
|
||||
};
|
||||
})(jQuery);
|
||||
|
||||
(function($) {
|
||||
var comp, by;
|
||||
|
||||
function init() {
|
||||
initEvents();
|
||||
initComparator();
|
||||
}
|
||||
|
||||
function initEvents() {
|
||||
$(document).on("click", 'a.comment-close', function(event) {
|
||||
event.preventDefault();
|
||||
hide($(this).attr('id').substring(2));
|
||||
});
|
||||
$(document).on("click", 'a.vote', function(event) {
|
||||
event.preventDefault();
|
||||
handleVote($(this));
|
||||
});
|
||||
$(document).on("click", 'a.reply', function(event) {
|
||||
event.preventDefault();
|
||||
openReply($(this).attr('id').substring(2));
|
||||
});
|
||||
$(document).on("click", 'a.close-reply', function(event) {
|
||||
event.preventDefault();
|
||||
closeReply($(this).attr('id').substring(2));
|
||||
});
|
||||
$(document).on("click", 'a.sort-option', function(event) {
|
||||
event.preventDefault();
|
||||
handleReSort($(this));
|
||||
});
|
||||
$(document).on("click", 'a.show-proposal', function(event) {
|
||||
event.preventDefault();
|
||||
showProposal($(this).attr('id').substring(2));
|
||||
});
|
||||
$(document).on("click", 'a.hide-proposal', function(event) {
|
||||
event.preventDefault();
|
||||
hideProposal($(this).attr('id').substring(2));
|
||||
});
|
||||
$(document).on("click", 'a.show-propose-change', function(event) {
|
||||
event.preventDefault();
|
||||
showProposeChange($(this).attr('id').substring(2));
|
||||
});
|
||||
$(document).on("click", 'a.hide-propose-change', function(event) {
|
||||
event.preventDefault();
|
||||
hideProposeChange($(this).attr('id').substring(2));
|
||||
});
|
||||
$(document).on("click", 'a.accept-comment', function(event) {
|
||||
event.preventDefault();
|
||||
acceptComment($(this).attr('id').substring(2));
|
||||
});
|
||||
$(document).on("click", 'a.delete-comment', function(event) {
|
||||
event.preventDefault();
|
||||
deleteComment($(this).attr('id').substring(2));
|
||||
});
|
||||
$(document).on("click", 'a.comment-markup', function(event) {
|
||||
event.preventDefault();
|
||||
toggleCommentMarkupBox($(this).attr('id').substring(2));
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Set comp, which is a comparator function used for sorting and
|
||||
* inserting comments into the list.
|
||||
*/
|
||||
function setComparator() {
|
||||
// If the first three letters are "asc", sort in ascending order
|
||||
// and remove the prefix.
|
||||
if (by.substring(0,3) == 'asc') {
|
||||
var i = by.substring(3);
|
||||
comp = function(a, b) { return a[i] - b[i]; };
|
||||
} else {
|
||||
// Otherwise sort in descending order.
|
||||
comp = function(a, b) { return b[by] - a[by]; };
|
||||
}
|
||||
|
||||
// Reset link styles and format the selected sort option.
|
||||
$('a.sel').attr('href', '#').removeClass('sel');
|
||||
$('a.by' + by).removeAttr('href').addClass('sel');
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a comp function. If the user has preferences stored in
|
||||
* the sortBy cookie, use those, otherwise use the default.
|
||||
*/
|
||||
function initComparator() {
|
||||
by = 'rating'; // Default to sort by rating.
|
||||
// If the sortBy cookie is set, use that instead.
|
||||
if (document.cookie.length > 0) {
|
||||
var start = document.cookie.indexOf('sortBy=');
|
||||
if (start != -1) {
|
||||
start = start + 7;
|
||||
var end = document.cookie.indexOf(";", start);
|
||||
if (end == -1) {
|
||||
end = document.cookie.length;
|
||||
by = unescape(document.cookie.substring(start, end));
|
||||
}
|
||||
}
|
||||
}
|
||||
setComparator();
|
||||
}
|
||||
|
||||
/**
|
||||
* Show a comment div.
|
||||
*/
|
||||
function show(id) {
|
||||
$('#ao' + id).hide();
|
||||
$('#ah' + id).show();
|
||||
var context = $.extend({id: id}, opts);
|
||||
var popup = $(renderTemplate(popupTemplate, context)).hide();
|
||||
popup.find('textarea[name="proposal"]').hide();
|
||||
popup.find('a.by' + by).addClass('sel');
|
||||
var form = popup.find('#cf' + id);
|
||||
form.submit(function(event) {
|
||||
event.preventDefault();
|
||||
addComment(form);
|
||||
});
|
||||
$('#s' + id).after(popup);
|
||||
popup.slideDown('fast', function() {
|
||||
getComments(id);
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Hide a comment div.
|
||||
*/
|
||||
function hide(id) {
|
||||
$('#ah' + id).hide();
|
||||
$('#ao' + id).show();
|
||||
var div = $('#sc' + id);
|
||||
div.slideUp('fast', function() {
|
||||
div.remove();
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Perform an ajax request to get comments for a node
|
||||
* and insert the comments into the comments tree.
|
||||
*/
|
||||
function getComments(id) {
|
||||
$.ajax({
|
||||
type: 'GET',
|
||||
url: opts.getCommentsURL,
|
||||
data: {node: id},
|
||||
success: function(data, textStatus, request) {
|
||||
var ul = $('#cl' + id);
|
||||
var speed = 100;
|
||||
$('#cf' + id)
|
||||
.find('textarea[name="proposal"]')
|
||||
.data('source', data.source);
|
||||
|
||||
if (data.comments.length === 0) {
|
||||
ul.html('<li>No comments yet.</li>');
|
||||
ul.data('empty', true);
|
||||
} else {
|
||||
// If there are comments, sort them and put them in the list.
|
||||
var comments = sortComments(data.comments);
|
||||
speed = data.comments.length * 100;
|
||||
appendComments(comments, ul);
|
||||
ul.data('empty', false);
|
||||
}
|
||||
$('#cn' + id).slideUp(speed + 200);
|
||||
ul.slideDown(speed);
|
||||
},
|
||||
error: function(request, textStatus, error) {
|
||||
showError('Oops, there was a problem retrieving the comments.');
|
||||
},
|
||||
dataType: 'json'
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Add a comment via ajax and insert the comment into the comment tree.
|
||||
*/
|
||||
function addComment(form) {
|
||||
var node_id = form.find('input[name="node"]').val();
|
||||
var parent_id = form.find('input[name="parent"]').val();
|
||||
var text = form.find('textarea[name="comment"]').val();
|
||||
var proposal = form.find('textarea[name="proposal"]').val();
|
||||
|
||||
if (text == '') {
|
||||
showError('Please enter a comment.');
|
||||
return;
|
||||
}
|
||||
|
||||
// Disable the form that is being submitted.
|
||||
form.find('textarea,input').attr('disabled', 'disabled');
|
||||
|
||||
// Send the comment to the server.
|
||||
$.ajax({
|
||||
type: "POST",
|
||||
url: opts.addCommentURL,
|
||||
dataType: 'json',
|
||||
data: {
|
||||
node: node_id,
|
||||
parent: parent_id,
|
||||
text: text,
|
||||
proposal: proposal
|
||||
},
|
||||
success: function(data, textStatus, error) {
|
||||
// Reset the form.
|
||||
if (node_id) {
|
||||
hideProposeChange(node_id);
|
||||
}
|
||||
form.find('textarea')
|
||||
.val('')
|
||||
.add(form.find('input'))
|
||||
.removeAttr('disabled');
|
||||
var ul = $('#cl' + (node_id || parent_id));
|
||||
if (ul.data('empty')) {
|
||||
$(ul).empty();
|
||||
ul.data('empty', false);
|
||||
}
|
||||
insertComment(data.comment);
|
||||
var ao = $('#ao' + node_id);
|
||||
ao.find('img').attr({'src': opts.commentBrightImage});
|
||||
if (node_id) {
|
||||
// if this was a "root" comment, remove the commenting box
|
||||
// (the user can get it back by reopening the comment popup)
|
||||
$('#ca' + node_id).slideUp();
|
||||
}
|
||||
},
|
||||
error: function(request, textStatus, error) {
|
||||
form.find('textarea,input').removeAttr('disabled');
|
||||
showError('Oops, there was a problem adding the comment.');
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Recursively append comments to the main comment list and children
|
||||
* lists, creating the comment tree.
|
||||
*/
|
||||
function appendComments(comments, ul) {
|
||||
$.each(comments, function() {
|
||||
var div = createCommentDiv(this);
|
||||
ul.append($(document.createElement('li')).html(div));
|
||||
appendComments(this.children, div.find('ul.comment-children'));
|
||||
// To avoid stagnating data, don't store the comments children in data.
|
||||
this.children = null;
|
||||
div.data('comment', this);
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* After adding a new comment, it must be inserted in the correct
|
||||
* location in the comment tree.
|
||||
*/
|
||||
function insertComment(comment) {
|
||||
var div = createCommentDiv(comment);
|
||||
|
||||
// To avoid stagnating data, don't store the comments children in data.
|
||||
comment.children = null;
|
||||
div.data('comment', comment);
|
||||
|
||||
var ul = $('#cl' + (comment.node || comment.parent));
|
||||
var siblings = getChildren(ul);
|
||||
|
||||
var li = $(document.createElement('li'));
|
||||
li.hide();
|
||||
|
||||
// Determine where in the parents children list to insert this comment.
|
||||
for(i=0; i < siblings.length; i++) {
|
||||
if (comp(comment, siblings[i]) <= 0) {
|
||||
$('#cd' + siblings[i].id)
|
||||
.parent()
|
||||
.before(li.html(div));
|
||||
li.slideDown('fast');
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
// If we get here, this comment rates lower than all the others,
|
||||
// or it is the only comment in the list.
|
||||
ul.append(li.html(div));
|
||||
li.slideDown('fast');
|
||||
}
|
||||
|
||||
function acceptComment(id) {
|
||||
$.ajax({
|
||||
type: 'POST',
|
||||
url: opts.acceptCommentURL,
|
||||
data: {id: id},
|
||||
success: function(data, textStatus, request) {
|
||||
$('#cm' + id).fadeOut('fast');
|
||||
$('#cd' + id).removeClass('moderate');
|
||||
},
|
||||
error: function(request, textStatus, error) {
|
||||
showError('Oops, there was a problem accepting the comment.');
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
function deleteComment(id) {
|
||||
$.ajax({
|
||||
type: 'POST',
|
||||
url: opts.deleteCommentURL,
|
||||
data: {id: id},
|
||||
success: function(data, textStatus, request) {
|
||||
var div = $('#cd' + id);
|
||||
if (data == 'delete') {
|
||||
// Moderator mode: remove the comment and all children immediately
|
||||
div.slideUp('fast', function() {
|
||||
div.remove();
|
||||
});
|
||||
return;
|
||||
}
|
||||
// User mode: only mark the comment as deleted
|
||||
div
|
||||
.find('span.user-id:first')
|
||||
.text('[deleted]').end()
|
||||
.find('div.comment-text:first')
|
||||
.text('[deleted]').end()
|
||||
.find('#cm' + id + ', #dc' + id + ', #ac' + id + ', #rc' + id +
|
||||
', #sp' + id + ', #hp' + id + ', #cr' + id + ', #rl' + id)
|
||||
.remove();
|
||||
var comment = div.data('comment');
|
||||
comment.username = '[deleted]';
|
||||
comment.text = '[deleted]';
|
||||
div.data('comment', comment);
|
||||
},
|
||||
error: function(request, textStatus, error) {
|
||||
showError('Oops, there was a problem deleting the comment.');
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
function showProposal(id) {
|
||||
$('#sp' + id).hide();
|
||||
$('#hp' + id).show();
|
||||
$('#pr' + id).slideDown('fast');
|
||||
}
|
||||
|
||||
function hideProposal(id) {
|
||||
$('#hp' + id).hide();
|
||||
$('#sp' + id).show();
|
||||
$('#pr' + id).slideUp('fast');
|
||||
}
|
||||
|
||||
function showProposeChange(id) {
|
||||
$('#pc' + id).hide();
|
||||
$('#hc' + id).show();
|
||||
var textarea = $('#pt' + id);
|
||||
textarea.val(textarea.data('source'));
|
||||
$.fn.autogrow.resize(textarea[0]);
|
||||
textarea.slideDown('fast');
|
||||
}
|
||||
|
||||
function hideProposeChange(id) {
|
||||
$('#hc' + id).hide();
|
||||
$('#pc' + id).show();
|
||||
var textarea = $('#pt' + id);
|
||||
textarea.val('').removeAttr('disabled');
|
||||
textarea.slideUp('fast');
|
||||
}
|
||||
|
||||
function toggleCommentMarkupBox(id) {
|
||||
$('#mb' + id).toggle();
|
||||
}
|
||||
|
||||
/** Handle when the user clicks on a sort by link. */
|
||||
function handleReSort(link) {
|
||||
var classes = link.attr('class').split(/\s+/);
|
||||
for (var i=0; i<classes.length; i++) {
|
||||
if (classes[i] != 'sort-option') {
|
||||
by = classes[i].substring(2);
|
||||
}
|
||||
}
|
||||
setComparator();
|
||||
// Save/update the sortBy cookie.
|
||||
var expiration = new Date();
|
||||
expiration.setDate(expiration.getDate() + 365);
|
||||
document.cookie= 'sortBy=' + escape(by) +
|
||||
';expires=' + expiration.toUTCString();
|
||||
$('ul.comment-ul').each(function(index, ul) {
|
||||
var comments = getChildren($(ul), true);
|
||||
comments = sortComments(comments);
|
||||
appendComments(comments, $(ul).empty());
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Function to process a vote when a user clicks an arrow.
|
||||
*/
|
||||
function handleVote(link) {
|
||||
if (!opts.voting) {
|
||||
showError("You'll need to login to vote.");
|
||||
return;
|
||||
}
|
||||
|
||||
var id = link.attr('id');
|
||||
if (!id) {
|
||||
// Didn't click on one of the voting arrows.
|
||||
return;
|
||||
}
|
||||
// If it is an unvote, the new vote value is 0,
|
||||
// Otherwise it's 1 for an upvote, or -1 for a downvote.
|
||||
var value = 0;
|
||||
if (id.charAt(1) != 'u') {
|
||||
value = id.charAt(0) == 'u' ? 1 : -1;
|
||||
}
|
||||
// The data to be sent to the server.
|
||||
var d = {
|
||||
comment_id: id.substring(2),
|
||||
value: value
|
||||
};
|
||||
|
||||
// Swap the vote and unvote links.
|
||||
link.hide();
|
||||
$('#' + id.charAt(0) + (id.charAt(1) == 'u' ? 'v' : 'u') + d.comment_id)
|
||||
.show();
|
||||
|
||||
// The div the comment is displayed in.
|
||||
var div = $('div#cd' + d.comment_id);
|
||||
var data = div.data('comment');
|
||||
|
||||
// If this is not an unvote, and the other vote arrow has
|
||||
// already been pressed, unpress it.
|
||||
if ((d.value !== 0) && (data.vote === d.value * -1)) {
|
||||
$('#' + (d.value == 1 ? 'd' : 'u') + 'u' + d.comment_id).hide();
|
||||
$('#' + (d.value == 1 ? 'd' : 'u') + 'v' + d.comment_id).show();
|
||||
}
|
||||
|
||||
// Update the comments rating in the local data.
|
||||
data.rating += (data.vote === 0) ? d.value : (d.value - data.vote);
|
||||
data.vote = d.value;
|
||||
div.data('comment', data);
|
||||
|
||||
// Change the rating text.
|
||||
div.find('.rating:first')
|
||||
.text(data.rating + ' point' + (data.rating == 1 ? '' : 's'));
|
||||
|
||||
// Send the vote information to the server.
|
||||
$.ajax({
|
||||
type: "POST",
|
||||
url: opts.processVoteURL,
|
||||
data: d,
|
||||
error: function(request, textStatus, error) {
|
||||
showError('Oops, there was a problem casting that vote.');
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Open a reply form used to reply to an existing comment.
|
||||
*/
|
||||
function openReply(id) {
|
||||
// Swap out the reply link for the hide link
|
||||
$('#rl' + id).hide();
|
||||
$('#cr' + id).show();
|
||||
|
||||
// Add the reply li to the children ul.
|
||||
var div = $(renderTemplate(replyTemplate, {id: id})).hide();
|
||||
$('#cl' + id)
|
||||
.prepend(div)
|
||||
// Setup the submit handler for the reply form.
|
||||
.find('#rf' + id)
|
||||
.submit(function(event) {
|
||||
event.preventDefault();
|
||||
addComment($('#rf' + id));
|
||||
closeReply(id);
|
||||
})
|
||||
.find('input[type=button]')
|
||||
.click(function() {
|
||||
closeReply(id);
|
||||
});
|
||||
div.slideDown('fast', function() {
|
||||
$('#rf' + id).find('textarea').focus();
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Close the reply form opened with openReply.
|
||||
*/
|
||||
function closeReply(id) {
|
||||
// Remove the reply div from the DOM.
|
||||
$('#rd' + id).slideUp('fast', function() {
|
||||
$(this).remove();
|
||||
});
|
||||
|
||||
// Swap out the hide link for the reply link
|
||||
$('#cr' + id).hide();
|
||||
$('#rl' + id).show();
|
||||
}
|
||||
|
||||
/**
|
||||
* Recursively sort a tree of comments using the comp comparator.
|
||||
*/
|
||||
function sortComments(comments) {
|
||||
comments.sort(comp);
|
||||
$.each(comments, function() {
|
||||
this.children = sortComments(this.children);
|
||||
});
|
||||
return comments;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the children comments from a ul. If recursive is true,
|
||||
* recursively include childrens' children.
|
||||
*/
|
||||
function getChildren(ul, recursive) {
|
||||
var children = [];
|
||||
ul.children().children("[id^='cd']")
|
||||
.each(function() {
|
||||
var comment = $(this).data('comment');
|
||||
if (recursive)
|
||||
comment.children = getChildren($(this).find('#cl' + comment.id), true);
|
||||
children.push(comment);
|
||||
});
|
||||
return children;
|
||||
}
|
||||
|
||||
/** Create a div to display a comment in. */
|
||||
function createCommentDiv(comment) {
|
||||
if (!comment.displayed && !opts.moderator) {
|
||||
return $('<div class="moderate">Thank you! Your comment will show up '
|
||||
+ 'once it is has been approved by a moderator.</div>');
|
||||
}
|
||||
// Prettify the comment rating.
|
||||
comment.pretty_rating = comment.rating + ' point' +
|
||||
(comment.rating == 1 ? '' : 's');
|
||||
// Make a class (for displaying not yet moderated comments differently)
|
||||
comment.css_class = comment.displayed ? '' : ' moderate';
|
||||
// Create a div for this comment.
|
||||
var context = $.extend({}, opts, comment);
|
||||
var div = $(renderTemplate(commentTemplate, context));
|
||||
|
||||
// If the user has voted on this comment, highlight the correct arrow.
|
||||
if (comment.vote) {
|
||||
var direction = (comment.vote == 1) ? 'u' : 'd';
|
||||
div.find('#' + direction + 'v' + comment.id).hide();
|
||||
div.find('#' + direction + 'u' + comment.id).show();
|
||||
}
|
||||
|
||||
if (opts.moderator || comment.text != '[deleted]') {
|
||||
div.find('a.reply').show();
|
||||
if (comment.proposal_diff)
|
||||
div.find('#sp' + comment.id).show();
|
||||
if (opts.moderator && !comment.displayed)
|
||||
div.find('#cm' + comment.id).show();
|
||||
if (opts.moderator || (opts.username == comment.username))
|
||||
div.find('#dc' + comment.id).show();
|
||||
}
|
||||
return div;
|
||||
}
|
||||
|
||||
/**
|
||||
* A simple template renderer. Placeholders such as <%id%> are replaced
|
||||
* by context['id'] with items being escaped. Placeholders such as <#id#>
|
||||
* are not escaped.
|
||||
*/
|
||||
function renderTemplate(template, context) {
|
||||
var esc = $(document.createElement('div'));
|
||||
|
||||
function handle(ph, escape) {
|
||||
var cur = context;
|
||||
$.each(ph.split('.'), function() {
|
||||
cur = cur[this];
|
||||
});
|
||||
return escape ? esc.text(cur || "").html() : cur;
|
||||
}
|
||||
|
||||
return template.replace(/<([%#])([\w\.]*)\1>/g, function() {
|
||||
return handle(arguments[2], arguments[1] == '%' ? true : false);
|
||||
});
|
||||
}
|
||||
|
||||
/** Flash an error message briefly. */
|
||||
function showError(message) {
|
||||
$(document.createElement('div')).attr({'class': 'popup-error'})
|
||||
.append($(document.createElement('div'))
|
||||
.attr({'class': 'error-message'}).text(message))
|
||||
.appendTo('body')
|
||||
.fadeIn("slow")
|
||||
.delay(2000)
|
||||
.fadeOut("slow");
|
||||
}
|
||||
|
||||
/** Add a link the user uses to open the comments popup. */
|
||||
$.fn.comment = function() {
|
||||
return this.each(function() {
|
||||
var id = $(this).attr('id').substring(1);
|
||||
var count = COMMENT_METADATA[id];
|
||||
var title = count + ' comment' + (count == 1 ? '' : 's');
|
||||
var image = count > 0 ? opts.commentBrightImage : opts.commentImage;
|
||||
var addcls = count == 0 ? ' nocomment' : '';
|
||||
$(this)
|
||||
.append(
|
||||
$(document.createElement('a')).attr({
|
||||
href: '#',
|
||||
'class': 'sphinx-comment-open' + addcls,
|
||||
id: 'ao' + id
|
||||
})
|
||||
.append($(document.createElement('img')).attr({
|
||||
src: image,
|
||||
alt: 'comment',
|
||||
title: title
|
||||
}))
|
||||
.click(function(event) {
|
||||
event.preventDefault();
|
||||
show($(this).attr('id').substring(2));
|
||||
})
|
||||
)
|
||||
.append(
|
||||
$(document.createElement('a')).attr({
|
||||
href: '#',
|
||||
'class': 'sphinx-comment-close hidden',
|
||||
id: 'ah' + id
|
||||
})
|
||||
.append($(document.createElement('img')).attr({
|
||||
src: opts.closeCommentImage,
|
||||
alt: 'close',
|
||||
title: 'close'
|
||||
}))
|
||||
.click(function(event) {
|
||||
event.preventDefault();
|
||||
hide($(this).attr('id').substring(2));
|
||||
})
|
||||
);
|
||||
});
|
||||
};
|
||||
|
||||
var opts = {
|
||||
processVoteURL: '/_process_vote',
|
||||
addCommentURL: '/_add_comment',
|
||||
getCommentsURL: '/_get_comments',
|
||||
acceptCommentURL: '/_accept_comment',
|
||||
deleteCommentURL: '/_delete_comment',
|
||||
commentImage: '/static/_static/comment.png',
|
||||
closeCommentImage: '/static/_static/comment-close.png',
|
||||
loadingImage: '/static/_static/ajax-loader.gif',
|
||||
commentBrightImage: '/static/_static/comment-bright.png',
|
||||
upArrow: '/static/_static/up.png',
|
||||
downArrow: '/static/_static/down.png',
|
||||
upArrowPressed: '/static/_static/up-pressed.png',
|
||||
downArrowPressed: '/static/_static/down-pressed.png',
|
||||
voting: false,
|
||||
moderator: false
|
||||
};
|
||||
|
||||
if (typeof COMMENT_OPTIONS != "undefined") {
|
||||
opts = jQuery.extend(opts, COMMENT_OPTIONS);
|
||||
}
|
||||
|
||||
var popupTemplate = '\
|
||||
<div class="sphinx-comments" id="sc<%id%>">\
|
||||
<p class="sort-options">\
|
||||
Sort by:\
|
||||
<a href="#" class="sort-option byrating">best rated</a>\
|
||||
<a href="#" class="sort-option byascage">newest</a>\
|
||||
<a href="#" class="sort-option byage">oldest</a>\
|
||||
</p>\
|
||||
<div class="comment-header">Comments</div>\
|
||||
<div class="comment-loading" id="cn<%id%>">\
|
||||
loading comments... <img src="<%loadingImage%>" alt="" /></div>\
|
||||
<ul id="cl<%id%>" class="comment-ul"></ul>\
|
||||
<div id="ca<%id%>">\
|
||||
<p class="add-a-comment">Add a comment\
|
||||
(<a href="#" class="comment-markup" id="ab<%id%>">markup</a>):</p>\
|
||||
<div class="comment-markup-box" id="mb<%id%>">\
|
||||
reStructured text markup: <i>*emph*</i>, <b>**strong**</b>, \
|
||||
<code>``code``</code>, \
|
||||
code blocks: <code>::</code> and an indented block after blank line</div>\
|
||||
<form method="post" id="cf<%id%>" class="comment-form" action="">\
|
||||
<textarea name="comment" cols="80"></textarea>\
|
||||
<p class="propose-button">\
|
||||
<a href="#" id="pc<%id%>" class="show-propose-change">\
|
||||
Propose a change ▹\
|
||||
</a>\
|
||||
<a href="#" id="hc<%id%>" class="hide-propose-change">\
|
||||
Propose a change ▿\
|
||||
</a>\
|
||||
</p>\
|
||||
<textarea name="proposal" id="pt<%id%>" cols="80"\
|
||||
spellcheck="false"></textarea>\
|
||||
<input type="submit" value="Add comment" />\
|
||||
<input type="hidden" name="node" value="<%id%>" />\
|
||||
<input type="hidden" name="parent" value="" />\
|
||||
</form>\
|
||||
</div>\
|
||||
</div>';
|
||||
|
||||
var commentTemplate = '\
|
||||
<div id="cd<%id%>" class="sphinx-comment<%css_class%>">\
|
||||
<div class="vote">\
|
||||
<div class="arrow">\
|
||||
<a href="#" id="uv<%id%>" class="vote" title="vote up">\
|
||||
<img src="<%upArrow%>" />\
|
||||
</a>\
|
||||
<a href="#" id="uu<%id%>" class="un vote" title="vote up">\
|
||||
<img src="<%upArrowPressed%>" />\
|
||||
</a>\
|
||||
</div>\
|
||||
<div class="arrow">\
|
||||
<a href="#" id="dv<%id%>" class="vote" title="vote down">\
|
||||
<img src="<%downArrow%>" id="da<%id%>" />\
|
||||
</a>\
|
||||
<a href="#" id="du<%id%>" class="un vote" title="vote down">\
|
||||
<img src="<%downArrowPressed%>" />\
|
||||
</a>\
|
||||
</div>\
|
||||
</div>\
|
||||
<div class="comment-content">\
|
||||
<p class="tagline comment">\
|
||||
<span class="user-id"><%username%></span>\
|
||||
<span class="rating"><%pretty_rating%></span>\
|
||||
<span class="delta"><%time.delta%></span>\
|
||||
</p>\
|
||||
<div class="comment-text comment"><#text#></div>\
|
||||
<p class="comment-opts comment">\
|
||||
<a href="#" class="reply hidden" id="rl<%id%>">reply ▹</a>\
|
||||
<a href="#" class="close-reply" id="cr<%id%>">reply ▿</a>\
|
||||
<a href="#" id="sp<%id%>" class="show-proposal">proposal ▹</a>\
|
||||
<a href="#" id="hp<%id%>" class="hide-proposal">proposal ▿</a>\
|
||||
<a href="#" id="dc<%id%>" class="delete-comment hidden">delete</a>\
|
||||
<span id="cm<%id%>" class="moderation hidden">\
|
||||
<a href="#" id="ac<%id%>" class="accept-comment">accept</a>\
|
||||
</span>\
|
||||
</p>\
|
||||
<pre class="proposal" id="pr<%id%>">\
|
||||
<#proposal_diff#>\
|
||||
</pre>\
|
||||
<ul class="comment-children" id="cl<%id%>"></ul>\
|
||||
</div>\
|
||||
<div class="clearleft"></div>\
|
||||
</div>\
|
||||
</div>';
|
||||
|
||||
var replyTemplate = '\
|
||||
<li>\
|
||||
<div class="reply-div" id="rd<%id%>">\
|
||||
<form id="rf<%id%>">\
|
||||
<textarea name="comment" cols="80"></textarea>\
|
||||
<input type="submit" value="Add reply" />\
|
||||
<input type="button" value="Cancel" />\
|
||||
<input type="hidden" name="parent" value="<%id%>" />\
|
||||
<input type="hidden" name="node" value="" />\
|
||||
</form>\
|
||||
</div>\
|
||||
</li>';
|
||||
|
||||
$(document).ready(function() {
|
||||
init();
|
||||
});
|
||||
})(jQuery);
|
||||
|
||||
$(document).ready(function() {
|
||||
// add comment anchors for all paragraphs that are commentable
|
||||
$('.sphinx-has-comment').comment();
|
||||
|
||||
// highlight search words in search results
|
||||
$("div.context").each(function() {
|
||||
var params = $.getQueryParameters();
|
||||
var terms = (params.q) ? params.q[0].split(/\s+/) : [];
|
||||
var result = $(this);
|
||||
$.each(terms, function() {
|
||||
result.highlightText(this.toLowerCase(), 'highlighted');
|
||||
});
|
||||
});
|
||||
|
||||
// directly open comment window if requested
|
||||
var anchor = document.location.hash;
|
||||
if (anchor.substring(0, 9) == '#comment-') {
|
||||
$('#ao' + anchor.substring(9)).click();
|
||||
document.location.hash = '#s' + anchor.substring(9);
|
||||
}
|
||||
});
|
||||
@@ -1,874 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>List of bundles — ClearLinux Documentation 1.0.1 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '1.0.1',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<link rel="top" title="ClearLinux Documentation 1.0.1 documentation" href="index.html" />
|
||||
<link rel="next" title="Bundles in ClearLinux" href="bundles_in_clr_html.html" />
|
||||
<link rel="prev" title="Bundle overview" href="bundles_overview.html" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
|
||||
|
||||
</head>
|
||||
<body role="document">
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="list-of-bundles">
|
||||
<h1>List of bundles<a class="headerlink" href="#list-of-bundles" title="Permalink to this headline">¶</a></h1>
|
||||
<p>This is a list of the basic bundles in Clear Linux* OS for Intel® Architecture:</p>
|
||||
</div>
|
||||
<div class="section" id="bundles-in-clearlinux">
|
||||
<span id="bundles-in-clr-html"></span><h1>Bundles in ClearLinux<a class="headerlink" href="#bundles-in-clearlinux" title="Permalink to this headline">¶</a></h1>
|
||||
<head>
|
||||
<title>Bundles in ClearLinux</title>
|
||||
<style media="screen" type="text/css">
|
||||
table { margin: 2em; border-collapse: collapse; }
|
||||
td, th { padding: .5em; border: 1px #ccc solid; }
|
||||
thead { background: #fc9; }
|
||||
</style>
|
||||
|
||||
</head>
|
||||
|
||||
<table border: 1px; callpadding: 15>
|
||||
<thead>
|
||||
<th align=left>Bundle Name</th>
|
||||
<th align=center>Status</th>
|
||||
<th align=left>Description</th>
|
||||
<!-- <th align=left>Capabilities</th> -->
|
||||
<!-- <th align=left>Maintainer</th> -->
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align=left> bat</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides the neccesary bundles to perform BAT succesfully</p>
|
||||
<li>Includes (devtools-basic) bundle.</p>
|
||||
<li>Includes (openstack-test-suite) bundle.</p>
|
||||
<li>Includes (os-testsuite) bundle.</p>
|
||||
<li>Includes (pnp-tools-basic) bundle.</p>
|
||||
<li>Includes (openstack-all-in-one) bundle.</p>
|
||||
<li>Includes (storage-utils) bundle.</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> bootloader</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> UEFI bootloaders</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> clr-devops</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides build/release tools for Clear devops team</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> containers-basic</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Installs rkt base for Clear Containers</p>
|
||||
<li>Includes (storage-utils) bundle.</p>
|
||||
<li>Includes (network-basic) bundle.</p>
|
||||
<li>Includes (kernel-container) bundle.</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> cryptography</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Cryptographic tools</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> database-mariadb</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides components needed to run MariaDB</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> database-mongodb</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Provides components needed to run mongodb</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> devtools-basic</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides basic set of languages and tools for development</p>
|
||||
<li>Includes (R-basic) bundle.</p>
|
||||
<li>Includes (go-basic) bundle.</p>
|
||||
<li>Includes (hpc-basic) bundle.</p>
|
||||
<li>Includes (os-core-dev) bundle.</p>
|
||||
<li>Includes (perl-basic) bundle.</p>
|
||||
<li>Includes (python-basic) bundle.</p>
|
||||
<li>Includes (ruby-basic) bundle.</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> devtools-extras</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides extra set of languages and tools for development</p>
|
||||
<li>Includes (R-extras) bundle.</p>
|
||||
<li>Includes (devtools-basic) bundle.</p>
|
||||
<li>Includes (go-extras) bundle.</p>
|
||||
<li>Includes (perl-extras) bundle.</p>
|
||||
<li>Includes (python-extras) bundle.</p>
|
||||
<li>Includes (ruby-extras) bundle.</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> dev-utils</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides a limited set of development utilities</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> dpdk-dev</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> All headers and libraries necessary to develop with the Data Plane Development Kit.</p>
|
||||
<li>Includes (os-core-dev) bundle.</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> editors</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides popular text editors</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> file-utils</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides basic set of file manipulation utilities</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> go-basic</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides basic Go language development</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> go-extras</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Most popular Golang libraries</p>
|
||||
<li>Includes (go-basic) bundle.</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> hpc-basic</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides basic suite of MPI/HPC development tools</p>
|
||||
<li>Includes (os-core-dev) bundle.</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> iot</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> The IoT (Internet of Things) base bundle</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> kernel-container</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Provides a Linux kernel appropriate for a Clear Container</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> kernel-kvm</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides a Linux kernel appropriate for running under KVM</p>
|
||||
<li>Includes (bootloader) bundle.</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> kernel-native</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides a Linux kernel appropriate for physical machines</p>
|
||||
<li>Includes (bootloader) bundle.</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> kernel-pxe</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides a Linux kernel linking an initramfs as root</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> koji</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Sets up a koji build service (builder-only, for now) based on NFS mounts.</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> kvm-host</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Provides necessary tools to run usable virtual machines with QEMU-KVM (independently of OpenStack).</p>
|
||||
<li>Includes (kernel-kvm) bundle.</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> lamp-basic</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Basic LAMP Server (apache2, mariadb, php5)</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> mail-utils</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Provides utilities for reading and sending email</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> message-broker-rabbitmq</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides the RabbitMQ messaging service</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> net-utils</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides an essential suite of core networking configuration and debug tools</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> network-advanced</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> More utilities for advanced host-level networking; bridge, switch, netfilter, vpn etc.</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> network-basic</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides a basic suite of networking utilities</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> network-proxy-client</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Tools for dealing with client-side network proxy settings.</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> openssh-server</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides an SSH server (and client)</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> openstack-all-in-one</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Provides an All-in-one OpenStack deployment</p>
|
||||
<li>Includes (database-mariadb) bundle.</p>
|
||||
<li>Includes (database-mongodb) bundle.</p>
|
||||
<li>Includes (message-broker-rabbitmq) bundle.</p>
|
||||
<li>Includes (openstack-block-storage) bundle.</p>
|
||||
<li>Includes (openstack-block-storage-controller) bundle.</p>
|
||||
<li>Includes (openstack-compute) bundle.</p>
|
||||
<li>Includes (openstack-compute-controller) bundle.</p>
|
||||
<li>Includes (openstack-dashboard) bundle.</p>
|
||||
<li>Includes (openstack-database) bundle.</p>
|
||||
<li>Includes (openstack-identity) bundle.</p>
|
||||
<li>Includes (openstack-image) bundle.</p>
|
||||
<li>Includes (openstack-lbaas) bundle.</p>
|
||||
<li>Includes (openstack-network) bundle.</p>
|
||||
<li>Includes (openstack-object-storage) bundle.</p>
|
||||
<li>Includes (openstack-orchestration) bundle.</p>
|
||||
<li>Includes (openstack-python-clients) bundle.</p>
|
||||
<li>Includes (openstack-telemetry-controller) bundle.</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> openstack-block-storage</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Provides an OpenStack Cinder service</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> openstack-block-storage-controller</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Provides an OpenStack Cinder controller service</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> openstack-compute</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Provides an OpenStack nova-compute node</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> openstack-compute-controller</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Provides an OpenStack Nova control server</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> openstack-configure</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Provides a suggested default configuration for OpenStack on Clear Linux.</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> openstack-controller</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Provides an OpenStack multi-service control server</p>
|
||||
<li>Includes (database-mariadb) bundle.</p>
|
||||
<li>Includes (message-broker-rabbitmq) bundle.</p>
|
||||
<li>Includes (openstack-identity) bundle.</p>
|
||||
<li>Includes (openstack-image) bundle.</p>
|
||||
<li>Includes (openstack-compute-controller) bundle.</p>
|
||||
<li>Includes (openstack-dashboard) bundle.</p>
|
||||
<li>Includes (openstack-python-clients) bundle.</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> openstack-dashboard</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Provides an OpenStack Horizon server</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> openstack-database</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Provides a Database as a Service server</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> openstack-identity</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Provides an OpenStack Keystone server</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> openstack-image</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Provides an OpenStack Glance server</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> openstack-lbaas</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Provides Load Balancing as a Service</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> openstack-network</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Provides an OpenStack Neutron server</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> openstack-object-storage</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Provides an OpenStack Swift service</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> openstack-orchestration</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Provides an OpenStack Heat service</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> openstack-python-clients</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Provides OpenStack command-line utilities</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> openstack-telemetry-controller</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Provides an OpenStack Telemetry server</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> openstack-test-suite</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Provides an OpenStack Tempest/test suite </p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> os-cloudguest</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Provides cloud-init cloud guest configuration utilities</p>
|
||||
<li>Includes (openssh-server) bundle.</p>
|
||||
<li>Includes (telemetrics) bundle.</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> os-clr-on-clr</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> content for development of the Clear Linux OS on the Clear Linux OS</p>
|
||||
<li>Includes (storage-utils) bundle.</p>
|
||||
<li>Includes (mail-utils) bundle.</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> os-core</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> The basic core OS components of Clear Linux for iA </p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> os-core-dev</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Basic development tools</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> os-core-update</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides basic suite for running the Clear Linux for iA Updater</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> os-installer</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides an installer for Clear Linux for iA</p>
|
||||
<li>Includes (telemetrics) bundle.</p>
|
||||
<li>Includes (network-proxy-client) bundle.</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> os-testsuite</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Provides basic test suite for Clear Linux for iA</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> os-testsuite-phoronix</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> All the required pieces for running the Phoronix Test Suite</p>
|
||||
<li>Includes (os-utils) bundle.</p>
|
||||
<li>Includes (devtools-basic) bundle.</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> os-utils</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides a core set of OS utilities</p>
|
||||
<li>Includes (editors) bundle.</p>
|
||||
<li>Includes (dev-utils) bundle.</p>
|
||||
<li>Includes (sysadmin) bundle.</p>
|
||||
<li>Includes (network-basic) bundle.</p>
|
||||
<li>Includes (file-utils) bundle.</p>
|
||||
<li>Includes (network-proxy-client) bundle.</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> os-utils-gui</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides a graphical desktop environment </p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> perl-basic</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides essential Perl language and dev tools</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> perl-extras</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides extra libraries for Perl</p>
|
||||
<li>Includes (perl-basic) bundle.</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> pnp-tools-advanced</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Provides advanced Power and Performance measurement tools</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> pnp-tools-basic</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Provides basic Power and Performance testing tools</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> pnp-tools-intermediate</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Provides a deeper-level suite of Power and Performance testing tools</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> python-basic</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides core Python language and libraries</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> python-extras</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides extra libraries for Python</p>
|
||||
<li>Includes (python-basic) bundle.</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> R-basic</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides core R language and libraries</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> R-extras</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides deeper functionality R language libraries</p>
|
||||
<li>Includes (R-basic) bundle.</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> ruby-basic</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Top 3 basic Ruby Libraries</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> ruby-extras</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Top 3 to 6 basic Ruby Libraries</p>
|
||||
<li>Includes (ruby-basic) bundle.</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> shells</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> All available shell programs for Clear, along with ancillary files</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> storage-utils</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides basic storage-related utilities</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> sysadmin</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides a basic set of system administration utilities.</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> telemetrics</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides the Telemetrics client for Clear Linux for iA</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> virtualbox-guest</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Include the modules and binaries meant to be used as a VirtualBox instance</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h3><a href="index.html">Table Of Contents</a></h3>
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">List of bundles</a></li>
|
||||
<li><a class="reference internal" href="#bundles-in-clearlinux">Bundles in ClearLinux</a></li>
|
||||
</ul>
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
<li>Previous: <a href="bundles_overview.html" title="previous chapter">Bundle overview</a></li>
|
||||
<li>Next: <a href="bundles_in_clr_html.html" title="next chapter">Bundles in ClearLinux</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="_sources/bundles_in_clr.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2015, Intel OTC.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.1</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.6</a>
|
||||
|
||||
|
|
||||
<a href="_sources/bundles_in_clr.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,864 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Bundles in ClearLinux — ClearLinux Documentation 1.0.1 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '1.0.1',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<link rel="top" title="ClearLinux Documentation 1.0.1 documentation" href="index.html" />
|
||||
<link rel="next" title="OpenStack* use cases with Clear Linux* OS for Intel® Architecture" href="openstack_use_cases.html" />
|
||||
<link rel="prev" title="List of bundles" href="bundles_in_clr.html" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
|
||||
|
||||
</head>
|
||||
<body role="document">
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="bundles-in-clearlinux">
|
||||
<span id="bundles-in-clr-html"></span><h1>Bundles in ClearLinux<a class="headerlink" href="#bundles-in-clearlinux" title="Permalink to this headline">¶</a></h1>
|
||||
<head>
|
||||
<title>Bundles in ClearLinux</title>
|
||||
<style media="screen" type="text/css">
|
||||
table { margin: 2em; border-collapse: collapse; }
|
||||
td, th { padding: .5em; border: 1px #ccc solid; }
|
||||
thead { background: #fc9; }
|
||||
</style>
|
||||
|
||||
</head>
|
||||
|
||||
<table border: 1px; callpadding: 15>
|
||||
<thead>
|
||||
<th align=left>Bundle Name</th>
|
||||
<th align=center>Status</th>
|
||||
<th align=left>Description</th>
|
||||
<!-- <th align=left>Capabilities</th> -->
|
||||
<!-- <th align=left>Maintainer</th> -->
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align=left> bat</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides the neccesary bundles to perform BAT succesfully</p>
|
||||
<li>Includes (devtools-basic) bundle.</p>
|
||||
<li>Includes (openstack-test-suite) bundle.</p>
|
||||
<li>Includes (os-testsuite) bundle.</p>
|
||||
<li>Includes (pnp-tools-basic) bundle.</p>
|
||||
<li>Includes (openstack-all-in-one) bundle.</p>
|
||||
<li>Includes (storage-utils) bundle.</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> bootloader</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> UEFI bootloaders</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> clr-devops</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides build/release tools for Clear devops team</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> containers-basic</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Installs rkt base for Clear Containers</p>
|
||||
<li>Includes (storage-utils) bundle.</p>
|
||||
<li>Includes (network-basic) bundle.</p>
|
||||
<li>Includes (kernel-container) bundle.</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> cryptography</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Cryptographic tools</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> database-mariadb</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides components needed to run MariaDB</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> database-mongodb</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Provides components needed to run mongodb</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> devtools-basic</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides basic set of languages and tools for development</p>
|
||||
<li>Includes (R-basic) bundle.</p>
|
||||
<li>Includes (go-basic) bundle.</p>
|
||||
<li>Includes (hpc-basic) bundle.</p>
|
||||
<li>Includes (os-core-dev) bundle.</p>
|
||||
<li>Includes (perl-basic) bundle.</p>
|
||||
<li>Includes (python-basic) bundle.</p>
|
||||
<li>Includes (ruby-basic) bundle.</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> devtools-extras</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides extra set of languages and tools for development</p>
|
||||
<li>Includes (R-extras) bundle.</p>
|
||||
<li>Includes (devtools-basic) bundle.</p>
|
||||
<li>Includes (go-extras) bundle.</p>
|
||||
<li>Includes (perl-extras) bundle.</p>
|
||||
<li>Includes (python-extras) bundle.</p>
|
||||
<li>Includes (ruby-extras) bundle.</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> dev-utils</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides a limited set of development utilities</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> dpdk-dev</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> All headers and libraries necessary to develop with the Data Plane Development Kit.</p>
|
||||
<li>Includes (os-core-dev) bundle.</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> editors</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides popular text editors</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> file-utils</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides basic set of file manipulation utilities</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> go-basic</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides basic Go language development</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> go-extras</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Most popular Golang libraries</p>
|
||||
<li>Includes (go-basic) bundle.</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> hpc-basic</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides basic suite of MPI/HPC development tools</p>
|
||||
<li>Includes (os-core-dev) bundle.</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> iot</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> The IoT (Internet of Things) base bundle</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> kernel-container</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Provides a Linux kernel appropriate for a Clear Container</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> kernel-kvm</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides a Linux kernel appropriate for running under KVM</p>
|
||||
<li>Includes (bootloader) bundle.</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> kernel-native</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides a Linux kernel appropriate for physical machines</p>
|
||||
<li>Includes (bootloader) bundle.</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> kernel-pxe</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides a Linux kernel linking an initramfs as root</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> koji</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Sets up a koji build service (builder-only, for now) based on NFS mounts.</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> kvm-host</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Provides necessary tools to run usable virtual machines with QEMU-KVM (independently of OpenStack).</p>
|
||||
<li>Includes (kernel-kvm) bundle.</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> lamp-basic</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Basic LAMP Server (apache2, mariadb, php5)</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> mail-utils</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Provides utilities for reading and sending email</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> message-broker-rabbitmq</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides the RabbitMQ messaging service</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> net-utils</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides an essential suite of core networking configuration and debug tools</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> network-advanced</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> More utilities for advanced host-level networking; bridge, switch, netfilter, vpn etc.</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> network-basic</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides a basic suite of networking utilities</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> network-proxy-client</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Tools for dealing with client-side network proxy settings.</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> openssh-server</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides an SSH server (and client)</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> openstack-all-in-one</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Provides an All-in-one OpenStack deployment</p>
|
||||
<li>Includes (database-mariadb) bundle.</p>
|
||||
<li>Includes (database-mongodb) bundle.</p>
|
||||
<li>Includes (message-broker-rabbitmq) bundle.</p>
|
||||
<li>Includes (openstack-block-storage) bundle.</p>
|
||||
<li>Includes (openstack-block-storage-controller) bundle.</p>
|
||||
<li>Includes (openstack-compute) bundle.</p>
|
||||
<li>Includes (openstack-compute-controller) bundle.</p>
|
||||
<li>Includes (openstack-dashboard) bundle.</p>
|
||||
<li>Includes (openstack-database) bundle.</p>
|
||||
<li>Includes (openstack-identity) bundle.</p>
|
||||
<li>Includes (openstack-image) bundle.</p>
|
||||
<li>Includes (openstack-lbaas) bundle.</p>
|
||||
<li>Includes (openstack-network) bundle.</p>
|
||||
<li>Includes (openstack-object-storage) bundle.</p>
|
||||
<li>Includes (openstack-orchestration) bundle.</p>
|
||||
<li>Includes (openstack-python-clients) bundle.</p>
|
||||
<li>Includes (openstack-telemetry-controller) bundle.</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> openstack-block-storage</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Provides an OpenStack Cinder service</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> openstack-block-storage-controller</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Provides an OpenStack Cinder controller service</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> openstack-compute</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Provides an OpenStack nova-compute node</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> openstack-compute-controller</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Provides an OpenStack Nova control server</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> openstack-configure</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Provides a suggested default configuration for OpenStack on Clear Linux.</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> openstack-controller</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Provides an OpenStack multi-service control server</p>
|
||||
<li>Includes (database-mariadb) bundle.</p>
|
||||
<li>Includes (message-broker-rabbitmq) bundle.</p>
|
||||
<li>Includes (openstack-identity) bundle.</p>
|
||||
<li>Includes (openstack-image) bundle.</p>
|
||||
<li>Includes (openstack-compute-controller) bundle.</p>
|
||||
<li>Includes (openstack-dashboard) bundle.</p>
|
||||
<li>Includes (openstack-python-clients) bundle.</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> openstack-dashboard</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Provides an OpenStack Horizon server</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> openstack-database</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Provides a Database as a Service server</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> openstack-identity</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Provides an OpenStack Keystone server</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> openstack-image</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Provides an OpenStack Glance server</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> openstack-lbaas</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Provides Load Balancing as a Service</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> openstack-network</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Provides an OpenStack Neutron server</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> openstack-object-storage</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Provides an OpenStack Swift service</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> openstack-orchestration</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Provides an OpenStack Heat service</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> openstack-python-clients</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Provides OpenStack command-line utilities</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> openstack-telemetry-controller</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Provides an OpenStack Telemetry server</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> openstack-test-suite</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Provides an OpenStack Tempest/test suite </p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> os-cloudguest</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Provides cloud-init cloud guest configuration utilities</p>
|
||||
<li>Includes (openssh-server) bundle.</p>
|
||||
<li>Includes (telemetrics) bundle.</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> os-clr-on-clr</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> content for development of the Clear Linux OS on the Clear Linux OS</p>
|
||||
<li>Includes (storage-utils) bundle.</p>
|
||||
<li>Includes (mail-utils) bundle.</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> os-core</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> The basic core OS components of Clear Linux for iA </p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> os-core-dev</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Basic development tools</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> os-core-update</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides basic suite for running the Clear Linux for iA Updater</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> os-installer</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides an installer for Clear Linux for iA</p>
|
||||
<li>Includes (telemetrics) bundle.</p>
|
||||
<li>Includes (network-proxy-client) bundle.</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> os-testsuite</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Provides basic test suite for Clear Linux for iA</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> os-testsuite-phoronix</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> All the required pieces for running the Phoronix Test Suite</p>
|
||||
<li>Includes (os-utils) bundle.</p>
|
||||
<li>Includes (devtools-basic) bundle.</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> os-utils</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides a core set of OS utilities</p>
|
||||
<li>Includes (editors) bundle.</p>
|
||||
<li>Includes (dev-utils) bundle.</p>
|
||||
<li>Includes (sysadmin) bundle.</p>
|
||||
<li>Includes (network-basic) bundle.</p>
|
||||
<li>Includes (file-utils) bundle.</p>
|
||||
<li>Includes (network-proxy-client) bundle.</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> os-utils-gui</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides a graphical desktop environment </p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> perl-basic</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides essential Perl language and dev tools</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> perl-extras</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides extra libraries for Perl</p>
|
||||
<li>Includes (perl-basic) bundle.</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> pnp-tools-advanced</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Provides advanced Power and Performance measurement tools</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> pnp-tools-basic</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Provides basic Power and Performance testing tools</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> pnp-tools-intermediate</td>
|
||||
<td align=center> WIP</td>
|
||||
<td align=left>
|
||||
<p> Provides a deeper-level suite of Power and Performance testing tools</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> python-basic</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides core Python language and libraries</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> python-extras</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides extra libraries for Python</p>
|
||||
<li>Includes (python-basic) bundle.</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> R-basic</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides core R language and libraries</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> R-extras</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides deeper functionality R language libraries</p>
|
||||
<li>Includes (R-basic) bundle.</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> ruby-basic</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Top 3 basic Ruby Libraries</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> ruby-extras</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Top 3 to 6 basic Ruby Libraries</p>
|
||||
<li>Includes (ruby-basic) bundle.</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> shells</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> All available shell programs for Clear, along with ancillary files</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> storage-utils</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides basic storage-related utilities</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> sysadmin</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides a basic set of system administration utilities.</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> telemetrics</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Provides the Telemetrics client for Clear Linux for iA</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
<tr>
|
||||
<td align=left> virtualbox-guest</td>
|
||||
<td align=center> ACTIVE</td>
|
||||
<td align=left>
|
||||
<p> Include the modules and binaries meant to be used as a VirtualBox instance</p>
|
||||
</td>
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
<!-- <td align=left><p></p></td> -->
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper"><div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
<li>Previous: <a href="bundles_in_clr.html" title="previous chapter">List of bundles</a></li>
|
||||
<li>Next: <a href="openstack_use_cases.html" title="next chapter">OpenStack* use cases with Clear Linux* OS for Intel® Architecture</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="_sources/bundles_in_clr_html.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2015, Intel OTC.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.1</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.6</a>
|
||||
|
||||
|
|
||||
<a href="_sources/bundles_in_clr_html.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,116 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Bundle overview — ClearLinux Documentation 1.0.1 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '1.0.1',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<link rel="top" title="ClearLinux Documentation 1.0.1 documentation" href="index.html" />
|
||||
<link rel="next" title="List of bundles" href="bundles_in_clr.html" />
|
||||
<link rel="prev" title="How to run the updater" href="swupdate_how_to_run_the_updater.html" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
|
||||
|
||||
</head>
|
||||
<body role="document">
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="bundle-overview">
|
||||
<h1>Bundle overview<a class="headerlink" href="#bundle-overview" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Linux-based operating systems contain the code of several hundred, if
|
||||
not thousands, of open source projects. To make this manageable,
|
||||
distributions use a concept called “packages” to configure and compile
|
||||
the source code of these projects into binaries.</p>
|
||||
<p>Many distributions then split the content of these compiled packages
|
||||
into so-called sub-packages, which are the granularity at which these
|
||||
distributions deploy their software. With those kinds of distributions,
|
||||
system administrators can then install and update sub-packages
|
||||
individually or as a set, using tools such as “yum” and “apt-get.”</p>
|
||||
<p>The Clear Linux* OS for Intel® Architecture does things a bit differently. While we also use the
|
||||
concept of packages to manage compiling source code into binaries, we do
|
||||
not use the package concept to deploy software. Instead, we provide
|
||||
“bundles” that provide a set of functionality to the system
|
||||
administrator, independent of how many and which pieces of the upstream
|
||||
open source projects are needed for this functionality. The diagram
|
||||
below gives an overall picture of it.</p>
|
||||
<img alt="confirmation" class="align-center" src="_images/bundles_overview.png" />
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper"><div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
<li>Previous: <a href="swupdate_how_to_run_the_updater.html" title="previous chapter">How to run the updater</a></li>
|
||||
<li>Next: <a href="bundles_in_clr.html" title="next chapter">List of bundles</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="_sources/bundles_overview.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2015, Intel OTC.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.1</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.6</a>
|
||||
|
||||
|
|
||||
<a href="_sources/bundles_overview.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,100 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title><no title> — ClearLinux Documentation 1.0.1 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '1.0.1',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<link rel="top" title="ClearLinux Documentation 1.0.1 documentation" href="index.html" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
|
||||
|
||||
</head>
|
||||
<body role="document">
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<p class="rubric" id="disclaimers">Disclaimer</p>
|
||||
<div class="admonition important">
|
||||
<p class="first admonition-title">Important</p>
|
||||
<p class="last">This documentation is a work in progress and is being provided for
|
||||
informative purposes only. Because it is a work in progress, there are
|
||||
parts that are either missing or will be revised as code development
|
||||
continues.</p>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper"><div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="_sources/disclaimers.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2015, Intel OTC.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.1</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.6</a>
|
||||
|
||||
|
|
||||
<a href="_sources/disclaimers.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,99 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title><no title> — ClearLinux Documentation 1.0.1 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '1.0.1',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<link rel="top" title="ClearLinux Documentation 1.0.1 documentation" href="index.html" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
|
||||
|
||||
</head>
|
||||
<body role="document">
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<p>Copyright © 2015 Intel Corporation</p>
|
||||
<a rel="license"
|
||||
href="http://creativecommons.org/licenses/by/4.0/"><img
|
||||
alt="Creative Commons License" style="border-width:0"
|
||||
src="https://i.creativecommons.org/l/by/4.0/88x31.png" /></a><br
|
||||
/>This work is licensed under a <a rel="license"
|
||||
href="http://creativecommons.org/licenses/by/4.0/">Creative Commons
|
||||
Attribution 4.0 International License</a>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper"><div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="_sources/documentation_license.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2015, Intel OTC.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.1</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.6</a>
|
||||
|
||||
|
|
||||
<a href="_sources/documentation_license.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,92 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Index — ClearLinux Documentation 1.0.1 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '1.0.1',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<link rel="top" title="ClearLinux Documentation 1.0.1 documentation" href="index.html" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
|
||||
|
||||
</head>
|
||||
<body role="document">
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
|
||||
<h1 id="index">Index</h1>
|
||||
|
||||
<div class="genindex-jumpbox">
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2015, Intel OTC.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.1</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.6</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,184 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Clear Containers getting started guide — ClearLinux Documentation 1.0.1 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '1.0.1',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
};
|
||||
</script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<link rel="top" title="ClearLinux Documentation 1.0.1 documentation" href="index.html" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
|
||||
|
||||
</head>
|
||||
<body role="document">
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="clear-containers-getting-started-guide">
|
||||
<span id="gs-clear-containers-gettting-started"></span><h1>Clear Containers getting started guide<a class="headerlink" href="#clear-containers-getting-started-guide" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Clear Containers for Docker* Engine is now available on multiple
|
||||
operating systems. This enables executing existing Docker applications
|
||||
in the secure and fast Clear Containers environment.</p>
|
||||
<div class="section" id="binary-packages">
|
||||
<h2>Binary packages<a class="headerlink" href="#binary-packages" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The primary host platform is Clear Linux* Project for Intel® Architecture, version 4000
|
||||
or better. However, binaries for a range of operating systems are available from:</p>
|
||||
<ul class="simple">
|
||||
<li><a class="reference external" href="https://software.opensuse.org/download.html?project=home%3Aclearlinux%3Apreview&package=clear-containers-docker">https://software.opensuse.org/download.html?project=home%3Aclearlinux%3Apreview&package=clear-containers-docker</a></li>
|
||||
</ul>
|
||||
<p>Currently experimental builds are available for:</p>
|
||||
<ul class="simple">
|
||||
<li>CentOS*, Scientific Linux* 7</li>
|
||||
<li>Fedora* 21, 22</li>
|
||||
<li>openSUSE* 13.1, 13.2, Tumbleweed</li>
|
||||
<li>SUSE* Linux Enterprise 12</li>
|
||||
<li>Debian* 8.0</li>
|
||||
<li>Ubuntu* 15.04</li>
|
||||
</ul>
|
||||
<p>If you have any feedback, please mail it to the <a class="reference external" href="mailto:dev%40lists.clearlinux.org">dev<span>@</span>lists<span>.</span>clearlinux<span>.</span>org</a> mailing list.
|
||||
Subscription to this list is available at: <a class="reference external" href="https://lists.clearlinux.org/mailman/listinfo/dev">https://lists.clearlinux.org/mailman/listinfo/dev</a>.</p>
|
||||
</div>
|
||||
<div class="section" id="installation-instructions">
|
||||
<h2>Installation instructions<a class="headerlink" href="#installation-instructions" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="using-hosts-other-than-clear-linux-os-for-intel-architecture">
|
||||
<h3>Using hosts other than Clear Linux OS for Intel Architecture<a class="headerlink" href="#using-hosts-other-than-clear-linux-os-for-intel-architecture" title="Permalink to this headline">¶</a></h3>
|
||||
<p>If you are <em>not</em> using Clear Linux OS for Intel Architecture, follow the instructions below:</p>
|
||||
<ol class="arabic">
|
||||
<li><p class="first">Visit the link below, and select your operating system by clicking the appropriate icon:
|
||||
<a class="reference external" href="https://software.opensuse.org/download.html?project=home%3Aclearlinux%3Apreview&package=clear-containers-docker">https://software.opensuse.org/download.html?project=home%3Aclearlinux%3Apreview&package=clear-containers-docker</a></p>
|
||||
</li>
|
||||
<li><p class="first">Follow the brief instructions shown.</p>
|
||||
</li>
|
||||
<li><p class="first">Reload your systemd configuration:</p>
|
||||
<div class="highlight-python"><div class="highlight"><pre>$ sudo systemctl daemon-reload
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
<li><p class="first">Start the Docker service:</p>
|
||||
<div class="highlight-python"><div class="highlight"><pre>$ systemctl restart docker
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
</ol>
|
||||
</div>
|
||||
<div class="section" id="using-clear-linux-os-for-intel-architecture-as-host">
|
||||
<h3>Using Clear Linux OS for Intel Architecture as Host<a class="headerlink" href="#using-clear-linux-os-for-intel-architecture-as-host" title="Permalink to this headline">¶</a></h3>
|
||||
<p>If you are running Clear Linux OS for Intel Architecture on your host system, follow the
|
||||
instructions below:</p>
|
||||
<ol class="arabic">
|
||||
<li><p class="first">Enable the repository by running the following as the <code class="docutils literal"><span class="pre">root</span></code> user:</p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span class="c"># clr_bundle_add containers-basic</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
<li><p class="first">Reload your systemd configuration:</p>
|
||||
<div class="highlight-python"><div class="highlight"><pre>$ sudo systemctl daemon-reload
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
<li><p class="first">Start the Docker service:</p>
|
||||
<div class="highlight-python"><div class="highlight"><pre>$ systemctl restart docker
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
</ol>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="source-code">
|
||||
<h2>Source Code<a class="headerlink" href="#source-code" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The experimental source code is based on the Docker version 1.8.1 upstream release and is available at:</p>
|
||||
<ul class="simple">
|
||||
<li><a class="reference external" href="https://github.com/clearlinux/docker">https://github.com/clearlinux/docker</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h3><a href="index.html">Table Of Contents</a></h3>
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">Clear Containers getting started guide</a><ul>
|
||||
<li><a class="reference internal" href="#binary-packages">Binary packages</a></li>
|
||||
<li><a class="reference internal" href="#installation-instructions">Installation instructions</a><ul>
|
||||
<li><a class="reference internal" href="#using-hosts-other-than-clear-linux-os-for-intel-architecture">Using hosts other than Clear Linux OS for Intel Architecture</a></li>
|
||||
<li><a class="reference internal" href="#using-clear-linux-os-for-intel-architecture-as-host">Using Clear Linux OS for Intel Architecture as Host</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#source-code">Source Code</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div role="note" aria-label="source link">
|
||||
<h3>This Page</h3>
|
||||
<ul class="this-page-menu">
|
||||
<li><a href="_sources/gs-clear-containers-gettting-started.txt"
|
||||
rel="nofollow">Show Source</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
<p class="searchtip" style="font-size: 90%">
|
||||
Enter search terms or a module, class or function name.
|
||||
</p>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2015, Intel OTC.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.1</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.6</a>
|
||||
|
||||
|
|
||||
<a href="_sources/gs-clear-containers-gettting-started.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user