Starting point for ODL Integration

[genesis.git] / fuel / build / README

diff --git a/fuel/build/README b/fuel/build/README
new file mode 100644 (file)
index 0000000..9692f34
--- /dev/null
+++ b/fuel/build/README
@@ -0,0 +1,23 @@
+##############################################################################
+# Copyright (c) 2015 Ericsson 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
+##############################################################################
+
+This purpose of this framework is to:
+
+1)      Build fuel baseline from upstream OpenStack Fuel repos (builds in a docker container to isolate dependencies from host
+        and full re-producability)
+2)      Apply arbitrary changes to the fuel baseline, consistent and non volatile:
+        - Add arbitrary packages with puppet modules for install and config. to be applied on controllers as well as computes.
+        - Change any stack-, or other pack config. using puppet
+        - Apply patches to the baseline.
+        - Etc.
+3)      Re factor/rebuild the .iso image for deployment (also builds in a container, for the same reason as mentioned above)
+4)      Through a pre-deployment script, setting config's not part of the pristine fuel build can be achieved
+
+For detailed instructions on how to add content, configuration, build and deply - please see: DOC/