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

README enhancement request #594

Open
rajan-mis opened this issue Jan 6, 2022 · 0 comments
Open

README enhancement request #594

rajan-mis opened this issue Jan 6, 2022 · 0 comments
Assignees
Labels
Component: Documentation Type: Documentation Idicates issue is related to documentation. Type: Enhancement Type: Enhancement Indicates a request for feature to be improved.

Comments

@rajan-mis
Copy link
Member

rajan-mis commented Jan 6, 2022

Describe the bug

I am opening this on behalf of another team outside of Scale that attempted to use the instructions and ran into issues with some of the wording. This was from someone that didn't know what an Self Extracting package was, so I think we can add a little statement somewhere explaining it or at least the naming convention to know when they have the actual SE package vs a tar file, etc.

The confusing part was here from: https://github.com/IBM/ibm-spectrum-scale-install-infra#installation-instructions

Create Ansible playbook
The basic Ansible playbook (e.g. ./playbook.yml) looks as follows:
# playbook.yml:
---
- hosts: cluster01
 vars:
   - scale_install_localpkg_path: /path/to/Spectrum_Scale_Standard-5.0.4.0-x86_64-Linux-install
 roles:
   - core/precheck
   - core/node
   - core/cluster
   - core/postcheck
Specifically: scale_install_localpkg_path

For someone unfamiliar with this, it's not super clear this is the full path including the SE package. At first, they pointed it to the .tar.gz file that was downloaded and then when that didn't work, they tried just pointing to the directory where the file was located which also didn't work. Once I explained what the SE package was, the format it was in, they were able to make progress by extracting it from the tar.gz and then pointing directly to it.

There is just a few additional details we can add to make it clearer to a customer who is not as familiar with the terminology.
@acch acch added Component: Documentation Type: Documentation Idicates issue is related to documentation. Type: Enhancement Type: Enhancement Indicates a request for feature to be improved. labels Feb 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Documentation Type: Documentation Idicates issue is related to documentation. Type: Enhancement Type: Enhancement Indicates a request for feature to be improved.
Projects
None yet
Development

No branches or pull requests

2 participants