fabrikate icon indicating copy to clipboard operation
fabrikate copied to clipboard

Getting Started guide does not work

Open BertelBB opened this issue 5 years ago • 1 comments

Describe the bug: If you follow the instructions in the Getting Started section, then the resulting generated files are not compatible with Flux. This is because when you run the command to add simple-service, you are actually referencing the fabrikate-istio definition. The cloud-native definition also references fabrikate-istio as a subcomponent, as is stated in the guide. This is a problem for Flux because now you have duplicate YAML files for istio. See screenshot below.

To Reproduce: Run the fab commands from the guide in your cluster directory.

fab add cloud-native --source https://github.com/microsoft/fabrikate-definitions --path definitions/fabrikate-cloud-native
fab add simple-service --source https://github.com/microsoft/fabrikate-definitions --path definitions/fabrikate-istio

Create the config/prod.yaml file as stated in the guide. Run: fab install fab generate prod

Expected behavior: I expect the generated files for simple-service to include YAML files describing that service but not istio.
I guess the YAML files existed at some point in the fabrikate-definitions repo, but were moved and the Getting Started guide was not updated to reflect those changes.

Screenshots: image

Additional context: I am going through the Bedrock tutorial and creating a High Level Fabrikate description is part two of that tutorial. I am new to all of this, but as I understand it the generated files from Fabrikate are the files that should be added to the manifest repository, which Flux monitors for changes. Please correct me if I am wrong about this part.

Desktop (please complete the following information):

  • OS: Windows Subsystem for Linux (Ubuntu 18.04)

BertelBB avatar Feb 18 '20 11:02 BertelBB