https://yue-jenny.github.io/tags/github-app/ Recent content in Github App on Jenny blog Hugo -- gohugo.io en-us Tue, 10 Jan 2023 16:05:56 +0800 https://yue-jenny.github.io/2023/01/%E5%9C%A8-argo-cd-%E4%B8%AD%E4%BD%BF%E7%94%A8-github-app-credential-%E4%BD%9C%E7%82%BA%E9%A9%97%E8%AD%89%E6%96%B9%E5%BC%8F/ Tue, 10 Jan 2023 16:05:56 +0800 https://yue-jenny.github.io/2023/01/%E5%9C%A8-argo-cd-%E4%B8%AD%E4%BD%BF%E7%94%A8-github-app-credential-%E4%BD%9C%E7%82%BA%E9%A9%97%E8%AD%89%E6%96%B9%E5%BC%8F/ <h2 id="在-argo-cd-中使用-github-app-credential-作為驗證方式">在 Argo CD 中使用 Github App Credential 作為驗證方式</h2> <h3 id="前言">前言</h3> <p>在先前文章<a class="link" href="../%e4%bd%bf%e7%94%a8-docker-desktop-%e9%81%8b%e8%a1%8c-argo-cd-%e4%bb%a5%e5%8f%8a%e5%9c%a8-argo-cd-%e5%85%a7%e5%bb%ba%e7%ab%8b-app-%e5%81%b5%e6%b8%ac-repository-%e7%8b%80%e6%85%8b/" >使用 Docker Desktop 運行 Argo CD 以及在 Argo CD 內建立 App 偵測 repository 狀態</a> 有提到 private repository 驗證的方式有 <code>SSH</code>、<code>Https</code> 以及 <code>Github App Credential</code></p> <p>此文章來筆記下，如何在 Argo CD 中使用 <code>Github App Credential</code> 作為驗證方式</p> <h3 id="實作">實作</h3> <ul> <li> <p>建立 Github App</p> <ul> <li> <p>步驟可參考 👉 <a class="link" href="https://docs.github.com/en/developers/apps/building-github-apps/creating-a-github-app" target="_blank" rel="noopener" >官方文件</a></p> </li> <li> <p>其中，特別需要設定的值</p> <ul> <li> <p><strong>Github App Name</strong>: 為你的 Github App 取名稱</p> </li> <li> <p><strong>Homepage URL</strong>: 你的 web app URL</p> <ul> <li>我的 argo cd 是以 docker desktop 啟動，並利用 port forward 方式，讓本地利用 <a class="link" href="http://localhost" target="_blank" rel="noopener" >localhost</a> 可連線 dashboard，可參考<a class="link" href="https://yue-jenny.github.io/2023/01/%E4%BD%BF%E7%94%A8-docker-desktop-%E9%81%8B%E8%A1%8C-argo-cd/" target="_blank" rel="noopener" >我的文章使用 Docker Desktop 運行 Argo CD</a></li> </ul> </li> <li> <p><strong>Callback URL</strong>: 當 github 認證完畢後，要 redirect 回去的 URL</p> </li> </ul> <p><img src="https://yue-jenny.github.io/2023/01/%E5%9C%A8-argo-cd-%E4%B8%AD%E4%BD%BF%E7%94%A8-github-app-credential-%E4%BD%9C%E7%82%BA%E9%A9%97%E8%AD%89%E6%96%B9%E5%BC%8F/basic-info-1.png" width="927" height="866" srcset="https://yue-jenny.github.io/2023/01/%E5%9C%A8-argo-cd-%E4%B8%AD%E4%BD%BF%E7%94%A8-github-app-credential-%E4%BD%9C%E7%82%BA%E9%A9%97%E8%AD%89%E6%96%B9%E5%BC%8F/basic-info-1_huc5491ce2dc66550e600cbcca3297735a_53484_480x0_resize_box_3.png 480w, https://yue-jenny.github.io/2023/01/%E5%9C%A8-argo-cd-%E4%B8%AD%E4%BD%BF%E7%94%A8-github-app-credential-%E4%BD%9C%E7%82%BA%E9%A9%97%E8%AD%89%E6%96%B9%E5%BC%8F/basic-info-1_huc5491ce2dc66550e600cbcca3297735a_53484_1024x0_resize_box_3.png 1024w" loading="lazy" alt="basic information 1 " class="gallery-image" data-flex-grow="107" data-flex-basis="256px" ></p> <p><img src="https://yue-jenny.github.io/2023/01/%E5%9C%A8-argo-cd-%E4%B8%AD%E4%BD%BF%E7%94%A8-github-app-credential-%E4%BD%9C%E7%82%BA%E9%A9%97%E8%AD%89%E6%96%B9%E5%BC%8F/basic-info-2.png" width="839" height="911" srcset="https://yue-jenny.github.io/2023/01/%E5%9C%A8-argo-cd-%E4%B8%AD%E4%BD%BF%E7%94%A8-github-app-credential-%E4%BD%9C%E7%82%BA%E9%A9%97%E8%AD%89%E6%96%B9%E5%BC%8F/basic-info-2_hua8d901ec71c1f4aeb1737fac5fac2f29_47817_480x0_resize_box_3.png 480w, https://yue-jenny.github.io/2023/01/%E5%9C%A8-argo-cd-%E4%B8%AD%E4%BD%BF%E7%94%A8-github-app-credential-%E4%BD%9C%E7%82%BA%E9%A9%97%E8%AD%89%E6%96%B9%E5%BC%8F/basic-info-2_hua8d901ec71c1f4aeb1737fac5fac2f29_47817_1024x0_resize_box_3.png 1024w" loading="lazy" alt="basic information 2 " class="gallery-image" data-flex-grow="92" data-flex-basis="221px" ></p> </li> </ul> </li> <li> <p>建立完成 Github App 後，還有兩件事情要做，Argo CD 設定連線時會用到</p> <ul> <li> <p>查看 Github App Installation ID</p> </li> <li> <p>看 URL <strong><a class="link" href="https://github.com/settings/installations/%7bYour" target="_blank" rel="noopener" >https://github.com/settings/installations/{Your</a> Github App Installation ID}</strong>, 可確認 Github App Installation ID</p> </li> </ul> </li> <li> <p>建立 private key</p> <ul> <li> <p>到 <code>Settings / Developer settings / Github Apps / {your-github-app-name}</code> 的 <code>General</code></p> <p><img src="https://yue-jenny.github.io/2023/01/%E5%9C%A8-argo-cd-%E4%B8%AD%E4%BD%BF%E7%94%A8-github-app-credential-%E4%BD%9C%E7%82%BA%E9%A9%97%E8%AD%89%E6%96%B9%E5%BC%8F/get-private-key-1.png" width="681" height="337" srcset="https://yue-jenny.github.io/2023/01/%E5%9C%A8-argo-cd-%E4%B8%AD%E4%BD%BF%E7%94%A8-github-app-credential-%E4%BD%9C%E7%82%BA%E9%A9%97%E8%AD%89%E6%96%B9%E5%BC%8F/get-private-key-1_hub4eca3abecd1bcd4a43190f529bfc084_23447_480x0_resize_box_3.png 480w, https://yue-jenny.github.io/2023/01/%E5%9C%A8-argo-cd-%E4%B8%AD%E4%BD%BF%E7%94%A8-github-app-credential-%E4%BD%9C%E7%82%BA%E9%A9%97%E8%AD%89%E6%96%B9%E5%BC%8F/get-private-key-1_hub4eca3abecd1bcd4a43190f529bfc084_23447_1024x0_resize_box_3.png 1024w" loading="lazy" alt="set a private key" class="gallery-image" data-flex-grow="202" data-flex-basis="484px" ></p> </li> <li> <p>將頁面往下拉可以看見 Private keys，點 <code>Generate a private key</code> 建立一組 private key</p> <p><img src="https://yue-jenny.github.io/2023/01/%E5%9C%A8-argo-cd-%E4%B8%AD%E4%BD%BF%E7%94%A8-github-app-credential-%E4%BD%9C%E7%82%BA%E9%A9%97%E8%AD%89%E6%96%B9%E5%BC%8F/get-private-key-2.png" width="806" height="251" srcset="https://yue-jenny.github.io/2023/01/%E5%9C%A8-argo-cd-%E4%B8%AD%E4%BD%BF%E7%94%A8-github-app-credential-%E4%BD%9C%E7%82%BA%E9%A9%97%E8%AD%89%E6%96%B9%E5%BC%8F/get-private-key-2_hu418a32b8c70bb709a8142c5945f221c3_17725_480x0_resize_box_3.png 480w, https://yue-jenny.github.io/2023/01/%E5%9C%A8-argo-cd-%E4%B8%AD%E4%BD%BF%E7%94%A8-github-app-credential-%E4%BD%9C%E7%82%BA%E9%A9%97%E8%AD%89%E6%96%B9%E5%BC%8F/get-private-key-2_hu418a32b8c70bb709a8142c5945f221c3_17725_1024x0_resize_box_3.png 1024w" loading="lazy" alt="set a private key" class="gallery-image" data-flex-grow="321" data-flex-basis="770px" ></p> </li> </ul> </li> <li> <p>到 Argo CD 的 Repositories 設定連線資訊</p> <ul> <li> <p>如何到這頁來設定，可參考<a class="link" href="https://argo-cd.readthedocs.io/en/stable/user-guide/private-repositories/#github-app-credential" target="_blank" rel="noopener" >官方文件</a></p> </li> <li> <p>這邊要填寫與設定的資訊分成兩部分</p> <ol> <li> <p>先選到 <code>VIA GITHUB APP</code></p> </li> <li> <p>依照上面的訊息完成填寫<code>框 2</code>的內容</p> </li> <li> <p>點 <code>CONNECT</code>，完成</p> </li> </ol> <p><img src="https://yue-jenny.github.io/2023/01/%E5%9C%A8-argo-cd-%E4%B8%AD%E4%BD%BF%E7%94%A8-github-app-credential-%E4%BD%9C%E7%82%BA%E9%A9%97%E8%AD%89%E6%96%B9%E5%BC%8F/connect-repo-1.png" width="849" height="881" srcset="https://yue-jenny.github.io/2023/01/%E5%9C%A8-argo-cd-%E4%B8%AD%E4%BD%BF%E7%94%A8-github-app-credential-%E4%BD%9C%E7%82%BA%E9%A9%97%E8%AD%89%E6%96%B9%E5%BC%8F/connect-repo-1_hud66466c9c685aacdb265a07c8d099a51_42099_480x0_resize_box_3.png 480w, https://yue-jenny.github.io/2023/01/%E5%9C%A8-argo-cd-%E4%B8%AD%E4%BD%BF%E7%94%A8-github-app-credential-%E4%BD%9C%E7%82%BA%E9%A9%97%E8%AD%89%E6%96%B9%E5%BC%8F/connect-repo-1_hud66466c9c685aacdb265a07c8d099a51_42099_1024x0_resize_box_3.png 1024w" loading="lazy" alt="Repositories 設定連線資訊" class="gallery-image" data-flex-grow="96" data-flex-basis="231px" ></p> </li> </ul> </li> <li> <p>連線成功</p> <p><img src="https://yue-jenny.github.io/2023/01/%E5%9C%A8-argo-cd-%E4%B8%AD%E4%BD%BF%E7%94%A8-github-app-credential-%E4%BD%9C%E7%82%BA%E9%A9%97%E8%AD%89%E6%96%B9%E5%BC%8F/connect-repo-2.png" width="1377" height="193" srcset="https://yue-jenny.github.io/2023/01/%E5%9C%A8-argo-cd-%E4%B8%AD%E4%BD%BF%E7%94%A8-github-app-credential-%E4%BD%9C%E7%82%BA%E9%A9%97%E8%AD%89%E6%96%B9%E5%BC%8F/connect-repo-2_hu171eb20f762b1004e7638657a00c1e7d_21668_480x0_resize_box_3.png 480w, https://yue-jenny.github.io/2023/01/%E5%9C%A8-argo-cd-%E4%B8%AD%E4%BD%BF%E7%94%A8-github-app-credential-%E4%BD%9C%E7%82%BA%E9%A9%97%E8%AD%89%E6%96%B9%E5%BC%8F/connect-repo-2_hu171eb20f762b1004e7638657a00c1e7d_21668_1024x0_resize_box_3.png 1024w" loading="lazy" alt="連結成功" class="gallery-image" data-flex-grow="713" data-flex-basis="1712px" ></p> </li> <li> <p>建立一組 NEW APP</p> <p><img src="https://yue-jenny.github.io/2023/01/%E5%9C%A8-argo-cd-%E4%B8%AD%E4%BD%BF%E7%94%A8-github-app-credential-%E4%BD%9C%E7%82%BA%E9%A9%97%E8%AD%89%E6%96%B9%E5%BC%8F/new-app.png" width="1408" height="564" srcset="https://yue-jenny.github.io/2023/01/%E5%9C%A8-argo-cd-%E4%B8%AD%E4%BD%BF%E7%94%A8-github-app-credential-%E4%BD%9C%E7%82%BA%E9%A9%97%E8%AD%89%E6%96%B9%E5%BC%8F/new-app_hu8d10ffa92c0cef9f32058c6d59afce6b_119484_480x0_resize_box_3.png 480w, https://yue-jenny.github.io/2023/01/%E5%9C%A8-argo-cd-%E4%B8%AD%E4%BD%BF%E7%94%A8-github-app-credential-%E4%BD%9C%E7%82%BA%E9%A9%97%E8%AD%89%E6%96%B9%E5%BC%8F/new-app_hu8d10ffa92c0cef9f32058c6d59afce6b_119484_1024x0_resize_box_3.png 1024w" loading="lazy" alt="NEW APP" class="gallery-image" data-flex-grow="249" data-flex-basis="599px" ></p> </li> </ul> <h2 id="心得">心得</h2> <p>看到官方提供驗證 private repository 的方式有 <code>Github App Credential</code>，讓我相當好奇，於是就有了這篇文章。<br> 後續再寫一篇文章來記錄 <code>Github App</code> 與 <code>OAuth App</code>差異。</p> <h2 id="參考資料-">參考資料 👐</h2> <ul> <li><a class="link" href="https://docs.github.com/en/developers/apps/getting-started-with-apps/about-apps" target="_blank" rel="noopener" >about-apps</a></li> <li><a class="link" href="https://argo-cd.readthedocs.io/en/stable/user-guide/private-repositories/#github-app-credential" target="_blank" rel="noopener" >github-app-credential</a></li> </ul> <p><strong>🍀 「記錄」是為了有意識地、有條理地統整所學的學習知識。</strong><br> <strong>🍀 最後，若喜歡我的分享，可以免費幫我按讚，是對我最大的鼓勵! ✨ ✨ ✨</strong></p>