aboutsummaryrefslogtreecommitdiffstats
path: root/ci/README
diff options
context:
space:
mode:
authorAlexandru Avadanii <Alexandru.Avadanii@enea.com>2017-09-10 01:11:23 +0200
committerAlexandru Avadanii <Alexandru.Avadanii@enea.com>2017-09-11 01:06:23 +0000
commit6fb970627653a5ae6293db6ef36b5a836e98769d (patch)
treebf2cb1a28f6e52e0ba863414c4e98a1cf6c2753e /ci/README
parent91312836e649c24d2d0268f1f5c8aa45fdd79a8d (diff)
Add & fix licensing in README.rst files, align ext
Rename all variations of README files to README.rst. Fix license headers according to OPNFV Contribution Guidelines [1]. Markdown syntax will be switched to rst in an ulterior change. [1] https://wiki.opnfv.org/display/DEV/Contribution+Guidelines Change-Id: I2c71fd62b38f218545507c79c39e07dbd35f7c88 Signed-off-by: Alexandru Avadanii <Alexandru.Avadanii@enea.com>
Diffstat (limited to 'ci/README')
-rw-r--r--ci/README100
1 files changed, 0 insertions, 100 deletions
diff --git a/ci/README b/ci/README
deleted file mode 100644
index 898442559..000000000
--- a/ci/README
+++ /dev/null
@@ -1,100 +0,0 @@
-##############################################################################
-# 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
-# are made available under the terms of the Apache License, Version 2.0
-# which accompanies this distribution, and is available at
-# http://www.apache.org/licenses/LICENSE-2.0
-##############################################################################
-
-Abstract
-========
-The fuel/ci directory holds all Fuel@OPNFV programatic abstractions for
-the OPNFV community release and continous integration pipeline.
-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:
-./deploy.sh -h
-
-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: mcp/config), per POD specific
-configuration (part of a separate classified POD configuration repo: securedlab
-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).
-- Per POD specific configuration specifies POD unique parameters, the POD
- parameter possible to alter is governed by the Fuel@OPNFV project.
-- Deployment scenario configuration - provides a high level, POD/HW environment
- independent scenario configuration for a specifiv deployment. It defines what
- 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 -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.
-
-Configuration repository structure
-----------------------------------
-The CI deployment engine relies on a configuration directory/file structure
-pointed to by the -b option described above.
-Normally this points to the secure classified OPNFV securedlab repo to which
-only jenkins and andmins have access to, but you may point to any local or
-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 adheare to:
-
-TOP
-!
-+---- labs
- !
- +---- lab-name-1
- ! !
- ! +---- pod-name-1
- ! ! !
- ! ! +---- fuel
- ! ! !
- ! ! +---- config
- ! ! !
- ! ! +---- dea-pod-override.yaml
- ! ! !
- ! ! +---- dha.yaml
- ! !
- ! +---- pod-name-2
- ! !
- !
- +---- lab-name-2
- ! !
-
-
-Creating a deployment scenario
-------------------------------
-Please find deploy/scenario/README for instructions on how to create a new
-deployment scenario.