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

Linch-pin feedback #147

Closed
jlebon opened this issue Feb 6, 2017 · 3 comments
Closed

Linch-pin feedback #147

jlebon opened this issue Feb 6, 2017 · 3 comments

Comments

@jlebon
Copy link

jlebon commented Feb 6, 2017

Hi all,

Thought I'd give some feedback from an exercise in trying out linch-pin for the first time. I understand a lot of the below is simply due to the project still being in its infancy, though I hope you still appreciate the feedback. :) Sorry in advance for the massive dump of issues in one shot. Some of those may already exist as independent issues.

Major issues:

  1. Documentation is incomplete. There are no mentions of essential things like basic CLI usage (e.g. init/rise/drop), the configuration file, credentials, etc... This makes it very hard for beginners to get started.

  2. Python packages are not namespaced, so e.g. library/provision/outputs etc... are all dumped directly in site-packages rather than e.g. a linchpin/ dir. Esp. important since most of those are not even actual python modules.

  3. Credentials files have to be stored in the vars dir, which is in the bowels of the python site-packages dir.

Minor issues:

  1. Inconsistent field naming. E.g. using res_ in some places and resource_ in others. (I'd prefer the latter everywhere). Also, it's generally nicer in YAML to use - instead of _, but that's subjective of course :).

  2. Unconditional debug print statements used rather than e.g. a logging module. It makes the output a bit harder to understand.

@greg-hellings
Copy link
Contributor

Documentation is a constant work-in-progress. We know we are woefully behind on that. Until about 2 weeks ago we had no docs, so we're trying to make steady progress on that!

Inconsistent field naming: Can you open a new issue to address this, specifically? This really is a bug and should be captured by some concerted work after a standard is decided upon.

As for the other items you bring up:

The lack of a top level namespace for the Python package components is captured in issue #133

The credentials problem has been raised before. We are working on a solution to credentials across the board, captured in #76

Debugging to a log file is already captured by #146

@jlebon
Copy link
Author

jlebon commented Feb 7, 2017

Documentation is a constant work-in-progress. We know we are woefully behind on that. Until about 2 weeks ago we had no docs, so we're trying to make steady progress on that!

Sounds good. This is by far the biggest issue I encountered.

Inconsistent field naming: Can you open a new issue to address this, specifically? This really is a bug and should be captured by some concerted work after a standard is decided upon.

OK, I created #149. I'll close this now, since all the other ones are captured in issues.

Thanks!

@jlebon jlebon closed this as completed Feb 7, 2017
@samvarankashyap
Copy link
Collaborator

@jlebon : Thank you for the feedback . We will working on the fixes. All the issues pointed out will be fixed in no time.

samvarankashyap added a commit to samvarankashyap/linchpin that referenced this issue Feb 27, 2017
To resolve the inconsistencies in topology field names schema_v4.json has been introduced.
In schema_v4.json the major changes are as follows:
<old field name> --> <new field name>
res_group_type   --> resource_group_type
res_defs         --> resource_definitions
res_name         --> name
res_type         --> type
assoc_creds      --> credentials

new fields in topology:
- schema_version

Resolves: CentOS-PaaS-SIG#149
See also: CentOS-PaaS-SIG#147
Note: Though the schema_v4.json is introduced . linchpin will try to address backward compatibilty towards old schema through logic implemented in playbooks.
samvarankashyap added a commit to samvarankashyap/linchpin that referenced this issue Mar 6, 2017
To resolve the inconsistencies in topology field names schema_v4.json has been introduced.
In schema_v4.json the major changes are as follows:
<old field name> --> <new field name>
res_group_type   --> resource_group_type
res_defs         --> resource_definitions
res_name         --> name
res_type         --> type
assoc_creds      --> credentials

new fields in topology:
- schema_version

Resolves: CentOS-PaaS-SIG#149
See also: CentOS-PaaS-SIG#147
Note: Though the schema_v4.json is introduced . linchpin will try to address backward compatibilty towards old schema through logic implemented in playbooks.
samvarankashyap added a commit to samvarankashyap/linchpin that referenced this issue Mar 9, 2017
To resolve the inconsistencies in topology field names schema_v4.json has been introduced.
In schema_v4.json the major changes are as follows:
<old field name> --> <new field name>
res_group_type   --> resource_group_type
res_defs         --> resource_definitions
res_name         --> name
res_type         --> type
assoc_creds      --> credentials

new fields in topology:
- schema_version

Resolves: CentOS-PaaS-SIG#149
See also: CentOS-PaaS-SIG#147
Note: Though the schema_v4.json is introduced . linchpin will try to address backward compatibilty towards old schema through logic implemented in playbooks.
samvarankashyap added a commit to samvarankashyap/linchpin that referenced this issue Mar 9, 2017
To resolve the inconsistencies in topology field names schema_v4.json has been introduced.
In schema_v4.json the major changes are as follows:
<old field name> --> <new field name>
res_group_type   --> resource_group_type
res_defs         --> resource_definitions
res_name         --> name
res_type         --> type
assoc_creds      --> credentials

new fields in topology:
- schema_version

Resolves: CentOS-PaaS-SIG#149
See also: CentOS-PaaS-SIG#147
Note: Though the schema_v4.json is introduced . linchpin will try to address backward compatibilty towards old schema through logic implemented in playbooks.
samvarankashyap added a commit to samvarankashyap/linchpin that referenced this issue Mar 30, 2017
To resolve the inconsistencies in topology field names schema_v4.json has been introduced.
In schema_v4.json the major changes are as follows:
<old field name> --> <new field name>
res_group_type   --> resource_group_type
res_defs         --> resource_definitions
res_name         --> name
res_type         --> type
assoc_creds      --> credentials

new fields in topology:
- schema_version

Resolves: CentOS-PaaS-SIG#149
See also: CentOS-PaaS-SIG#147
Note: Though the schema_v4.json is introduced . linchpin will try to address backward compatibilty towards old schema through logic implemented in playbooks.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Development

No branches or pull requests

3 participants