-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update all the Cheat Sheets of the tools
- Loading branch information
Showing
14 changed files
with
330 additions
and
74 deletions.
There are no files selected for viewing
18 changes: 18 additions & 0 deletions
18
org.dice.root/bundles/org.dice.methodology/cheatsheets/tools/anomaly_detection.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <cheatsheet | ||
| title="Anomaly Detection Tool"> | ||
| <intro> | ||
| <description>This Cheat Sheet will help you to start working with the tool</description> | ||
| </intro> | ||
| <item title="Configuring and executing the tool"> | ||
| <description>The tool is available via two menu entries:</description> | ||
| <subitem | ||
| label="You can configure the tool using the menu DICE Tools --> ADT Configure"> | ||
| </subitem> | ||
| <subitem | ||
| label="You can run the tool using the menu DICE Tools --> ADT Launch"> | ||
| </subitem> | ||
|
|
||
| </item> | ||
|
|
||
| </cheatsheet> |
14 changes: 14 additions & 0 deletions
14
org.dice.root/bundles/org.dice.methodology/cheatsheets/tools/configuration_optimization.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <cheatsheet | ||
| title="Configuration Optimization Tool"> | ||
| <intro> | ||
| <description>This Cheat Sheet will help you to start working with the tool</description> | ||
| </intro> | ||
| <item title="Open the View of the tool"> | ||
| <description>There is a view dedicated to the tool, where the user can interact with it and execute the service over Jenkins. The name of the view is "DICE Configuration View"</description> | ||
| </item> | ||
| <item title="Further information in the GitHub website"> | ||
| <description>The user will find further information about how to use the tool in the GitHub website: https://github.com/dice-project/DICE-Configuration-BO4CO/wiki/Getting-Started</description> | ||
| </item> | ||
|
|
||
| </cheatsheet> |
37 changes: 0 additions & 37 deletions
37
org.dice.root/bundles/org.dice.methodology/cheatsheets/tools/delivery.xml
This file was deleted.
Oops, something went wrong.
29 changes: 29 additions & 0 deletions
29
org.dice.root/bundles/org.dice.methodology/cheatsheets/tools/delivery_1.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <cheatsheet | ||
| title="Delivery Tool - Registering deployment service"> | ||
| <intro> | ||
| <description>This Cheat Sheet will help you registering DICE Deployment Service that is accessible over HTTP or uses a trusted certificate over HTTPS</description> | ||
| </intro> | ||
| <item title="Obtain service registration data"> | ||
| <description>If we would like to register new deployment service into delivery tool, we need to obtain the following pieces of information from administrator, responsible for maintaining the service: service address, username and password</description> | ||
| </item> | ||
| <item title="Open deployment tool preferences"> | ||
| <description>If we would like to register new service, we must first open the preferences page.</description> | ||
| </item> | ||
| <item title="Open dialog for adding new service"> | ||
| <description>To start service registration, we must press Add button that will open dialog with service entry fields</description> | ||
| </item> | ||
| <item title="Enter service data"> | ||
| <description>When we have dialog open, we can enter the service information. Address, username and password should contain the data administrator supplied. Name field should contain short, descriptive name that we will use to identify this service in other dialogs. Keystore related fields can be left empty in this scenario. If the data we entered is valid, last field in the dialog will be auto-populated for us with some default value that we can change if we wish. If we make any error while entering the data, the error will be displayed at the top of the dialog. When we are done, we press Ok. If the data we entered is valid, last field in the dialog will be auto-populated for us with some default value that we can change if we wish. If we make any error while entering the data, the error will be displayed at the top of the dialog</description> | ||
| </item> | ||
| <item title="Save configuration"> | ||
| <description>This far, we only have data in temporary buffers. To save it, we press OK and we are done with configuration</description> | ||
| </item> | ||
| <item title="Adding more services"> | ||
| <description>If we would like to add more services, we simply repeat the last two steps for each additional service</description> | ||
| </item> | ||
| <item title="Saving changes"> | ||
| <description>All of the changes that we made this far only persist in memory. In order to save them, we must press OK button that will close the preferences and save the values</description> | ||
| </item> | ||
|
|
||
| </cheatsheet> |
32 changes: 32 additions & 0 deletions
32
org.dice.root/bundles/org.dice.methodology/cheatsheets/tools/delivery_2.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <cheatsheet | ||
| title="Delivery Tool - Registering deployment service that uses self signed certificate"> | ||
| <intro> | ||
| <description>This Cheat Sheet will help you registering DICE Deployment Service that is accessible over HTTPS that uses self-signed certificate</description> | ||
| </intro> | ||
| <item title="Obtain service registration data"> | ||
| <description>If we would like to register new deployment service into delivery tool, we need to obtain the following pieces of information from administrator, responsible for maintaining the service: service address, username, password and service certificate</description> | ||
| </item> | ||
| <item title="Importing certificate into keystore"> | ||
| <description>In order to be able to use server certificate that administrator supplied to us, we must import it into keystore. Exact instructions are out of scope for this task, so consult documentation on how to achieve this</description> | ||
| </item> | ||
| <item title="Open deployment tool preferences"> | ||
| <description>If we would like to register new service, we must first open the preferences page</description> | ||
| </item> | ||
| <item title="Open dialog for adding new service"> | ||
| <description>To start service registration, we must press Add button that will open dialog with service entry fields</description> | ||
| </item> | ||
| <item title="Enter service data"> | ||
| <description>When we have dialog open, we can enter the service information. Address, username and password should contain the data administrator supplied. Name field should contain short, descriptive name that we will use to identify this service in other dialogs. Keystore file field should point to your keystore and password should be the password used to unlock it. If the data we entered is valid, last field in the dialog will be auto-populated for us with some default value that we can change if we wish. If we make any error while entering the data, the error will be displayed at the top of the dialog. When we are done, we press Ok. If the data we entered is valid, last field in the dialog will be auto-populated for us with some default value that we can change if we wish. If we make any error while entering the data, the error will be displayed at the top of the dialog</description> | ||
| </item> | ||
| <item title="Save configuration"> | ||
| <description>This far, we only have data in temporary buffers. To save it, we press OK and we are done with configuration</description> | ||
| </item> | ||
| <item title="Adding more services"> | ||
| <description>If we would like to add more services, we simply repeat the last two steps for each additional service</description> | ||
| </item> | ||
| <item title="Saving changes"> | ||
| <description>All of the changes that we made this far only persist in memory. In order to save them, we must press OK button that will close the preferences and save the values</description> | ||
| </item> | ||
|
|
||
| </cheatsheet> |
17 changes: 17 additions & 0 deletions
17
org.dice.root/bundles/org.dice.methodology/cheatsheets/tools/delivery_3.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <cheatsheet | ||
| title="Delivery Tool - Create blueprint"> | ||
| <intro> | ||
| <description>This Cheat Sheet will help you creating minimal blueprint project that can be deployed</description> | ||
| </intro> | ||
| <item title="Create new project"> | ||
| <description>Each blueprint that we would like to deploy needs to live in a project. To satisfy this condition we must first create new project</description> | ||
| </item> | ||
| <item title="Create blueprint"> | ||
| <description>Now we need to actually produce valid blueprint. In order to speed up the process, we can simply download sample blueprint from DICE deployment service's repository and place it into project we created in previous step</description> | ||
| </item> | ||
| <item title="Create resources folder"> | ||
| <description>In order to be able to send additional data along with the blueprint, we need to create a folder in our project that will hold those additional resources</description> | ||
| </item> | ||
|
|
||
| </cheatsheet> |
17 changes: 17 additions & 0 deletions
17
org.dice.root/bundles/org.dice.methodology/cheatsheets/tools/delivery_4.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <cheatsheet | ||
| title="Delivery Tool - Create deploy configuration"> | ||
| <intro> | ||
| <description>This Cheat Sheet will help you creating new run configuration that can be used to deploy selected blueprint</description> | ||
| </intro> | ||
| <item title="Open run configurations dialog"> | ||
| <description>From the DICE Tools menu we select DICE Tools -> Delivery Tool, which will open the configuration dialog</description> | ||
| </item> | ||
| <item title="Create new configuration"> | ||
| <description>To create new deploy configuration, we must select DICE Deploy in the left selector and then click the new button</description> | ||
| </item> | ||
| <item title="Add deploy data"> | ||
| <description>First, we need to pick a sensible name for deploy. Right now, we might just as well call it test, since this is its purpose. Next, we need to select our blueprint and resources folder we created earlier. Deployment service part should be already configured correctly, but we can modify it if we wish. We can save the deploy by pressing Apply button</description> | ||
| </item> | ||
|
|
||
| </cheatsheet> |
14 changes: 14 additions & 0 deletions
14
org.dice.root/bundles/org.dice.methodology/cheatsheets/tools/delivery_5.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <cheatsheet | ||
| title="Delivery Tool - Deploy blueprint"> | ||
| <intro> | ||
| <description>This Cheat Sheet will help you learning how to deploy a blueprint</description> | ||
| </intro> | ||
| <item title="Start deployment process"> | ||
| <description>In order to start deployment process, we must open the runtime configuration dialog, select test configuration from the selector in the left side and press Run</description> | ||
| </item> | ||
| <item title="Monitor progress"> | ||
| <description>To keep an eye on the deployment process we can open container view that will display statuses of all containers that are available to us</description> | ||
| </item> | ||
|
|
||
| </cheatsheet> |
26 changes: 26 additions & 0 deletions
26
org.dice.root/bundles/org.dice.methodology/cheatsheets/tools/enhancement.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <cheatsheet | ||
| title="Enhancement Tool"> | ||
| <intro> | ||
| <description>This Cheat Sheet describes the steps that the DICE user follows for using DICE Enhancement tool in DICE IDE</description> | ||
| </intro> | ||
| <item title="Install Matlab Compiler Runtime (MCR) 2015a"> | ||
| <description>Install Matlab Compiler Runtime (MCR) 2015a. This is a royalty-free runtime that does not require owning a Matlab license</description> | ||
| </item> | ||
| <item title="Configure the Matlab Runtime Environment"> | ||
| <description>After installed the MCR, user needs to ensure that Java environment, Classpath, system path are properly configured. For example, if user installed R2015a(8.5)-64bit in the Windows Operating System under path “C:\MATLAB\MATLAB Runtime”</description> | ||
| <subitem | ||
| label="Configure CLASSPATH: to use the compiled classes, user needs to include a file called javabuilder.jar on the Java class path. User needs to add “C:\MATLAB\MATLAB Runtime\v85\toolbox\javabuilder\jar” to CLASSPATH"> | ||
| </subitem> | ||
| <subitem | ||
| label="Configure system PATH: user needs to add the MCR runtime path “C:\MATLAB\MATLAB Runtime\v85\runtime\win64” to the system PATH"> | ||
| </subitem> | ||
| <subitem | ||
| label="The Enhancement tool needs to read two configuration files, DICE-FG-Configuration.xml and DICE-APR-Configuration.xml, to obtain the related parameters for running. User can download the sample configuration files from the following Github page: https://github.com/dice-project/DICE-Enhancement-APR/tree/master/Plugin/doc"> | ||
| </subitem> | ||
| <subitem | ||
| label="User needs to put configuration files under the same folder of the target UML model and set the corresponding parameters. The more details of the meaning of those parameters can be found at the following Github page: https://github.com/dice-project/DICE-Enhancement-APR/tree/master/Plugin/doc/Configuration%20Files"> | ||
| </subitem> | ||
| </item> | ||
|
|
||
| </cheatsheet> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
Oops, something went wrong.