diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/build-instruction.rst | 16 | ||||
| -rw-r--r-- | docs/configguide/postinstall.rst | 26 |
2 files changed, 37 insertions, 5 deletions
diff --git a/docs/build-instruction.rst b/docs/build-instruction.rst index b7b13c896..1bfc8bed6 100644 --- a/docs/build-instruction.rst +++ b/docs/build-instruction.rst @@ -41,6 +41,9 @@ Version history | | | (Ericsson AB) | for plugin build | | | | | selection | +--------------------+--------------------+--------------------+----------------------+ +| 2016-01-20 | 1.2.1 | Daniel Smith | Minor updates for | +| | | (Ericsson AB) | docker requirements | ++--------------------+--------------------+--------------------+----------------------+ Introduction ============ @@ -66,6 +69,8 @@ Minimum Hardware Requirements - An x86_64 host (Bare-metal or VM) with Ubuntu 14.04 LTS installed + - Note: Builds on Wily (Ubuntu 15.x) are not supportted currently + - ~30 GB available disc - 4 GB RAM @@ -77,9 +82,9 @@ The build host should run Ubuntu 14.04 operating system. On the host, the following packages must be installed: -- docker - see https://docs.docker.com/installation/ubuntulinux/ for +- docker - see https://docs.docker.com/engine/installation/ubuntulinux/ for installation notes for Ubuntu 14.04. Note: only use the Ubuntu stock - distro of Docker (docker.io) + distro of Docker (docker-engine). Tested against ver 1.9.x and greater - git (simply available through sudo apt-get install git) @@ -94,16 +99,17 @@ Setting up the Docker build container ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ After having installed Docker, add yourself to the docker group: -<usermod -a -G docker [userid]> +<sudo usermod -a -G docker [userid]> Also make sure to define relevant DNS servers part of the global dns chain in -in your </etc/default/docker> configuration file, for example: +in your </etc/default/docker> configuration file. Uncomment, modify the values appropriately +and save and quit the file. For example: <DOCKER_OPTS=" --dns=8.8.8.8 --dns=8.8.8.4"> Then restart docker: -<sudo service docker.io restart> +<sudo service docker restart> Setting up OPNFV Gerrit in order to being able to clone the code ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/configguide/postinstall.rst b/docs/configguide/postinstall.rst new file mode 100644 index 000000000..1702cea5f --- /dev/null +++ b/docs/configguide/postinstall.rst @@ -0,0 +1,26 @@ +<Project> post installation procedures +====================================== +Add a brief introduction to the methods of validating the installation +according to this specific installer or feature. + +Automated post installation activities +-------------------------------------- +Describe specific post installation activities performed by the OPNFV +deployment pipeline including testing activities and reports. Refer to +the relevant testing guides, results, and release notes. + +note: this section should be singular and derived from the test projects +once we have one test suite to run for all deploy tools. This is not the +case yet so each deploy tool will need to provide (hopefully very simillar) +documentation of this. + +<Project> post configuration procedures +-------------------------------------- +Describe any deploy tool or feature specific scripts, tests or procedures +that should be carried out on the deployment post install and configuration +in this section. + +Platform components validation +--------------------------------- +Describe any component specific validation procedures necessary for your +deployment tool in this section. |