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

Update workflow node aliasing to be seperate from the identifier #11911

Open
sean-m-sullivan opened this issue Mar 15, 2022 · 6 comments
Open

Comments

@sean-m-sullivan
Copy link
Contributor

ISSUE TYPE
  • Feature Idea
SUMMARY

However the Identifier has been setup to be used as a unique ID

    identifier:
      description:
        - An identifier for this node that is unique within its workflow.

And with the previous UUID system they were unique, and identifiers to differentiate and know which node was which.

Proposal
An alias field should be added to the API for the workflow_nodes to be used as the alias when displayed in the visualizer, so the user has the option of using Both the Identifier as a unique ID as has been the practice until this previous change, AND an alias that is separate from the identifier.

@termlen0
Copy link

This is critical for controller config as code. The identifier is used for tying together the workflow nodes and having the identifier to use a different string than the JT name will make it easy to manage.

@sean-m-sullivan sean-m-sullivan changed the title Update aliasing to be seperate from the identifier Update workflow node aliasing to be seperate from the identifier Mar 15, 2022
@AlanCoding
Copy link
Member

This came up in #2032, as a UI feature, and there was no resistance to the idea.

@IPvSean
Copy link
Contributor

IPvSean commented Mar 16, 2022

This came up in #2032, as a UI feature, and there was no resistance to the idea.

From reading the initial issue... the problem is not the alias (I want an alias), the problem is the alias IS the unique identifier for a node within a workflow.

So to summarize:
Yes, I would like an ALIAS for the visualization of jobs in the workflow visualizer. Look how un-human friendly a workflow can be without an alias (this is my blog on ansible.com this week)->
image

but.... if we use the ansible.controller.workflow_job_template_node I would expect that the identifier!=alias... (which I think is what @sean-m-sullivan is saying).

https://docs.ansible.com/ansible/latest/collections/awx/awx/workflow_job_template_node_module.html#parameter-identifier

Imagine someone provisions Automation controller with Ansible (Automation controller as code) like we do in workshops, demos, consulting engagements). Then someone, out of band, adds an alias. The workflow will break next time the workflow is run. It is also confusing because it is not a common design flow to have a unique identifier be something like an alias. Alias is defined as "used to indicate that a named person is also known or more familiar under another specified name."

Hopefully this makes more sense?

@termlen0
Copy link

100% what @IPvSean said.

@sean-m-sullivan
Copy link
Contributor Author

Bumping this again as it was on Long term 2.3 Roadmap, and no longer in the 2.4 Roadmap, Ran into this again at another customer.

@DE110283
Copy link

Voting for this!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

7 participants