Differences

This shows you the differences between two versions of the page.

--- apex:integration_guide [2015/12/23 21:56]
Tim Rozet
+++ apex:integration_guide [2016/01/22 17:03] (current)
Dan Radez [Building Apex]
@@ Line 5: / Line 5: @@
 To get a good overview of the terms that describe an Apex deployment and the target architecture of what is deployed please review the Installation Instructions. [[http://artifacts.opnfv.org/apex/docs/installation-instructions/installation-instructions.html | Apex Installation Instructions]]
-===== Building Apex =====
+===== Building and Deploying Apex for Development =====
+Building and Deploying Apex for development is a set of instructions to build and deploy out of the code repository in order to iterate quickly over building and deploying. If you are interested in deploying OPNFV Apex on a system to evaluate or use please use the Installation Documentation released with our official builds or skip to the section "Building Apex to produce Packages" for installable packages.
+<code>
+$ cd ~
+$ git clone https://gerrit.opnfv.org/gerrit/p/apex.git
+$ cd apex/build
+$ make instack-clean
+$ make instack
+$ cd ../ci
+$ ./clean.sh
+$ ./deploy.sh -v --no-ha -c ~/apex/build/ -r ~/apex/build/stack/ \
+-n ~/apex/config/deploy/network/network_settings.yaml -d ~/apex/config/deploy/deploy_settings.yaml
+</code>
+  * -v means virtual
+  * --no-ha means use a single controller and single compute node
+  * -c and -r point to configuration and resource directories. This indicates the deploy to use the locally built images from `make instack`
+  * -d and -n are settings files that are discussed more in the installation instructions documentation.
+Network_settings.yaml can be left as it is for a virtual deployment\\
+Look though the catalog of files in apex/config/deploy to choose the flavor of deployment you would like. There are a collection of SDN controllers and features that can be enabled or swapped out. You can also just edit the stock deploy_settings.yaml if you would like.
+===== Building Apex to produce Packages =====
+Building Apex to produce packages will produce a set of RPMs that should be installed following the Installation Instructions distributed with OPNFV Apex.
+<code>
+$ git clone https://gerrit.opnfv.org/gerrit/p/apex.git
+$ cd apex/ci
+$ ./build -v {build-version} -c file:///{cache-storage-location}
+</code>
+RPMS will be put in the build/noarch directory.
+{build-version} is an RPM release number compatible identifier. This is used in both the RPM release value and to name the ISO.\\
+{cache-storage-location} is where the 7-10G cache file will be stored between builds
+===== Build process details =====
 There are a collection of files executed during build that are helpful to understand. Not all files used in build are listed here, these are the primary files.
@@ Line 30: / Line 68: @@
   * a new user will be autocreated named stack (this is for awareness only, no action required)
   * disk images, a centos iso, the Apex RPMs and iso and a build cache will all be written to disk which average around 80G of space at the time of this doc being written.
-Steps to build:
-<code>
-$ git clone https://gerrit.opnfv.org/gerrit/p/apex.git
-$ cd apex/ci
-$ ./build -v {build-version} -c file:///{cache-storage-location}
-</code>
-{build-version} is an RPM release number compatible identifier. This is used in both the RPM release value and to name the ISO.\\
-{cache-storage-location} is where the 7-10G cache file will be stored between builds
 === What happens during build in the instack.sh file ===
@@ Line 63: / Line 91: @@
 Once the RPM is built the CentOS installation DVD is downloaded, exploded, modified adding the Apex RPM and updating the installation configuration files for the OS and the ISO is rebuilt with the updated contents.
 ===== Apex Feature Integration =====

Wiki

User Tools

Site Tools

Differences

Page Tools