summaryrefslogtreecommitdiffstats
path: root/ci/README
diff options
context:
space:
mode:
Diffstat (limited to 'ci/README')
-rw-r--r--ci/README39
1 files changed, 19 insertions, 20 deletions
diff --git a/ci/README b/ci/README
index 46698a739..898442559 100644
--- a/ci/README
+++ b/ci/README
@@ -1,5 +1,5 @@
##############################################################################
-# Copyright (c) 2015 Ericsson AB and others.
+# Copyright (c) 2017 Ericsson AB, Mirantis Inc., Enea Software AB and others.
# stefan.k.berg@ericsson.com
# jonas.bjurel@ericsson.com
# All rights reserved. This program and the accompanying materials
@@ -12,14 +12,13 @@ Abstract
========
The fuel/ci directory holds all Fuel@OPNFV programatic abstractions for
the OPNFV community release and continous integration pipeline.
-There are two Fuel@OPNF autonomous scripts fo this, complying to the OPNFV CI pipeline guideline:
- - build.sh
+There is now only one Fuel@OPNFV autonomous script for this, complying to the
+OPNFV CI pipeline guideline:
- deploy.sh
USAGE
=====
For usage information of the CI/CD scripts, please run:
-./build.sh -h
./deploy.sh -h
Details on the CI/CD deployment framework
@@ -28,35 +27,31 @@ Details on the CI/CD deployment framework
Overview and purpose
--------------------
The CI/CD deployment script relies on a configuration structure, providing base
-installer configuration (part of fuel repo: deploy/config), per POD specific
+installer configuration (part of fuel repo: mcp/config), per POD specific
configuration (part of a separate classified POD configuration repo: securedlab
-, plugin configuration (part of fuel repo: deploy/config/plugins), and
-deployment scenario configuration (part of fuel repo: deploy/scenario).
+and deployment scenario configuration (part of fuel repo: mcp/config/scenario).
- The base installer configuration resembles the least common denominator of all
- HW/POD environment and deployment scenarios (These configurations are
- normally carried by the the installer projects in this case (fuel@OPNFV).
+ HW/POD environment and deployment scenarios. These configurations are
+ normally carried by the the installer projects in this case (Fuel@OPNFV).
- Per POD specific configuration specifies POD unique parameters, the POD
parameter possible to alter is governed by the Fuel@OPNFV project.
-- Plugin configuration - providing configuration of a specific plugin.
- these configurations maintain there own namespace and are normally maintained
- by collaborative projects building Fuel@OPNFV plugins
- Deployment scenario configuration - provides a high level, POD/HW environment
independent scenario configuration for a specifiv deployment. It defines what
- features/plugins that shall be deployed - as well needed overrides of the base
- installer-, POD/HW environment- configurations. Objects allowed to override
- is governed by the Fuel@OPNFV project.
+ features shall be deployed - as well needed overrides of the base
+ installer, POD/HW environment configurations. Objects allowed to override
+ are governed by the Fuel@OPNFV project.
Executing a deployment
----------------------
deploy.sh must be executed locally at the target lab/pod/jumpserver
A configuration structure must be provided - see the section below.
It is straight forward to execute a deployment task - as an example:
-sudo deploy.sh -b file:///home/jenkins/config -l LF-1 -p POD-2 -s
-os_odl-l2_ha -i file:///home/jenkins/MyIso.iso
+$ sudo deploy.sh -b file:///home/jenkins/config \
+ -l lf -p pod2 -s os-nosdn-nofeature-ha
-b and -i arguments should be expressed in URI style (eg: file://...
-or http://.... The resources can thus be local or remote.
+or http://...). The resources can thus be local or remote.
Configuration repository structure
----------------------------------
@@ -68,9 +63,13 @@ remote strcture fullfilling the diectory/file structure below.
The reason that this configuration structure needs to be secure/hidden
is that there are security sensitive information in the various configuration
files.
+
+FIXME: Below information is out of date and should be refreshed after PDF
+support is fully implemented.
+
A local stripped version of this configuration structure with virtual
deployment configurations also exist under build/config/.
-Following configuration directory and file structure should be adheare to:
+Following configuration directory and file structure should adheare to:
TOP
!
@@ -98,4 +97,4 @@ TOP
Creating a deployment scenario
------------------------------
Please find deploy/scenario/README for instructions on how to create a new
-deployment scenario. \ No newline at end of file
+deployment scenario.