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

オープン
#789 コメント 15 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
25/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
azure, git, github
領域
api, cloud, devops

調査の方向性

Issue に記載されている APIOps publisher pipeline と Publisher Config ファイルから始め、完全なリポジトリベースのデプロイとコミットベースのデプロイで、現在どのようにコンテンツが選択されているかを確認します。dev から UAT に昇格される API に対して、除外または選択の仕組みがどのように機能すべきかを定義し、既存のデプロイモードを維持したまま、環境のプロモーションで未完成の API を除外できることを確認します。

索引モデルが issue の本文から書いたものです。

説明

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.

主要言語
C#
スター
448
フォーク
247
PR マージ指標
30日以内にマージされた PR はありません

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

Azure/apiops のほかの issue

Azure/apiops の issue をすべて見る

似ている issue

C# の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。