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

feature: Object Templates #5556

Open
5 tasks
FragmentedPacket opened this issue Jan 23, 2025 · 0 comments · Fixed by #5610
Open
5 tasks

feature: Object Templates #5556

FragmentedPacket opened this issue Jan 23, 2025 · 0 comments · Fixed by #5610
Assignees
Labels
state/planned This issue is planned to be worked on in an upcoming release. type/feature New feature or request

Comments

@FragmentedPacket
Copy link
Contributor

FragmentedPacket commented Jan 23, 2025

Component

No response

Describe the Feature Request

Object Templates

The goal of this feature is provide the ability for users to define templates for Schema nodes that will allow easy and templated object creation that includes the relationships of the object.

There may be some features of templates that are delivered in later iterations, but this issue serves as a purpose of feedback into the feature and describing the use cases for the feature.

An example would be the Device Types feature in NetBox/Nautobot, but due to a flexible schema, we need to support custom objects.

Initial Ideas

  • One time clone/copy on creation of the object using the template
  • Create a template from an existing object
  • UI workflow:
    • When creating an object, if a template is tied to the schema node, provide it as a drop down option to select a single template to generate the object from.
    • Navigate to object template and have a button to create an object based off the template
    • View object that used the template for creation

Describe the Use Case

Use Cases

  1. The ability to define device types that can be used to define the different components of a device such as interfaces, etc. that will build the device in Infrahub with the defined components of the template.
  2. SFP that supports breakout cables will create the necessary interfaces/relationships based on the template selected.

Additional Information

Open Questions

  • What is the UI workflow for creating objects from a template? What do users think?
  • How nested do the object templates get when it comes to relationships?
  • How are templates managed and loaded into Infrahub?
  • To attempt to make these portable, should we allow users to define the kind of object so it allows portability with custom schemas? For example, we define a device with interfaces, but the user will define the kind of interfaces?
  • Is there a want for lifecycle management between the object templates and the created objects? What would this look like?

Related Issues

@FragmentedPacket FragmentedPacket added the type/feature New feature or request label Jan 23, 2025
@exalate-issue-sync exalate-issue-sync bot added state/need-triage This issue needs to be triaged state/planned This issue is planned to be worked on in an upcoming release. and removed state/need-triage This issue needs to be triaged labels Jan 23, 2025
@gmazoyer gmazoyer linked a pull request Jan 29, 2025 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
state/planned This issue is planned to be worked on in an upcoming release. type/feature New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants