search

Azure / apiops

APIOps applies the concepts of GitOps and DevOps to API deployment. By using practices from these two methodologies, APIOps can enable everyone involved in the lifecycle of API design, development, and deployment with self-service and automated tools to ensure the quality of the specifications and APIs that they’re building.
https://azure.github.io/apiops
MIT License
328 stars 193 forks source link

[BUG] #700

Open rhenatas opened 3 weeks ago

rhenatas commented 3 weeks ago

Release version

APIOps Toolkit for Azure APIM v5.1.4

Describe the bug

Hi,

I am Rhenatas Rajan from Toyota Motor Corporation Australia.

We have a plan to implement APIOPS in our environment. Based on that i downloaded the v5.1.4 code and started implementing. During implementation, I found the following issues. I reached out to Microsoft support program. They directed me to this forum.

Following are the issue I am facing :

  1. While extracting the specific api using configuration.extractor.yaml file, i am getting and additional folder named artifact-name/version sets. This is not required.
  2. I need to extract the specific subscription names that is associated to the API. But, it does not extract when i try to extract specific API. Whereas, subscriptions gets populated when i extract all.
  3. I would like to extract only the Global policy xml . But, that is not happening.

Please do the needful.

apiNames:

productNames:

tagNames:

subscriptionNames:

backendNames:

diagnosticNames:

loggerNames:

namedValueNames:

policyFragmentNames:

Expected behavior

subscription folder should appear

Actual behavior

Subscription folder not appearing

Reproduction Steps

  1. Run the extractor pipeline with extract using configurator.extractor.yaml pipeline with the below mentioned entries:

apiNames:

productNames:

tagNames:

subscriptionNames:

backendNames:

diagnosticNames:

loggerNames:

namedValueNames:

policyFragmentNames:

github-actions[bot] commented 3 weeks ago 
  Thank you for opening this issue! Please be patient while we will look into it and get back to you as this is an open source project. In the meantime make sure you take a look at the [closed issues](https://github.com/Azure/apiops/issues?q=is%3Aissue+is%3Aclosed) in case your question has already been answered. Don't forget to provide any additional information if needed (e.g. scrubbed logs, detailed feature requests,etc.).
  Whenever it's feasible, please don't hesitate to send a Pull Request (PR) our way. We'd greatly appreciate it, and we'll gladly assess and incorporate your changes.
guythetechie commented 2 weeks ago

@rhenatas - please use the latest version instead of v5. Any bug fixes will be implemented in the newer versions only.

As for your questions:

  1. You can prevent the extraction of version sets by updating your configuration.extractor.yaml. Add versionSetNames: [ignore]. That said, if version sets are being extracted, it's probably because you have versioned APIs. Publishing those APIs will fail without the version sets.
  2. If the subscription names were automatically created, their names were likely randomly generated (something like 6a3kadfkalfakldkl3). continuous-integration-subscription is likely the display name, not the name. Look in your artifacts/subscriptions folder and check the subscriptionInformation.json file for the display name.
  3. That is not supported in the extractor. You will have to use a .gitignore or something to prevent the other poliy.xml files from making it to source control.
rhenatas commented 2 weeks ago

Hi @guythetechie ,

Thanks for your reply.

  1. I tried V5.1.3 for versionsetnames : [ignore]. It did not work. I am setting up the V6.0.1.3 workspace. will try and update you
  2. I want to extract the specific subscription names that is associated to the API. That is not happening in V5.1.3. Are you supporting in the latest version
  3. I want to extract the global policy.xml file only. Not the other apis, products, subscrptions. Are you supporting in the latest version