在 Argo CD 中使用 Github App Credential 作為驗證方式

前言

在先前文章使用 Docker Desktop 運行 Argo CD 以及在 Argo CD 內建立 App 偵測 repository 狀態 有提到 private repository 驗證的方式有 SSH、Https 以及 Github App Credential

此文章來筆記下，如何在 Argo CD 中使用 Github App Credential 作為驗證方式

實作

• 建立 Github App

  • 步驟可參考 👉 官方文件

  • 其中，特別需要設定的值

    • Github App Name: 為你的 Github App 取名稱

    • Homepage URL: 你的 web app URL

      • 我的 argo cd 是以 docker desktop 啟動，並利用 port forward 方式，讓本地利用 localhost 可連線 dashboard，可參考我的文章使用 Docker Desktop 運行 Argo CD

    • Callback URL: 當 github 認證完畢後，要 redirect 回去的 URL

    

    

• 建立完成 Github App 後，還有兩件事情要做，Argo CD 設定連線時會用到

  • 查看 Github App Installation ID

  • 看 URL https://github.com/settings/installations/{Your Github App Installation ID}, 可確認 Github App Installation ID

• 建立 private key

  • 到 Settings / Developer settings / Github Apps / {your-github-app-name} 的 General

    

  • 將頁面往下拉可以看見 Private keys，點 Generate a private key 建立一組 private key

    

• 到 Argo CD 的 Repositories 設定連線資訊

  • 如何到這頁來設定，可參考官方文件

  • 這邊要填寫與設定的資訊分成兩部分

    1. 先選到 VIA GITHUB APP

    2. 依照上面的訊息完成填寫框 2的內容

    3. 點 CONNECT，完成

    

• 連線成功

  

• 建立一組 NEW APP

  

心得

看到官方提供驗證 private repository 的方式有 Github App Credential，讓我相當好奇，於是就有了這篇文章。
後續再寫一篇文章來記錄 Github App 與 OAuth App差異。

參考資料 👐

• about-apps
• github-app-credential

🍀 「記錄」是為了有意識地、有條理地統整所學的學習知識。
🍀 最後，若喜歡我的分享，可以免費幫我按讚，是對我最大的鼓勵! ✨ ✨ ✨