Allow customized topic name format

[jkorab]

Add a topicNameFormat configuration element with tokens that pull in environment variables, and also ones that correspond to the config elements. That way, if people wanted to tweak the default conventions, it's configurable.
e.g.
topicNameFormat={env.CP_ENVIRONMENT_NAME}-{team}-{source}-{project}-{topic}

[purbon]

Hi @jkorab
thanks a lot for your question.

Actually currently this is somehow possible, if you build a topology that looks like

---
company: "company"
env: "env"
team: "team"
source: "source"
projects:
  - name: "foo"

this will generate topic that looks like

team.company.env.source.foo.foo

the only key that is mandatory in the topology is the team, because at the end of the story we need a PK for the case when there are multiple files representing a single topology so we can group.

Are you thinking more about the line of adding patterns in the values that get resolved at execution time?

[purbon]

The current pattern is:

• [team].[others in order of appearance].[project].[topic]

might be we can add a pattern as configuration ? this might be a way to implement this. What do you think?

[nerdynick]

I need to add this support for my customer, any opposition against implementing this using Jinja2 templates? Would allow for great flexibility for the end-user, so we don't have to keep making changes to support more use cases. Plus it's a templating engine that most people in the DevOps world are used to.

[purbon]

that would be awesome, go ahead! if I can help in anyhow let me know :-)

[purbon]

Just remember at some point we need a way to group multiple files into a single topology so we need to designate a PK for the grouping.

[nerdynick]

Yeah, that's something I've been thinking through with a few of the changes. I'm looking at the idea of a context that would change based on the Base/Core, Topology file, and the project. This would be to address this issue, as well as the Vault integration, and I'd imagine more features would need this support.

[purbon]

Hi @nerdynick , are you making any sharable advance on this topic? otherwise I would really like to start tracking this problem here.

[purbon]

Hi @nerdynick, with #68 I have renamed team for context for a better understanding. I am sorry if this caused problems with your current work line, however I had to do that to enable a few people move forward. The change is a simple rename as context describe much better the purpose of the old team.

[purbon]

related to #84

[purbon]

@jkorab I added #86 to implement a solution for this request. Would you be so nice to let me know if this fits your expectations? thanks a lot.

[purbon]

@nerdynick I know you are working on this, however I need to move forward with it. happy to get your feedback as well.