@@ -18,52 +18,53 @@ 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.
3031
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.
32+ The instructions here are likely version-specific (i.e. Building 4.7.x
33+ is different from building 4.2.x).
3434
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.
35+ If you are working with an unreleased version of CloudStack, please read the
36+ `` INSTALL.md `` file in the top-level directory of the release.
3737
3838
39- Downloading the release
39+ Downloading the Release
4040-----------------------
4141
4242You can download the latest CloudStack release from the `Apache
43- CloudStack project download page
43+ CloudStack project download page
4444<http://cloudstack.apache.org/downloads.html> `_.
4545
46- Prior releases are available via archive.apache.org as well. See the
47- downloads page for more information on archived releases.
46+ Prior releases are available via `archive.apache.org
47+ <https://archive.apache.org> `_ as well. Please see the
48+ Downloads page for more information on archived releases.
4849
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,
50+ You will notice several links under the * Latest CloudStack Releases * section.
51+ A link to a file ending in ``tar.bz2 ``, as well as a PGP/GPG signature, MD5,
5152and SHA512 file.
5253
53- - The ``tar.bz2 `` file contains the Bzip2 -compressed tarball with the
54+ - The ``tar.bz2 `` file contains the bzip2 -compressed tarball with the
5455 source code.
5556
5657- The ``.asc `` file is a detached cryptographic signature that can be
57- used to help verify the authenticity of the release .
58+ used to verify release authenticity.
5859
59- - The ``.md5 `` file is an MD5 hash of the release to aid in verify the
60- validity of the release download .
60+ - The ``.md5 `` file is a MD5 hash that can be used to verify release
61+ authenticity .
6162
62- - The ``.sha `` file is a SHA512 hash of the release to aid in verify
63- the validity of the release download .
63+ - The ``.sha `` file is a SHA512 hash that can be used to verify release
64+ authenticity .
6465
6566
66- Verifying the downloaded release
67+ Verifying the Downloaded Release
6768--------------------------------
6869
6970There are a number of mechanisms to check the authenticity and validity
@@ -202,7 +203,7 @@ Make sure to activate the repository for MySQL connectors.
202203.. parsed-literal ::
203204
204205 sudo apt-get update
205- sudo apt-get install mysql-connector-python
206+ sudo apt-get install mysql-connector-python
206207
207208 .. note ::
208209
@@ -250,7 +251,7 @@ several other dependencies. Note that we recommend using Maven 3.
250251 $ sudo apt-get install python-software-properties
251252 $ sudo apt-get update
252253 $ sudo apt-get install debhelper openjdk-11-jdk libws-commons-util-java genisoimage libcommons-codec-java libcommons-httpclient-java liblog4j1.2-java maven
253-
254+
254255 .. note ::
255256
256257 If on Ubuntu 18.04, in above command, please replace "python-software-properties" with "software-properties-common"
@@ -397,10 +398,10 @@ You can now move on to the instructions under Install on Ubuntu.
397398Building RPMs from Source
398399-------------------------
399400
400- As mentioned previously in `“Prerequisites for building Apache CloudStack”
401- <#prerequisites-for-building-apache-cloudstack> `_, you will need to install
401+ As mentioned previously in `“Prerequisites for building Apache CloudStack”
402+ <#prerequisites-for-building-apache-cloudstack> `_, you will need to install
402403several 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
404+ assume you're working with a 64-bit build of CentOS or Red Hat Enterprise
404405Linux.
405406
406407.. parsed-literal ::
@@ -449,16 +450,16 @@ minutes.
449450
450451.. note ::
451452
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
453+ Packaging has changed. If you've created packages for CloudStack
454+ previously, you should be aware that the process has changed considerably
455+ since the project has moved to using Apache Maven. Please be sure to follow
455456 the steps in this section closely.
456457
457458
458459Generating RPMS
459460~~~~~~~~~~~~~~~
460461
461- Now that we have the prerequisites and source, you will cd to the
462+ Now that we have the prerequisites and source, you will cd to the
462463`packaging/ ` directory.
463464
464465.. parsed-literal ::
@@ -470,7 +471,7 @@ Generating RPMs is done using the ``package.sh`` script:
470471.. parsed-literal ::
471472
472473 $ ./package.sh -d centos63
473-
474+
474475 For other supported options(like centos7), run ``./package.sh --help ``
475476
476477That will run for a bit and then place the finished packages in
@@ -537,19 +538,19 @@ to build from source.
537538
538539.. warning ::
539540
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
541+ Some of the plugins supported by CloudStack cannot be distributed with
542+ CloudStack for licensing reasons. In some cases, some of the required
543+ libraries/JARs are under a proprietary license. In other cases, the
544+ required libraries may be under a license that's not compatible with
545+ `Apache's licensing guidelines for third-party products
545546 <http://www.apache.org/legal/resolved.html#category-x> `_.
546547
547548#. To build the Non-OSS plugins, you'll need to have the requisite JARs
548549 installed under the ``deps `` directory.
549550
550551 Because these modules require dependencies that can't be distributed
551552 with CloudStack you'll need to download them yourself. Links to the
552- most recent dependencies are listed on the `*How to build CloudStack*
553+ most recent dependencies are listed on the `*How to build CloudStack*
553554 <https://cwiki.apache.org/confluence/display/CLOUDSTACK/How+to+build+CloudStack> `_
554555 page on the wiki.
555556
@@ -567,6 +568,5 @@ to build from source.
567568 $ mvn install -Dnoredist
568569
569570 #. Once you've built CloudStack with the ``noredist `` profile, you can
570- package it using the `“Building RPMs from Source” <#building-rpms-from-source >`_
571+ package it using the `“Building RPMs from Source” <#building-rpms-from-source >`_
571572 or `“Building DEB packages” <#building-deb-packages >`_ instructions.
572-
0 commit comments