mirror of https://github.com/apache/cloudstack.git
Simplified build-and-run-from-source instructions, and removed autolinking for CamelCase words on the handbook.
This commit is contained in:
Manuel Amador (Rudd-O)
parent
8577624e85
commit
576e4f163b
176
README.html
176
README.html
|
|
@ -512,6 +512,13 @@ Also see [[AdvancedOptions]]</pre>
|
|||
</div>
|
||||
<!--POST-SHADOWAREA-->
|
||||
<div id="storeArea">
|
||||
<div title="(default) on http://tiddlyvault.tiddlyspot.com/#%5B%5BDisableWikiLinksPlugin%20(TiddlyTools)%5D%5D" modifier="(System)" created="201009040211" tags="systemServer" changecount="1">
|
||||
<pre>|''Type:''|file|
|
||||
|''URL:''|http://tiddlyvault.tiddlyspot.com/#%5B%5BDisableWikiLinksPlugin%20(TiddlyTools)%5D%5D|
|
||||
|''Workspace:''|(default)|
|
||||
|
||||
This tiddler was automatically created to record the details of this server</pre>
|
||||
</div>
|
||||
<div title="AntInformation" creator="RuddO" modifier="RuddO" created="201008072228" changecount="1">
|
||||
<pre>---------------------------------------------------------------------
|
||||
FOR ANT USERS
|
||||
|
|
@ -702,21 +709,18 @@ Once this command is done, the packages will be built in the directory {{{artifa
|
|||
# As a non-root user, run the command {{{./waf deb}}} in the source directory.
|
||||
Once this command is done, the packages will be built in the directory {{{artifacts/debbuild}}}.</pre>
|
||||
</div>
|
||||
<div title="Building from the source and installing directly from there" creator="RuddO" modifier="RuddO" created="201008080022" modified="201009040156" changecount="15">
|
||||
<pre>!Obtain the source for the CloudStack
|
||||
<div title="Building from the source and installing directly from there" creator="RuddO" modifier="RuddO" created="201008080022" modified="201009040235" changecount="20">
|
||||
<pre>You need to do the following steps on each machine that will run a CloudStack component.
|
||||
!Obtain the source for the CloudStack
|
||||
If you aren't reading this from a local copy of the source code, see [[Obtaining the source]].
|
||||
!Prepare your environment
|
||||
See [[Preparing your environment]].
|
||||
!Configure the build on the builder machine
|
||||
!Configure the build
|
||||
As non-root, run the command {{{./waf configure}}}. See [[waf configure]] to discover configuration options for that command.
|
||||
!Build the CloudStack on the builder machine
|
||||
!Build the CloudStack
|
||||
As non-root, run the command {{{./waf build}}}. See [[waf build]] for an explanation.
|
||||
!Install the CloudStack on the target systems
|
||||
On each machine where you intend to run a CloudStack component:
|
||||
# upload the entire source code tree after compilation, //ensuring that the source ends up in the same path as the machine in which you compiled it//,
|
||||
## {{{rsync}}} is [[usually very handy|Using rsync to quickly transport the source tree to another machine]] for this
|
||||
# in that newly uploaded directory of the target machine, run the command {{{./waf install}}} //as root//.
|
||||
Consult [[waf install]] for information on installation.</pre>
|
||||
!Install the CloudStack
|
||||
Run the command {{{./waf install}}} //as root//. Consult [[waf install]] for information on installation.</pre>
|
||||
</div>
|
||||
<div title="Changing the build, install and packaging processes" creator="RuddO" modifier="RuddO" created="201008081215" modified="201008081309" tags="fixme" changecount="15">
|
||||
<pre>!Changing the [[configuration|waf configure]] process
|
||||
|
|
@ -737,8 +741,8 @@ See the files in the {{{debian/}}} folder.</pre>
|
|||
<div title="CloudStack" creator="RuddO" modifier="RuddO" created="201008072205" changecount="1">
|
||||
<pre>The Cloud.com CloudStack is an open source software product that enables the deployment, management, and configuration of multi-tier and multi-tenant infrastructure cloud services by enterprises and service providers.</pre>
|
||||
</div>
|
||||
<div title="CloudStack build dependencies" creator="RuddO" modifier="RuddO" created="201008081310" modified="201009040201" changecount="16">
|
||||
<pre>Prior to building the CloudStack, you need to install the following software packages in your system:
|
||||
<div title="CloudStack build dependencies" creator="RuddO" modifier="RuddO" created="201008081310" modified="201009040226" changecount="20">
|
||||
<pre>Prior to building the CloudStack, you need to install the following software packages in your system.
|
||||
# Sun Java 1.6
|
||||
## You must install the Java Development Kit with {{{javac}}}, not just the Java Runtime Environment
|
||||
## The commands {{{java}}} and {{{javac}}} must be found in your {{{PATH}}}
|
||||
|
|
@ -752,12 +756,9 @@ See the files in the {{{debian/}}} folder.</pre>
|
|||
## Do ''not'' install Cygwin Python!
|
||||
# The MySQLdb module for Python 2.6
|
||||
## If you use Windows, you can find a [[pre-built package here|http://soemin.googlecode.com/files/MySQL-python-1.2.3c1.win32-py2.6.exe]]
|
||||
# bash
|
||||
# coreutils
|
||||
!Installing the dependencies on Windows
|
||||
Some of the packages in the above list are only available on Windows through Cygwin. If that is your case, install them using Cygwin and remember to include the Cygwin {{{bin/}}} directory in your PATH.
|
||||
|
||||
Do not install Cygwin Python! Use the Python for Windows official installer instead.
|
||||
# The Bourne-again shell (also known as bash)
|
||||
# GNU coreutils
|
||||
''Note for Windows users'': Some of the packages in the above list are only available on Windows through Cygwin. If that is your case, install them using Cygwin and remember to include the Cygwin {{{bin/}}} directory in your PATH. Under no circumstances install Cygwin Python! Use the Python for Windows official installer instead.
|
||||
!Additional dependencies for Linux development environments
|
||||
# GCC (only needed on Linux)
|
||||
# glibc-devel / glibc-dev
|
||||
|
|
@ -768,15 +769,17 @@ Do not install Cygwin Python! Use the Python for Windows official installer ins
|
|||
## commons-logging-api
|
||||
## commons-pool
|
||||
## commons-httpclient
|
||||
## ws-commons-util</pre>
|
||||
## ws-commons-util
|
||||
# useradd
|
||||
# userdel</pre>
|
||||
</div>
|
||||
<div title="CloudStack run-time dependencies" creator="RuddO" modifier="RuddO" created="201008081310" modified="201009040200" tags="fixme" changecount="10">
|
||||
<div title="CloudStack run-time dependencies" creator="RuddO" modifier="RuddO" created="201008081310" modified="201009040225" tags="fixme" changecount="16">
|
||||
<pre>The following software / programs must be correctly installed in the machines where you will run a CloudStack component. This list is by no means complete yet, but it will be soon.
|
||||
!Dependencies common to all components of the CloudStack
|
||||
|
||||
''Note for Windows users'': Some of the packages in the lists below are only available on Windows through Cygwin. If that is your case, install them using Cygwin and remember to include the Cygwin {{{bin/}}} directory in your PATH. Under no circumstances install Cygwin Python! Use the Python for Windows official installer instead.
|
||||
!Run-time dependencies common to all components of the CloudStack
|
||||
# bash
|
||||
# coreutils
|
||||
# useradd
|
||||
# userdel
|
||||
# Sun Java 1.6
|
||||
## You must install the Java Development Kit with {{{javac}}}, not just the Java Runtime Environment
|
||||
## The commands {{{java}}} and {{{javac}}} must be found in your {{{PATH}}}
|
||||
|
|
@ -791,10 +794,6 @@ Do not install Cygwin Python! Use the Python for Windows official installer ins
|
|||
## commons-pool
|
||||
## commons-httpclient
|
||||
## ws-commons-util
|
||||
!!Installing the dependencies on Windows
|
||||
Some of the packages in the above list are only available on Windows through Cygwin. If that is your case, install them using Cygwin and remember to include the Cygwin {{{bin/}}} directory in your PATH.
|
||||
|
||||
Do not install Cygwin Python! Use the Python for Windows official installer instead.
|
||||
!Management Server-specific dependencies
|
||||
# Apache Tomcat
|
||||
## If you are using the official Apache binary distribution, set the environment variable {{{TOMCAT_HOME}}} to point to the Apache Tomcat directory
|
||||
|
|
@ -834,6 +833,108 @@ Otherwise, ''end-user migration will fail catastrophically''.</pre>
|
|||
<div title="Development conventions" creator="RuddO" modifier="RuddO" created="201008081334" modified="201008081336" changecount="4">
|
||||
<pre>#[[Source layout guide]]</pre>
|
||||
</div>
|
||||
<div title="DisableWikiLinksPlugin" modifier="ELSDesignStudios" created="200512092239" modified="200807230133" tags="systemConfig" server.type="file" server.host="www.tiddlytools.com" server.page.revision="200807230133">
|
||||
<pre>/***
|
||||
|Name|DisableWikiLinksPlugin|
|
||||
|Source|http://www.TiddlyTools.com/#DisableWikiLinksPlugin|
|
||||
|Version|1.6.0|
|
||||
|Author|Eric Shulman|
|
||||
|License|http://www.TiddlyTools.com/#LegalStatements|
|
||||
|~CoreVersion|2.1|
|
||||
|Type|plugin|
|
||||
|Description|selectively disable TiddlyWiki's automatic ~WikiWord linking behavior|
|
||||
This plugin allows you to disable TiddlyWiki's automatic ~WikiWord linking behavior, so that WikiWords embedded in tiddler content will be rendered as regular text, instead of being automatically converted to tiddler links. To create a tiddler link when automatic linking is disabled, you must enclose the link text within {{{[[...]]}}}.
|
||||
!!!!!Usage
|
||||
<<<
|
||||
You can block automatic WikiWord linking behavior for any specific tiddler by ''tagging it with<<tag excludeWikiWords>>'' (see configuration below) or, check a plugin option to disable automatic WikiWord links to non-existing tiddler titles, while still linking WikiWords that correspond to existing tiddlers titles or shadow tiddler titles. You can also block specific selected WikiWords from being automatically linked by listing them in [[DisableWikiLinksList]] (see configuration below), separated by whitespace. This tiddler is optional and, when present, causes the listed words to always be excluded, even if automatic linking of other WikiWords is being permitted.
|
||||
|
||||
Note: WikiWords contained in default ''shadow'' tiddlers will be automatically linked unless you select an additional checkbox option lets you disable these automatic links as well, though this is not recommended, since it can make it more difficult to access some TiddlyWiki standard default content (such as AdvancedOptions or SideBarTabs)
|
||||
<<<
|
||||
!!!!!Configuration
|
||||
<<<
|
||||
<<option chkDisableWikiLinks>> Disable ALL automatic WikiWord tiddler links
|
||||
<<option chkAllowLinksFromShadowTiddlers>> ... except for WikiWords //contained in// shadow tiddlers
|
||||
<<option chkDisableNonExistingWikiLinks>> Disable automatic WikiWord links for non-existing tiddlers
|
||||
Disable automatic WikiWord links for words listed in: <<option txtDisableWikiLinksList>>
|
||||
Disable automatic WikiWord links for tiddlers tagged with: <<option txtDisableWikiLinksTag>>
|
||||
<<<
|
||||
!!!!!Revisions
|
||||
<<<
|
||||
2008.07.22 [1.6.0] hijack tiddler changed() method to filter disabled wiki words from internal links[] array (so they won't appear in the missing tiddlers list)
|
||||
2007.06.09 [1.5.0] added configurable txtDisableWikiLinksTag (default value: "excludeWikiWords") to allows selective disabling of automatic WikiWord links for any tiddler tagged with that value.
|
||||
2006.12.31 [1.4.0] in formatter, test for chkDisableNonExistingWikiLinks
|
||||
2006.12.09 [1.3.0] in formatter, test for excluded wiki words specified in DisableWikiLinksList
|
||||
2006.12.09 [1.2.2] fix logic in autoLinkWikiWords() (was allowing links TO shadow tiddlers, even when chkDisableWikiLinks is TRUE).
|
||||
2006.12.09 [1.2.1] revised logic for handling links in shadow content
|
||||
2006.12.08 [1.2.0] added hijack of Tiddler.prototype.autoLinkWikiWords so regular (non-bracketed) WikiWords won't be added to the missing list
|
||||
2006.05.24 [1.1.0] added option to NOT bypass automatic wikiword links when displaying default shadow content (default is to auto-link shadow content)
|
||||
2006.02.05 [1.0.1] wrapped wikifier hijack in init function to eliminate globals and avoid FireFox 1.5.0.1 crash bug when referencing globals
|
||||
2005.12.09 [1.0.0] initial release
|
||||
<<<
|
||||
!!!!!Code
|
||||
***/
|
||||
//{{{
|
||||
version.extensions.DisableWikiLinksPlugin= {major: 1, minor: 6, revision: 0, date: new Date(2008,7,22)};
|
||||
|
||||
if (config.options.chkDisableNonExistingWikiLinks==undefined) config.options.chkDisableNonExistingWikiLinks= false;
|
||||
if (config.options.chkDisableWikiLinks==undefined) config.options.chkDisableWikiLinks=false;
|
||||
if (config.options.txtDisableWikiLinksList==undefined) config.options.txtDisableWikiLinksList="DisableWikiLinksList";
|
||||
if (config.options.chkAllowLinksFromShadowTiddlers==undefined) config.options.chkAllowLinksFromShadowTiddlers=true;
|
||||
if (config.options.txtDisableWikiLinksTag==undefined) config.options.txtDisableWikiLinksTag="excludeWikiWords";
|
||||
|
||||
// find the formatter for wikiLink and replace handler with 'pass-thru' rendering
|
||||
initDisableWikiLinksFormatter();
|
||||
function initDisableWikiLinksFormatter() {
|
||||
for (var i=0; i<config.formatters.length && config.formatters[i].name!="wikiLink"; i++);
|
||||
config.formatters[i].coreHandler=config.formatters[i].handler;
|
||||
config.formatters[i].handler=function(w) {
|
||||
// supress any leading "~" (if present)
|
||||
var skip=(w.matchText.substr(0,1)==config.textPrimitives.unWikiLink)?1:0;
|
||||
var title=w.matchText.substr(skip);
|
||||
var exists=store.tiddlerExists(title);
|
||||
var inShadow=w.tiddler && store.isShadowTiddler(w.tiddler.title);
|
||||
// check for excluded Tiddler
|
||||
if (w.tiddler && w.tiddler.isTagged(config.options.txtDisableWikiLinksTag))
|
||||
{ w.outputText(w.output,w.matchStart+skip,w.nextMatch); return; }
|
||||
// check for specific excluded wiki words
|
||||
var t=store.getTiddlerText(config.options.txtDisableWikiLinksList);
|
||||
if (t && t.length && t.indexOf(w.matchText)!=-1)
|
||||
{ w.outputText(w.output,w.matchStart+skip,w.nextMatch); return; }
|
||||
// if not disabling links from shadows (default setting)
|
||||
if (config.options.chkAllowLinksFromShadowTiddlers && inShadow)
|
||||
return this.coreHandler(w);
|
||||
// check for non-existing non-shadow tiddler
|
||||
if (config.options.chkDisableNonExistingWikiLinks && !exists)
|
||||
{ w.outputText(w.output,w.matchStart+skip,w.nextMatch); return; }
|
||||
// if not enabled, just do standard WikiWord link formatting
|
||||
if (!config.options.chkDisableWikiLinks)
|
||||
return this.coreHandler(w);
|
||||
// just return text without linking
|
||||
w.outputText(w.output,w.matchStart+skip,w.nextMatch)
|
||||
}
|
||||
}
|
||||
|
||||
Tiddler.prototype.coreAutoLinkWikiWords = Tiddler.prototype.autoLinkWikiWords;
|
||||
Tiddler.prototype.autoLinkWikiWords = function()
|
||||
{
|
||||
// if all automatic links are not disabled, just return results from core function
|
||||
if (!config.options.chkDisableWikiLinks)
|
||||
return this.coreAutoLinkWikiWords.apply(this,arguments);
|
||||
return false;
|
||||
}
|
||||
|
||||
Tiddler.prototype.disableWikiLinks_changed = Tiddler.prototype.changed;
|
||||
Tiddler.prototype.changed = function()
|
||||
{
|
||||
this.disableWikiLinks_changed.apply(this,arguments);
|
||||
// remove excluded wiki words from links array
|
||||
var t=store.getTiddlerText(config.options.txtDisableWikiLinksList,"").readBracketedList();
|
||||
if (t.length) for (var i=0; i<t.length; i++)
|
||||
if (this.links.contains(t[i]))
|
||||
this.links.splice(this.links.indexOf(t[i]),1);
|
||||
};
|
||||
//}}}</pre>
|
||||
</div>
|
||||
<div title="Git" creator="RuddO" modifier="RuddO" created="201008081330" tags="fixme" changecount="1">
|
||||
<pre>Not done yet!</pre>
|
||||
</div>
|
||||
|
|
@ -987,16 +1088,17 @@ This will create a folder called {{{cloudstack-oss}}} in your current folder.
|
|||
!Browsing the source code online
|
||||
You can browse the CloudStack source code through [[our CGit Web interface|http://git.cloud.com/cloudstack-oss]].</pre>
|
||||
</div>
|
||||
<div title="Preparing your environment" creator="RuddO" modifier="RuddO" created="201008081133" modified="201009040156" changecount="8">
|
||||
<pre>!Install the build dependencies on the machine where you will compile the CloudStack
|
||||
!!Fedora / CentOS
|
||||
The command [[waf installrpmdeps]] issued from the source tree gets it done.
|
||||
!!Ubuntu
|
||||
The command [[waf installdebdeps]] issues from the source tree gets it done.
|
||||
!!Other distributions
|
||||
See [[CloudStack build dependencies]]
|
||||
!Install the run-time dependencies on the machines where you will run the CloudStack
|
||||
See [[CloudStack run-time dependencies]].</pre>
|
||||
<div title="Preparing your environment" creator="RuddO" modifier="RuddO" created="201008081133" modified="201009040238" changecount="17">
|
||||
<pre>!Install the build dependencies
|
||||
* If you want to compile the CloudStack on Linux:
|
||||
** Fedora / CentOS: The command [[waf installrpmdeps]] issued from the source tree gets it done.
|
||||
** Ubuntu: The command [[waf installdebdeps]] issues from the source tree gets it done.
|
||||
** Other distributions: Manually install the packages listed in [[CloudStack build dependencies]].
|
||||
* If you want to compile the CloudStack on Windows or Mac:
|
||||
** Manually install the packages listed in [[CloudStack build dependencies]].
|
||||
** Note that you won't be able to deploy this compiled CloudStack onto Linux machines -- you will be limited to running the Management Server.
|
||||
!Install the run-time dependencies
|
||||
In addition to the build dependencies, a number of software packages need to be installed on the machine to be able to run certain components of the CloudStack. These packages are not strictly required to //build// the stack, but they are required to run at least one part of it. See the topic [[CloudStack run-time dependencies]] for the list of packages.</pre>
|
||||
</div>
|
||||
<div title="Preserving the CloudStack configuration across source reinstalls" creator="RuddO" modifier="RuddO" created="201008080958" modified="201008080959" changecount="2">
|
||||
<pre>Every time you run {{{./waf install}}} to deploy changed code, waf will install configuration files once again. This can be a nuisance if you are developing the stack.
|
||||
|
|
|
|||
Loading…
Reference in New Issue