Versions Compared

Old Version 68

changes.mady.by.user Jacqueline Beaulac

Saved on

compared with

New Version Current

changes.mady.by.user Jacqueline Beaulac

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

This page is now obsolete, please see Using Papyrus 2020-06 for Modeling !

Introduction

The Open Source UML tool Papyrus is a plug-in for the Open Source integrated development environment (IDE) Eclipse.

...

  • Eclipse has a number of pre-defined perspectives associated with different tasks and plugins. In ONAP we mainly use the perspectives for Papyrus and for Git.
  • To change perspective, go to "Window→Perspective→Open Perspective→Other" on the top of your screen and then select the perspective that you want to use:
  • Another quick way to change perspective exists on the top right side of your screen. Next to the "Quick Access" bar, you will see a number of small icons:
    • Select the icon for the perspective that you want to use. The storage/cylinder icon marked "GIT" is for Git, and the bird icon is for Papyrus.
    • If you don't see the icon for the perspective that you want to use, clicking the icon with the "+" to the left of the predefined perspectives brings you to the same popup window as going to "Window"→"Perspective"→"Open Perspective"→Other".
  • If you have moved around or minimized some of the view areas and can't find something you're looking for, you can reset the perspective to its default by first selecting "Window"→"Perspective"→"Reset Perspective..." and then clicking "Reset Perspective" in the popup window.

EGit (Eclipse/Git)

If you encounter unanticipated problems when following the procedures below for working with Eclipse/Git, check http://wiki.eclipse.org/EGit/User_Guide for possible solutions.

Using the ONAP Model with Gerrit

...

This process must be followed if you have never used the Eclipse/Git function with Gerrit.

Setup of RSA Keys in Eclipse and Gerrit

  • You must first generate an SSH key within Eclipse/Papyrus.
  • Go to "Window→ Preferences→ General→ Network Connection→ SSH2"Window"→ "Preferences", then "General"→ "Network Connection"→ "SSH2".
  • Select the"Key Management" tab and click Select the tab "Key Management" and choose "Generate RSA Key...".

         

  • The system will generate a key for you and place the key in the same window.
  • Select "Save private key", which will save your key as an id_rsa file.
    • Note:
     
    • You may be asked if you want to save this private key without passphrase protection - select OK.

      Image Modified

  • A window will pop up with a location and a name for the key file - just click Save.


  • Before you hit Don't click "Apply and Close" , "copy/paste" that key so that you can upload it into Gerrit.

Uploading an RSA key from Eclipse into ONAP Gerrit

  • yet.
  • Login to Gerrit (https://gerrit.onap.org/).
  • Click your name at the top right and click "Settings".
  • Go Click or scroll to Settings → "SSH Public KeysClick Add Key".
  • Go back to Eclipse and go to "Window"→ "Preferences"→ "General"→ "Network Connection"→ "SSH2" → LOAD EXISTING KEY
  • Switch to the open "SSH2" window in Eclipse and copy the text of your public key.
  • Switch back to Gerrit, paste Paste the text of your public key into the "New SSH key" text box .

  • Click Add.

...

  • and click "Add New SSH Key".
  • Now you can go back to Eclipse and click "Apply and Close".

Gerrit user contributor agreement

To be able to push model changes to Gerrit, your "committer" user information in Eclipse/Git must correspond to the user name and email you have you need to have a CCLA (Corporate Contributor License Agreement) associated with your account in Gerrit account. 

  • Login to To see these settings in Gerrit (https://gerrit.onap.org/), click on the drop down next to .
  • Click your name at the top right and choose click "settings". You will see your user name and email.To check the committer information being used by EGit (a.k.a. Git in Eclipse), in Eclipse go to: "Window" → "Preferences", then "Team" → "Git"→ "Configuration", and select the "User Settings" tab:
    Image Removed
  • The table should contain a "user" category with an "email" and a "name" entry.
  • The value for the "email" key should be your email from Gerrit.
  • The value for the "name" key should be your user name from Gerrit.
  • If "User Settings" is empty or the information doesn't match your settings in Gerrit, you will add or update entries in the key-value table.
  • Sometimes on an initial setup, your settings may not be writable.
    • First check that the Location field points at a valid Git config file. If you're unsure, click on "Open". This should open the .gitconfig file in the background in Eclipse.
      • Note: if you want to switch to the opened file and see its contents, you'll need to close the settings window and reopen it.
    • If the specified .gitconfig file isn't valid and writable, you may be able to fix this by exiting Eclipse, specifying your home directory in Windows, and reopening Eclipse. Follow the instructions here: http://wiki.eclipse.org/EGit/User_Guide#Setting_up_the_Home_Directory_on_Windows
  • Once your User Settings are editable:
    • If the "email" key exists but has the wrong value, select the value field in the table and provide your email from Gerrit.
    • If the table is empty or missing the "email" key, select "Add Entry...", type in the key "user.email", and provide your email from Gerrit as the value.
    • If the "name" key exists but has the wrong value, select the value field in the table and provide your user name from Gerrit.
    • If the table is empty or missing the "name" key, select "Add Entry...", type in the key "user.name", and provide your user name from Gerrit as the value.

Cloning the Model

The ONAP model currently resides in Gerrit in the modeling/modelspec repository. In order to download the model to your machine, to either visualize it or make updates, you will need to clone it in Eclipse/Git.

  • Bring up the Eclipse/Papyrus that you installed in the previous steps, if you haven't done so already.
    • Note: you may have to CLOSE THE ECLIPSE WELCOME PAGE.
    • Note: If you were previously using Papyrus ONAP model when it was in a "Private" GitHub, you will have to select that repository, right click, and select "Delete Repository". Make sure you delete all files.
  • Go to the Git Perspective by selecting "Window"→"Perspective"→"Open Perspective"→"Other..." on the top of your screen and then select "Git".
  • Once in the Git perspective, your screen should have the following on top:

           Image Removed

  • Select the "cloud" icon with a repository and a green arrow. This is your "clone repository" function in Git:
    Image Removed
  • In the popup window, you need to supply the URI for the Source Git Repository. The format of that URI is ssh://{LF Userid}@gerrit.onap.org:29418/modeling/modelspec
    • Ex. ssh://bencheung@gerrit.onap.org:29418/modeling/modelspec
    • Based upon what you have just entered, the rest of the screen gets populated with the correct info. It should look something like this:
      Image Removed
  • Make sure to fill in User and Password with your LF Userid and password. Once the screen is filled in, select "Next".
  • It will then prompt you for the branches to select. Choose: "master" (DESELECT everything else) and click "Next". The popup should looks like this:
    Image Removed
  • You will then be prompted to select a local directory on your machine into which the model should be loaded by Git. It can be any location you want, and not necessarily the workspace you are using for Eclipse/Papyrus projects. Check the box "Import all existing Eclipse projects...".  Your screen at this point should look like this:
    Image Removed
  • Select "Finish".
    • For a first-time setup, you may get the following message. Select "Yes".
      Image Removed
  • The cloning process should complete, and the repository should be created on your local machine. If you encounter errors, contact the ONAP model administrator to get help.
  • The view below shows an example of the newly created repository which has been opened up down to the level of the "Local" folder. Only the "master" branch should show up as your "Local".

          Image Removed

What if Eclipse/Git won't connect to ONAP Gerrit?

  • If it looks like Eclipse is not able to connect to Gerrit, you may have to exit your corporate VPN when working with the model.
  • Alternatively, set up a proxy access to Gerrit:
    • Go to "Window"→"Preferences"→"General"→"Network Connections"
    • Edit the entries for HTTP and HTTPS that have "Provider" preset to Manual. For both, set the URL for your proxy under "Host" and its port under "Port".
      Image Removed

Viewing the Model in Papyrus

Once you have successfully cloned the ONAP model, you can now view it in Papyrus.

...

  • If you do not see the project in the "Project Explorer", probably you forget to check the box to import all existing Eclipse projects when cloning the model. To fix this, switch to the Git perspective, select the repository name or the Working Tree, then right-click and select "Import projects...".

...

  • Each of the "green birds" represent a Papyrus model. Double-clicking on any of these models will open it in a new Model Explorer panel, which is usually on the left side of the screen in the center.
    • The icon with the triangle saying "model" represents the top-level of the ONAP model. Double-click on "model" like you would a folder, and you should see something like this: 
      Image Removed
    •  The icons with a little arrow coming out of a circle represent the sub-models. Open up any sub-model like you would a folder, and you should see something like this (in this example it is the Vnf sub-model):
      Image Removed
  • Start viewing the model by selecting any diagram, i.e. in the Vnf → Diagrams package.
    • Here's a little trick for seeing the associated artifacts in the diagram. In the model explorer bar you will see two arrows opposing each other. Select that double-arrow option:
      Image Removed
    • What this means, is when you select any artifact on a diagram, i.e. a "Class", the model explorer takes you directly to that artifact in the model explorer tree.
  • Now, explore the model yourself by taking a look at all the class diagrams in the sub-models! Note, some of the sub-models are currently empty.

Contents of the ONAP Information Model

Here is a description of what you have in the ONAP Information Model.

  • The overall ONAP "model" is composed of "sub-models".
  • Each of the "sub-models" has a model editor that is responsible for editing the model and uploading the changes into Gerrit/Git.
    • Note: two people should never edit a "sub-model" at the same time without clearly communicated coordination, otherwise "model conflicts" may arise.
  • You should see the following in the ONAP Information Model folder:
    • GenDoc  - This is where the GenDoc templates reside for creating an output of the model in Word
    • StyleSheets - These are CSS stylesheets to use when formatting the model                                                              
    • Common - The common submodel of the model (where artifacts used by multiple sub-models are stored)           
    • Infrastructure -  The infrastructure submodel where the multi-cloud artifacts are stored                                          
    • model - This is the "umbrella" ONAP model that contains all the submodels                                                            
    • Nf - Network Function submodel                                                                                                                                
    • Ns - Network Service submodel                                                                                                                                  
    • OpenModel_Profile.profile - Contains IISOMI stereotypes                                                                                                                                     
    • Party - The party submodel for party related artifacts                                                                                                 
    • Pnf - The Pnf submodel where PNFD resides                                                                                                               
    • Resource - The resource submodel for resource related artifacts                                                                                
    • Service - The service submodel for service related artifacts                                                                                         
    • Vnf - The Vnf submodel for Vnf specific artifacts
  • Each sub-model has the following types of packages
    • Associations - Contains all associations used in diagrams.
    • Diagrams - Contains UML diagrams
    • Interfaces - Contains Component, Interface, and Operation artifacts (usually empty for now)
    • ObjectClasses - Contains all class definitions
    • TypeDefinitions - Contains all DataTypes and Enumerations.

Updating the Model in Gerrit

Only approved model editors can update the working branch in Gerrit. To be a model editor you must undergo Papyrus training. Current model editors for each submodel are specified here.

Once you have finished making your model changes, make sure you "save" them in Papyrus, by selecting "File→ Save", or select the Save icon.

Staging changes

Only changes that have been staged will be included in the Push to Gerrit.

...

  • Note: If there is a file in the list that you did not intend to change, you can revert the unwanted changes by right-clicking on that file and selecting "Replace with HEAD revision".

...

Writing the commit message

Next you will need to prepare to "Commit and Push" your changes.

  • Position your cursor in the "Commit Message" window.
  • Add a commit message indicating the change you have done, i.e. "Added new diagram to service model".
  • Then press carriage return twice so that you have a blank line after your message.
    • You can then optionally add a more detailed message about the change.
  • Next, you will have to associate the change to a JIRA ticket. Add on the line after the blank line:  Issue-ID: MODELING-xxx
  • Git should generate a "Change-Id" for you, so you don't need to manually add one.
    • If there is no "Change-Id" line in the "Commit Message" window, click the "Add Change-ID" icon to the right on the same line as the "Commit Message" title.
  • Then "Sign-off" on the change by clicking the "Add Signed-off-by" icon that looks like a pen and is on the same line as the "Commit Message" title:

                   Image Removed

Commit to local repository and push to remote Gerrit

...

  • Note that the "Committer" must correspond to the user name and email you have associated to your Gerrit account. If they don't, follow the instructions here: ONAP Gerrit user setup in Eclipse
  • Settings".
  • Click or scroll to "Agreements".
  • If you do not see a CCLA clickable link, click on "New Contributor Agreement" and follow the instructions:
    Image Added

ONAP Gerrit user setup in Eclipse

To be able to push model changes to Gerrit, your "committer" user information in Eclipse/Git must correspond to the user name and email you have associated with your Gerrit account. 

  • To see these settings in Gerrit (https://gerrit.onap.org/), click on the drop down next to your name and choose "settings". You will see your user name and email.
  • To check the committer information being used by EGit (a.k.a. Git in Eclipse), in Eclipse go to: "Window"→"Preferences", then "Team"→"Git"→"Configuration", and select the "User Settings" tab:
    Image Added

  • The table should contain a "user" category with an "email" and a "name" entry.
  • The value for the "email" key should be your email from Gerrit.
  • The value for the "name" key should be your user name from Gerrit.
  • If "User Settings" is empty or the information doesn't match your settings in Gerrit, you will add or update entries in the key-value table.
  • Sometimes on an initial setup, your settings may not be writable.
    • First check that the Location field points at a valid Git config file. If you're unsure, click on "Open". This should open the .gitconfig file in the background in Eclipse.
      • Note: if you want to switch to the opened file and see its contents, you'll need to close the settings window and reopen it.
    • If the specified .gitconfig file isn't valid and writable, you may be able to fix this by exiting Eclipse, specifying your home directory in Windows, and reopening Eclipse. Follow the instructions here: http://wiki.eclipse.org/EGit/User_Guide#Setting_up_the_Home_Directory_on_Windows
  • Once your User Settings are editable:
    • If the "email" key exists but has the wrong value, select the value field in the table and provide your email from Gerrit.
    • If the table is empty or missing the "email" key, select "Add Entry...", type in the key "user.email", and provide your email from Gerrit as the value.
    • If the "name" key exists but has the wrong value, select the value field in the table and provide your user name from Gerrit.
    • If the table is empty or missing the "name" key, select "Add Entry...", type in the key "user.name", and provide your user name from Gerrit as the value.

Cloning the Model

The ONAP model currently resides in Gerrit in the modeling/modelspec repository. In order to download the model to your machine, to either visualize it or make updates, you will need to clone it in Eclipse/Git.

  • Bring up the Eclipse/Papyrus that you installed in the previous steps, if you haven't done so already.
    • Note: you may have to close the Eclipse Welcome page.
    • Note: If you were previously using Papyrus ONAP model when it was in a "Private" GitHub, you will have to select that repository, right click, and select "Delete Repository". Make sure you delete all files.
  • Go to the Git Perspective by selecting "Window"→"Perspective"→"Open Perspective"→"Other..." on the top of your screen and then select "Git".
  • Once in the Git perspective, your screen should have the following on top:

           Image Added

  • Select the "cloud" icon with a repository and a green arrow. This is your "clone repository" function in Git:
    Image Added
  • In the popup window, you need to supply the URI for the Source Git Repository. The format of that URI is ssh://{LF Userid}@gerrit.onap.org:29418/modeling/modelspec
    • Ex. ssh://bencheung@gerrit.onap.org:29418/modeling/modelspec
    • Based upon what you have just entered, the rest of the screen gets populated with the correct info. It should look something like this:
      Image Added
  • Make sure to fill in User and Password with your LF Userid and password. Once the screen is filled in, select "Next".
  • It will then prompt you for the branches to select. Choose: "master" (DESELECT everything else) and click "Next". The popup should looks like this:
    Image Added
  • You will then be prompted to select a local directory on your machine into which the model should be loaded by Git. It can be any location you want, and not necessarily the workspace you are using for Eclipse/Papyrus projects. Check the box "Import all existing Eclipse projects...".  Your screen at this point should look like this:
    Image Added
  • Select "Finish".
    • For a first-time setup, you may get the following message. Select "Yes".
      Image Added
  • The cloning process should complete, and the repository should be created on your local machine.
  • The view below shows an example of the newly created repository which has been opened up down to the level of the "Local" folder. Only the "master" branch should show up as your "Local".

          Image Added

What if Eclipse/Git won't connect to ONAP Gerrit?

  • If it looks like Eclipse is not able to connect to Gerrit, you can try working with the model outside your corporate VPN.
  • However, the preferred way to solve this problem is to set up a proxy access to Gerrit:
    • Go to "Window"→"Preferences"→"General"→"Network Connections"
    • Edit the entries for HTTP and HTTPS that have "Provider" preset to Manual. For both, set the URL for your proxy under "Host" and its port under "Port".
    • For "Active Provider" at the top of the window, select "Manual".
    • The resulting configuration should look something like this:
      Image Added

Viewing the Model in Papyrus

Once you have successfully cloned the ONAP model, you can now view it in Papyrus.

  • Go to the Papyrus perspective by selecting  "Window"→"Perspective"→"Open Perspective"→ "Other..." on the top of your screen and then select "Papyrus".
  • This perspective should show a "Project Explorer" on the left side of the screen that looks something like this:
    Image Added

  • You should see your newly created Eclipse/Papyrus project in the "Project Explorer" on the left side of the screen. (ignore the question mark, it shouldn't be there)
    Image Added

  • The text in light brown is telling you that your project is in the modelspec repository you just created, in the branch "master". Note that all model work is being performed in the "master" branch.
    • If you do not see the project in the "Project Explorer", probably you forget to check the box to import all existing Eclipse projects when cloning the model. To fix this, switch to the Git perspective, select the repository name or the Working Tree, then right-click and select "Import projects...".
  • If you click on the ">" to open/explore the ONAP Information Model folder, you will see something like:
    Image Added
  • Each of the "green birds" represent a Papyrus model. Double-clicking on any of these models will open it in a new Model Explorer panel, which is usually on the left side of the screen in the center.
    • The icon with the triangle saying "model" represents the top-level of the ONAP model. Double-click on "model" like you would a folder, and you should see something like this: 
      Image Added
    •  The icons with a little arrow coming out of a circle represent the sub-models. Open up any sub-model like you would a folder, and you should see something like this (in this example it is the Vnf sub-model):
      Image Added
  • Start viewing the model by selecting any diagram, i.e. in the Vnf → Diagrams package.
    • Here's a little trick for seeing the associated artifacts in the diagram. In the model explorer bar you will see two arrows opposing each other. Select that double-arrow option:
      Image Added
    • What this means, is when you select any artifact on a diagram, i.e. a "Class", the model explorer takes you directly to that artifact in the model explorer tree.
  • Now, explore the model yourself by taking a look at all the class diagrams in the sub-models! Note, some of the sub-models are currently empty.

Contents of the ONAP Information Model

Here is a description of what you have in the ONAP Information Model.

  • The overall ONAP "model" is composed of "sub-models".
  • Each of the "sub-models" has a model editor that is responsible for editing the model and uploading the changes into Gerrit/Git.
    • Note: two people should never edit a "sub-model" at the same time without clearly communicated coordination, otherwise "model conflicts" may arise.
  • You should see the following in the ONAP Information Model folder:
    • GenDoc  - This is where the GenDoc templates reside for creating an output of the model in Word
    • StyleSheets - These are CSS stylesheets to use when formatting the model                                                              
    • Common - The common submodel of the model (where artifacts used by multiple sub-models are stored)           
    • Infrastructure -  The infrastructure submodel where the multi-cloud artifacts are stored                                          
    • model - This is the "umbrella" ONAP model that contains all the submodels                                                            
    • Nf - Network Function submodel                                                                                                                                
    • Ns - Network Service submodel                                                                                                                                  
    • OpenModel_Profile.profile - Contains IISOMI stereotypes                                                                                                                                     
    • Party - The party submodel for party related artifacts                                                                                                 
    • Pnf - The Pnf submodel where PNFD resides                                                                                                               
    • Resource - The resource submodel for resource related artifacts                                                                                
    • Service - The service submodel for service related artifacts                                                                                         
    • Vnf - The Vnf submodel for Vnf specific artifacts
  • Each sub-model has the following types of packages
    • Associations - Contains all associations used in diagrams.
    • Diagrams - Contains UML diagrams
    • Interfaces - Contains Component, Interface, and Operation artifacts (usually empty for now)
    • ObjectClasses - Contains all class definitions
    • TypeDefinitions - Contains all DataTypes and Enumerations.

Updating the Model in Gerrit

Only approved model editors can update the working branch in Gerrit. To be a model editor you must undergo Papyrus training. Current model editors for each submodel are specified here.

  • Before making changes, always ensure that you have the latest version of the model from the ONAP Gerrit repository.
    • If you have not yet cloned the model, the clone process will provide you with the latest version.
    • If you have already cloned the model into your workspace, make sure to "Fetch" the latest updates from Gerrit before making any changes.
  • Once you have finished making your model changes, select "File"→ "Save" or click the Save icon.

Staging changes

Only changes that have been staged will be included in the Push to Gerrit.

  • If this is a first-time that you're updating the model, make sure that you first have set up the user information for Gerrit properly. See these instructions: ONAP Gerrit user setup in Eclipse
  • Next, go to the Git perspective by selecting "Window"→"Perspective"→"Open Perspective"→"Other..." on the top of your screen and then select "Git".
  • Once in the Git Perspective, select the repository where you have changed the files:
    Image Added
  • Select the "Git Staging" tab in the lower right hand portion of your screen (it might also be on the right-hand side of your screen based on your layout)
    It looks like this: Image Added with a little green down-arrow
  • The Git Staging window looks like this:
    Image Added
  • You will see all of the files that you have changed in the "Unstaged changes".
    • Note: If there is a file in the list that you did not intend to change, you can revert the unwanted changes by right-clicking on that file and selecting "Replace with HEAD revision".
  • For each changed file that you want to stage, right-click and select "Add to index". Once they have been added, the files will move to "Staged Changes".
    • As a shortcut, you can select the little green "++" sign that will add all the files for you:
      Image Added
    • After you hit the green "++" it should look something like this:
      Image Added

Writing the commit message

Next you will need to prepare to "Commit and Push" your changes.

  • Position your cursor in the "Commit Message" window.
  • Add a commit message indicating the change you have done, i.e. "Added new diagram to service model".
  • Then press carriage return twice so that you have a blank line after your message.
    • You can then optionally add a more detailed message about the change.
  • Next, you will have to associate the change to a JIRA ticket. Add on the line after the blank line:  Issue-ID: MODELING-xxx
  • Git should generate a "Change-Id" for you, so you don't need to manually add one.
    • If there is no "Change-Id" line in the "Commit Message" window, click the "Add Change-ID" icon to the right on the same line as the "Commit Message" title.
  • Then "Sign-off" on the change by clicking the "Add Signed-off-by" icon that looks like a pen and is on the same line as the "Commit Message" title:

                   Image Added

Commit to local repository and push to remote Gerrit

  • Now you are ready to select "Commit and Push". This commits your local changes and pushes them to the remote Gerrit repository (which should be the working branch).
    Image Added

    • Note that the "Committer" must correspond to the user name and email you have associated to your Gerrit account. If they don't, follow the instructions here: ONAP Gerrit user setup in Eclipse
  • After you press "Commit and Push...", you will see this popup:
    Image Added
  • Click "Finish".

Asking for approval in Gerrit

  • Once your changes have been successfully pushed to Gerrit, you should see push result messages from Gerrit in a new window in Eclipse:

                Image Added

  • This window display the Gerrit identifier (in this case 59893) associated with the change. Make a note of the identifier.
  • Now open a browser and login to Gerrit (https://gerrit.onap.org/).
  • You should then see the change you have just made. Select that change.
  • Click "Add..." and specify the name of the person to approve that change. Approvers are Deng Hui as well as the model owner, if you are updating a model for which you are not the owner.
    Image Added
  • Once the change has been committed, you will receive an email confirmation of the commit.

Recovering from a failed push to Gerrit

  • If your commit and push fails for any reason, once you have fixed the problem, you can try to resend the request by selecting the "Amend (Edit previous commit)" icon in the Commit Message bar:
    Image Added
  • If you want to roll back your failed commits:
    • Go to the Git Perspective by selecting "Window"→"Perspective"→"Open Perspective"→"Other..." on the top of your screen and then select "Git".
    • Right-click on the "modelspec" repository and select "Reset...".
    • Image Added
    • Select "Remote Tracking"→"origin"→"master", then "Mixed", and then click "Reset".
      Image Added
    • This operation will let your local back to keep aligned with the remote merged changes, then you can do a new commit.

...

Asking for approval in Gerrit

  • Once your changes have been successfully pushed to Gerrit, you should see the result messages from Gerrit in Eclipse:

                Image Removed

...

Export the ONAP Model

Export to a Word Document

...