CodeCommitとローカル環境の連携 【CodeFamily Practices 1/7】
開発手法について
組織内での情報共有・連携が取れないサイロ化は問題であり、障害を取り除くための開発手法を用いてリリースを迅速化。
Agile
開発のプロセスにフォーカス。
開発のサイクルを細分化し、コードなどの更新とテストを頻繁に行うことで、迅速にソフトウェアをリリース。
顧客からの仕様変更や追加などへ柔軟に対応するため、ソフトウェアの更新を迅速に行う手法。
開発チームと運用チームの連携が必要なため、DevOpsの文化が必要。
CI/CD
継続的インテクレーション/継続的デリバリーの略。
ツールを活用した開発の自動化にフォーカス。
コードの頻繁な更新によるテストやデプロイ、本番環境へのリリースのプロセスを仕組み化。
ツールを用いて自動化することで、開発に集中することが可能。
統合開発環境、Git、構成管理、ビルド、テストなど、様々なツールを組み合わせて自動化。
DevOps
組織の文化や役割にフォーカス。
開発者と運用者のスキルを互いに習得し協働することで、障害点の無い効率的な開発・運用を実施。
開発の段階からセキュリティ基盤を導入するDevSecOpsがある。
| 用語 | 意味 |
|---|---|
| DevSecOps | DevOpsサイクルにセキュリティーを組み込んだソフトウェアの開発手法。 DevOpsによるアジリティを活用した短期的かつ頻繁な開発サイクルにより、早期にセキュリティ基盤を導入する必要性から生まれた。 自動化にセキュリティを統合し、コードの保管からパイプラインまでのプロセスを保護。 |
CodeCommitの概念
-
システム
プライベートGitリポジトリをホストする、マネージド型のソースコントロールサービス。 ハードウェアとソフトウェアの管理は不要で、転送時と保管時の暗号化をサポート。 開発のニーズに合わせて自動的にスケールアップし、大量のファイル、バージョン、ブランチの管理などに対応。 リポジトリのサイズ保存できるファイルのタイプに制限が無い。
リポジトリはS3とDynamo DBに暗号化と冗長性を確保して保存。この構成により、高い可用性と耐久性を維持。 -
操作
IAMでHTTPS接続とGit認証情報を使用し、ユーザー名とパスワードを生成。HTTPS接続で操作。 SSHキーをIAMユーザーに紐付け、SSH接続による操作も可能。ローカルにリモートリポジトリを作成し、GitコマンドとAWS CLIコマンドを使用。 -
AWSサービスとの統合
他のAWSサービスと統合が可能で、Cloud9でコードの作成とコミットを行い、EventBridgeでリポジトリの変更をトリガー、CodePipelineがコードを読み取りビルドとデプロイを実行。
| 用語 | 意味 |
|---|---|
| ソースコントロール | 開発プロセスにおける要素。 ソースコード管理システムを使用してコードの変更を履歴として残し、必要に応じて過去のバージョンに戻すことが可能。 開発者ごとに作業を切り離したり、コードのレビューと承認作業を行い反映させることが可能。 個人、もしくはチームに関わらず、コードを一元化して管理することで開発を効率化。 Gitはその代表的なシステム。 |
CodeCommitの開始方法
AWS CodeCommit の HTTPS Git 認証情報
IAMのセキュリティー認証情報を選択。
HTTTPSのGit認証情報を生成をクリック。
認証情報のCSVをダウンロード。
IAMに認証情報が登録される。
VSCodeの設定
ローカル環境で初めてクローンを作成する場合、Git認証を求められる。
IAMで取得したユーザネームの情報を入力。
Git認証のパスワードを入力。
Codecommitコンソール操作
CodeCommitコンソールにあるリポジトリを作成を選択。
リポジトリ名と説明を入力。
ローカルにリポジトリのクローンを作成するため、コマンドをコピー。
コンソール画面に戻り、リポジトリを確認。
ローカル操作
- Codecommit用のディレクトリを作成し、Gitの初期化を実行。
git config --global init.defaultBranch main
- Codecommitリポジトリのクローンを作成。共有リポジトリを作成できるように、ディレクトリ名を指定可能。
git clone https://git-codecommit.ap-northeast-1.amazonaws.com/v1/repos/abetest abetest
グローバルでinitをしなかった場合に実行。
git config --local init.defaultBranch main
git add .
git commit -m "first commit"
- オプション
uは上流ブランチに設定。--set-upstreamと同じ。
git push -u origin main
もしくは以下のコマンドでも可能だが、ブランチ名を指定していない状態。
git push
CodeCommitのリポジトリにファイルがアップロードされる。
コミットの履歴はコミットページから確認可能。
ブランチはブランチページより確認可能。
- リポジトリの削除(CLI)
aws codecommit delete-repository --repository-name abetest
- リポジトリの作成(CLI)
aws codecommit create-repository --repository-name abetest \
--repository-description "my repository" \
--tags Team=abetest
結果
REPOSITORYMETADATA arn:aws:codecommit:ap-northeast-1:123456789012:abetest 123456789012 https://git-codecommit.ap-northeast-1.amazonaws.com/v1/repos/abetest ssh://git-codecommit.ap-northeast-1.amazonaws.com/v1/repos/abetest 2023-02-22T04:19:12.706000+09:00 2023-02-22T04:19:12.706000+09:00 my repository 8a5e5bfc-7057-45fc-ae9c-73f535fd6414 abetest
共有リポジトリの作成
- リポジトリの作成は基本的に同じ。
git config --global init.defaultBranch main
git clone https://git-codecommit.ap-northeast-1.amazonaws.com/v1/repos/abetest share
クローンを作成すると、リポジトリの最新情報を取得。
- Codecommitリポジトリから最新情報を受け取る。
git pull
git add .
git commit -m "first commit"
git push
例) lambda-condition.ymlをCodeCommitリポジトリに追加。
片方のリポジトリへ移動し、CodeCommitリポジトリの最新情報を取得。
git pull
例) shareリポジトリからpushしたlambda-codition.ymlがabetestリポジトリへ反映された。
ブランチの作成
git log
結果
commit 3e9eba5c9a8c7c18dbc691f3776c59e8dee9a9b2 (HEAD -> main, origin/main)
Author: Shintaro Abe <123456789+Shintaro-Abe@users.noreply.github.com>
Date: Wed Feb 22 05:05:03 2023 +0900
sns.yml
- ブランチを作成する構文は、
git checkout -b ブランチ名 分岐させたいバージョンのコミットID
git checkout -b newbranch 3e9eba5c9a8c7c18dbc691f3776c59e8dee9a9b2
作成と同時に新しいブランチへ切り替え。
結果
Switched to a new branch 'newbranch'
Codecommitリポジトリへ新しいブランチを送信。
git push origin newbranch
- 新しいブランチをプルインするコマンド。
git fetch origin
- リポジトリの全ブランチのリスト。最新情報を入手する場合はプルインしてから行う。
git branch --all
結果
main
* newbranch
remotes/origin/main
remotes/origin/newbranch
git checkout newbranch
git branch
or
git status
結果
main
* newbranch
- ブランチを切り替える場合は
git checkoutコマンドを使用。
git checkout main
結果
Switched to branch 'main'
Your branch is up to date with 'origin/main'.
git branch
or
git status
結果
On branch main
Your branch is up to date with 'origin/main'.
コミットごとに、作成者やバージョンのリンクを表示。
コミットIDをクリックすると、バージョンの内容を確認可能
ブランチページで現在使用しているブランチを確認可能。
まとめ
CI/CDのプロセスでリポジトリの役割を担うCodeCommit。
今回はVSCodeからのpushを行ったが、Cloud9との連携も試して各ツールの利点などを掘り下げていきたい。
合わせて読みたい👀👉CodeFamily Practicesの記事
CodeBuildでビルドプロジェクトを作ってみよう 【CodeFamily Practices 2/7】
CodeDeployでEC2にアプリケーションをデプロイ 【CodeFamily Practices 3/7】
CodePipelineでシンプルなパイプラインを構築してみた 【CodeFamily Practices 4/7】
CodePipelineとCloudformationで、API Gatewayをビルド【CodeFamily Practices 5/7】
CodePipelineとServerless Frameworkでビルド【CodeFamily Practices 6/7】
CodePipelineとTerraformで、API Gatewayをビルド【CodeFamily Practices 7/7】
Discussion