Update readme + add manifest for ansible files #109
There are no files selected for viewing
File renamed without changes.
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,4 @@ | ||
| # maybe there is a better way to do it: | ||
| # https://stackoverflow.com/questions/1612733 | ||
|
|
||
| recursive-include orchestrator/ansible * | ||
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 |
|---|---|---|
|
|
@@ -44,10 +44,8 @@ cd ombt-orchestrator | |
| * Install the dependencies | ||
|
There was a problem hiding this comment. It seems that the README isn't rendered correctly on pypi, that's probably because it's written in md instead of rst. There was a problem hiding this comment. I added in f856066 the proper type to the configuration, see: https://packaging.python.org/tutorials/distributing-packages/#description |
||
|
|
||
| ``` | ||
| pip install -U pip | ||
| pip install -e . | ||
| ``` | ||
|
|
||
| > On Grid'5000 you can launch this command from any frontend. | ||
|
|
@@ -59,8 +57,8 @@ The default configurations are currently defined in the `conf.yaml` file. | |
| ## Command line interface | ||
|
|
||
| ``` | ||
| > oo | ||
| Usage: oo [OPTIONS] COMMAND [ARGS]... | ||
|
|
||
| Options: | ||
| --help Show this message and exit. | ||
|
|
@@ -83,14 +81,14 @@ Commands: | |
| ## Workflow to run a test case | ||
|
|
||
|
|
||
| * Deploying and launching the benchmark (default driver `broker` is defined in the configuration file) | ||
|
|
||
| ``` | ||
| # default confs.yaml on $PWD will be read | ||
| > oo deploy --driver=broker vagrant | ||
|
|
||
| # Launch the one benchmark | ||
| > oo test_case_1 --nbr_clients 10 --nbr_servers 2 | ||
| ``` | ||
|
|
||
| > Adapt to the relevant provider (e.g `g5k`) | ||
|
|
@@ -102,7 +100,7 @@ Grafana is available on the port 3000 of the control node (check the inventory f | |
| * Backuping the environment | ||
|
|
||
| ``` | ||
| > oo backup | ||
| ``` | ||
|
|
||
| > The files retrieved by this action are located in `current/backup` dir by default. | ||
|
|
@@ -111,11 +109,11 @@ Grafana is available on the port 3000 of the control node (check the inventory f | |
|
|
||
| ``` | ||
| # Preparing the next run by cleaning the environment | ||
| > oo destroy | ||
| > oo deploy vagrant | ||
|
|
||
| # Next run | ||
| > oo test_case_1 --nbr_clients 20 --nbr_servers 2 | ||
| ``` | ||
|
|
||
| > It's possible to force an experimentation dir with `--env mydir` | ||
|
|
@@ -130,7 +128,7 @@ Grafana is available on the port 3000 of the control node (check the inventory f | |
| to run the first test case enabled on the framework run: | ||
|
|
||
| ``` shell | ||
| > oo campaign --provider g5k test_case_1 | ||
| ``` | ||
|
|
||
| * Alternatively a campaign can be executed in a _incremental_ mode in which deployments are | ||
|
|
@@ -150,7 +148,7 @@ Grafana is available on the port 3000 of the control node (check the inventory f | |
| instead of the default and execute: | ||
|
|
||
| ``` shell | ||
| > oo campaign --incremental --provider g5k test_case_1 | ||
| ``` | ||
|
|
||
| ## Misc. | ||
|
|
||
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 |
|---|---|---|
|
|
@@ -4,10 +4,12 @@ version = 1.0.0 | |
| description = Oslo messaging benchmarking orchestrator | ||
| keywords = benchmark, oslo messaging, RPC | ||
| license = GPL-3.0 | ||
| license_file = LICENSE.txt | ||
| url = https://github.com/msimonin/ombt-orchestrator/ | ||
| author = Matthieu Simonin | ||
| author_email = matthieu.simonin@inria.fr | ||
| long_description = file: README.md | ||
| long_description_content_type = text/markdown | ||
|
There was a problem hiding this comment. the PKG-INFO in the tgz file set the value properly: There was a problem hiding this comment.
|
||
| project_urls = | ||
| Bug Reports = https://github.com/msimonin/ombt-orchestrator/issues | ||
| Source = https://github.com/msimonin/ombt-orchestrator/ | ||
|
|
@@ -41,3 +43,6 @@ exclude = | |
| [options.entry_points] | ||
| console_scripts = | ||
| oo = orchestrator.cli:cli | ||
|
|
||
| [bdist_wheel] | ||
| python-tag = py27 | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe add
include LICENSEalsoThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
running
python setup.py bdist_wheellooks good on my side now. I've renamed the licence file to fit the spec.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
include LICENSE.txtis necessary for the dist package to work.Should we publish only wheels ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
wheels is based on the new spec but if for any reason a system only allows users to use former formats we can also include the licence in the manifest.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ok