diff --git a/README.md b/README.md index bf4b9d7..dceb560 100644 --- a/README.md +++ b/README.md @@ -1 +1,39 @@ -# codespaces-playground \ No newline at end of file +# GitHub Codespaces + Microsoft Azure 体験ハンズオン + +## GitHub Codespaces について知る + +[GitHub Codespaces](https://github.co.jp/features/codespaces) は、GitHub のプラットフォーム上でサポートされる、わずか数秒で起動する Visual Studio Code ベースの開発環境です。 + +![GitHub Codespaces - 超高速で構築するクラウド開発環境](./docs/images/github-codespaces_hero.png) + +※ 現在(2022年10月)の段階では、GitHub Team または GitHub Enterprise Cloud で利用する Organization の配下で利用できます。個人アカウントの場合、ベータ版の申請が受理された方は利用できです。なお、ベータ版の利用申請は、現在は申し込み口の公開が終了したようです。 + +### 特徴 + +- GitHub プラットフォーム上に立ち上げられた独立した環境 +- 実態はコンテナだが、コンテナについての知識がなくても利用しやすい +- ブラウザまたは Visual Studio Code から利用できる +- ほとんどの Visual Studio Code の拡張機能を利用できる +- GitHub とのシームレスな連携 +- Visual Studio Code のポートフォワーディング機能（`localhost` としてアクセス可能）に加え、パブリックまたは組織内のみ限定でURLとして公開できる +- 事前にビルドしておく機構を用いて、素早く環境を立ち上げられる +- 利用量（アクティブな時間とストレージ利用量）に従った課金 + - コンピュート SKU: 2 ～ 32 core、ストレージ: 1GB/month +- [Development Containers](https://containers.dev/) に則ったカスタマイズができる + - [dev container features](https://containers.dev/features) を利用して簡単に機能追加ができる + - 拡張機能のプリインストール + - 任意のイメージ及び Dockerfile で構築できる + + +## Microsoft Azure について知る + +- [Microsoft Azure](https://azure.microsoft.com/ja-jp/) + +### このハンズオンで利用する範囲 + +- FaaS (Functions as a Service) である [Azure Functions](https://learn.microsoft.com/ja-jp/azure/azure-functions/functions-overview) を用いて、ローカルでの実行およびクラウド上のリソースにデプロイするまでをご紹介します。 + +## ハンズオン + +ハンズオン資料は、[こちら](./docs/self-paced-hands-on.md)をご参照ください。 + diff --git a/docs/images/add-dev-container-configuration-files_001.png b/docs/images/add-dev-container-configuration-files_001.png new file mode 100644 index 0000000..367d834 Binary files /dev/null and b/docs/images/add-dev-container-configuration-files_001.png differ diff --git a/docs/images/add-dev-container-configuration-files_002.png b/docs/images/add-dev-container-configuration-files_002.png new file mode 100644 index 0000000..8b54a0c Binary files /dev/null and b/docs/images/add-dev-container-configuration-files_002.png differ diff --git a/docs/images/add-dev-container-configuration-files_003.png b/docs/images/add-dev-container-configuration-files_003.png new file mode 100644 index 0000000..6bfe912 Binary files /dev/null and b/docs/images/add-dev-container-configuration-files_003.png differ diff --git a/docs/images/copy-function-url_001.png b/docs/images/copy-function-url_001.png new file mode 100644 index 0000000..70bf6c0 Binary files /dev/null and b/docs/images/copy-function-url_001.png differ diff --git a/docs/images/copy-function-url_002.png b/docs/images/copy-function-url_002.png new file mode 100644 index 0000000..4efc8d3 Binary files /dev/null and b/docs/images/copy-function-url_002.png differ diff --git a/docs/images/create-function-app-in-azure-advanced_001.png b/docs/images/create-function-app-in-azure-advanced_001.png new file mode 100644 index 0000000..ed37ef0 Binary files /dev/null and b/docs/images/create-function-app-in-azure-advanced_001.png differ diff --git a/docs/images/create-function-app-in-azure-advanced_002.png b/docs/images/create-function-app-in-azure-advanced_002.png new file mode 100644 index 0000000..b11e996 Binary files /dev/null and b/docs/images/create-function-app-in-azure-advanced_002.png differ diff --git a/docs/images/create-function-app-in-azure-advanced_003.png b/docs/images/create-function-app-in-azure-advanced_003.png new file mode 100644 index 0000000..7a4c831 Binary files /dev/null and b/docs/images/create-function-app-in-azure-advanced_003.png differ diff --git a/docs/images/create-function-app-in-azure-advanced_004.png b/docs/images/create-function-app-in-azure-advanced_004.png new file mode 100644 index 0000000..adfb774 Binary files /dev/null and b/docs/images/create-function-app-in-azure-advanced_004.png differ diff --git a/docs/images/create-function-app-in-azure-advanced_005.png b/docs/images/create-function-app-in-azure-advanced_005.png new file mode 100644 index 0000000..d4ac472 Binary files /dev/null and b/docs/images/create-function-app-in-azure-advanced_005.png differ diff --git a/docs/images/create-function-app-in-azure-advanced_006.png b/docs/images/create-function-app-in-azure-advanced_006.png new file mode 100644 index 0000000..c30a563 Binary files /dev/null and b/docs/images/create-function-app-in-azure-advanced_006.png differ diff --git a/docs/images/create-function-app-in-azure-advanced_007.png b/docs/images/create-function-app-in-azure-advanced_007.png new file mode 100644 index 0000000..9058f88 Binary files /dev/null and b/docs/images/create-function-app-in-azure-advanced_007.png differ diff --git a/docs/images/create-function-app-in-azure-advanced_008.png b/docs/images/create-function-app-in-azure-advanced_008.png new file mode 100644 index 0000000..c5b9cf3 Binary files /dev/null and b/docs/images/create-function-app-in-azure-advanced_008.png differ diff --git a/docs/images/create-function-app-in-azure-advanced_009.png b/docs/images/create-function-app-in-azure-advanced_009.png new file mode 100644 index 0000000..10a5291 Binary files /dev/null and b/docs/images/create-function-app-in-azure-advanced_009.png differ diff --git a/docs/images/create-function-app-in-azure-advanced_010.png b/docs/images/create-function-app-in-azure-advanced_010.png new file mode 100644 index 0000000..66a30ec Binary files /dev/null and b/docs/images/create-function-app-in-azure-advanced_010.png differ diff --git a/docs/images/create-function-app-in-azure-advanced_011.png b/docs/images/create-function-app-in-azure-advanced_011.png new file mode 100644 index 0000000..e22aa65 Binary files /dev/null and b/docs/images/create-function-app-in-azure-advanced_011.png differ diff --git a/docs/images/create-new-function-project_001.png b/docs/images/create-new-function-project_001.png new file mode 100644 index 0000000..b354dde Binary files /dev/null and b/docs/images/create-new-function-project_001.png differ diff --git a/docs/images/create-new-function-project_002.png b/docs/images/create-new-function-project_002.png new file mode 100644 index 0000000..7ad82cf Binary files /dev/null and b/docs/images/create-new-function-project_002.png differ diff --git a/docs/images/create-new-function-project_003.png b/docs/images/create-new-function-project_003.png new file mode 100644 index 0000000..f08cca7 Binary files /dev/null and b/docs/images/create-new-function-project_003.png differ diff --git a/docs/images/deploy-to-function-app_001.png b/docs/images/deploy-to-function-app_001.png new file mode 100644 index 0000000..1e3082c Binary files /dev/null and b/docs/images/deploy-to-function-app_001.png differ diff --git a/docs/images/deploy-to-function-app_002.png b/docs/images/deploy-to-function-app_002.png new file mode 100644 index 0000000..a80deb1 Binary files /dev/null and b/docs/images/deploy-to-function-app_002.png differ diff --git a/docs/images/deploy-to-function-app_003.png b/docs/images/deploy-to-function-app_003.png new file mode 100644 index 0000000..78a63a8 Binary files /dev/null and b/docs/images/deploy-to-function-app_003.png differ diff --git a/docs/images/first-codespace_001.png b/docs/images/first-codespace_001.png new file mode 100644 index 0000000..b49ace5 Binary files /dev/null and b/docs/images/first-codespace_001.png differ diff --git a/docs/images/function-default-page.png b/docs/images/function-default-page.png new file mode 100644 index 0000000..c80befa Binary files /dev/null and b/docs/images/function-default-page.png differ diff --git a/docs/images/github-codespaces_hero.png b/docs/images/github-codespaces_hero.png new file mode 100644 index 0000000..040f7b9 Binary files /dev/null and b/docs/images/github-codespaces_hero.png differ diff --git a/docs/images/open-command-palette.png b/docs/images/open-command-palette.png new file mode 100644 index 0000000..b463586 Binary files /dev/null and b/docs/images/open-command-palette.png differ diff --git a/docs/images/open-new-terminal.png b/docs/images/open-new-terminal.png new file mode 100644 index 0000000..d7ad934 Binary files /dev/null and b/docs/images/open-new-terminal.png differ diff --git a/docs/images/prebuilt-codespace_001.png b/docs/images/prebuilt-codespace_001.png new file mode 100644 index 0000000..55286d6 Binary files /dev/null and b/docs/images/prebuilt-codespace_001.png differ diff --git a/docs/images/run-first-codespace_001.png b/docs/images/run-first-codespace_001.png new file mode 100644 index 0000000..8aad4be Binary files /dev/null and b/docs/images/run-first-codespace_001.png differ diff --git a/docs/images/run-first-codespace_002.png b/docs/images/run-first-codespace_002.png new file mode 100644 index 0000000..f1a4f40 Binary files /dev/null and b/docs/images/run-first-codespace_002.png differ diff --git a/docs/images/run-prebuilt-codespace_001.png b/docs/images/run-prebuilt-codespace_001.png new file mode 100644 index 0000000..a176b46 Binary files /dev/null and b/docs/images/run-prebuilt-codespace_001.png differ diff --git a/docs/images/run-prebuilt-codespace_002.png b/docs/images/run-prebuilt-codespace_002.png new file mode 100644 index 0000000..673b120 Binary files /dev/null and b/docs/images/run-prebuilt-codespace_002.png differ diff --git a/docs/images/run-prebuilt-codespace_003.png b/docs/images/run-prebuilt-codespace_003.png new file mode 100644 index 0000000..c0ed5c5 Binary files /dev/null and b/docs/images/run-prebuilt-codespace_003.png differ diff --git a/docs/images/run-prebuilt-codespace_004.png b/docs/images/run-prebuilt-codespace_004.png new file mode 100644 index 0000000..e94b432 Binary files /dev/null and b/docs/images/run-prebuilt-codespace_004.png differ diff --git a/docs/images/sign-in-to-azure_001.png b/docs/images/sign-in-to-azure_001.png new file mode 100644 index 0000000..17652dd Binary files /dev/null and b/docs/images/sign-in-to-azure_001.png differ diff --git a/docs/self-paced-hands-on.md b/docs/self-paced-hands-on.md new file mode 100644 index 0000000..bfeca10 --- /dev/null +++ b/docs/self-paced-hands-on.md @@ -0,0 +1,240 @@ +# セルフペース ハンズオン + +このハンズオン資料は、Microsoft Ignite Spotlight on Japan の現地会場ハンズオンで利用するためにまとめられたものです。 + +ただし、事前準備の条件をクリアできる方は実施できる内容になっていますので、ご参考になれば幸いです。 + + +## 事前準備 + +- GitHub アカウントを用意する + - 個人アカウントの場合、GitHub Codespaces ベータ版の申請が受理されていること + - もしくは、GitHub Codespaces が有効になっている（Spent limit が 0 より大きく設定されている）Organization に属していて、リポジトリを用意できること +- Microsoft Azure のアカウントを用意する + + +## 手順＆解説 + +### GitHub Codespaces を立ち上げる + +それでは早速 GitHub Codespaces を立ち上げてみましょう！ + +リポジトリの「Code」ボタンを選択します。 + +![](./images/run-first-codespace_001.png) + +すると、見慣れた「Local」とは別に「Codespaces」タブが有効になっているのが確認できます。「Create codespace on main」ボタンを選択します。 + +![](./images/run-first-codespace_002.png) + +Codespaces は、ブラウザまたは Visual Studio Code で立ち上げることができます。後半、ポートフォワーディングの動作が双方で異なりますが、どちらもサポートするのでお好きな方で立ち上げてみてください。 + +![](./images/first-codespace_001.png) + +このリポジトリのメインブランチには `devcontainer.json`（Development Containers の設定ファイル）がないので、GitHub Codespaces の default image で環境が立ち上がります。default image の詳細は、[vscode-dev-containers/containers/codespaces-linux](https://aka.ms/ghcs-default-image) をご参照ください。 + +default image は Ubuntu で構成されていて、`apt` を利用して追加のパッケージをインストールすることも可能です。また、主要な言語が含まれており、カスタマイズしなくても使える場合も多いです。テキストを書くだけなら、default image で事足ります。 + +default image は Visual Studio Code の拡張機能はインストールされていませんが、自由にインストールすることができます。 + +保存したファイルやインストールしたパッケージ、インストールした拡張機能は、その codespace のインスタンスを消すまでは保持されます。 + +今回は、Azure Functions の開発を行いたいのですが、今ここで必要なパッケージや拡張機能をインストールしていると時間がかかってしまうので、"すでに用意されているイメージ" を使った環境を立ち上げてみましょう。 + + +### Prebuild が設定されたブランチから codespace を立ち上げてみる + +リポジトリの「Code」ボタンを再度開き、「Create codespace on main」の横の矢印ボタンを選択します。 + +![](./images/run-prebuilt-codespace_001.png) + +「Configure and create codespace」を選択します。 + +![](./images/run-prebuilt-codespace_002.png) + +ボタンが「Configure and crate codespace」に変わるので、それを選択します。 + +![](./images/run-prebuilt-codespace_003.png) + +GitHub Codespaces は、起動するオプションを選ぶことができます。今回は、事前に用意しておいた `pre-built` ブランチで起動してみましょう。 + +- ブランチ +- 参照する Dev container の設定ファイル +- codespace を配置するリージョン +- SKU（コア数、メモリ、ストレージ量） + +![](./images/run-prebuilt-codespace_004.png) + +`pre-built` ブランチには、`.devcontainer/devcontainer.json` と `.devcontainer/Dockerfile` が含まれており、このファイルがあると Codespaces はその設定をもとにイメージをビルドした上で環境を起動します。 + +![](./images/prebuilt-codespace_001.png) + +さて、お気づきでしょうか？即座に立ち上がりましたね？ + +実は、リポジトリの設定で GitHub Codespaces の Prebuild という機能を設定しておくことで、先にイメージをビルドしておくことができます。利用するリージョンにイメージを保存しておいてくれるので、すぐダウンロードが終わり起動することができるのです。 + +この Dev container の設定は、とても簡単にベースを作成できます。 + +メニューから「View」→「Command Palette...」を開き、`Codespaces: Add Dev Container Configuration Files...` を選択してみましょう。 + +![](./images/open-command-palette.png) + +![](./images/add-dev-container-configuration-files_001.png) + +すると、設定の定義一覧が表示されます。`Show All Definitions...` からすべての定義を表示し、`Azure Functions & Node.js` をみつけてみてください。 + +![](./images/add-dev-container-configuration-files_002.png) + +![](./images/add-dev-container-configuration-files_003.png) + +これが今開いてもらっている `pre-built` ブランチで利用している Dev container の設定のベースです。私はこの設定のうち、Node.js のバージョンだけを `16` に変更して利用しています。 + +この `Azure Functions & Node.js` イメージには、Azure Functions の開発に必要なパッケージや拡張機能が事前にインストールされています。 + +ターミナルを開き、`az` や `func` コマンドを確認してみましょう。また、拡張機能の一覧を開き、「CODESPACES - INSTALLED」に「[Azure Account](https://marketplace.visualstudio.com/items?itemName=ms-vscode.azure-account)」や「[Azure Functions](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azurefunctions)」がインストールされていることが確認できます。 + +![](./images/open-new-terminal.png) + +> **Note** このハンズオンでは機能説明をしやすいようにデフォルトではないブランチに prebuild を設定していますが、実際に利用するときは、デフォルトブランチ（`main`）に設定する方が直感的で、プロジェクトのメンバーがより早く環境にアクセスできるようになるでしょう。 + + +### Azure Functions のプロジェクトを作成する + +それではさっそく Azure Functions の開発に着手しましょう！ + +まず、今は `pre-built` ブランチが開かれているので、作業用のブランチに切替え、作業用のディレクトリを作成しておきましょう。メニューから「Terminal」→「New Terminal」を開き、下記を実行します。 + +``` +git switch -c add-functions +mkdir functions +``` + +つぎに、拡張機能を用いて Azure Functions の新規プロジェクトを生成しましょう。Command Palette で、`Azure Functions: Create New Project...` を選択します。 + +![](./images/create-new-function-project_001.png) + +ファイルを配置するディレクトリを問われるので、`Browse...` で先ほど作成した `functions` ディレクトリを選択してください。 + +![](./images/create-new-function-project_002.png) + +言語の選択では、Functions を記述する言語を選択します。ここでは `JavaScript` を選択します。 + +つぎに、最初の関数のテンプレートを選択します。ここでは、API を作成したので、`HTTP trigger` を選択しましょう。 + +HTTP trigger の名前は、そのまま決定（`Enter`キー押下）しておきます。 + +認証レベルは `Anonymous` を選択しておきましょう。 + +![](./images/add-dev-container-configuration-files_003.png) + +これで `HttpTrigger1` という HTTP trigger 関数が作成されました。 + + +### GitHub Codespaces 上でローカル実行する + +まずはローカル（ここでは GitHub Codespaces インスタンス上）で Azure Functions を実行してみましょう。 + +すでに、デバッグ用の設定ファイルが配置されているので、F5キー押下、またはデバッグペインからすぐデバッグ実行ができます。 + +すると Function Runtime のログが表示され起動されたら、API にアクセスしてみましょう。 + +Visual Studio Code で作業されている方は、`http://localhost:7071/api/HttpTrigger1` にアクセスしてみてください。 + +ブラウザで作業されている方は、ポートフォワーディングの設定を public に設定して開くアクセスできることを試してみましょう。ターミナルを開いているペインのタブで「PORTS」を選択し、`7071` の行を右クリックし表示されたメニューで「Port Visibility」→「Public」を選択することで、接続用のURLが発行されるのでそれを用いてアクセスします。`http://localhost:` の部分を置き換え、 `https:///api/HttpTrigger1` にアクセスしてみてください。 + +> **Note** GitHub Codespaces を Organization で利用している場合は、Port Visibility の「Private to Organization」を選択することで、Organization の認証が済んだセッション内でURLを利用できるようになります。 + +> **Note** これらの ポートフォワーディングの「Port Visibility」の設定は、ブラウザ及び Visual Studio Code どちらでも利用可能です。 + +`/api/HttpTrigger1` にアクセスすると、先ほど生成した HTTP trigger 関数が呼び出されレスポンスを返却していることがわかります。 + +これで、あたかも手元の環境で作業しているかのようにスムーズに開発できることを体験いただけたかと思います。 + +また、この環境は GitHub Codespaces 内に閉じられ、手元の環境に影響しないこともメリットの一つでしょう。 + + +###　Azure Functions を Microsoft Azure にデプロイする + +それでは最後に、作成した Azure Functions のプロジェクトを、Microsoft Azure にデプロイしてみましょう！ + +Azure Functions のデプロイはいくつかの方法がありますか、今回は拡張機能[Azure Account](https://marketplace.visualstudio.com/items?itemName=ms-vscode.azure-account)」と「[Azure Functions](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azurefunctions)」を利用します。 + +まず、拡張機能で Microsoft Azure にログインします。Command Palette を開き、`Azure: Sign in` または `Azure: Sign in with Device Code` を実行して Azure にログインしましょう。前者はアクティブなブラウザでログイン画面が開き認証を促されます。もし、アクティブなブラウザのセッションがサインインしたいアカウントと異なる場合、後者の方式でデバイスコードを用いてサインインを行なってください。 + +![](./images/sign-in-to-azure_001.png) + +サインインができたら、Azure Functions のリソース（Function App）を作成するために、Command Palette で `Azure Functions: Create Function App in Azure... (Advanced)` を選択します。 + +![](./images/create-function-app-in-azure-advanced_001.png) + +使用するサブスクリプションを選択します。 + +![](./images/create-function-app-in-azure-advanced_002.png) + +「Create new Function App in Azure (1/7)」で、作成する Function App リソース名を入力します。Function App のリソース名は、グローバルで一位である必要があります。（誰とも被ってはいけません） + +![](./images/create-function-app-in-azure-advanced_003.png) + +「Create new Function App in Azure (2/7)」では、ランタイムスタックを選択します。ここでは、「Node.js 16 LTS」を選択してください。 + +![](./images/create-function-app-in-azure-advanced_004.png) + +「Create new Function App in Azure (3/8)」では、Function App のベースとする OS を選択します。ここでは、`Linux` を選択します。 + +![](./images/create-function-app-in-azure-advanced_005.png) + +「Create new Function App in Azure (4/8)」では、Function App を配置するリソースグループを指定します。招待されているリソースグループを選択してください。 + +![](./images/create-function-app-in-azure-advanced_006.png) + +「Create new Function App in Azure (5/8)」では、リソースを配置するリージョンを選択しましょう。リージョンはそのリソースを利用するユーザーの地域に近いところを選択することが一般的です。 + +![](./images/create-function-app-in-azure-advanced_007.png) + +「Create new Function App in Azure (6/8)」では、課金体系を選択します。ここでは `Consumption` （従量課金）を選択します。 + +![](./images/create-function-app-in-azure-advanced_008.png) + +「Create new Function App in Azure (7/8)」では、Function App の稼働のための保存領域としてのストレージアカウントを指定します。「+ Create new storage account」を選択し、任意の名前を指定します。ここでは、提示されたままの名前で進めてください。 + +![](./images/create-function-app-in-azure-advanced_009.png) + +![](./images/create-function-app-in-azure-advanced_010.png) + +「Create new Function App in Azure (9/9)」では、モニタリングに使用する Aplication Insights のリソースを指定します。ここでは、「Skip for now」を選択し進めてください。 + +![](./images/create-function-app-in-azure-advanced_011.png) + +Function App の作成が完了したら、いよいよプロジェクトをデプロイしましょう。 + +Command Palette で `Azure Functions: Deploy to Function App...` を実行してください。 + +![](./images/deploy-to-function-app_001.png) + +使用するサブスクリプションを選択します。 + +Function App のリソース一覧が表示されるので、先ほど作成した Function App を選択します。 + +![](./images/deploy-to-function-app_002.png) + +「先にデプロイしたものを上書きするがよいか？」というポップアップが表示されるので、「Deploy」ボタンを選択して進めてください。 + +![](./images/deploy-to-function-app_003.png) + +デプロイが終わるまでしばらく待ちます。 + +デプロイが終わったら、左のメニューの Azure （Aのマーク）を開き、リソースを確認してみましょう。 + +「RESOURCES」の一覧を辿っていくと、先ほどデプロイした関数を確認することができます。 + +![](./images/copy-function-url_001.png) + +HTTP trigger として作成した関数「HttpTrigger1」を右クリックしメニューから「Copy Function Url」を選択します。 + +![](./images/copy-function-url_002.png) + +このようなURL `https://.azurewebsites.net/api/httptrigger1` がコピーされ、それを実行すると先ほど作成した関数が動作していることが確認できます。 + + +Congratulations!🎉 +