summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFrank Brockners <fbrockne@cisco.com>2015-03-07 18:38:39 +0100
committerFrank Brockners <fbrockne@cisco.com>2015-03-10 10:27:04 +0000
commit803498b2412e1753d60a9c359fd528ffa54ba580 (patch)
tree288beb2469f5bf80ee60d7d72736474d9753079c
parent6cb518c68eb136ad448e96716ef8b1348440949f (diff)
Initial setup of "common" directory tree
Complement the tree structure that was created by Joseph with a directory tree that is to hold files which are independent from a particular installer approach and as such are common to the OPNFV install and maintenance process: genesis └── common ├── manifests └── tools Directories contain README files that describe their use. Cleaned up trailing whitespaces. Change-Id: Icad2a9e9e64764d8d495f779d73176a36208062e Signed-off-by: Frank Brockners <fbrockne@cisco.com>
-rw-r--r--common/README.md30
-rw-r--r--common/manifests/README.md17
-rw-r--r--common/tools/README.md17
3 files changed, 64 insertions, 0 deletions
diff --git a/common/README.md b/common/README.md
new file mode 100644
index 0000000..537c8ea
--- /dev/null
+++ b/common/README.md
@@ -0,0 +1,30 @@
+<!---
+Copyright 2015 Open Platform for NFV Project, Inc. and its contributors
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+# Common
+This directory contains those files which belong to the "OPNFV-Installation and Maintenance" phase of the installation process.
+
+The OPNFV install process consists of two main phases:
+* **BASE-INSTALLATION:** Installation of plain-vanilla VM-manager (for BGS, OpenStack will be used as VM-Manager)
+ * (repeatable) install of a plain vanilla VM-manager (for BGS this is OpenStack) that deploys to bare metal and supports a HA-setup of the VM-manager
+ * the installation is performed with an installer “i” that creates a system in state BASE(i).
+ * Files which are specific to an installer process are found in the directory of the associated installer approach (e.g. "fuel", "foreman", "opensteak", etc.)
+ * Once the installation of the plain vanilla environment is complete, the installer i is terminated. The system is left in state BASE(i) and handed over to the second phase.
+* **OPNFV-INSTALLATION and MAINTENANCE:** Installation of OPNFV specific modules, maintenance of the overall OPNFV installation
+ * the system state for this second phase is called OPNFV(x) - where x is determined by a particular OPNFV release item.
+ * install deltas to state BASE(i) to reach the desired state OPNFV(x). Deltas would be defined as a set of scripts/manifests. Given that the state BASE(i) differs by installer used, the scripts could also be different. That said, it is a clear objective to make these scripts as generic and independent from the installer used as possible.
+ * maintain the system in state OPNFV(x)
+ * decouple device configuration from orchestration; allow for different tool chains to be used for device configuration and orchestration. I.e. rather than couple device config and orchestration with a single tool such as puppet in master-agent mode, enable a single tool to be focused on config (e.g. puppet in master-less mode) and another one for orchestration (e.g. Ansible/Salt driving upgrade of components, download of particular manifests to the nodes etc.
+
diff --git a/common/manifests/README.md b/common/manifests/README.md
new file mode 100644
index 0000000..2c34e19
--- /dev/null
+++ b/common/manifests/README.md
@@ -0,0 +1,17 @@
+<!---
+Copyright 2015 Open Platform for NFV Project, Inc. and its contributors
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+# Manifests
+Puppet manifests which are common to OPNFV (i.e. independent from the various installer approaches).
diff --git a/common/tools/README.md b/common/tools/README.md
new file mode 100644
index 0000000..e407dd2
--- /dev/null
+++ b/common/tools/README.md
@@ -0,0 +1,17 @@
+<!---
+Copyright 2015 Open Platform for NFV Project, Inc. and its contributors
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+# Tools
+This directory contains tools which are common to OPNFV (i.e. independent from the various installer approaches).