x/anvil
Code Issues Proposed changes

Continue of rename to anvil

Browse Source
This commit is contained in:
Joshua Harlow
2012-05-02 21:19:41 -07:00
parent ebf7bfe0dc
commit 1ae3a3fb97
14 changed files with 53 additions and 57 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/source/topics/advanced/addingyourowndistro.rst
View File

@@ -6,7 +6,7 @@ Adding your own distribution
Your mission...
=============
So you have decided you want to venture into the bowels of DEVSTACKpy
So you have decided you want to venture into the bowels of ANVIL
and want to get support for your latest and greatest distribution. This
wiki will hopefully make that adventure simpler by listing out the key
places, files and configs that may have to be adjusted to get that to

2
docs/source/topics/advanced/addingyourownpersona.rst
View File

@@ -6,7 +6,7 @@ Adding your own persona
Your mission...
=============
So you have decided you want to venture into the bowels of DEVSTACKpy
So you have decided you want to venture into the bowels of ANVIL
and want to alter what is installed/started/stopped, the order of what
is installed/started/stopped, what subsystems are activated (or the
component options). This wiki will hopefully make that adventure simpler

18
docs/source/topics/advanced/design.rst
View File

@@ -5,7 +5,7 @@ Design
How it works
------------
DEVSTACKpy is based along the following system design
ANVIL is based along the following system design
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- Having shared components/actions be shared (using object oriented
@@ -18,16 +18,16 @@ DEVSTACKpy is based along the following system design
Directory structure is the following
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- Parent classes located in *devstack/component.py*, it contains the
- Parent classes located in *anvil/component.py*, it contains the
root install/uninstall/start/stop classes
- Subclasses in *devstack/components/*, it contains the individual
- Subclasses in *anvil/components/*, it contains the individual
install classes for each openstack component
- Running modes implementations in *devstack/runners/* (ie fork,
- Running modes implementations in *anvil/runners/* (ie fork,
screen, upstart)
- Packaging implementations in *devstack/packaging/*
- Image uploading/registry/management (for glance) in *devstack/image/*
- Shared classes and utils in *devstack/*
- Main entry point/s in *devstack/progs/*
- Packaging implementations in *anvil/packaging/*
- Image uploading/registry/management (for glance) in *anvil/image/*
- Shared classes and utils in *anvil/*
- Main entry point/s in *anvil/progs/*
- Other various tools in *tools/*
- Configuration in *conf/* (see below)
@@ -69,7 +69,7 @@ Functions
'''''''''
For a install class the following functions are activated (in the
following order by *devstack/progs/actions.py*):
following order by *anvil/actions.py*):
::

9
docs/source/topics/bugshugscode.rst
View File

@@ -7,7 +7,7 @@ Bugs & Hugs & Code
Community
=========
DEVSTACKpy is an open-source tool released under the `apache version 2.0 license`_. It *depends* on its **community** to keep it alive.
ANVIL is an open-source tool released under the `apache version 2.0 license`_. It *depends* on its **community** to keep it alive.
Source code
===========
@@ -16,8 +16,7 @@ The source code is on github located at:
https://github.com/yahoo/Openstack-DevstackPy.
Feel free to fork it and contribute to it. You can also get a tarball or
zip archive of the code.
Feel free to fork it and contribute to it. You can also get a tarball or zip archive of the code.
Tags
----
@@ -26,7 +25,7 @@ Stable *tags* can also be downloaded:
https://github.com/yahoo/Openstack-DevstackPy/tags.
**Note:** that for these tags you may have to edit *conf/stack.ini*
**Note:** that for these tags you may have to edit *conf/anvil.ini*
to point to stable branch/es for the various *OpenStack* components.
Bugs/Features
@@ -43,7 +42,7 @@ Feel free to hack but please try to follow the `hacking guidelines`_
Discussions
===========
Please either use `launchpad’s email system`_ or find us on ``irc.freenode.net`` in channel ``#openstack-devstackpy``
Please either use `launchpad’s email system`_ or find us on ``irc.freenode.net`` in channel ``#openstack-anvil``
.. _apache version 2.0 license: https://github.com/yahoo/Openstack-DevstackPy/blob/master/LICENSE
.. _github’s issue tracking system: https://github.com/yahoo/Openstack-Devstackpy/issues

4
docs/source/topics/features.rst
View File

@@ -4,11 +4,11 @@ Features
- Supports more than one distribution.
- Currently RHEL 6.2 (with `epel`_), Ubuntu 11.10, Fedora 16
- Currently RHEL 6.2 (with `epel`_), Ubuntu 11.10, Fedora 16, Ubuntu 12.10 (seems to work)
- Supports dry-run mode (to see what *would* happen)
- Supports varying installation *personas*
- A single ``stack.ini`` file that shows common configuration
- A single ``anvil.ini`` file that shows common configuration
- Supports install/uninstall/starting/stopping of OpenStack components.
- In various styles (daemonizing via `forking`_, `screen`_, `upstart`_)

33
docs/source/topics/gettingstarted.rst
View File

@@ -48,7 +48,7 @@ configure and get right!**
--------------
DEVSTACKpy will configure the network in a identical manner to version
ANVIL will configure the network in a identical manner to version
*1.0*. This means that the default network manager will be the
*FlatDHCPManager*. The following settings are relevant in configuring
your network.
@@ -155,17 +155,17 @@ Get git!
Download
--------
We’ll grab the latest version of DEVSTACKpy via git:
We’ll grab the latest version of ANVIL via git:
::
$ git clone git://github.com/yahoo/Openstack-DevstackPy.git DevstackPy
$ git clone git://github.com/yahoo/Openstack-DevstackPy.git anvil
Now setup the prerequisites needed to run DEVSTACKpy:
Now setup the prerequisites needed to run:
::
$ cd DevstackPy && sudo ./prepare.sh
$ cd anvil && sudo ./warmup.sh
Configuration
-------------
@@ -173,7 +173,7 @@ Configuration
Apache configuration
~~~~~~~~~~~~~~~~~~~~
We need to adjust the configuration of DEVSTACKpy to reflect the above
We need to adjust the configuration of ANVIL to reflect the above
user (``iff you created a user``).
Open ``conf/stack.ini``
@@ -211,14 +211,13 @@ Open ``conf/stack.ini``
Network configuration
~~~~~~~~~~~~~~~~~~~~~
We need to adjust the configuration of DEVSTACKpy to reflect our above
network configuration.
We need to adjust the configuration of ANVIL to reflect our above network configuration.
Please reference:
Please reference
http://docs.openstack.org/diablo/openstack-compute/admin/content/configuring-networking-on-the-compute-node.html
If you need to adjust those variables the matching config variables in
``stack.ini`` are:
If you need to adjust those variables the matching config variables in ``anvil.ini`` are:
::
@@ -254,11 +253,11 @@ Now install *OpenStacks* components by running the following:
::
sudo ./stack -a install -d ~/openstack
sudo ./smithy -a install -d ~/openstack
You should see a set of distribution packages and/or pips being
installed, python setups occurring and configuration files being written
as DEVSTACKpy figures out how to install your desired components (if you
as ANVIL figures out how to install your desired components (if you
desire more informational output add a ``-v`` or a ``-vv`` to that
command).
@@ -270,7 +269,7 @@ Now that you have installed *OpenStack* you can now start your
::
sudo ./stack -a start -d ~/openstack
sudo ./smithy -a start -d ~/openstack
If you desire more informational output add a ``-v`` or a ``-vv`` to
that command.
@@ -295,7 +294,7 @@ If you see a login page and can access horizon then:
Command line tools
~~~~~~~~~~~~~~~~~~
In your DEVSTACKpy directory:
In your ANVIL directory:
::
@@ -349,7 +348,7 @@ the following:
::
sudo ./stack -a stop -d ~/openstack
sudo ./smithy -a stop -d ~/openstack
You should see a set of stop actions happening and ``stderr`` and
``stdout`` and ``pid`` files being removed (if you desire more
@@ -376,7 +375,7 @@ can uninstall them by running the following:
::
sudo ./stack -a uninstall -d ~/openstack
sudo ./smithy -a uninstall -d ~/openstack
You should see a set of packages, configuration and directories, being
removed (if you desire more informational output add a ``-v`` or a

1
docs/source/topics/goals.rst
View File

@@ -17,6 +17,7 @@ Goals
they can productively contribute without having to understand every
part of the system at once.
- To make it easy to prototype cross-project features.
- To have an installer that works!
.. _OpenStack: http://openstack.org/

2
docs/source/topics/knownissues.rst
View File

@@ -21,7 +21,7 @@ RHEL 6.2
the current sudo user. Without this though it doesn’t seem like
*python-wsgi* can access the users libraries that are downloaded and
other files can’t be accessed either. This could be solved by having
a new user and group and doing what devstack v1.0 does (but this
a new user and group and doing what devstack.sh does (but this
seems like overkill).
Others

12
docs/source/topics/qanda.rst
View File

@@ -4,25 +4,23 @@
Questions and Answers
===============
Can I use DEVSTACKpy for production?
Can I use ANVIL for production?
------------------------------------
**No.** We mean it. **Really.** DEVSTACKpy makes some implementation
choices that are not appropriate for production deployments. *We warned
you!* **No, no no no no no no no no no. No.**
Up to u! Beware of the sea and the black waters!
How do I get program usage?
---------------------------
::
$ ./stack --help
$ ./smithy --help
How do I run a specific OpenStack milestone?
--------------------------------------------
OpenStack milestones have tags set in the git repo. Set the appropriate
setting in the **branch** variables in *conf/stack.ini*.
setting in the **branch** variables in *conf/anvil.ini*.
**Note:** Swift is on its own release schedule so pick a tag in the
Swift repo that is just before the milestone release.
@@ -49,7 +47,7 @@ OMG the images take forever to download!
Sometimes the images that will be uploaded to glance take a long time to
download and extract and upload.
To adjust this edit *conf/stack.ini* and change the following:
To adjust this edit *conf/anvil.ini* and change the following:
::

8
docs/source/topics/usageexamples.rst
View File

@@ -8,21 +8,21 @@ Usage Examples
Commands
--------
To get the ``stack`` help display try:
To get the help display try:
::
$ ./stack --help
$ ./smithy --help
To examine what installing the basics (nova, horizon, glance, keystone…)
will do (with installation in ``~/openstack``) try:
::
$ sudo ./stack -d ~/openstack -a install --dryrun
$ sudo ./smithy -d ~/openstack -a install --dryrun
With more information/debugging/auditing output try:
::
$ sudo ./stack -d ~/openstack -a install -vv
$ sudo ./smithy -d ~/openstack -a install -vv

4
docs/source/topics/warning.rst
View File

@@ -2,10 +2,10 @@
Important!
==========
**Warning:** Be sure to carefully read ``stack`` and any other scripts
**Warning:** Be sure to carefully read ``smithy`` and any other scripts
you execute before you run them, as they install software and may alter
your networking configuration. We strongly recommend that you run
``stack`` in a clean and disposable virtual machine when you are first
``smithy`` in a clean and disposable virtual machine when you are first
getting started.
.. _epel: http://fedoraproject.org/wiki/EPEL