|
| 1 | +--------------------------------------------------------------------- |
| 2 | +TABLE OF CONTENTS |
| 3 | +--------------------------------------------------------------------- |
| 4 | + |
| 5 | + |
| 6 | +1. Really quick start: building and installing a production stack |
| 7 | +2. Post-install: setting the CloudStack components up |
| 8 | +3. Installation paths: where the stack is installed on your system |
| 9 | +4. Uninstalling the CloudStack from your system |
| 10 | + |
| 11 | + |
| 12 | +--------------------------------------------------------------------- |
| 13 | +REALLY QUICK START: BUILDING AND INSTALLING A PRODUCTION STACK |
| 14 | +--------------------------------------------------------------------- |
| 15 | + |
| 16 | + |
| 17 | +You have two options. Choose one: |
| 18 | + |
| 19 | +a) Building distribution packages from the source and installing them |
| 20 | +b) Building from the source and installing directly from there |
| 21 | + |
| 22 | + |
| 23 | +=== I want to build and install distribution packages === |
| 24 | + |
| 25 | +This is the recommended way to run your CloudStack cloud. The |
| 26 | +advantages are that dependencies are taken care of automatically |
| 27 | +for you, and you can verify the integrity of the installed files |
| 28 | +using your system's package manager. |
| 29 | + |
| 30 | +1. As root, install the build dependencies. |
| 31 | + |
| 32 | + a) Fedora / CentOS: ./waf installrpmdeps |
| 33 | + |
| 34 | + b) Ubuntu: ./waf installdebdeps |
| 35 | + |
| 36 | +2. As a non-root user, build the CloudStack packages. |
| 37 | + |
| 38 | + a) Fedora / CentOS: ./waf rpm |
| 39 | + |
| 40 | + b) Ubuntu: ./waf deb |
| 41 | + |
| 42 | +3. As root, install the CloudStack packages. |
| 43 | + You can choose which components to install on your system. |
| 44 | + |
| 45 | + a) Fedora / CentOS: the installable RPMs are in artifacts/rpmbuild |
| 46 | + install as root: rpm -ivh artifacts/rpmbuild/RPMS/{x86_64,noarch,i386}/*.rpm |
| 47 | + |
| 48 | + b) Ubuntu: the installable DEBs are in artifacts/debbuild |
| 49 | + install as root: dpkg -i artifacts/debbuild/*.deb |
| 50 | + |
| 51 | +4. Configure and start the components you intend to run. |
| 52 | + Consult the Installation Guide to find out how to |
| 53 | + configure each component, and "Installation paths" for information |
| 54 | + on where programs, initscripts and config files are installed. |
| 55 | + |
| 56 | + |
| 57 | +=== I want to build and install directly from the source === |
| 58 | + |
| 59 | +This is the recommended way to run your CloudStack cloud if you |
| 60 | +intend to modify the source, if you intend to port the CloudStack to |
| 61 | +another distribution, or if you intend to run the CloudStack on a |
| 62 | +distribution for which packages are not built. |
| 63 | + |
| 64 | +1. As root, install the build dependencies. |
| 65 | + See below for a list. |
| 66 | + |
| 67 | +2. As non-root, configure the build. |
| 68 | + See below to discover configuration options. |
| 69 | + |
| 70 | + ./waf configure |
| 71 | + |
| 72 | +3. As non-root, build the CloudStack. |
| 73 | + To learn more, see "Quick guide to developing, building and |
| 74 | + installing from source" below. |
| 75 | + |
| 76 | + ./waf build |
| 77 | + |
| 78 | +4. As root, install the runtime dependencies. |
| 79 | + See below for a list. |
| 80 | + |
| 81 | +5. As root, Install the CloudStack |
| 82 | + |
| 83 | + ./waf install |
| 84 | + |
| 85 | +6. Configure and start the components you intend to run. |
| 86 | + Consult the Installation Guide to find out how to |
| 87 | + configure each component, and "Installation paths" for information |
| 88 | + on where to find programs, initscripts and config files mentioned |
| 89 | + in the Installation Guide (paths may vary). |
| 90 | + |
| 91 | + |
| 92 | +=== Dependencies of the CloudStack === |
| 93 | + |
| 94 | +- Build dependencies: |
| 95 | + |
| 96 | + 1. FIXME DEPENDENCIES LIST THEM HERE |
| 97 | + |
| 98 | +- Runtime dependencies: |
| 99 | + |
| 100 | + 2. FIXME DEPENDENCIES LIST THEM HERE |
| 101 | + |
| 102 | + |
| 103 | +--------------------------------------------------------------------- |
| 104 | +INSTALLATION PATHS: WHERE THE STACK IS INSTALLED ON YOUR SYSTEM |
| 105 | +--------------------------------------------------------------------- |
| 106 | + |
| 107 | + |
| 108 | +The CloudStack build system installs files on a variety of paths, each |
| 109 | +one of which is selectable when building from source. |
| 110 | + |
| 111 | +- $PREFIX: |
| 112 | + the default prefix where the entire stack is installed |
| 113 | + defaults to /usr/local on source builds |
| 114 | + defaults to /usr on package builds |
| 115 | + |
| 116 | +- $SYSCONFDIR/cloud: |
| 117 | + |
| 118 | + the prefix for CloudStack configuration files |
| 119 | + defaults to $PREFIX/etc/cloud on source builds |
| 120 | + defaults to /etc/cloud on package builds |
| 121 | + |
| 122 | +- $SYSCONFDIR/init.d: |
| 123 | + the prefix for CloudStack initscripts |
| 124 | + defaults to $PREFIX/etc/init.d on source builds |
| 125 | + defaults to /etc/init.d on package builds |
| 126 | + |
| 127 | +- $BINDIR: |
| 128 | + the CloudStack installs programs there |
| 129 | + defaults to $PREFIX/bin on source builds |
| 130 | + defaults to /usr/bin on package builds |
| 131 | + |
| 132 | +- $LIBEXECDIR: |
| 133 | + the CloudStack installs service runners there |
| 134 | + defaults to $PREFIX/libexec on source builds |
| 135 | + defaults to /usr/libexec on package builds (/usr/bin on Ubuntu) |
| 136 | + |
| 137 | + |
| 138 | +--------------------------------------------------------------------- |
| 139 | +UNINSTALLING THE CLOUDSTACK FROM YOUR SYSTEM |
| 140 | +--------------------------------------------------------------------- |
| 141 | + |
| 142 | + |
| 143 | +- If you installed the CloudStack using packages, use your operating |
| 144 | + system package manager to remove the CloudStack packages. |
| 145 | + |
| 146 | + a) Fedora / CentOS: the installable RPMs are in artifacts/rpmbuild |
| 147 | + as root: rpm -qa | grep ^cloud- | xargs rpm -e |
| 148 | + |
| 149 | + b) Ubuntu: the installable DEBs are in artifacts/debbuild |
| 150 | + aptitude purge '~ncloud' |
| 151 | + |
| 152 | +- If you installed from a source tree: |
| 153 | + |
| 154 | + ./waf uninstall |
| 155 | + |
0 commit comments