diff options
| author |   Denis Kasanic <d.kasanic@partner.samsung.com> | 2019-11-14 12:35:46 +0100 |
|---|---|---|
| committer | Denis Kasanic <d.kasanic@partner.samsung.com> | 2019-11-15 11:35:00 +0000 |
| commit | a7702f2e1721b90a4314af906ca3a8807d199f14 (patch) | |
| tree | 0977a9f644de704c79862de44f8b80a0b1813669 /docs/BuildGuide.rst | |
| parent | 1ed2b6fce2c08867c55786fc4aeebe983f312b4c (diff) | |
Update documentation
Fix several typos in Build and Install parts of docs
Fix paths of configuration files in Install part
Remove note discouraging making changes in config files
Issue-ID: OOM-2158
Issue-ID: OOM-2197
Signed-off-by: Denis Kasanic <d.kasanic@partner.samsung.com>
Change-Id: I28d9b43a56791bc3c1c53c12f7c852f5a1a885c6
Diffstat (limited to 'docs/BuildGuide.rst')
| -rw-r--r-- | docs/BuildGuide.rst | 16 |
1 files changed, 10 insertions, 6 deletions
diff --git a/docs/BuildGuide.rst b/docs/BuildGuide.rst index 27c0835e..01f248ff 100644 --- a/docs/BuildGuide.rst +++ b/docs/BuildGuide.rst @@ -128,14 +128,18 @@ so one might try following command to download most of the required artifacts in :: # following arguments are provided - # all data lists are taken in ./build/data_lists/ folder + # all data lists are taken from ./build/data_lists/ folder # all resources will be stored in expected folder structure within ../resources folder ./build/download/download.py --docker ./build/data_lists/infra_docker_images.list ../resources/offline_data/docker_images_infra \ - --docker ./build/data_lists/rke_docker_images.list \ + --http ./build/data_lists/infra_bin_utils.list ../resources/downloads + + # following docker images do not necessarily need to be stored under resources as they load into repository in next part + # if second argument for --docker is not present, images are just pulled and cached. + # Warning: script must be run twice separately, for more details run download.py --help + ./build/download/download.py --docker ./build/data_lists/rke_docker_images.list \ --docker ./build/data_lists/k8s_docker_images.list \ --docker ./build/data_lists/onap_docker_images.list \ - --http ./build/data_lists/infra_bin_utils.list ../resources/downloads Alternatively, step-by-step procedure is described in Appendix 1. @@ -148,7 +152,7 @@ Part 3. Populate local nexus Prerequisites: - All data lists and resources which are pushed to local nexus repository are available -- Following ports are not occupied buy another service: 80, 8081, 8082, 10001 +- Following ports are not occupied by another service: 80, 8081, 8082, 10001 - There's no docker container called "nexus" .. note:: In case you skipped the Part 2 for the artifacts download, please ensure that the onap docker images are cached and copy of resources data are untarred in *./onap-offline/../resources/* @@ -185,13 +189,13 @@ From onap-offline directory run: :: - ./build/package.py <helm charts repo> --build_version "" --application-repository_reference <commit/tag/branch> --output-dir <target\_dir> --resources-directory <target\_dir> + ./build/package.py <helm charts repo> --build-version <version> --application-repository_reference <commit/tag/branch> --output-dir <target\_dir> --resources-directory <target\_dir> For example: :: - ./build/package.py https://gerrit.onap.org/r/oom --build_version "" --application-repository_reference master --output-dir /tmp/packages --resources-directory /tmp/resources + ./build/package.py https://gerrit.onap.org/r/oom --application-repository_reference master --output-dir /tmp/packages --resources-directory /tmp/resources In the target directory you should find tar files: |