Update the FAQs
[so.git] / docs / developer_info / FAQs.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. Copyright 2018 Huawei Technologies Co., Ltd.
4
5 Frequently Asked Questions SO
6 =============================
7
8 Casablanca Release throws java.sql.SQLDataException: (conn:85) Data too long for column 'RESOURCE_INPUT' at row 1
9 -----------------------------------------------------------------------------------------------------------------
10     
11   This issue could be solved either using the SO-1.3.7 release or through a manual patch to update the lenght of the column 'RESOURCE_INPUT'.
12   
13   Following are the sql statements to update length of resource_input:
14         
15         use catalogdb;
16         
17         ALTER TABLE vnf_resource_customization
18         MODIFY IF EXISTS RESOURCE_INPUT varchar(20000);
19         
20         ALTER TABLE network_resource_customization
21         MODIFY IF EXISTS RESOURCE_INPUT varchar(20000);
22         
23         ALTER TABLE allotted_resource_customization
24         MODIFY IF EXISTS RESOURCE_INPUT varchar(20000);
25         
26         in so mariadb pod (username/password root/password)
27
28 Integrate SO with MultiCloud
29 ----------------------------
30 .. toctree::
31    :maxdepth: 1
32
33    SOMCIntegrate.rst
34
35 Building Block Understanding
36 ----------------------------
37 .. toctree::
38    :maxdepth: 1
39
40    BBUnderstanding.rst
41
42 How to Build software without unit tests
43 ----------------------------------------
44
45 .. code-block:: bash
46
47   cd $HOME/onap/workspace/SO/libs
48
49   $HOME/onap/apache-maven-3.3.9/bin/mvn -s $HOME/onap/.m2/settings.xml -DskipTests -Dmaven.test.skip=true clean install
50
51   cd $HOME/onap/workspace/SO/so
52
53   $HOME/onap/apache-maven-3.3.9/bin/mvn -s $HOME/onap/.m2/settings.xml -DskipTests -Dmaven.test.skip=true clean install
54
55 How to Build docker images
56 --------------------------
57
58 SO docker images are built using the "docker" maven profile.  
59
60 During the build, the chef-repo and so-docker repositories are cloned from gerrit into the "so" directory structure.  Extra definitions are required in the build environment to make this happen.   You may need to adjust the definition of mso.chef.git.url.prefix to match the way you authenticate yourself when performing git clone.
61
62 If you are behind a corporate firewall, you can specify proxy definitions for the constructed docker images.
63
64 **Remove existing docker containers and images**
65
66 .. code-block:: bash
67
68   docker stop $(docker ps -qa)
69
70   docker rm $(docker ps -aq)
71
72   docker rmi -f $(docker images -q)
73
74 **Build docker images (without proxy definition):**
75
76 .. code-block:: bash
77
78   cd $HOME/onap/workspace/SO/so/packages
79
80   $HOME/onap/apache-maven-3.3.9/bin/mvn -s $HOME/onap/.m2/settings.xml clean install -P docker
81   -Dmso.chef.git.url.prefix=ssh://$USER@gerrit.onap.org:29418 -Dmso.chef.git.branchname=master
82   -Dmso.chef.git.url.suffix.chef.repo=so/chef-repo -Dmso.chef.git.url.suffix.chef.config=so/so-config
83   -Ddocker.buildArg.http_proxy=http://one.proxy.att.com:8080
84   -Ddocker.buildArg.https_proxy=http://one.proxy.att.com:8080
85
86 **Build docker images (with proxy definition):**
87
88 .. code-block:: bash
89
90   cd $HOME/onap/workspace/SO/so/packages
91   
92   $HOME/onap/apache-maven-3.3.9/bin/mvn -s $HOME/onap/.m2/settings.xml clean install -P docker
93   -Dmso.chef.git.url.prefix=ssh://$USER@gerrit.onap.org:29418 -Dmso.chef.git.branchname=master
94   -Dmso.chef.git.url.suffix.chef.repo=so/chef-repo -Dmso.chef.git.url.suffix.chef.config=so/so-config
95   -Ddocker.buildArg.http_proxy=http://proxyhost:port -Ddocker.buildArg.https_proxy=http://proxyhost:port
96
97 How to Build with Integration Tests
98 -----------------------------------
99
100 This is done exactly as described for building docker images, except that the maven profile to use is "with-integration-tests" instead of "docker".  Integration tests are executed inside docker containers constructed by the build.
101
102