Skip to content
This repository has been archived by the owner on Jan 10, 2024. It is now read-only.

Show additional properties / details in deploymentNode diagrams #46

Closed
djjlewis opened this issue Feb 11, 2023 · 5 comments
Closed

Show additional properties / details in deploymentNode diagrams #46

djjlewis opened this issue Feb 11, 2023 · 5 comments

Comments

@djjlewis
Copy link
Contributor

I'm not sure the best place to put this, but I'm using Structurizr lite in a container so will go with here for now :-)

C4-PlantUML allows for any number of Property attributes to be applied to a deployment node which can be useful for giving additional details (SKUs, sizing, IPs, hostnames etc) e.g.

SetPropertyHeader("Property","Value", "Description")
AddProperty("Prop1", "Value1", "Details1")
AddProperty("Prop2", "Value2", "Details2")
Deployment_Node_L(nodeAlias, "Label", "Optional Type", "Optional Description (with custom property header)") {

  WithoutPropertyHeader()
  AddProperty("PropC1", "ValueC1")
  AddProperty("PropC2", "ValueC2")
  Container(containerAlias, "Label", "Technology", "Optional Description (without property header)")
}

image

I noticed that the deploymentNodes rendered in the deployment diagrams by Structurizr Lite (and the CLI export) only show the values from name and technologyand anything else is ignored / not rendered e.g. description

As a work around I can add anything of interest into name or technology, but do you think it would be useful to render a general set / table of properties similar to C4-PlantUML?

@simonbrowndotje
Copy link
Contributor

Properties are not rendered, to keep the diagram looking simple, but are available via the tooltips.

@djjlewis
Copy link
Contributor Author

Thanks @simonbrowndotje , I wondered if this is something I could add for our own use and noticed it has in fact already been included (#12). However, this PR did not include support for Deployment Nodes as they are rendered on a slightly different code path.

I've just opened #45 which add this support so would be grateful if you can take a look!

@simonbrowndotje
Copy link
Contributor

I'm using Structurizr lite

I've just opened #45 which add this support

Are you aware that Lite doesn't use the export library?

@djjlewis
Copy link
Contributor Author

Yes.. tbh, including this information in an export from the cli was my main use case but didn't appreciate how the different repos were split and used until I went to do the work yesterday!

@simonbrowndotje simonbrowndotje transferred this issue from structurizr/lite Feb 13, 2023
@simonbrowndotje
Copy link
Contributor

Sure, PR merged ... thanks!

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

No branches or pull requests

2 participants