Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix yaml issue #3

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/user_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,18 +17,18 @@ cd Simoorg
```
When installing from the source, we recommend that you run all the unit and integration tests that are included with the source code, before starting the installations. You can do this by running the command
```
python setuptools.py test
sudo python setup.py test
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you explain what issues you faced or error you got when you ran the previous command?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @MayureshGharat

IF i do $ python setuptools.py test

[ec2-user@ip- simoorg]$ ls
docs failure_scripts LICENSE MANIFEST.in NOTICE README.rst requirements.txt sample_configs setup.cfg setup.py src
[ec2-user@ip- simoorg]$ python setuptools.py test
python: can't open file 'setuptools.py': [Errno 2] No such file or directory
[ec2-user@ip- simoorg]$

However if I DO:

[ec2-user@ip simoorg]$ sudo python setup.py test
running test
running egg_info
creating src/simoorg.egg-info
writing requirements to src/simoorg.egg-info/requires.txt
writing src/simoorg.egg-info/PKG-INFO
writing top-level names to src/simoorg.egg-info/top_level.txt
writing dependency_links to src/simoorg.egg-info/dependency_links.txt
writing entry points to src/simoorg.egg-info/entry_points.txt
writing manifest file 'src/simoorg.egg-info/SOURCES.txt'
reading manifest file 'src/simoorg.egg-info/SOURCES.txt'
reading manifest template 'MANIFEST.in'
warning: no files found matching 'product-spec.json'
warning: no files found matching 'mppy-pinned.txt'
writing manifest file 'src/simoorg.egg-info/SOURCES.txt'
running build_ext


Ran 0 tests in 0.000s

OK
[ec2-user@ip simoorg]$

```
Once you have confirmed that the tests have passed, you can install the code by running the command
```
python setuptools.py install
sudo python setup.py install
```
If you are planning to use ssh handler plugin to induce failures against a specific service cluster, please ensure that the user you are using to run simoorg have Passwordless SSH access to all the nodes in the cluster. You should also ensure that any failure scripts you plan to use are already present on all the nodes in the target service cluster.

##Basic Usage
Simoorg is started using the command *simoorg* which takes the path to your config directory as the only argument. Please check the config document ([link][docs/config.rst]) to better understand the configuration files. The sample config directory packaged with the product can be used to set up your configs.
```
Ex: simoorg ~/configs/
Ex: simoorg sample_configs/
```

##Usage Example
Expand Down
2 changes: 1 addition & 1 deletion sample_configs/plugins/topology/static/topo.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@
# Static topology definition
#
topology:
nodes: ['test-node]
nodes: [test-node]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice catch!!!

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks :-)

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@suletm, I remember you had some concerns on this.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sarathsreedharan @suletm Can you take a look?