x/inception
Code Issues Proposed changes

Merge "Added instructions to build images and cleaned up trailing whitespace"

Browse Source
This commit is contained in:
Jenkins 2013-09-29 00:55:29 +00:00 committed by Gerrit Code Review
commit 4223996ab6
2 changed files with 116 additions and 96 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
doc/source/ic_user/prep.tex
View File

@ -9,11 +9,12 @@ Nova client CLI.
\item Set environment variables \item Set environment variables
\item Create keys \item Create keys
\item Start small boot-up VM \item Start small boot-up VM
\item Create Images
\item Add floating IP to the VM \item Add floating IP to the VM
\item Start \verb!sshuttle! \item Start \verb!sshuttle!
\end{enumerate} \end{enumerate}
\subsubsection{Install Software} \subsection{Install Software}
Some or all of the required software might already be installed. Some or all of the required software might already be installed.
Verify that the correct versions of each of the software packages are available on the workstation Verify that the correct versions of each of the software packages are available on the workstation
and take steps to upgrade or load the missing packages as is needed. and take steps to upgrade or load the missing packages as is needed.
@ -40,7 +41,7 @@ If the decision is made to install inception, the following command should be us
python setup.py install python setup.py install
\end{verbatim}\normalsize \end{verbatim}\normalsize
\subsubsection{Set Environment Variables} \subsection{Set Environment Variables}
Ensure that the environment variables which define the authorisation URL and credentials for OpenStack are set and exported. Ensure that the environment variables which define the authorisation URL and credentials for OpenStack are set and exported.
OpenStack credentials can be obtained using the OpenStack dashboard interface and following these steps: OpenStack credentials can be obtained using the OpenStack dashboard interface and following these steps:
\label{set_env_sect} \label{set_env_sect}
@ -70,7 +71,7 @@ Sourcing the file should prompt for a password, and then export the following va
\dlitem{OS\_USERNAME}{ Your user name.} \dlitem{OS\_USERNAME}{ Your user name.}
\dlend \dlend
\subsubsection{Create Keys} \subsection{Create Keys}
Create (if needed) a public/private key pair and register it with OpenStack. If you do not have a key pair, generate one using Create (if needed) a public/private key pair and register it with OpenStack. If you do not have a key pair, generate one using
nova. (I prefer to name these with the OpenStack cluster/environment name, and then the key name with an extension that nova. (I prefer to name these with the OpenStack cluster/environment name, and then the key name with an extension that
indicates private key: agave.scooter.pk.) indicates private key: agave.scooter.pk.)
@ -97,21 +98,39 @@ If you already have a private key (one that several users might share) then a pu
If you have both a public and private key file, then the \verb!ssh-keygen! command can be skipped; it is only necessary to supply the existing public key to If you have both a public and private key file, then the \verb!ssh-keygen! command can be skipped; it is only necessary to supply the existing public key to
OpenStack using the nova command line. OpenStack using the nova command line.
\subsubsection{Start Tiny Boot-up VM} \subsection{Start Boot-up VM}
Create and initialise a tiny VM that will act as the initial gateway to the virtual environment for processes running on the workstation. Create and initialise a tiny\footnote{If you are going to need to create OS images during setup, use a meidum VM.}
VM that will act as the initial gateway to the virtual environment for processes running on the workstation.
For the examples used in the remainder of this document, the boot-up VM is given the name \verb!scooter_bv.! For the examples used in the remainder of this document, the boot-up VM is given the name \verb!scooter_bv.!
The VM should be started with the key that was registered with OpenStack. The VM should be started with the key that was registered with OpenStack.
\small\begin{verbatim} \small\begin{verbatim}
nova boot --image centos --flavor m1.tiny --key_name shared \ nova boot --image centos --flavor m1.tiny --key_name shared \
--security_groups default scooter_bv --security_groups default scooter_bv
}
\end{verbatim}\normalsize \end{verbatim}\normalsize
\noindent \noindent
The VM should boot quickly and once it is active you may continue. The VM should boot quickly and once it is active you may continue.
\subsubsection{Add A Floating IP Address} \subsection{Create O/S Images}
If suitable inception cloud images are not already available in the current virtual environment, they must be created.
The following lists the steps necessary to create the O/S images:
\begin{enumerate}
\item Ssh to the boot-up VM.
\item Copy inception utility scripts from the source installed on the workstation.
\item Run the script \verb!pre_switch_kernel.sh! to convert from a vertual kernel to a generic kernel.
\item Wait for the VM to reboot and log in again.
\item Run the script \verb!pre_install_ovs.sh! to install open vswitch.
\item Using nova, or the dashboard, take a snapshot of the VM giving it an image name of XXX-gv.
\item Run the script \verb!pre_install_chefserver.sh! to install the Chef software.
\item Create another image naming it XXX-gvc.
\end{enumerate}
Image names (shown as XXX in the above list), can be anything that aligns with local policy and are used
with the \verb!--image! and \verb!--chefserver_image! options on the \verb!orcehestrator! command line.
\subsection{Add A Floating IP Address}
Add a floating (public) IP address to the new VM so that it can be reached from the "real world." Add a floating (public) IP address to the new VM so that it can be reached from the "real world."
(xxx.xxx.xxx.xxx is one of the public floating IP addresses that are available; use \verb!nova floating-ip-list! (xxx.xxx.xxx.xxx is one of the public floating IP addresses that are available; use \verb!nova floating-ip-list!
to get a list of available addresses. to get a list of available addresses.
@ -120,7 +139,7 @@ to get a list of available addresses.
nova add-floating-ip scooter_bv xxx.xxx.xxx.xxx nova add-floating-ip scooter_bv xxx.xxx.xxx.xxx
\end{verbatim}\normalsize \end{verbatim}\normalsize
\subsubsection{Start sshuttle} \subsection{Start sshuttle}
The sshuttle programme creates a tunnel through ssh allowing programmes on the workstation to access VMs created on the The sshuttle programme creates a tunnel through ssh allowing programmes on the workstation to access VMs created on the
same internal network as the boot-up VM without having to assign each VM a public address. same internal network as the boot-up VM without having to assign each VM a public address.
The sshuttle command is given the private key portion of the key pair that was used to start the boot-up VM; this is The sshuttle command is given the private key portion of the key pair that was used to start the boot-up VM; this is

3
doc/source/ic_user/running.tex
View File

@ -35,7 +35,8 @@ It will probably be necessary to add the top level inception directory to the \v
if inception was not installed. if inception was not installed.
%.sp %.sp
Using the \verb!--help! option will cause all of the possible command line options to be written to the tty device. Using the \verb!--help! option will cause all of the possible command line options to be written to the tty device.
For the most part, at least for the first time user, only a few are needed and are described below. For the most part, at least for the first time user, only a few are needed and are described
below. %\footnote{A complete list of orchestrator command line options are presented in an appendix}.
\dlbeg{0.85in} \dlbeg{0.85in}
\dlitem{-p prefix}{ \dlitem{-p prefix}{