Page History

...

	<proxies>
        <proxy>
            <id>evil-corp-http</id>
            <active>true</active>
            <protocol>http</protocol>
            <host>proxy.evil-corp.com</host>
            <port>599</port>
            <nonProxyHosts>localhost|127.0.0.1|*.evil-corp.com|*.happy.evil-corp.com|fun.evil-corp.com</nonProxyHosts>
        </proxy>
        <proxy>
            <id>evil-corp-https</id>
            <active>true</active>
            <protocol>https</protocol>
            <host>proxy.evil-corp.com</host>
            <port>599</port>
            <nonProxyHosts>localhost|127.0.0.1|*.evil-corp.com|*.happy.evil-corp.com|fun.evil-corp.com</nonProxyHosts>
        </proxy>
	</proxies>

OS Specific Instructions

MAC/OSX  (

...

in review under 10.15.7)

/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

Redhat/CentOS (

...

in review under RHEL 8.3)

sudo curl https://releases.rancher.com/install-docker/17.03.sh | sh

sudo wget https://github.com/stedolan/jq/releases/download/jq-1.5/jq-linux64 -O jq
sudo chmod 777 jq
# not +x or jq will not be runnable from your non-root user
sudo mv jq /usr/local/bin
jq --version

sudo usermod -aG docker ubuntu

Ubuntu (to be reviewed/updated by an Ubuntu user )

...

apt-get update

apt-get install ubuntu-desktop

...

vi /etc/network/interfaces

add

iface enp0s25 inet static

address 192.168.15.101

netmask 255.255.255.0

network 192.168.15.0

broadcast 192.168.15.255

gateway 192.168.15.1

dns-nameservers 8.8.4.4

...

in ~/.ssh/config

Host *
   StrictHostKeyChecking no
   UserKnownHostsFile=/dev/null

...

Enable non CD repositories so an apt-get update will work

...

sudo passwd root

sudo usermod -U root

sudo reboot now

sudo vi /etc/lightdm/lightdm.conf

[SeatDefaults]

greeter-session=unity-greeter

user-session=ubuntu

greeter-show-manual-login=true

: enable root login

vi /etc/ssh/sshd_config

FROM:
PermitRootLogin prohibit-password
TO:
PermitRootLogin yes

systemctl restart sshd

...

in /etc/environment

-Djava.net.preferIPv4Stack=true

...

use the current as of 20180621 17.03 version in the script
https://git.onap.org/logging-analytics/tree/deploy/rancher/oom_rancher_setup.sh
which is

curl https://releases.rancher.com/install-docker/17.03.sh | sh

Connecting to ONAP Gerrit

SSH Connection (Recommended)

Log in to the Gerrit host https://gerrit.onap.org/, pull down the menu under your user name (at the extreme top right of the browser window), click on "Settings":

Click your account name on the top right corner of the website and click on Settings.

Add the public ssh key that you created in the previous step.

HTTPS Connection

Problem running 'git remote update gerrit'
Fetching gerrit
fatal: unable to access 'https://USERNAME@gerrit.onap.org/r/a/mso/ ': Unknown SSL protocol error in connection to gerrit.onap.org:443 error: Could not fetch gerrit 

Proxy setting for IntelliJ and Git (if required)

...

For developers working with a proxy, you might have proxy issues connecting to Linux Foundation website. To avoid the connection issue, you must define the proxy setting for both IntelliJ and Git.

To configure the proxy settings in IntelliJ;

click File -> Settings -> Appearance & Behavior -> System Settings -> HTTP Proxy

 enter the correct proxy settings and click Apply.

In case of Manual proxy configuration, while entering the Host name, there is no need to write http:// in front of the URL. For example, if the proxy value is http://one.proxy.com, you would put one.proxy.com as the Host name

To configure the proxy settings for Git, play the following command:

git config --global https.proxy https://<proxy username>:<proxy password>@<proxy url> 

git config --global http.proxy http://<proxy username>:<proxy password>@<proxy url>

Note: while entering the proxy username, sometimes it may require to add the domain name in front.

to install kubernetes follow Cloud Native Deployment#Scriptedundercloud(Helm/Kubernetes/Docker)andONAPinstall-SingleVM

Ubuntu (in review under 20.04 )

in ~/.ssh/config

Host *
   StrictHostKeyChecking no
   UserKnownHostsFile=/dev/null

sudo passwd root

vi /etc/ssh/sshd_config

FROM:
PermitRootLogin prohibit-password
TO:
PermitRootLogin yes

curl https://releases.rancher.com/install-docker/17.03.sh | sh

Connecting to ONAP Gerrit

SSH Connection (Recommended)

Log in to the Gerrit host https://gerrit.onap.org/, pull down the menu under your user name (at the extreme top right of the browser window), click on "Settings":

Click your account name on the top right corner of the website and click on Settings.

Add the public ssh key that you created in the previous step.

HTTPS Connection

Problem running 'git remote update gerrit'
Fetching gerrit
fatal: unable to access 'https://USERNAME@gerrit.onap.org/r/a/mso/ ': Unknown SSL protocol error in connection to gerrit.onap.org:443 error: Could not fetch gerrit 

Proxy setting for IntelliJ and Git (if required)

git config --global https.proxy https://<proxy username>:<proxy password>@<proxy url> 

git config --global http.proxy http://<proxy username>:<proxy password>@<proxy url>

IDEs

Eclipse

Install Eclipse

Download and run the installer from: Install Eclipse. Select "Eclipse IDE for Java Developers" to install.

ONAP Eclipse Java Formatter 

Download onap-java-formatter.xml and import into Eclipse. 

(updates to the settings should be committed and merged back into the repository)

ONAP uses Google Java Style with some modifications. ( See Java code style )

            <plugins>
                <!--
                Using https://code.revelc.net/formatter-maven-plugin/ for Eclipse formatter
                Using https://github.com/diffplug/spotless/tree/master/plugin-maven for import order
                Use in combination to rewrite code and imports, then checkstyle
  

IDEs

Eclipse

Install Eclipse

Download and run the installer from: Install Eclipse. Select "Eclipse IDE for Java Developers" to install.

ONAP Eclipse Java Formatter 

Download onap-java-formatter.xml and import into Eclipse. 

(updates to the settings should be committed and merged back into the repository)

ONAP uses Google Java Style with some modifications. ( See Java code style )

            <plugins>
  
              <!--
  mvn formatter:format spotless:apply process-sources
           Using https://code.revelc.net/formatter-maven-plugin/ for Eclipse formatter     -->
                Using https://github.com/diffplug/spotless/tree/master/plugin-maven for import order<plugin>
                Use in combination to rewrite code and imports, then checkstyle<groupId>net.revelc.code.formatter</groupId>
                
      <artifactId>formatter-maven-plugin</artifactId>
          mvn formatter:format spotless:apply process-sources
        <version>2.8.1</version>
        -->
             <configuration>
   <plugin>
                     <groupId>net<configFile>${project.revelc.code.formatter</groupId>parent.basedir}/onap-java-formatter.xml</configFile>
                     <artifactId>formatter-maven-plugin</artifactId></configuration>
                     <version>2.8.1</version>
 <!-- https://code.revelc.net/formatter-maven-plugin/
                     <configuration>
     use mvn formatter:format to rewrite source files
             <configFile>${project.parent.basedir}/onap-java-formatter.xml</configFile>
             use mvn formatter:validate to validate source   </configuration>files -->
                 </plugin>
    <!-- https://code.revelc.net/formatter-maven-plugin/
           <plugin>
               use mvn formatter:format to rewrite source files
 <groupId>com.diffplug.spotless</groupId>
                  <artifactId>spotless-maven-plugin</artifactId>
           use mvn formatter:validate to validate source files -->
 <version>1.18.0</version>
                  </plugin><configuration>
                <plugin>
       <java>
           <groupId>com.diffplug.spotless</groupId>
           <importOrder>
       <artifactId>spotless-maven-plugin</artifactId>
                  <version>1.18.0</version><order>com,java,javax,org</order>
                  <configuration>
   </importOrder>
                 <java>
   </java>
                  <importOrder></configuration>
                <!-- https://github.com/diffplug/spotless/tree/master/plugin-maven
      <order>com,java,javax,org</order>
               use mvn spotless:apply to rewrite source </importOrder>files
                    </java>
 use mvn spotless:check to validate source            </configuration>files -->
                <!-- https://github.com/diffplug/spotless/tree/master/plugin-maven/plugin>
            </plugins>

mvn formatter:format        use mvn spotless:apply to rewrite source files
                     use mvn spotless:check to validate source files -->
                </plugin>
            </plugins>

mvn formatter:format spotless:apply spotless:apply process-sources

Install useful plugins for Eclipse

...

============LICENSE_START=======================================================
 Copyright (C) $today.year <organization name>
 ================================================================================
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at
  
       http://www.apache.org/licenses/LICENSE-2.0
 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
  
 SPDX-License-Identifier: Apache-2.0
 ============LICENSE_END=======================================================================

IntelliJ

Download & Install

see https://www.jetbrains.com/idea/download/#section=windows

...

=

IntelliJ

Download & Install

see https://www.jetbrains.com/idea/download/#section=windows

Make sure you have added the Checkstyle plugin . Follow the below link

https://plugins.jetbrains.com/plugin/1065-checkstyle-idea

Configure ONAP code CheckStyle Plugin for IntelliJ

1. Select, File, Settings, Tools, Checkstyle  
2. Click on + beside the 'Configuration File' box to add a configuration
3. Set description to something like 'ONAP Rules'
4. Click on Browse to select the file <your_git_folder>/oparent/checkstyle/src/main/resources/onap-checkstyle/onap-java-style.xml  
   (assuming you have downloaded the oparent repo)
5. Complete the Wizard (you can set exclusion properties if needed)
6. Select the Configuration File you just added by selecting the relevant checkbox
7. Click [OK] to close the settings popup

Configure ONAP code style auto formatting for IntelliJ (using the same checkstyle rules and automating it for you )

1. Select, File, Settings, ToolsEditor, Checkstyle  Code Style
2. Click on + beside the 'Configuration File' box to add a configuration
3. Set description to something like 'ONAP Rules'
4. the gear icon at the end of the line for "Scheme:"
5. Optional: As importing a schema overrides the current scheme you might want to first use the 'Duplicate..' and  'Rename...' options to create an easily identifiable scheme e.g. 'ONAP Standard'
6. Import Scheme→Checkstyle Configuration
7. Click on Browse to select the file <your_git_folder>/oparent/checkstyle/src/main/resources/onap-checkstyle/onap-java-style.xml  
   (assuming you have downloaded the oparent repo)
8. Complete the Wizard (you can set exclusion properties if needed)
9. Select the Configuration File you just added by selecting the relevant checkbox
10. Click [OK] to close the settings popupClick OK

Configure ONAP copyright for IntelliJ

...

• You need to be part of the onap organization in GitHub (see GitHub, click on your icon and select 'My Organizations')
  If you are not a member of this organization email support.linuxfoundation.org  and ask to be added to the onap organization in GitHub
  Note. It is possible to enter a different organization if you at least member of 1 organization (you can create your own in GitHub).
  The plugin wizard crashes if you are member of no organization at all, see this Bug: https://jira.sonarsource.com/browse/SLI-426
• Make sure you have added the SonarLint plugin

To use SonarLint with Onap projects you need to setup a connection with SonarCloud

...

1. Select, File, Settings, Tools, SonarLint, Project Settings
2. Enable (check) 'Binfd Bind project to SonarQube / SonarCloud'
3. Select the connection created above using the [Configure the connection] button
4. Enter the project name (e.g. 'onap_ccsdk-sli-plugins') or select it using [Search in list..] 
5. Start typing the name of your project, and it should appear in a list box where it should be selected.
6. Click [OK] to finish

...

Install "pip3", if you plan to use git-review.

sudo apt-get update

sudo apt-get -y install python3-pip

pip3 --version

git-review (optional)

In a shell, type the following command (assumes you installed python above) :  

...