GitHubとの連携

GitHub連携とは

GitHub連携機能は、RinstackとGitHubとの間で双方向のコード連携を実現する機能です。 自動生成したソースコードや構成図を指定のリポジトリへ直接コミット・プッシュできるだけでなく、既存のリポジトリからTerraformコードをインポートすることも可能です。これにより、既存資産の活用から最新のコード管理までを一気通貫で行うことができ、開発チームの生産性を最大化します。

GitHub連携の前提条件

連携実行の条件

GitHub連携を実行するには、以下の条件を満たす必要があります:

  • 管理者による承認:連携リクエストを送信し、管理者の承認が必要

  • リポジトリのアクセス権限:連携対象となるGitHubリポジトリに対する権限が必要

  • 有効なRinstackアカウント:ログイン済みのRinstackアカウントが必要

  • ネットワーク接続:インターネット接続が安定していること

連携の種類

  • プロジェクト連携:GitHubリポジトリとRinstackプロジェクトの連携

連携の開始方法

アクセス手順

方法1

  1. Rinstackにログイン

  2. ヘッダーで「新しいプロジェクトの作成」を選択

  3. プロジェクトの新規作成画面で「GitHubインポート」のトグルをONにする

  4. 連携プロセスを実行

方法2

  1. Rinstackにログイン

  2. ヘッダーで任意のプロジェクトを選択し、サイドメニューの「インフラ生成」をクリック

  3. 画面右側の結果表示エリアで「Git」タブを選択し、「GitHubアカウントを連携」をクリック

  4. 連携プロセスを実行

連携の実行

連携手順

  1. プロジェクト新規作成画面、またはインフラ生成画面にある[GitHubアカウントを連携]をクリックすると、GitHubの認証画面がに遷移します

  • 認証画面の「Organization access」項目にある「Request」をクリックし、 管理者へ連携リクエストを送信してください ※管理者による承認後、連携が有効になります

注意事項

初回連携時は以下手順を実行してください

  • 「Authorized OAuth Apps」にて、rinstack-appsを選択

  • 「Organization access」にて、インポートしたいリポジトリに権限を付与

連携の確認

Github設定の「GitHubアカウント」「リポジトリ」「ブランチ」の各プルダウンに、 該当する項目が表示されていたら連携完了です

連携状態の管理

プロジェクト連携解除の方法

  • 対象のプロジェクトを削除することで、GitHubリポジトリとの連携を解除できます ※プロジェクト内のすべてのデータが削除されますので、実行の際はご注意ください

利用可能な機能

変更内容の確認

  • ソースコードのインポート: GitHub上の既存リポジトリからTerraformコードを取り込み、Rinstackで構成変更やドキュメント生成のベースとして活用できます

  • ソースコードのエクスポート: Rinstackで生成・編集したコードや構成図を、指定のリポジトリ・ブランチへ直接コミットおよびプッシュし、シームレスに開発フローへ反映できます

  • 変更点の確認(Diff表示): 前回生成したコードと、今回LLMが生成した最新コードとの差分を画面上で詳細に比較できます。追加・削除された箇所を事前に把握できるため、安全なコード更新が可能です

セキュリティとプライバシー

データ保護

  • 暗号化通信:すべての通信はHTTPS/TLSで暗号化

  • トークン管理:認証トークンは安全に管理され、定期的に更新

  • 最小権限の原則:必要最小限の権限のみを要求

  • OAuth認証:OAuthで連携開始時にアカウント認証を実施

プライバシー配慮

  • 個人情報の保護:個人を特定できる情報は適切に保護

  • データの利用範囲:連携データはサービス提供の目的のみに使用

  • 削除権:連携解除時にはデータが適切に削除

アクセス制御

  • ユーザーレベルの制御:各ユーザーが自分の連携を個別に管理

  • 監査ログ:連携操作の履歴が記録され、必要に応じて確認可能

注意事項

  • 定期的な確認:連携状態を定期的に確認し、不正な連携がないかチェック

  • 権限の適切な管理:必要以上の権限を付与しないよう注意

Last updated