Remove "collection" from git repository name

[rpignolet]

Context

We have 3 repositories with collection in the name:

• tdp-collection
• tdp-collection-extras
• tdp-collection-prerequisites

We named them that because they are repositories with an Ansible collection.

Problem

When adding the collection to an Ansible collection directory, we remove the collection word and replace - by _. For example in getting started https://github.com/TOSIT-IO/tdp-getting-started/tree/b82ee024ec1215f5441e53a46cf0b5df982cd859/ansible_collections/tosit.
We remove the word collection in order to call playbook with tosit.tdp.xxx.yyy as we see here https://github.com/TOSIT-IO/tdp-collection/blob/290d4b63e39d850c1a63c373a351ea4ffda630b1/playbooks/hdfs_datanode_install.yml#L12.

Proposition

For consistency, we should remove the collection word from our repositories name.

For tdp-collection, a repository tdp will conflict with our TDP repository so we should add a suffix.

[Nuttymoon]

Why not use a naming convention like the collections in ansible-collections:

• tdp-collection -> tosit.tdp
• tdp-collection-extras -> tosit.tdp_extras
• etc.

[rpignolet]

My bad I understood Ansible Galaxy. Our org name already have tosit in the name. It will be weird to have a repo tosit-io/tosit.tdp no ?

[Pierrotws]

Not really shocking to me. At least it would use naming convention of ansible-collections, implicitely suggesting what it does. Which is not the case with any tdp-base / tdp-core which can be easily miggled with tdp-lib and/or tdp-server.

[gonzaloetjo]

Considering both points (name repetition and convention) maybe use tdp.core:

• tosit-io/tdp-collection -> tosit-io/tdp.core
• tosit-io/tdp-collection-extra -> tosit-io/tdp.extras

[rpignolet]

With tdp.core we will have this tree: ansible_collections/tosit/tdp/core and with tdp_core: ansible_collections/tosit/tdp_core so one more directory with tdp.core.

[gonzaloetjo]

I see it normal as tosit has the tdp project with different features (core, extras, lib, server) and tosit may have other projects.

[jusstol]

Hi! I think these repositories should keep "collection" in their names, to better differentiate them from the ones that are not ansible collections like tdp-lib or tdp-vagrant . The main one would be renamed :

• TOSIT-IO/tdp-collection 👉 TOSIT-IO/tdp-collection-core
• TOSIT-IO/tdp-collection-prerequisites
• TOSIT-IO/tdp-collection-extras
• TOSIT-IO/tdp-observability 👉 TOSIT-IO/tdp-collection-observability

As for the link between the repositories names and installed collections paths, I think the key is to rely on ansible-galaxy and not git submodules. That way, repositories names could be anything and collections paths wouldn't be impacted. Example of requirements.yml with current configuration using git tags as versions :

collections:
  - name: https://github.com/TOSIT-IO/tdp-collection.git
    type: git
    version: 0.0.1 # branch or tag or commit
  - name: https://github.com/TOSIT-IO/tdp-collection-extras.git
    type: git
    version: 0.0.1 # branch or tag or commit
  - name: https://github.com/TOSIT-IO/tdp-collection-prerequisites.git
    type: git
    version: 0.0.1 # branch or tag or commit

Which after installation (ansible-galaxy collection install -r requirements.yml) generates this tree in the collections path :

./ansible_collections
└── tosit
    ├── tdp
    ├── tdp_extra
    └── tdp_prerequisites

So if we edited each galaxy.yml to :

namespace: tdp
# tdp-collection/galaxy.yml
name: core
# tdp-collection-prerequisites/galaxy.yml
name: prerequisites
# tdp-collection-extras/galaxy.yml
name: extras

It would generate :

./ansible_collections
└── tdp
    ├── core
    ├── extras
    └── prerequisites

So importing playbooks would look like :

name: tdp.core.hadoop.datanode
name: tdp.prerequisites.system

If you want tosit to be mentioned, you can change the namespaces to namespace: tosit_tdp (as collections cannot have a third level of definition), and you would have :

./ansible_collections
└── tosit_tdp
    ├── core
    ├── extras
    └── prerequisites

name: tosit_tdp.core.hadoop.datanode
name: tosit_tdp.prerequisites.system

If you still want to use git submodules in tdp-getting-stared for development purposes, then I think the tree should closely match what is generated by ansible-galaxy, to make sure all TDP collections are still usable by users that install them via ansible-galaxy, and that the READMEs works for both cases.

Hope that wasn't off topic, have a nive day!

PS: I initially voted to rename tdp-collection to tdp-core then changed my mind but the poll is now closed.

[rpignolet]

Thanks for the input, totally on topic. You can change your vote by clicking on "Hide Results" below the poll answers.

[gonzaloetjo]

Conclusions:

To resume the discussion and @jusstol explanation. I think there's 3 different topics

Topics - Polls:

1. Ansible-galaxy or git submodules
2. Repository names
3. Folder tree in getting-started

"Ansible-galaxy or git submodules" should the first separate poll, and if you agree I will open that. Regarding the next topics i'll resume their content:

Repository names:

Option by @jusstol: Argument collection has to remain and continue to use tdp.

- TOSIT-IO/tdp-collection-core
- TOSIT-IO/tdp-collection-extras
- TOSIT-IO/tdp-collection-prerequisites
- TOSIT-IO/tdp-collection-observability

Option by @gonzaloetjo: Argument collection has to remain and tdp is unnecessary.

- TOSIT-IO/collection-core
- TOSIT-IO/collection-extras
- TOSIT-IO/collection-prerequisites
- TOSIT-IO/collection-observability

Option by @Nuttymoon:

- TOSIT-IO/tosit.tdp
- TOSIT-IO/tosit-extras
- TOSIT-IO/tosit.prerequisites
- TOSIT-IO/tosit.observability

Option by 2 @gonzaloetjo:

- TOSIT-IO/tdp.core
- TOSIT-IO/tdp.extras
- TOSIT-IO/tdp.prerequisites
- TOSIT-IO/tdp.observability

Folder tree

Possible thanks to tags and galaxy according to @jusstol:

Option 1:

./ansible_collections
└── tosit_tdp
    ├── core
    ├── extras
    └── prerequisites

Option 2:

./ansible_collections
└── tdp
    ├── core
    ├── extras
    └── prerequisites

Option 3:

./ansible_collections
└── tosit
    ├── tdp
    ├── tdp_extra
    └── tdp_prerequisites

Option 4:

./ansible_collections
└── tosit
    ├── core
    ├── extra
    └── prerequisites

[gonzaloetjo]

"Ansible-galaxy or git submodules" should the first separate poll, and if you agree I will open that.

If anyone wants to add an other option to the other 2 topics, please add it here.

[Pierrotws]

Vote for:

Option by 2 @gonzaloetjo:

• TOSIT-IO/tdp.core
• TOSIT-IO/tdp.extras
• TOSIT-IO/tdp.prerequisites
• TOSIT-IO/tdp.observability

with:
Option by 2 @gonzaloetjo:

./ansible_collections
└── tdp
├── core
├── extras
└── prerequisites

[jusstol]

Repository names :

• TOSIT-IO/tdp-collection-core
• TOSIT-IO/tdp-collection-extras
• TOSIT-IO/tdp-collection-prerequisites
• TOSIT-IO/tdp-collection-observability

Folder tree :

./ansible_collections
└── tdp
    ├── core
    ├── extras
    └── prerequisites

[PACordonnier]

My vote:
Repository names:

Option by @jusstol: Argument collection has to remain and continue to use tdp.

TOSIT-IO/tdp-collection-core
TOSIT-IO/tdp-collection-extras
TOSIT-IO/tdp-collection-prerequisites
TOSIT-IO/tdp-collection-observability

I just have an issue with prerequisites being on the same level as core. Since prerequisites does not implement the DAG, i see a bit of confusion between the two. Maybe TOSIT-IO/collection-prerequisites even though I'm not a big fan either.

Tree:
./ansible_collections
└── tdp
├── core
├── extras
└── prerequisites

Same argument as before here.