開発チームと運用チームの一貫したワークフローを構築する方法

GitHubが最近発表した「2022 State of the Octoverse」レポートにおいて、HashiCorp Configuration Language（HCL）がGitHubで最も成長したプログラミング言語となりました。HashiCorpは、クラウドコンピューティングのためのInfrastructure as Code (IaC) 自動化のリーディングプロバイダーです。HCLは、Terraformや Vaultなどのツールと共に使用されるHashiCorpの設定言語で、マルチクラウドやオンプレミス環境において、人間が読みやすい設定ファイルでIaC機能を提供することができます。 HCLの成長は、インフラ、運用、開発者の世界を一つにすることの重要性を示しています。これは常にDevOpsの目標でした。しかし、現実には、多くの企業でこれらの世界がサイロ化したままになっています。この記事では、開発チームと運用チーム、そしてセキュリティ、ガバナンス、ネットワーク・チームを結びつけるビジネスと文化の影響について見ていきます。そして、GitHubとHashiCorpがCI/CDパイプライン全体を通して一貫したワークフローとガードレールをどのように実現できるかを探ります。従来の運用（Ops）の世界 HashiCorpの共同創業者であるArmon Dadgar氏は、従来のOpsの世界を「木」に例えて説明しています。トランクには、物事を成し遂げるために企業で必要な、共有され一貫性のあるサービスがすべて含まれています。セキュリティ要件、Active Directory、ネットワーク構成などを考えてみてください。ブランチは、企業内のさまざまなビジネスラインを表し、社内または社外にサービスや製品を提供します。葉は、ソフトウェアやサービスが展開されるさまざまな環境と技術を表します。クラウド、オンプレミス、コンテナ環境などです。多くの企業では、これらの異なるビジネス領域間のコミュニケーション・チャネルやプロセスが煩雑で、コストがかかる場合があります。インフラやアーキテクチャに大きな変更があった場合、通常、複数のチケットが複数のチームに提出され、企業内のさまざまな部署でレビューと承認が行われます。組織を保護するために、変更諮問委員会が一般的に使用されます。通常、文書化が完了しない限り、変更を進めることはできません。一般的に、将来の監査に必要な一連のガバナンスログと監査可能な成果物が存在します。もし、チームが最適化された自動化されたワークフローを持ち、それを使って納期を早め、安全なガードレールのセットで仕事を終わらせることができるようになったら、企業にとってより有益ではないでしょうか？これは、時間とコストの大幅な節約につながり、ビジネス価値の向上につながる可能性があります。最近のForresterのレポートでは、GitHubを使うことで3年間で433%のROIを達成したという結果が出ています。もちろん、時間の節約や効率の向上は言うまでもなく、一貫性と作業の合理化によってもたらされるその他の質的なメリットもあります。あなたの製品やサービスは、遅々として進まない、手作業でエラーが起こりやすいプロセスではなく、セキュリティとガバナンスが組み込まれた最適化された経路でデプロイされることになるでしょう。これこそ、DevOps、GitOps、Cloud Nativeの夢ではないでしょうか？ IaCの導入別の例えを使いましょう。IaCは、ソフトウェアやサービスをホストするリソース（サーバー、データベース、ネットワークコンポーネント、PaaSサービスなど）の設計図だと考えてください。病院と学校を設計する場合、両シナリオで同じ全体的な設計図を使用することはないでしょう。なぜなら、両シナリオはまったく異なる目的を持ち、要件も大きく異なるからです。しかし、2つの設計にまたがって再利用できる構成要素や基礎があるはずです。 HCLのようなIaCソリューションでは、ソフトウェア開発でメソッド、モジュール、パッケージライブラリを再利用するのと同様に、これらのビルディングブロックを定義して再利用することができます。IaCであるため、アプリケーションでコラボレーションやデプロイを行う際に使用するのと同じ推奨プラクティスをインフラに採用することができます。結局のところ、DevOpsの方法論を採用するチームは、生産性、クラウド対応のスケーラビリティ、コラボレーション、およびセキュリティが向上することが分かっているのです。より良いデリバリー方法このような背景から、インフラストラクチャをコード化することで得られる具体的なメリットと、それが従来の運用文化の変革にどのように役立つかを探ってみましょう。リポジトリにコードを保存するまずは、最も低いところにある果実から始めましょう。IaCであれば、GitHubなどのソースコード・リポジトリにインフラストラクチャやアーキテクチャ・パターンを保存することができます。これにより、完全なバージョン履歴を持つ単一のソース・オブ・トゥルースを手に入れることができる。これにより、必要に応じて変更をロールバックしたり、履歴から特定のバージョンの真実をデプロイしたりすることが容易にできるようになります。企業内のチームは、Git リポジトリ内の個別のブランチでコラボレーションを行うことができます。ブランチを使うことで、チームや個人は「自分のスペース」で生産的になり、「本番」の真実のソース（通常はメインブランチ）から離れて、他のチームの進行中の作業に悪影響を与えることを心配する必要がなくなります。前節で述べた再利用可能なビルディングブロックであるTerraformモジュールも、Gitリポジトリに保存されバージョン管理されています。そこからTerraform Cloudのプライベートレジストリにインポートすることで、全チームが簡単にモジュールを発見できるようになります。GitHubで新しいリリースバージョンのタグが付けられると、レジストリにも自動的に更新されます。早期かつ頻繁にコラボレーションする上で説明したように、チームは現在の状態に影響を与えないように、別々のブランチで変更を加えることができます。しかし、その変更を本番環境のコードベースに反映させたい場合はどうすればいいのでしょうか。もしあなたが Git に慣れていないのなら、プルリクエストという言葉を聞いたことがないかもしれません。その名のとおり、あるブランチから別のブランチに変更を「引き込む」ことができます。 GitHub のプルリクエストは、チーム内の他のユーザーとコラボレーションするためのすばらしい方法です。ピアレビューを受けることで、フィードバックを自分の作業に反映させることができます。プルリクエストのプロセスは、チーム全体のコラボレーションを促進するために意図的に非常にソーシャルになっています。 GitHub では、ブランチ保護ルールを設定してメインブランチへの直接の変更を不可とすることもできます。そうすれば、すべてのユーザーがコードを実運用に移すにはプルリクエストを経由しなければならなくなります。ブランチ保護ルールには、最低限必要なレビュアーの人数を指定することもできます。ヒント:GitHub のCODEOWNERS ファイルという特殊なファイルを使えば、編集中のファイルに基づいてプルリクエストにレビュアーを自動的に追加することができます。例えば、すべてのHCLファイルは、コアインフラストラクチャチームによるレビューが必要かもしれません。あるいは、勘定系システムのIaC設定には、コンプライアンスチームによるレビューが必要かもしれません。通常、特定の周期で行われる変更諮問委員会とは異なり、プルリクエストはコードを本番環境に導入するためのプロセスの自然な一部となります。また、意思決定や議論の質も向上します。外部システムで推奨される「イエス/ノー」の決定ではなく、プルリクエストで直接コンテキストと推奨を確認することができます。プロビジョニングプロセスではコラボレーションも重要です。GitHubとTerraform Cloudの統合により、これらのプロセスを複数のチーム間でスケールさせることができます。Terraform Cloud は Terraform の状態を安全に保存し、GitHub リポジトリと直接統合することで、プルリクエストとマージのライフサイクルをターンキーで体験できるようなワークフロー機能を提供します。自動化された品質レビューをプロセスに取り入れる前節の続きですが、プルリクエストでは、提案された変更の品質を自動的にチェックすることもできます。ソフトウェアでは、アプリケーションが正しくコンパイルされているか、ユニットテストは合格しているか、セキュリティの脆弱性はないかなどをチェックするのが一般的です。 IaCの観点からは、同様の自動チェックを我々のプロセスに取り入れることができます。GitHub のステータスチェックを使えば、特定の条件を満たしているかどうかを明確に把握することができます。 GitHub Actions は、GitHub のプルリクエストでこうした自動チェックを実行するためによく使われるものです。IaCの品質を判断するために、以下のようなチェックを入れることができます。コードが構文的に正しいかどうかを検証する（例えばTerraform validate）。コードが特定の標準に従っていることを確認するためのLinting（例えば、TFLintや Terraform format）。静的コード解析により、「設計時」にインフラストラクチャの設定ミスを特定します (たとえば、tfsecやterrascan など)。関連するユニットテストまたは統合テスト（Terratest などのツールを使用）。インフラストラクチャを「スモークテスト」環境にデプロイし、インフラストラクチャの構成が（既知のパラメータセットと共に）望ましい状態にデプロイされることを検証します。 Terraform on GitHubを使い始めるのは簡単です。TerraformのバージョンはLinuxベースのGitHubでホストされたランナーにインストールされていますし、HashiCorpには公式のGitHub Actionがあり、指定したTerraformバージョンを使ってランナーにTerraformをセットアップしてくれます。

意外と知らない、GitHub Codespacesでできる10のこと！

Published at February 28, 2023
Category: Engineering,Product,Codespaces
Author: Rizel Scarlett

Summary

GitHub Codespacesは、仮想マシン上に強力な統合開発環境（IDE）を提供し、性能の低いマシンを持つ開発者がローカルリソースを消耗せずにコーディングできるようにし、AI画像の生成など様々なタスクに利用することが可能です。

GitHub Codespacesの可能性を最大限に引き出す10のヒントとトリックをご紹介します。AIイメージの生成から、セルフガイドのコーディングワークショップの運営まで、このパワフルなツールを使ってソフトウェア開発のワークフローを最適化する方法を発見してください。

飛行中の飛行機でコーディングしているような気分になったことはありませんか？私が初めてコードを学んだ5年ほど前、私のノートパソコンは苦痛を感じるほど遅かったのですが、もっと良いものを買う余裕はありませんでした。そのため、私はコードを実行するためにjsbin.comのようなブラウザベースの IDE に頼っていました。

GitHub Codespaces は、仮想マシン上で本格的なブラウザベースの統合開発環境 (IDE) を提供します。つまり、ローカルマシンのリソースを消費することなく、コードを書くことができるのです。クラウドパワーによる開発は、マシン性能の低いユーザーにとっては画期的なことですが、GitHub Codespacesの多機能性についてはまだほんの少ししか触れていないのが現状です。

このブログでは、GitHub Codespacesを最大限に活用するための方法をいくつか紹介します。

AI画像の生成

GitHub CodespacesでStable Diffusionを実行することができます。DALL-EやMidjourneyのように、Stable Diffusionはディープラーニングを使ってテキストをアートに変換する数多くの機械学習モデルの1つです。

Stable Diffusionは、以下の手順でテキストをアートに変換します。

AIが画像を受け取る
AIは、画像が全く認識できなくなるまで、画像にノイズを加える。(ノイズは、ピクセル化されたドットの別の言い方です）。
AIがノイズを除去し、クリアで高品質な画像を生成する
AIは「LAION-Aesthetics」と呼ばれるデータベースから学習する。このデータベースには画像とテキストのペアがあり、テキストを画像に変換するための学習を行っています。

このプロセス全体は、リソースを大量に消費します専門家は、Stable Diffusionのようなデータの多いタスクを実行するには、強力なグラフィック・プロセッシング・ユニット（GPU）を搭載したコンピュータを使用することを推奨しています。しかし、誰もがそのような計算能力を持つコンピューターを持っているわけではないので（私も含めて）、私は代わりにGitHub Codespacesを使用しています。

コードスペースは仮想マシン上でホストされるので、マシンの種類を2コアから32コアまで設定することができます。より強力なマシンが必要な場合は、GPUを搭載したコードスペースへのアクセスをリクエストすることができます。つまり、機械学習エンジニアがiPadやChromebookを使って、GitHub Codespaces経由でデータ量の多い深層学習の計算を行うことができるのです。

私がどのようにコードスペース内でアートを生成したかについては、私のDEV投稿とリポジトリをチェックしてみてください。

以下では、GitHub Codespacesで生成したコードとAI画像をご覧いただけます。


from torch import autocast
画像のプロンプトをここで変更しましょう
prompt = “綿菓子の髪とピンクのドレスを着た漫画の黒人の女の子が、綿菓子の雲があるピンクの空の前に立っている”
with autocast(device):
image = pipe(prompt, height=768, width=768).images[0].
イメージ

Computer-generated drawing-style image of a Black woman wearing a pink t-shirt, standing in front of a green field and some trees, with a pink cloud floating above her in the blue sky.

GitHub のコード空間をコマンドラインから管理する

2000年代には、うっかりドキュメントを閉じてしまったり、コンピュータが突然シャットダウンしてしまったりして、せっかく作った作品が永遠に失われてしまうことがありました。幸いなことに、今は2023年、GitHub Codespacesを含め、多くのエディターがそのような事態を防いでくれています。コードスペースを閉じれば、たとえ変更をコミットし忘れたとしても作業内容が保存されます。

しかし、コードをリポジトリにプッシュしたからといって、コードスペースが終了したのであれば、遠慮なく削除してしまってかまいません。GitHub のコードスペース管理は、次のような理由から重要です。

GitHub Codespace がたくさんあって混乱して、誤って間違ったものを削除してしまわないように。
デフォルトでは、アクティブでないGitHub Codespacesは30日ごとに自動的に削除されます。

GitHub CodespacesはGitHub UIまたはGitHub CLIで管理することができます。GitHub CLIでは、以下のようなことができます。

コードスペースの作成

gh codespace create -r OWNER/REPO_NAME [-b BRANCH] (コードスペースの作成)

自分のコードスペースをすべてリストアップする

gh コードスペースの一覧

コードスペースを削除する

gh コードスペースの削除 -c CODESPACE-NAME

コードスペースの名前を変更する

gh コードスペース編集 -c CODESPACE-NAME -d DISPLAY-NAME

コードスペースのマシンタイプを変更

gh コード空間の編集 -m MACHINE-TYPE-NAME

GitHub コードスペースを CLI で管理する方法については、これですべてを網羅したわけではありません。コマンドラインからコードスペースを管理する方法については、こちらで詳しく説明しています。

チームメイトとのペアプログラミング

リモートで作業しているときのペアプログラミングは、なかなか難しいものです。チームメイトの隣に座っていないと、画面やコードを共有するのが難しくなります。しかし、それがうまくいけば、双方のコミュニケーションと技術的なスキルの向上につながるので、価値があるのです。Live Share エクステンションをインストールしてポートを転送すれば、GitHub Codespaces でのリモートペアプログラミングをより簡単に行えるようになります。

ローカルでホストしているウェブアプリの URL を共有し、チームメイトや共同作業者がそれを使えるようにすることができます。共有したいポートを右クリックすると、ポートの可視性を "Private" から "Public" に切り替えるオプションが表示されます。ローカルアドレスの値をコピーして必要な共同作業者に共有すれば、あなたとは別の部屋にいてもローカルでホストされているウェブアプリを閲覧したりテストやデバッグをしたりすることができるようになります。

Screenshot of how to share the URL of your locally hosted web app by setting its port to public.

Live Shareエクステンションを使えば、あなたとあなたのチームメイトが同時に同じプロジェクトに入力することができます。チームメイトのカーソルとあなたのカーソルがハイライトされるので、誰がタイピングしているのかを簡単に識別することができます。

Screenshot of code in an editor showing sections highlighted and labeled with the names of users currently working on those lines.

AIとのペアプログラム

Visual Studio Codeのマーケットプレイスでは、GitHubCopilotをはじめ、GitHub Codespacesと互換性のあるさまざまな拡張機能が提供されています。コードを書きながらアイデアを交換したいけれど、周りに誰もいないという場合は、GitHub Copilotという拡張機能をインストールして、AIとペアプログラミングをしてみてはいかがでしょうか。GitHub CopilotはAIを搭載したコード補完ツールで、コードスニペットを提案したり、コードを補完したりして、より速くコードを書くことを支援します。

コード補完による生産性向上だけでなく、GitHub Copilotは様々なバックグラウンドを持つ開発者に力を与えてくれます。私のお気に入りのGitHub Copilotツールの1つは、ハンズフリーで音声起動するAIプログラマーの「Hey, GitHub」です。以下のビデオで、"Hey, GitHub "が手先が不自由な人や視覚障害者の開発者体験をどのように向上させるかをご覧ください。

GitHub Copilotのその他の使用例については、こちらをご覧ください。

Gif demonstrating how Copilot can recommend lines of code.

コーディングを教える

ブートキャンプ、教室、ミートアップ、カンファレンスなどを通じてコーディングについて教育する中で、私は、人々にコードを教えることは難しいということを学びました。ワークショップでは、参加者がフォローできるように環境を整えることにほとんどの時間を費やしてしまうこともあります。しかし、GitHub Codespacesでコーディングを教えたり、ワークショップを運営したりすることは、参加者全員にとってより良い経験を生み出します。初心者の開発者に、テンプレートを使って作業するためにリポジトリをクローンする方法を理解することを期待するのではなく、コードスペースを開いて、設定した開発環境で作業することができるのです。これで、誰もがあなたと同じ環境を持っていて、簡単にフォローできるという安心感を得ることができます。これにより、多くの時間、ストレス、混乱が軽減されます。

GitHub Codespaces を教師や学生にとってより利用しやすくするために、180時間の無料利用（50人のクラスで月5回分の課題に相当）を提供しました。GitHub Codespacesの設定と、CodeTourなどの拡張機能を活用したセルフガイドのワークショップの運営に関するチュートリアルをご覧ください。

ハーバード大学最大のクラスであるCS50が、どのようにGitHub Codespacesを使って学生にコードを教えているのか、ご覧ください。

新しいフレームワークを学ぶ

コードを学ぶとき、チュートリアルを追うことに時間をかけすぎてしまいがちです。チュートリアルの消費とプロジェクトの構築のバランスをとることで、学習はより効果的になることが多いのです。GitHub Codespaces のクイックスタート・テンプレートは、フレームワークを学ぶための迅速かつ効率的な方法です。

クイックスタートテンプレートには、Next.js, React.js, Django, Express, Ruby on Rails, Preact, Flask, Jupyter Notebookといった最も一般的なアプリケーションフレームワークの定型コード、転送ポート、設定済み開発コンテナなどが含まれています。テンプレートは、開発者に、コードスペースでアプリケーションを構築、テスト、デバッグするためのサンドボックスを提供します。ワンクリックでテンプレートを開き、新しいフレームワークで実験することができます。

コードスペースでフレームワークを試すことで、開発者はフレームワークの構造と機能をよりよく理解し、よりよい定着と習得につなげることができます。たとえば、私は Jupyter Notebook にはなじみがありませんが、GitHub Codespaces の Jupyter Notebook テンプレートを使ったことがあります。この定型文のおかげで、Jupyter Notebookの構造を実験し、よりよく理解することができました。このテンプレートを使って、小さなプロジェクトも作りました。

このブログ記事とテンプレートは、GitHub Codespacesを使って、開発者がReactの最初の行を書くのをガイドするもので、チェックしてみてください。

Screenshot showing a list of available codespace templates.

環境変数の保存

過去に何度か、環境変数を誤って共有したり誤操作したりしたことがありました。ここでは、私が環境変数を誤って扱ってしまった、ぞっとするような瞬間をいくつか紹介します。

ライブデモで聴衆に見せてしまった。
環境変数をGitHubにアップロードしてしまった。
チームメイトと値を共有する良い方法が見つからなかった。

このような事態を避けるために、GitHub の Codespaces シークレットを使うことができました。GitHub Codespaces の secret には、API Key や環境変数、秘密の認証情報などを GitHub Codespaces ごとに保存しておくことができます。

GitHub Codespaces secret に保存した後は、コード内でprocess.env.{SUPER_SECRET_API_KEY} のように環境変数を参照することができるようになります。

GitHub Codespaces で環境変数を安全に保存する方法については、こちらのチュートリアルを参照ください。

Screenshot showing how to securely store your environment variables with GitHub Codespaces.

開発者をより早く取り込む

一般に、ソフトウェアエンジニアはチームに参加したときに自分のローカル環境をセットアップする責任があります。ローカル環境のセットアップには、ドキュメントの質にもよりますが一日から一週間かかることもあります。幸いなことに、組織は GitHub Codespaces を使ってカスタム環境を設定し、オンボーディングプロセスを自動化することができます。新しいエンジニアがチームに参加する際、コードスペースを開くと、必要な拡張機能、依存関係、環境変数がコードスペース内に存在するため、ローカル環境のセットアップを省略することができるのです。

2021年、GitHubエンジニアリングチームは、GitHub.comの開発において、macOSモデルからGitHubコードスペースに移行しました。14年以上経過し、私たちのリポジトリはディスク上に約13GBを蓄積していました。リポジトリのクローン、依存関係のセットアップ、ブートストラップに約45分かかりました。GitHub Codespacesに完全に移行した後は、事前に設定された信頼性の高いコードスペースでGitHub.comを起動するのに10秒しかかかりません。

しかし、私たちの言葉を鵜呑みにする必要はありません。通信会社TELUSの情報サービス担当マネージャーであるKetan Shah氏は、「GitHubは新入社員のオンボーディングプロセスを丸々一日短縮してくれるんだ」と証言しています。新しい開発者は、すべてが一カ所に集まっているため、数分で作業を開始することができます」。

GitHub Codespacesによる開発者の迅速なオンボーディングについて、詳しくはこちらをご覧ください。

TELUS社によるGitHub Codespacesの活用方法
Elanco社によるGitHub Codespacesの利用方法
GitHub Codespace を使って、開発コンテナでポジティブなオンボーディング体験を構成する方法

技術面接の実施

持ち帰りのプロジェクトやテクニカルスクリーン、ライブコーディングは、ソフトウェア開発者にとって苦痛でありながらも必要な面接体験の一部となります。候補者にきちんと設定された信頼性の高い環境を提供することで、面接官は不安を軽減し、パフォーマンスを向上させることができるのです。GitHub Codespacesを使えば、候補者はもう環境のセットアップを心配する必要はありません。面接官はGitHub Codespacesを使ってリアルタイムにフィードバックを行い、Visual Studio Code Live Shareなどの組み込みツールを使ってコラボレーションを行うことができます。さらに、GitHub Codespacesは面接プロセスにおいて安全で隔離された環境を提供し、機密情報やデータの保護を保証します。

GitHubの様々なエンジニアリングチームがGitHub Codespacesを使用してどのようにインタビューを実施しているかをご覧ください。

クラウド上で好きなエディターでコーディング

私はVisual Studio Codeが大好きで、メインエディターとして使っています。しかし、あなたの役割や他の要因によって、異なる好みがあるかもしれません。 GitHub Codespaces は Visual Studio Code 以外にも、以下のエディタをサポートしています。

Jupyter Notebook
IntelliJ IDEA
RubyMine
GoLand
PyCharm
PhpStorm
WebStorm

でも、まだあるんです

GitHub Codespacesの超能力は、どんなデバイスからでもコーディングができ、インターネットさえあれば標準化された環境を手に入れることができることです。しかし、ソフトウェア開発のワークフローをより簡単にする機能も搭載されています。GitHubユーザーは月60時間、GitHub Proユーザーは月90時間無料で利用できるので、実際に試してその良さを体験しない手はない。さあ、今すぐ試してみませんか？

Source

10 things you didn’t know you could do with GitHub Codespaces

Ever feel like you’re coding on a plane mid-flight? When I first learned to code about five years ago, my laptop was painstakingly slow, but I couldn’t afford a better one. That’s why I relied on browser-based IDEs like jsbin.com to run my code. Now fast forward to today, where GitHub Codespaces …

GitHub Blog | 非公式日本語

すべての公開リポジトリでシークレットスキャンアラートが無料で利用可能になりました！