Azure-docs: Full documentation of YAML and JSON format

[MikeChristensen]

I've seen a few examples of Service Fabric Mesh application definitions in both JSON and YAML, however I can't see to find documentation on all the various options and how to do some of the more advanced things. Are these formats documented somewhere?

---

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: ee008384-eb96-4f20-89eb-8fa4226c5a3f
• Version Independent ID: 3092e38b-706e-c550-eca3-2e6b017ec7ae
• Content: Introduction to Azure Service Fabric Resource Model
• Content Source: articles/service-fabric-mesh/service-fabric-mesh-service-fabric-resources.md
• Service: service-fabric-mesh
• GitHub Login: @vturecek
• Microsoft Alias: vturecek

[mimckitt]

Thanks for the feedback! We are currently investigating and will update you shortly.

[MikeChristensen]

I did a bit more digging, and it seems that YAML is just supported by the Visual Studio tools, and converted to JSON under the covers which is what the CLI tools use. So, mainly we should have good JSON documentation. Basically my app design is something like this:

• 1 app
• 4 services: Api, Web, Cache, Sql
• 2 networks, each with public IP that exposes port 80
  
  
  
  • ApiNetwork maps port 80 to ApiService port 80
  
  
  • WebNetwork maps port 80 to WebService port 80
  
  
• Both Web and Api can resolve Cache and Sql services by hostname

I had this working in Service Fabric, but I haven't a clue as to how to describe this with JSON, and all of the samples are just super basic examples.

[mimckitt]

@MikeChristensen thanks Mike for the extra details. Can you explain a bit more what you are looking for assistance with in the context of this doc?

[MikeChristensen]

I am looking for assistance writing JSON templates for Service Fabric Mesh. I can find simple examples, but I cannot find detailed documentation on network resources, service properties, etc.

[MikeChristensen]

Also can you clarify what _The current preview only supports a one to one mapping between applications and networks_ means?

[mimckitt]

Got it. Thanks!

@vturecek can you chime in and assist on this one?

[dkkapur]

@MikeChristensen - I'm working on adding some better documentation on the options you have with YAML and JSON to describe applications correctly. This will include details on properties in resource types. If you have any specific questions in the next week or two I can definitely help out before the documentation is published - feel free to reach out to me at deep dot kapur at Microsoft dot com and we can work through setting up the template correctly. With regards to your app description above - definitely seems doable; just wanted to clarify what you mean by "resolve by hostname" for the web/api services, since in Mesh you do not have access to the host.

For the bit on app / network mapping - in the future, we will support having multiple applications in the same network, but currently, each application has its own network.

[mimckitt]

thanks @dkkapur!

@MikeChristensen does that help?

[mimckitt]

Thanks again for helping out @dkkapur

@MikeChristensen I will close this for now but if you have additional questions just let us know :)

[robinmanuelthiel]

I would not say that this is closed, as we do not have "Service Fabric Mesh application definitions in both JSON and YAML" as originally asked for in the issue. We should reopen it!