Initial rearrangements for the OPNFV/opnfvdoc documentation structure including LOW level READMEs, LICENCEs, and TODOs.

JIRA:

Change-Id: Ifd2baa5b1db3ae0fb354e39548eb7f9547639581
Signed-off-by: Jonas Bjurel <jonas.bjurel@ericsson.com>

6 files changed, 0 insertions, 314 deletions

diff --git a/fuel/build/DOC/BUILD/README.architecture b/fuel/build/DOC/BUILD/README.architecture
deleted file mode 100644
index 4629763..0000000
--- a/fuel/build/DOC/BUILD/README.architecture
+++ /dev/null
@@ -1,10 +0,0 @@
-##############################################################################
-# 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
-##############################################################################
-
diff --git a/fuel/build/DOC/BUILD/README.build b/fuel/build/DOC/BUILD/README.build
deleted file mode 100644
index b8ce799..0000000
--- a/fuel/build/DOC/BUILD/README.build
+++ /dev/null
@@ -1,98 +0,0 @@
-##############################################################################
-# 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
-##############################################################################
-
-How to setup and use the OPNFV/BGS/FUEL build system
-====================================================
-
-1. Build system requirements
-----------------------------
-1.1 Host HW/VM requirements
----------------------------
-- An x86_64 host (real iron or VM) with Ubuntu 14.04 LTS installed
-- ~30 GB available disc
-- 4 GB RAM
-
-1.2 Host SW dependencies
-------------------------
-The host should run Ubuntu 14.04
-On the host, the following packages must be installed:
-- docker - see https://docs.docker.com/installation/ubuntulinux/ for installation notes
-for Ubuntu 14.04. Note: only use the Ubuntu stock distro of Docker (docker.io)
-- git (simply available through apt-get install git)
-- make (simply available through apt-get install make)
-- curl
-
-2 Setting up the Docker build container
-----------------------------------------
-When having installed Docker, add yourself to the docker group:
-usermod -a -G docker <userid>
-
-Also make sure to define rellevant dns servers part of the global dns chain in
-in your /etc/default/docker config file, eg.
-DOCKER_OPTS=" --dns=8.8.8.8 --dns=8.8.8.4"
-
-Then restart docker with "service docker.io restart".:
-
-3. Setting up OPNFV Gerrit in order to being able to clone the code
--------------------------------------------------------------------
-- Start by creating a SSH key, if you don't already have one, create one with ssh-keygen
-
-- Add your generated public key in OPNFV Gerrit -https://gerrit.opnfv.org/
-  (this requires a linuxfoundation account, create one if you do not already have one)
-
-- Select "SSH Public Keys" to the left and then "Add Key" and paste your public key in.
-
-4. Clone the OPNFV code git repository
---------------------------------------
- So now we're coming to the fun part! Let's clone the code repository:
- git clone ssh://<Linux foundation user>@gerrit.opnfv.org:29418/genesis
-
- Change the directory to "fuel-build"
- cd fuel-build/
-
-5. Set up (build) your build environment
-----------------------------------------
-Select the versions of the components you want to build by editing the
-fuel-build/config-spec file. Note if you want to build with OpenDaylight
-SDN controller you need to uncomment the lines starting with odl-main and
-java-main
-
-6. Build your fuel .iso image
------------------------------
-That's it, time to build!
-make [all]
-
-This will:
-- If not allready existing, initialize the docker build environment
-- If not already done, build OpenDaylight from upstream (as defined by fuel-build/
-  config-spec)
-- If not already done, build fuel from upstream (as defined by fuel-build/config-spec)
-- Build the defined additions to fuel (as defined by the structure of this framework)
-- Apply changes and patches to fuel (as defined by the structure of this framework)
-- Reconstruct a fuel .iso image
-
-If the build is successful, you will find the generated ISO file in the release
-subdirectory!
-
-NOTE: the build of the baseline for Fuel and odl are cached, if build results reffering
-to the same versions as specified in fuel-build/config spec has been built before, these
-packages will not be rebuilt. The cache is cleared by "make clean"
-
-7. Install your stack
----------------------
-Please see DOC/INSTALL/README
-
-NOTES and TODO:
----------------
-The build system will for now partly run as sudo
-BUT NOTE, NONE OF THE MAKEFILES OR SCRIPTS SHALL BE EXECUTED WITH
-SUDO/ROOT PRIVILEDGES!
-TODO: Change the scripts so that no root priviledges will be needed
-
diff --git a/fuel/build/DOC/BUILD/README.examples b/fuel/build/DOC/BUILD/README.examples
deleted file mode 100644
index 4629763..0000000
--- a/fuel/build/DOC/BUILD/README.examples
+++ /dev/null
@@ -1,10 +0,0 @@
-##############################################################################
-# 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
-##############################################################################
-
diff --git a/fuel/build/DOC/INSTALL/README b/fuel/build/DOC/INSTALL/README
deleted file mode 100644
index 456e26d..0000000
--- a/fuel/build/DOC/INSTALL/README
+++ /dev/null
@@ -1,154 +0,0 @@
-##############################################################################
-# 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 README file describes how to install the OPNFV BGS Stack
-=============================================================
-1.1 Install Fuel Server
------------------------
-1. Mount the built .iso file (release/opnfv-<version>.iso) as a bootdevice to the fuel server.
-
-2. Reboot the fuel server.
-   The system now boots from the ISO image.
-
-3. Change the grub boot params
-   When Press Tab to edit . is shown press Tab.
-   Change showmenu=no to showmenu=yes.
-   Change netmask=255.255.255.0 to netmask=255.255.0.0.
-   Press Enter.
-
-4  Wait until screen Fuel setup . is shown.
-   Note: This takes about 30 minutes.
-
-5. Select PXE Setup and change the following fields to appropriate values (example below):
-   Static Pool Start 10.20.0.3
-   Static Pool End 10.20.0.254
-   DHCP Pool Start 10.20.128.3
-   DHCP Pool End 10.20.128.254
-
-6. Select DNS & Hostname and change the following fields to appropriate values:
-   Hostname <CEE Region name>-fuel
-   Domain <Domain Name>
-   Search Domain <Search Domain Name>
-   Hostname to test DNS <Hostname to test DNS>
-
-7. Select Time Sync and change the following fields to appropriate values:
-   NTP Server 1 <Customer NTP server 1>
-   NTP Server 2 <Customer NTP server 2>
-   NTP Server 3<Customer NTP server 3>
-   Note: This step is only to pass the network test, the actual ntp parameters will be set with the pre_deply script.
-
-8. Start the installation.
-   Select Quit Setup and press Save and Quit.
-   Installation starts, wait until a screen with logon credentials is shown.
-   Note: This takes about 15 minutes.
-
-10. Enable PXE Booting and put it first in the bios boot order menu.
-
-11. Reboot the controller- and compute blades.
-
-12. Connect to Fuel wit a browser towards port 8000
-
-13. Create and name a new OpenStack environment, to be installed.
-
-14. Select Icehouse on Ubuntu . in field OpenStack Release.
-
-15. Select deployment mode.
-    Select the Multi-node with HA.
-
-16. Select compute node mode.
-    Select KVM as hypervisor.
-
-17. Select network mode.
-    Select Neutron with VLAN segmentation.
-
-18. Select Storage Backends.
-    Select Ceph for Cinder and default for glance.
-
-
-19. Select additional services.
-    Check option Install Celiometer (OpenStack Telemetry).
-
-20. Create the new environment.
-
-21. Wait for availability nodes.
-    Wait until all nodes are displayed in top right in <total number of server> TOTAL NODES and <total number of servers> UNALLOCATED NODES.
-
-22. Open the created environment.
-
-23. Open the networks tab.
-
-24. Update the public configuration.
-    Change the following fields to appropriate values:
-    IP Range Start to <Public IP Address start>
-    IP Range End to <Public IP Address end>
-    CIDR to <CIDR for Public IP Addresses>
-    Gateway to <Gateway for Public IP Addresses>
-    Check  VLAN tagging.
-    Set appropriate VLAN id.
-
-25. Update the management configuration.
-    Set CIDR to 172.16.255.128/25.
-    Check VLAN tagging.
-    Set appropriate  VLAN id.
-
-26. Update the storage configuration.
-    Set CIDR to the appropriate value
-    Check VLAN tagging.
-    Set appropriate VLAN id.
-
-27. Update the Neutron L2 configuration.
-    Set VLAN ID range.
-
-28. Update the Neutron L3 configuration.
-    Set Internal network CIDR to an appropriate value
-    Set Internal network gateway to an appropriate value
-    Set Floating IP ranges.
-    Set DNS Servers
-
-29. Save Settings.
-
-30. Click "verify network" to check the network set-up
-
-31. Update storage configuration.
-
-32. Open the nodes tab.
-
-33. Assign roles.
-    Check Controller and Telemetry . MongoDB.
-    Check three nodes to be installed as Controller in pane Assign Role.
-    Click Apply Changes.
-    Check Compute.
-    Check nodes to be installed as Compute nodes in pane Assign Role.
-    Click Apply Changes.
-
-34. Configure interfaces.
-    Check Select All to select all nodes with Control, Telemetry . MongoDB and Compute node roles.
-    Click Configure Interfaces.
-    Screen Configure interfaces on number of <number of nodes> nodes is shown.
-    Assign interfaces (bonded) for mgmt-, admin-, private-, public- and storage networks
-
-35. Run the pre-deploy script.
-    Log on as root to the Fuel node.
-    Print Fuel environment Id (fuel env)
-    #> id | status | name | mode | release_id | changes <id>| new | <CEE Region name>| ha_compact | 2 | <ite specific information>
-
-36. Run the pre-deployment script (/opt/opnfv/pre-deploy.sh <id>)
-    As prompted for-, set the DNS servers to go into /etc/resolv.conf.
-    As prompted for-, set any Hosts file additions for controllers and compute nodes. You will be prompted for name, FQDN and IP for each entry. Press return when prompted for a name when you have completed your input.
-    As prompted for-, set NTP upstream configuration for controllers. You will be prompted for a NTP server each entry. Press return when prompted for a NTP server when you have completed your input.
-
-37. Deploy the environment.
-    In the Fuel GUI, click Deploy Changes.
-
-38 Verify the OpenStack Environment
-   Open the Health Check tab .
-   Select Select All.
-   Click Run tests.
diff --git a/fuel/build/RELEASENOTES b/fuel/build/RELEASENOTES
deleted file mode 100644
index 76b4208..0000000
--- a/fuel/build/RELEASENOTES
+++ /dev/null
@@ -1,32 +0,0 @@
-##############################################################################
-# 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 patch introduces the following features and bug fixes:
------------------------------------------------------------
-1) The OpenDaylight SDN server - unplumbed (config.mk needs to be changed
-   in order to enable it, see: fuel-build/DOC/BUILD/README.build)
-2) cofig-spec - a way to configure the stack component versions
-   to be built - see the fuel-build/config.mk file
-3) A simplified Docker build startegy, pulling a pre-fabricated
-   docker base image from the Internet
-
-NOTE: Before you start building - you need to purge any previous
-"opnfv.org/ubuntu-builder" docker image: "sudo docker rmi -f opnfv.org/ubuntu-builder
-Double check that you dont have any remaining "opnfv.org/ubuntu-builder" images by
-"docker images".
-A new docker image will automatically be rebuilt in the build process.
-
-Limitations and known issues:
------------------------------
-1) OpenDaylight is for now just sitting in the controllers, not plumbed to anything
-   northbound or southbound.
-2) OpenDaylight is currently only building with Oracle Java JDK, that is Oracle Java
-   is used in the build process while OpenJava is used in the runtime environment.
-   Read the licencing obligations in /fuel-build/LICENCE before you start building.
diff --git a/fuel/build/TODO b/fuel/build/TODO
deleted file mode 100644
index 897a7e8..0000000
--- a/fuel/build/TODO
+++ /dev/null
@@ -1,10 +0,0 @@
-############################################
-# Contributors/version/date
-# jonas.bjurel@ericsson.com 0.1 2015.01.28
-############################################
-Following items needs to be done to achieve an OPNFV/BGS R1 Stack:
-1) Rebase to Fuel 6.0/6.1 - DONE
-2) Add support for CentOS 6.5 - REMAINING
-3) Add build-support and manifests for Open daylight Ubuntu and CentOS
-   - Initial build and deployment of ODL/Helium - DONE
-   - Configuration and plumbing - IN PROGRESS
\ No newline at end of file