[Question] How to selectively publish APIs across diff instance of APIM env

Aperta
#789 15 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
25/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
azure, git, github
Ambito
api, cloud, devops

Direzione di ricerca

Inizia con la pipeline del publisher APIOps e il file Publisher Config descritti nell’issue, quindi verifica come le distribuzioni dell’intero repository e quelle basate sui commit selezionano attualmente i contenuti. Definisci come dovrebbe funzionare un meccanismo di esclusione o selezione per le API promosse da dev a UAT e conferma che una promozione dell’ambiente possa omettere le API non completate mantenendo le modalità di distribuzione esistenti.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Release version

v6.0.1.10

Question Details

Background
I have 3 different instances of APIM, 1 APIM instance for each env. E.g. dev, uat and production (PRD).
Each env have their own branch in Github too.

APIM between each env may not be the same, because APIs are in different stages of SDLC. More details below.

In Dev APIM will contains APIs that are Proof-of-concept, under development or for demo. When the APIs are ready from development or successful POC, i will put the APIs in UAT APIM for user testing. Once UAT is ready and user sign-off, only then the API will go into PRD APIM.

Publishing Across Env
My ideal flow of ApiOps (CICD + GitOps) is for main to be single source of truth.
So from main, i will generate the dev branch, then uat branch.
Any new API will be a feature branch from dev.

Flow: feature -> dev -> uat -> prd

Issue
There is currently no option to selectively publish specific APIs during promotion between environments.

The publisher supports only:

Full repository deployment, or
Deployment by specific commit ID

As a result, APIs that are not yet ready for promotion (e.g. unfinished POCs or APIs without user sign-off) get deployed unintentionally.

Hence will like to check if anyone has similar set-up and how you configure your CI/CD?

Expected behavior

When Merge to higher env, e.g. from dev to uat
Able to select which APIs that are not to be publish e.g. in Publisher Config file
Only APIs that are not in it will be publish

Actual behavior

Either publish by commit id or whole repo

Reproduction Steps
  • Setup 3 different Azure API Management (APIM) instances — one for each environment:
    apim-dev (development)
    apim-uat (user acceptance testing)
    apim-prd (production)

  • Configure the APIOps extractor and publisher pipelines, each linked to a different GitHub branch:
    dev branch → apim-dev
    uat branch → apim-uat
    prd branch → apim-prd

  • In apim-dev, create several APIs for testing or proof-of-concept (POC).
    Example:
    orders-api (ready for UAT)
    inventory-api (still under development)

  • Run the extractor pipeline for apim-dev, pushing configurations to the dev branch.

  • Merge the dev branch into the uat branch to promote APIs to UAT.

  • Run the APIOps publisher pipeline for the uat environment.

  • Observe that the publisher pipeline publishes all APIs from the dev branch (both orders-api and inventory-api) to apim-uat.

Lingua principale
C#
Stelle
448
Fork
247
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di Azure/apiops

Tutte le issue di Azure/apiops

Issue simili

Altre issue su C#

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.