| Table of Contents |
|---|
The following table lists tables list the tools required for OpenECOMP developmentused in ONAP development. This is intended for reference. For instructions on installing theseclient tools and preparing to access the server-based tools, see Setting Up the EnvironmentYour Development Environment.
Client-Based Tools
These tools are installed on your client development system.
| Tool Name | URL | Description | ||
| Git client | https://www.atlassian.com/git-scm/tutorials/install-git | Client for distributed source control system. The download referenced here includes the command-line tool Git Bash. | ||
| IntelliJ | Distributed source control system. | SonarOne of several possible Java development environments. (The IntelliJ Community Edition is open source.) Uses the Java SDK. | ||
| Java SDK | http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html | Required for Java builds | ||
| Maven | http://maven.apache.org/download.cgi | command-line tool for building Java (and other) programs Install maven 3.3.3+ as 3.2.x may have issues with an ODL certificate name mismatch | ||
| PuTTY | http://www.putty.org/ | Remote SSH terminal; also, a public/private key generator. | ||
| Python (optional) | Script engine needed by some components (select add python to your path in the installer) | |||
| other tools | https://confluence.atlassian.com/get-started-with-sourcetree/install-sourcetree-847359094.html | See the Development Guides for specific additional tools required by different subsystems. Example tools include: nodejs, node-gyp (which in turn requires Python v.2.7.x and GCC), grunt-cli, and bower. SourceTree from Atlassian is a git shell for windows/mac | ||
| Docker | https://docs.docker.com/engine/installation/linux/centos/#install-using-the-repository | Required to build dcae-inventory (create the images) | ||
| Kubernetes | https://kubernetes.io/docs/tasks/tools/install-kubectl/ https://kubernetes.io/docs/tasks/tools/install-minikube/ | Future only | ||
| Postman | https://chrome.google.com/webstore/detail/postman/fhbjgbiflinjbdggehcddcbncdddomop?hl=en | Exercise REST endpoints like the following examples in Verifying your ONAP Deployment#Postman/CurlRESTcalls |
Server-Based Tools and Repositories
These tools and repositories are server-based. Some are accessed via a browser with no setup, other than obtaining a login and password. Others may require you to set environment variables, create private encryption keys, or make settings within client tools.
| Tool Name | URL | Description | ||||||
| Confluence | https://wiki.onap.org | ONAP Development Wiki, which you are looking at now. Used to provide project documentation, guidelines, and other information. | ||||||
| Insights | LFX Insights | A metrics dashboard reporting on multiple aspects of community development and engagement. | ||||||
| Gerrit server | https:// | sonargerrit. | openecomponap.org/ | OpenECOMP Sonar server, will hold Sonar metrics computed by each component builds | Gerrit code review server, hosting the Git repositories as well as controlling access, push, and review of new code. It also hosts the Jenkins job configuration in a Git repository that follows the same workflow. | |||
| Identity portal | https://identity.linuxfoundation.org/ | registering portal : controls user account and group management. | ||||||
| Jenkins Master | https://jenkins.onap.org/ | ONAP Jenkins Master host, this host will only serve as a 'Display' as most of the jobs will be executed by 'minions' (slave hosts which are defined by using the Jenkins configuration repository in Gerrit). | ||||||
| JIRA | https://jira.onap.org/ | ONAP JIRA instance, used to track issues, releases, stories... | ||||||
| Nexus 2Nexus 3 | https://nexus3nexus.openecomponap.org/ | OpenECOMP ONAP Nexus 3 2 repository, this repo will hold Docker containers Maven2 artifacts produced by OpenECOMP builds. builds (both Release and Snapshot, also Javadoc-mavensite), Access is automatically provided to builds by the maven settings on the Jenkins Master, see Jenkins job for more details. User should be able to access and browse artifacts through this URL. | ||||||
| Nexus | 23 | https:// | nexusnexus3. | openecomponap.org/ | OpenECOMPONAP Nexus | 2 3 repository, this repo will hold | Maven2 artifacts Docker containers produced by | builds (both Release and Snapshot, also Javadoc-mavensite), ONAP builds. Access is automatically provided to builds by the maven settings on the Jenkins Master, see Jenkins job for more details. User should be able to access and browse artifacts through this URL. |
| JIRA | https://jira.openecomp.org/ | OpenECOMP JIRA instance, used to track issues, releases, stories... | ||||||
| Jenkins Master | https://jenkins.openecomp.org/ | OpenECOMP Jenkins Master host, this host will only serve as a 'Display' as most of the Jobs will be executed by 'minions' (slave hosts. which are defined by using the jenkins configuration repository in Gerrit. | ||||||
| Identity portal | https://identity.linuxfoundation.org/ | registering portal : controls user account and group management. | ||||||
| Gerrit server | https://gerrit.openecomp.org/ | Gerrit code review server, hosting the OpenECOMP git repositories as well as controlling access, push, review of new code Also host the jenkins job configuration in a git repository that is following the same workflow (see Gerrit Workflow below). | ||||||
There are three hosted repositories:
The release repository contains the docker images at specific release cuts. The snapshot repository contains daily docker image builds. The staging repository contains docker images before a release cut. When approved, docker images in the staging repository are moved to the release repository. There is an additional repository, nexus3.onap.org:10001, which is a proxy to the hosted repositories. By logging into the proxy repository, it is possible to access all the docker images contained in release, snapshot and staging repository. Also, from the proxy repository it is possible to access public docker images that are used in ONAP, such as MariaDB, HBASE, Cassandra, etc. Access to hosted and proxy repositories is regulated by username and password:
These credentials provide read-only access to repositories. This is the only account that will work for community members to be able to access docker images. How to download a docker image
| ||||||||
| Sonar | ONAP Sonar server, will hold Sonar metrics computed by component builds | |||||||
| Read the Docs | https://docs.onap.org/ | Formal ONAP documentation | Confluence | https://wiki.openecomp.org | OpenECOMP Development Wiki, used to provide project documentation, guidelines, and other information. |