...
Follow the instructions on the identity portal to create a Linux Foundation account and get access to the OpenECOMP Gerrit instance. Then verify that you can log in at https://gerrit.openecomp.org/ and that you can see the OpenECOMP list of repositories.
Unix Setup
Redhat/CentOS
...
set JAVA_HOME in ~/.bashrc
...
yum install java-1.8.0-openjdk-devel
get it via alternatives --config javac
...
yum install git
yum groupinstall 'Development Tools'
...
download and install Maven 3.5.0
create an ~/.m2 folder and copy our settings.xml there
add maven to your path - check it with mvn --version
...
http://maven.apache.org/download.cgi
tar -xvf apache-maven-3.5.0-bin.tar.gz
...
Mac/OSX
get your MBP 2016 ready for development
generate keys - either ssh-add the key or rename it as id_rsa and put it into your ~/.ssh dir
Install the JDK (as dmg) - http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html
Install homebrew package manager -
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
python should already be installed. - do a --version check
install pip - sudo easy_install pip
install openstack tools
install docker (dmg) - https://docs.docker.com/docker-for-mac/install/#download-docker-for-mac
install maven - apache-maven-3.5.0-bin.tar, create and ~./m2 and place settings.xml there
git comes with Xcode or Homebrew - do a --version check
Unix Setup
Redhat/CentOS
set JAVA_HOME in ~/.bashrc | yum install java-1.8.0-openjdk-devel get it via alternatives --config javac |
install git and development tools | yum install git yum groupinstall 'Development Tools' |
install |
Ubuntu 16.04
set JAVA_HOME in ~/.bashrc | install git and development tools | install npm (will also be installed automatically by the ecomp build) | |
download and install Maven 3.5.0 create an ~/.m2 folder and copy our settings.xml there add maven to your path - check it with mvn --version | http://maven.apache.org/download.cgi tar -xvf apache-maven-3.5.0-bin.tar.gz | ||
Add the following option to your MAVEN_OPTS in order not to periodically hang on downloading artifacts in linux | -Djava.net.preferIPv4Stack=true | ||
Install docker (required for some repos like dcae-inventory off dcae | sudo aptyum install -y yum-utils sudo yum-config-manager --add-repository 'deb repo https://aptdownload.dockerproject.org/repo ubuntu-xenial main' sudo apt-key adv --keyserver hkp://p80.pool.sks-keyservers.net:80 --recv-keys 58118E89F3A912897C070ADBF76221572C52609D sudo apt-get update apt-cache policy docker-engine sudo apt-get install -y docker-engine docker ps |
...
<<TODO: describe a Linux client set-up for Git and git-review>>
To install git-review on Linux (Ubuntu), type the following command.
sudo apt-get install git-review
Windows Setup
Note: The DCAE and SDC repo will not fully clone in a windows environment (even git-bash) until some file paths are reduced below 255 chars -
Jira | ||||||
---|---|---|---|---|---|---|
|
Jira | ||||||
---|---|---|---|---|---|---|
|
Enabling long paths in windows - thanks Michael Lando
git config --system core.longpaths true |
---|
Installing Git
To install Git on your client, visit: https://www.atlassian.com/git/tutorials/install-git, and download the appropriate installation image for your host. Once downloaded, execute the installation script ("open" the .msi file).
During installation, you will see the following dialog box. Include the "Git Bash" and "Git GUI" components (this is the default).To do this, leave the following boxes checked:
If you intend to type Git commands from the Windows Command Prompt, leave the default setting for adjusting the PATH environment:
The repositories use Unix-style line-feed for line termination, so on your windows Git client, select the conversion option:
Select the following option based on your own preference (non-default shown, so 'winpty' is not required):
Choose the defaults here:
The installer lets you choose the experimental 'difftool'; either choice will work. Continue with the installation dialogs until the installation is complete.
Install Python on Windows (optional)
Not all components require Python for development. See the documentation for your component in the Development Guides section. (Note: the "node-gyp" tool requires Python.)
Download Python version 2.7.10:
...
sudo yum-config-manager --enable docker-ce-edge sudo yum makecache fast sudo yum install docker-ce sudo systemctl start docker |
Ubuntu 16.04
set JAVA_HOME in ~/.bashrc | |
install git and development tools | |
install npm (will also be installed automatically by the ecomp build) | |
download and install Maven 3.5.0 create an ~/.m2 folder and copy our settings.xml there add maven to your path - check it with mvn --version | http://maven.apache.org/download.cgi tar -xvf apache-maven-3.5.0-bin.tar.gz |
Add the following option to your MAVEN_OPTS in order not to periodically hang on downloading artifacts in linux | -Djava.net.preferIPv4Stack=true |
Install docker (required for some repos like dcae-inventory off dcae | sudo apt-add-repository 'deb https://apt.dockerproject.org/repo ubuntu-xenial main' |
Install git-review
<<TODO: describe a Linux client set-up for Git and git-review>>
To install git-review on Linux (Ubuntu), type the following command.
sudo apt-get install git-review
Windows Setup
Note: The DCAE and SDC repo will not fully clone in a windows environment (even git-bash) until some file paths are reduced below 255 chars -
Jira | ||||||
---|---|---|---|---|---|---|
|
Jira | ||||||
---|---|---|---|---|---|---|
|
Enabling long paths in windows - thanks Michael Lando
git config --system core.longpaths true |
---|
Installing Git
To install Git on your client, visit: https://www.
...
...
...
...
tutorials/install-git, and download the appropriate installation image for your host. Once downloaded, execute the installation script ("open" the .msi file).
During installation, you will see the following dialog box. Include the "Git Bash" and "Git GUI" components (this is the default).To do this, leave the following boxes checked:
If you intend to type Git commands from the Windows Command Prompt, leave the default setting for adjusting the PATH environment:
The repositories use Unix-style line-feed for line termination, so on your windows Git client, select the conversion option:
Select the following option based on your own preference (non-default shown, so 'winpty' is not required):
Choose the defaults here:
The installer lets you choose the experimental 'difftool'; either choice will work. Continue with the installation dialogs until the installation is complete.
Install Python on Windows (optional)
Not all components require Python for development. See the documentation for your component in the Development Guides section. (Note: the "node-gyp" tool requires Python.)
Download Python version 2.7.10:
Execute the install file that you just downloaded. (You must have administrative privileges.) During installation, select "Add python.exe to Path", overriding the default setting. Also, be sure to install "pip" (this is the default).
Continue with the installation until it is completed.
Set up Git review and Configure Git
Run Git Bash as Administrator (for example, in Windows 10, use the Windows menu, scroll to the Git directory, right-click on Git-bash, and select "Run as administrator":
Within Git Bash, type the following command:
$ pip install git-review
To use git review
, you have to be in a Git clone directory that already contains a (possibly hidden) .gitreview
configuration file (see Gerrit/Advanced usage#Setting up a repository for git-remote), otherwise you will get the error message UnboundLocalError: local variable 'no_git_dir' referenced before assignment.
Info |
---|
The Git and git-review installation steps above are derived from the description at: https://www.mediawiki.org/wiki/Gerrit/git-review#Windows |
Configure Git to remember your Linux Foundation user name and email address (the user name and email address associated with your Linux Foundation login):
git config --global user.email <your_LF_account_email>
git config --global --add gitreview.username
<your_LF_user_name>
If you are using VPN, you might encounter a proxy problem while connecting to the Linux Foundation website. To avoid the problem, you should add the proxy setting in git config, using 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: When entering the proxy username, you might be required to add the domain name in front of the username.
Install Putty and Generate Keys
Info |
---|
An alternate method for creating public and private keys, without using PuTTY, is given here: https://help.github.com/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/ |
Info |
---|
If you already have keys registered with PuTTY, skip this section. |
PuTTY is a terminal emulator that uses Secure SHell (SSH) to communicate with a host. You need to install PuTTY in order to create a public/private encryption key pair. This pair of keys enables Git to communicate securely with the repositories.
To install PuTTY, visit, www.putty.org and follow the links to the appropriate Windows installation for your machine (32-bit or 64 bit). The downloaded file will be named putty-0.67-installer.msi
or the like.
Execute the .msi
file. Use all the default settings, thereby ensuring that you will install pageant.exe
, plink.exe
, and puttygen.exe
.
Generate Public and Private Keys
OSX
ssh-keygen -t rsa |
---|
Windows
The puttygen
utility, installed with putty
, generates public and private keys used for secure communication with Gerrit.
Info |
---|
You should execute |
To do this, right-click on C:\Program Files (x86)\PuTTY\puttygen.exe
and select Run as Administrator:
Answer "Yes" to the User Account Control challenge. Then click the "Generate" button in the puttygen window. puttygen will ask you to move your mouse over its dialog box to generate random seed bits. After it has computed a public key, it will display a dialog box resembling the following:
If you want to edit this key pair in the future, create a text file containing a short phrase, called a "passphrase". Copy and paste this passphrase into the "Key passphrase" and "Confirm passphrase" lines, then select "Save public key" and choose a filename (e.g. public.txt
); also "Save private key" and choose another filename (e.g. private.ppk
). Since you ran puttygen
as Administrator, the files are visible to Windows Explorer.
Close puttygen
.
Load Your Private Key Into Pageant
Pageant is an SSH authentication agent. It holds your private keys in memory, already decoded, so that you can use them often without needing to type a passphrase.
To load your private key into pageant
, right-click on the private key file (e.g. private.ppk
in this example), and select Load into pageant
:
This action not only loads private.ppk
into pageant, but also starts pageant if it is not already running. You will be prompted for the passphrase that you entered into puttygen
when you created the key. If successful, pageant will load the key without further interaction.
Panel | ||
---|---|---|
| ||
You can right-click on this icon to perform actions with pageant, including "View Keys" (which brings up a dialog box that allows you to add or remove keys.) The "Add Key" button offers another way to enter your private key into pegeant: after clicking on "Add Key", select the file containing your private key (for example, |
Set the GIT_SSH Environment Variable
From the Desktop, right-click the Windows logo at the very bottom left corner of the screen, , and select "System". Within the System dialog box, select "Advanced system settings" to get the Power User Task Menu.
In the next dialog box, select "Environment Variables":
If you don't already have a GIT_SSH entry in your System Variables list, click "New..." and create GIT_SSH, defined to be the location of plink.exe
:
Copy/paste the known_hosts entries listed, into a file named known_hosts under your .ssh profile (something like C:\Users\<my-id>\.ssh) (if known_hosts does not exist, create it).
Execute the install file that you just downloaded. (You must have administrative privileges.) During installation, select "Add python.exe to Path", overriding the default setting. Also, be sure to install "pip" (this is the default).
Continue with the installation until it is completed.
Set up Git review and Configure Git
Run Git Bash as Administrator (for example, in Windows 10, use the Windows menu, scroll to the Git directory, right-click on Git-bash, and select "Run as administrator":
Within Git Bash, type the following command:
$ pip install git-review
To use git review
, you have to be in a Git clone directory that already contains a (possibly hidden) .gitreview
configuration file (see Gerrit/Advanced usage#Setting up a repository for git-remote), otherwise you will get the error message UnboundLocalError: local variable 'no_git_dir' referenced before assignment.
Info |
---|
The Git and git-review installation steps above are derived from the description at: https://www.mediawiki.org/wiki/Gerrit/git-review#Windows |
Configure Git to remember your Linux Foundation user name and email address (the user name and email address associated with your Linux Foundation login):
git config --global user.email <your_LF_account_email>
git config --global --add gitreview.username
<your_LF_user_name>
If you are using VPN, you might encounter a proxy problem while connecting to the Linux Foundation website. To avoid the problem, you should add the proxy setting in git config, using 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: When entering the proxy username, you might be required to add the domain name in front of the username.
Install Putty and Generate Keys
Info |
---|
An alternate method for creating public and private keys, without using PuTTY, is given here: https://help.github.com/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/ |
Info |
---|
If you already have keys registered with PuTTY, skip this section. |
PuTTY is a terminal emulator that uses Secure SHell (SSH) to communicate with a host. You need to install PuTTY in order to create a public/private encryption key pair. This pair of keys enables Git to communicate securely with the repositories.
To install PuTTY, visit, www.putty.org and follow the links to the appropriate Windows installation for your machine (32-bit or 64 bit). The downloaded file will be named putty-0.67-installer.msi
or the like.
Execute the .msi
file. Use all the default settings, thereby ensuring that you will install pageant.exe
, plink.exe
, and puttygen.exe
.
Generate Public and Private Keys
OSX
...
ssh-keygen -t rsa
...
The puttygen
utility, installed with putty
, generates public and private keys used for secure communication with Gerrit.
Info |
---|
You should execute |
To do this, right-click on C:\Program Files (x86)\PuTTY\puttygen.exe
and select Run as Administrator:
Answer "Yes" to the User Account Control challenge. Then click the "Generate" button in the puttygen window. puttygen will ask you to move your mouse over its dialog box to generate random seed bits. After it has computed a public key, it will display a dialog box resembling the following:
If you want to edit this key pair in the future, create a text file containing a short phrase, called a "passphrase". Copy and paste this passphrase into the "Key passphrase" and "Confirm passphrase" lines, then select "Save public key" and choose a filename (e.g. public.txt
); also "Save private key" and choose another filename (e.g. private.ppk
). Since you ran puttygen
as Administrator, the files are visible to Windows Explorer.
Close puttygen
.
Load Your Private Key Into Pageant
Pageant is an SSH authentication agent. It holds your private keys in memory, already decoded, so that you can use them often without needing to type a passphrase.
To load your private key into pageant
, right-click on the private key file (e.g. private.ppk
in this example), and select Load into pageant
:
This action not only loads private.ppk
into pageant, but also starts pageant if it is not already running. You will be prompted for the passphrase that you entered into puttygen
when you created the key. If successful, pageant will load the key without further interaction.
Panel | ||
---|---|---|
| ||
You can right-click on this icon to perform actions with pageant, including "View Keys" (which brings up a dialog box that allows you to add or remove keys.) The "Add Key" button offers another way to enter your private key into pegeant: after clicking on "Add Key", select the file containing your private key (for example, |
Set the GIT_SSH Environment Variable
From the Desktop, right-click the Windows logo at the very bottom left corner of the screen, , and select "System". Within the System dialog box, select "Advanced system settings" to get the Power User Task Menu.
In the next dialog box, select "Environment Variables":
If you don't already have a GIT_SSH entry in your System Variables list, click "New..." and create GIT_SSH, defined to be the location of plink.exe
:
Copy/paste the known_hosts entries listed, into a file named known_hosts under your .ssh profile (something like C:\Users\<my-id>\.ssh) (if known_hosts does not exist, create it).
Mac/OSX
get your MBP 2016 ready for development
under construction
generate keys - either ssh-add the key or rename it as id_rsa and put it into your ~/.ssh dir
Install the JDK (as dmg) - http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html
Install homebrew package manager -
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
python should already be installed. - do a --version check
install pip - sudo easy_install pip
install openstack tools
install docker (dmg) - https://docs.docker.com/docker-for-mac/install/#download-docker-for-mac
install maven - apache-maven-3.5.0-bin.tar, create and ~./m2 and place settings.xml there
git comes with Xcode or Homebrew - do a --version check
IDEs
IDE: Eclipse: Does Not Support Gerrit Plugin
...