@@ -18,52 +18,56 @@ Introduction
1818------------
1919
2020The official CloudStack release is always in source code form. You will
21- likely be able to find "convenience binaries," the source is the
22- canonical release. In this section, we'll cover acquiring the source
23- release and building that so that you can deploy it using Maven or
24- create Debian packages or RPMs .
21+ likely be able to find "convenience binaries", where the source is the
22+ canonical release. In this section, we will cover acquiring and building
23+ the source release so that you can deploy using Maven or
24+ build packages for distribution (e.g. `` .deb ``, `` .rpm ``) .
2525
26- Note that building and deploying directly from source is typically not
27- the most efficient way to deploy an IaaS. However, we will cover that
28- method as well as building RPMs or Debian packages for deploying
29- CloudStack.
26+ .. note ::
27+
28+ Building and deploying directly from source is typically not
29+ the most efficient way to deploy CloudStack. Also, please be aware that
30+ development branches may contain unstable code. If you run into any issues
31+ during the build process, please check the CloudStack `Issues
32+ <https://github.com/apache/cloudstack/issues> `_ page on GitHub. You may find
33+ that the issue you are experiencing has already been reported.
3034
31- The instructions here are likely version-specific. That is, the method
32- for building from source for the 4.7.x series is different from the
33- 4.2.x series.
35+ The instructions here are likely version-specific (i.e. Building 4.7.x
36+ is different from building 4.2.x).
3437
35- If you are working with a unreleased version of CloudStack, see the
36- INSTALL.md file in the top-level directory of the release.
38+ If you are working with an unreleased version of CloudStack, please read the
39+ `` INSTALL.md `` file in the top-level directory of the release.
3740
3841
39- Downloading the release
42+ Downloading the Release
4043-----------------------
4144
4245You can download the latest CloudStack release from the `Apache
43- CloudStack project download page
46+ CloudStack project download page
4447<http://cloudstack.apache.org/downloads.html> `_.
4548
46- Prior releases are available via archive.apache.org as well. See the
47- downloads page for more information on archived releases.
49+ Prior releases are available via `archive.apache.org
50+ <https://archive.apache.org> `_ as well. Please see the
51+ Downloads page for more information on archived releases.
4852
49- You'll notice several links under the ' Latest release' section. A link
50- to a file ending in ``tar.bz2 ``, as well as a PGP/GPG signature, MD5,
53+ You will notice several links under the * Latest CloudStack Releases * section.
54+ A link to a file ending in ``tar.bz2 ``, as well as a PGP/GPG signature, MD5,
5155and SHA512 file.
5256
53- - The ``tar.bz2 `` file contains the Bzip2 -compressed tarball with the
57+ - The ``tar.bz2 `` file contains the bzip2 -compressed tarball with the
5458 source code.
5559
5660- The ``.asc `` file is a detached cryptographic signature that can be
57- used to help verify the authenticity of the release .
61+ used to verify release authenticity.
5862
59- - The ``.md5 `` file is an MD5 hash of the release to aid in verify the
60- validity of the release download .
63+ - The ``.md5 `` file is a MD5 hash that can be used to verify release
64+ authenticity .
6165
62- - The ``.sha `` file is a SHA512 hash of the release to aid in verify
63- the validity of the release download .
66+ - The ``.sha `` file is a SHA512 hash that can be used to verify release
67+ authenticity .
6468
6569
66- Verifying the downloaded release
70+ Verifying the Downloaded Release
6771--------------------------------
6872
6973There are a number of mechanisms to check the authenticity and validity
@@ -202,7 +206,7 @@ Make sure to activate the repository for MySQL connectors.
202206.. parsed-literal ::
203207
204208 sudo apt-get update
205- sudo apt-get install mysql-connector-python
209+ sudo apt-get install mysql-connector-python
206210
207211 .. note ::
208212
@@ -250,7 +254,7 @@ several other dependencies. Note that we recommend using Maven 3.
250254 $ sudo apt-get install python-software-properties
251255 $ sudo apt-get update
252256 $ sudo apt-get install debhelper openjdk-11-jdk libws-commons-util-java genisoimage libcommons-codec-java libcommons-httpclient-java liblog4j1.2-java maven
253-
257+
254258 .. note ::
255259
256260 If on Ubuntu 18.04, in above command, please replace "python-software-properties" with "software-properties-common"
@@ -397,10 +401,10 @@ You can now move on to the instructions under Install on Ubuntu.
397401Building RPMs from Source
398402-------------------------
399403
400- As mentioned previously in `“Prerequisites for building Apache CloudStack”
401- <#prerequisites-for-building-apache-cloudstack> `_, you will need to install
404+ As mentioned previously in `“Prerequisites for building Apache CloudStack”
405+ <#prerequisites-for-building-apache-cloudstack> `_, you will need to install
402406several prerequisites before you can build packages for CloudStack. Here we'll
403- assume you're working with a 64-bit build of CentOS or Red Hat Enterprise
407+ assume you're working with a 64-bit build of CentOS or Red Hat Enterprise
404408Linux.
405409
406410.. parsed-literal ::
@@ -449,16 +453,16 @@ minutes.
449453
450454.. note ::
451455
452- Packaging has changed. If you've created packages for CloudStack
453- previously, you should be aware that the process has changed considerably
454- since the project has moved to using Apache Maven. Please be sure to follow
456+ Packaging has changed. If you've created packages for CloudStack
457+ previously, you should be aware that the process has changed considerably
458+ since the project has moved to using Apache Maven. Please be sure to follow
455459 the steps in this section closely.
456460
457461
458462Generating RPMS
459463~~~~~~~~~~~~~~~
460464
461- Now that we have the prerequisites and source, you will cd to the
465+ Now that we have the prerequisites and source, you will cd to the
462466`packaging/ ` directory.
463467
464468.. parsed-literal ::
@@ -470,7 +474,7 @@ Generating RPMs is done using the ``package.sh`` script:
470474.. parsed-literal ::
471475
472476 $ ./package.sh -d centos63
473-
477+
474478 For other supported options(like centos7), run ``./package.sh --help ``
475479
476480That will run for a bit and then place the finished packages in
@@ -537,19 +541,19 @@ to build from source.
537541
538542.. warning ::
539543
540- Some of the plugins supported by CloudStack cannot be distributed with
541- CloudStack for licensing reasons. In some cases, some of the required
542- libraries/JARs are under a proprietary license. In other cases, the
543- required libraries may be under a license that's not compatible with
544- `Apache's licensing guidelines for third-party products
544+ Some of the plugins supported by CloudStack cannot be distributed with
545+ CloudStack for licensing reasons. In some cases, some of the required
546+ libraries/JARs are under a proprietary license. In other cases, the
547+ required libraries may be under a license that's not compatible with
548+ `Apache's licensing guidelines for third-party products
545549 <http://www.apache.org/legal/resolved.html#category-x> `_.
546550
547551#. To build the Non-OSS plugins, you'll need to have the requisite JARs
548552 installed under the ``deps `` directory.
549553
550554 Because these modules require dependencies that can't be distributed
551555 with CloudStack you'll need to download them yourself. Links to the
552- most recent dependencies are listed on the `*How to build CloudStack*
556+ most recent dependencies are listed on the `*How to build CloudStack*
553557 <https://cwiki.apache.org/confluence/display/CLOUDSTACK/How+to+build+CloudStack> `_
554558 page on the wiki.
555559
@@ -567,6 +571,5 @@ to build from source.
567571 $ mvn install -Dnoredist
568572
569573 #. Once you've built CloudStack with the ``noredist `` profile, you can
570- package it using the `“Building RPMs from Source” <#building-rpms-from-source >`_
574+ package it using the `“Building RPMs from Source” <#building-rpms-from-source >`_
571575 or `“Building DEB packages” <#building-deb-packages >`_ instructions.
572-
0 commit comments