クイックスタート: ARM テンプレートを使用して Azure Kubernetes Service (AKS) クラスターをデプロイする

[アーティクル]
01/12/2024

Azure Kubernetes Service (AKS) は、クラスターをすばやくデプロイおよび管理することができる、マネージド Kubernetes サービスです。このクイックスタートでは次の作業を行います。

Azure Resource Manager テンプレートを使用して AKS クラスターをデプロイします。
マイクロサービスのグループと、小売シナリオをシミュレートする Web フロントエンドを使用して、サンプルのマルチコンテナーアプリケーションを実行します。

Azure Resource Manager テンプレートは JavaScript Object Notation (JSON) ファイルであり、プロジェクトのインフラストラクチャと構成が定義されています。このテンプレートでは、宣言型の構文が使用されています。デプロイしようとしているものを、デプロイを作成する一連のプログラミングコマンドを記述しなくても記述できます。

Note

AKS クラスターの迅速なプロビジョニングを開始するため、この記事には、評価のみを目的とした既定の設定でクラスターをデプロイする手順が含まれています。運用環境に対応したクラスターをデプロイする前に、ベースライン参照アーキテクチャを理解して、ビジネス要件にどの程度合致しているかを検討することをお勧めします。

開始する前に

この記事では、Kubernetes の基本的な概念を理解していることを前提としています。詳細については、「Azure Kubernetes Services (AKS) における Kubernetes の中心概念」を参照してください。

Azure サブスクリプションをお持ちでない場合は、開始する前に Azure 無料アカウントを作成してください。
クラスターの作成に使用する ID に、適切な最小限のアクセス許可が付与されていることを確認してください。 AKS のアクセスと ID の詳細については、「Azure Kubernetes Service (AKS) でのアクセスと ID オプション」を参照してください。
ARM テンプレートをデプロイするには、デプロイするリソースに対する書き込みアクセス権と、 Microsoft.Resources/deployments リソースの種類に対するすべての操作へのアクセス権が必要です。たとえば、仮想マシンをデプロイするには、Microsoft.Compute/virtualMachines/write および Microsoft.Resources/deployments/* アクセス許可が必要です。ロールとアクセス許可の一覧については、Azure の組み込みロールに関するページを参照してください。

テンプレートからクラスターをデプロイした後、Azure CLI または Azure PowerShell を使用してクラスターに接続し、サンプルアプリケーションをデプロイできます。

Azure CLI
Azure PowerShell

Azure Cloud Shell で Bash 環境を使用します。詳細については、「Azure Cloud Shell の Bash のクイックスタート」を参照してください。
CLI リファレンスコマンドをローカルで実行する場合、Azure CLI をインストールします。 Windows または macOS で実行している場合は、Docker コンテナーで Azure CLI を実行することを検討してください。詳細については、「Docker コンテナーで Azure CLI を実行する方法」を参照してください。
- ローカルインストールを使用する場合は、az login コマンドを使用して Azure CLI にサインインします。認証プロセスを完了するには、ターミナルに表示される手順に従います。その他のサインインオプションについては、Azure CLI でのサインインに関するページを参照してください。
- 初回使用時にインストールを求められたら、Azure CLI 拡張機能をインストールします。拡張機能の詳細については、Azure CLI で拡張機能を使用する方法に関するページを参照してください。
- az version を実行し、インストールされているバージョンおよび依存ライブラリを検索します。最新バージョンにアップグレードするには、az upgrade を実行します。

この記事では、Azure CLI バージョン 2.0.64 以降が必要です。 Azure Cloud Shell を使用している場合は、最新バージョンが既にインストールされています。

SSH キーペアを作成する

ARM テンプレートを使用して AKS クラスターを作成するには、SSH 公開キーを指定します。このリソースが必要な場合は、このセクションの手順に従ってください。それ以外の場合は、「テンプレートの確認」セクションに進みます。

AKS ノードにアクセスするには、SSH キーペア (パブリックとプライベート) を使用して接続します。 SSH キーの組を作成するには:

https://shell.azure.com にアクセスし、お使いのブラウザーで Cloud Shell を開きます。

az-sshkey-create コマンドまたは ssh-keygen コマンドを使用して SSH キーペアを作成します。

# Create an SSH key pair using Azure CLI
az sshkey create --name "mySSHKey" --resource-group "myResourceGroup"

# or

# Create an SSH key pair using ssh-keygen
ssh-keygen -t rsa -b 4096

テンプレートをデプロイするには、SSH ペアから公開キーを指定する必要があります。公開キーを取得するには、az sshkey show を呼び出します:
```
az sshkey show --name "mySSHKey" --resource-group "myResourceGroup" --query "publicKey"
```

既定では、これらの SSH キーファイルは ~/.ssh ディレクトリに作成されます。 az sshkey create または ssh-keygen コマンドを実行すると、既存の SSH キーペアが同じ名前で上書きされます。

SSH キーの作成の詳細については、Azure での認証用の SSH キーの作成と管理に関するページを参照してください。

テンプレートを確認する

このクイックスタートで使用されるテンプレートは Azure クイックスタートテンプレートからのものです。

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "metadata": {
    "_generator": {
      "name": "bicep",
      "version": "0.9.1.41621",
      "templateHash": "2637152180661081755"
    }
  },
  "parameters": {
    "clusterName": {
      "type": "string",
      "defaultValue": "aks101cluster",
      "metadata": {
        "description": "The name of the Managed Cluster resource."
      }
    },
    "location": {
      "type": "string",
      "defaultValue": "[resourceGroup().location]",
      "metadata": {
        "description": "The location of the Managed Cluster resource."
      }
    },
    "dnsPrefix": {
      "type": "string",
      "metadata": {
        "description": "Optional DNS prefix to use with hosted Kubernetes API server FQDN."
      }
    },
    "osDiskSizeGB": {
      "type": "int",
      "defaultValue": 0,
      "maxValue": 1023,
      "minValue": 0,
      "metadata": {
        "description": "Disk size (in GB) to provision for each of the agent pool nodes. This value ranges from 0 to 1023. Specifying 0 will apply the default disk size for that agentVMSize."
      }
    },
    "agentCount": {
      "type": "int",
      "defaultValue": 3,
      "maxValue": 50,
      "minValue": 1,
      "metadata": {
        "description": "The number of nodes for the cluster."
      }
    },
    "agentVMSize": {
      "type": "string",
      "defaultValue": "standard_d2s_v3",
      "metadata": {
        "description": "The size of the Virtual Machine."
      }
    },
    "linuxAdminUsername": {
      "type": "string",
      "metadata": {
        "description": "User name for the Linux Virtual Machines."
      }
    },
    "sshRSAPublicKey": {
      "type": "string",
      "metadata": {
        "description": "Configure all linux machines with the SSH RSA public key string. Your key should include three parts, for example 'ssh-rsa AAAAB...snip...UcyupgH azureuser@linuxvm'"
      }
    }
  },
  "resources": [
    {
      "type": "Microsoft.ContainerService/managedClusters",
      "apiVersion": "2022-05-02-preview",
      "name": "[parameters('clusterName')]",
      "location": "[parameters('location')]",
      "identity": {
        "type": "SystemAssigned"
      },
      "properties": {
        "dnsPrefix": "[parameters('dnsPrefix')]",
        "agentPoolProfiles": [
          {
            "name": "agentpool",
            "osDiskSizeGB": "[parameters('osDiskSizeGB')]",
            "count": "[parameters('agentCount')]",
            "vmSize": "[parameters('agentVMSize')]",
            "osType": "Linux",
            "mode": "System"
          }
        ],
        "linuxProfile": {
          "adminUsername": "[parameters('linuxAdminUsername')]",
          "ssh": {
            "publicKeys": [
              {
                "keyData": "[parameters('sshRSAPublicKey')]"
              }
            ]
          }
        }
      }
    }
  ],
  "outputs": {
    "controlPlaneFQDN": {
      "type": "string",
      "value": "[reference(resourceId('Microsoft.ContainerService/managedClusters', parameters('clusterName'))).fqdn]"
    }
  }
}

ARM テンプレートで定義されているリソースの種類は Microsoft.ContainerService/managedClusters です。

他の AKS サンプルについては、AKS クイックスタートのテンプレートに関するサイトを参照してください。

テンプレートのデプロイ

[Azure にデプロイ]を選択してサインインし、テンプレートを開きます。
基本ページで、 OS ディスクサイズ GB、 エージェント数、 エージェント VM サイズ、 OS のタイプを既定値のままにして、次のテンプレートパラメータを構成します:
- サブスクリプション:Azure サブスクリプションを選択します。
- [リソースグループ] : [新規作成] を選択します。 myResourceGroupなど、リソースグループの一意の名前を入力し、[OK]を選択します。
- [場所] :場所 (米国東部など) を選択します。
- [クラスター名] : AKS クラスターの一意の名前 (myAKSCluster など) を入力します。
- [DNS プレフィックス] : クラスターの一意の DNS プレフィックス (myakscluster など) を入力します。
- [Linux Admin Username](Linux 管理者ユーザー名) : SSH を使用して接続するためのユーザー名 (azureuser など) を入力します。
- SSH 公開キーソース: [既存の公開キー使用] を選択します。
- キーペア名: SSH キーペアの パブリック パーツ (既定では、~/.ssh/id_rsa.pub の内容) をコピーして貼り付けます。
[確認および作成]>[作成] の順に選択します。

AKS クラスターの作成には数分かかります。クラスターが正常にデプロイされるのを待ってから、次の手順に進みます。

クラスターに接続する

Kubernetes クラスターを管理するには、Kubernetes のコマンドラインクライアントである kubectl を使います。

Azure CLI
Azure PowerShell

Azure Cloud Shell を使用している場合、kubectl は既にインストールされています。 kubectl をローカルにインストールして実行するには、az aks install-cli コマンドを呼び出します。

az aks get-credentials コマンドを使用して、Kubernetes クラスターに接続するように kubectl を構成します。このコマンドは、資格情報をダウンロードし、それを使用するように Kubernetes CLI を構成します。
```
az aks get-credentials --resource-group myResourceGroup --name myAKSCluster
```
kubectl get コマンドを使用して、ご利用のクラスターへの接続を確認します。このコマンドでは、クラスターノードの一覧が返されます。
```
kubectl get nodes
```
次の出力例は、前の手順で作成された 3 つのノードを示しています。ノードの状態が [Ready] であることを確認してください。
```
NAME                                STATUS   ROLES   AGE   VERSION
aks-agentpool-27442051-vmss000000   Ready    agent   10m   v1.27.7
aks-agentpool-27442051-vmss000001   Ready    agent   10m   v1.27.7
aks-agentpool-27442051-vmss000002   Ready    agent   11m   v1.27.7
```

Azure Cloud Shell を使用している場合、kubectl は既にインストールされています。 kubectl をローカルにインストールするには、Install-AzAksCliTool コマンドレットを呼び出します。

Import-AzAksCredential コマンドレットを使用して、Kubernetes クラスターに接続するように kubectl を構成します。このコマンドは、資格情報をダウンロードし、それを使用するように Kubernetes CLI を構成します。
```
Import-AzAksCredential -ResourceGroupName myResourceGroup -Name myAKSCluster
```
kubectl get コマンドを使用して、ご利用のクラスターへの接続を確認します。このコマンドでは、クラスターノードの一覧が返されます。
```
kubectl get nodes
```
次の出力例は、前の手順で作成された 3 つのノードを示しています。ノードの状態が [Ready] であることを確認してください。
```
NAME                                STATUS   ROLES   AGE   VERSION
aks-agentpool-27442051-vmss000000   Ready    agent   10m   v1.27.7
aks-agentpool-27442051-vmss000001   Ready    agent   10m   v1.27.7
aks-agentpool-27442051-vmss000002   Ready    agent   11m   v1.27.7
```

アプリケーションの配置

アプリケーションをデプロイするには、マニフェストファイルを使用して、AKS ストアアプリケーションの実行に必要なすべてのオブジェクトを作成します。 Kubernetes のマニフェストファイルでは、どのコンテナーイメージを実行するかなど、クラスターの望ましい状態を定義します。マニフェストには、次の Kubernetes のデプロイとサービスが含まれています。

ネットショップ: 顧客が製品を見て注文するための Web アプリケーション。
製品サービス: 製品情報が表示されます。
注文サービス: 注文を行います。
Rabbit MQ: 注文キューのメッセージキュー。

Note

運用環境の永続ストレージを使用せずに Rabbit MQ などのステートフルコンテナーを実行することはお勧めしません。これらはわかりやすくするためにここで使用しますが、Azure CosmosDB や Azure Service Bus などのマネージドサービスを使用することをお勧めします。

aks-store-quickstart.yaml という名前のファイルを作成し、そこに次のマニフェストをコピーします。

apiVersion: apps/v1
kind: Deployment
metadata:
  name: rabbitmq
spec:
  replicas: 1
  selector:
    matchLabels:
      app: rabbitmq
  template:
    metadata:
      labels:
        app: rabbitmq
    spec:
      nodeSelector:
        "kubernetes.io/os": linux
      containers:
      - name: rabbitmq
        image: mcr.microsoft.com/mirror/docker/library/rabbitmq:3.10-management-alpine
        ports:
        - containerPort: 5672
          name: rabbitmq-amqp
        - containerPort: 15672
          name: rabbitmq-http
        env:
        - name: RABBITMQ_DEFAULT_USER
          value: "username"
        - name: RABBITMQ_DEFAULT_PASS
          value: "password"
        resources:
          requests:
            cpu: 10m
            memory: 128Mi
          limits:
            cpu: 250m
            memory: 256Mi
        volumeMounts:
        - name: rabbitmq-enabled-plugins
          mountPath: /etc/rabbitmq/enabled_plugins
          subPath: enabled_plugins
      volumes:
      - name: rabbitmq-enabled-plugins
        configMap:
          name: rabbitmq-enabled-plugins
          items:
          - key: rabbitmq_enabled_plugins
            path: enabled_plugins
---
apiVersion: v1
data:
  rabbitmq_enabled_plugins: |
    [rabbitmq_management,rabbitmq_prometheus,rabbitmq_amqp1_0].
kind: ConfigMap
metadata:
  name: rabbitmq-enabled-plugins            
---
apiVersion: v1
kind: Service
metadata:
  name: rabbitmq
spec:
  selector:
    app: rabbitmq
  ports:
    - name: rabbitmq-amqp
      port: 5672
      targetPort: 5672
    - name: rabbitmq-http
      port: 15672
      targetPort: 15672
  type: ClusterIP
---
apiVersion: apps/v1
kind: Deployment
metadata:
  name: order-service
spec:
  replicas: 1
  selector:
    matchLabels:
      app: order-service
  template:
    metadata:
      labels:
        app: order-service
    spec:
      nodeSelector:
        "kubernetes.io/os": linux
      containers:
      - name: order-service
        image: ghcr.io/azure-samples/aks-store-demo/order-service:latest
        ports:
        - containerPort: 3000
        env:
        - name: ORDER_QUEUE_HOSTNAME
          value: "rabbitmq"
        - name: ORDER_QUEUE_PORT
          value: "5672"
        - name: ORDER_QUEUE_USERNAME
          value: "username"
        - name: ORDER_QUEUE_PASSWORD
          value: "password"
        - name: ORDER_QUEUE_NAME
          value: "orders"
        - name: FASTIFY_ADDRESS
          value: "0.0.0.0"
        resources:
          requests:
            cpu: 1m
            memory: 50Mi
          limits:
            cpu: 75m
            memory: 128Mi
      initContainers:
      - name: wait-for-rabbitmq
        image: busybox
        command: ['sh', '-c', 'until nc -zv rabbitmq 5672; do echo waiting for rabbitmq; sleep 2; done;']
        resources:
          requests:
            cpu: 1m
            memory: 50Mi
          limits:
            cpu: 75m
            memory: 128Mi    
---
apiVersion: v1
kind: Service
metadata:
  name: order-service
spec:
  type: ClusterIP
  ports:
  - name: http
    port: 3000
    targetPort: 3000
  selector:
    app: order-service
---
apiVersion: apps/v1
kind: Deployment
metadata:
  name: product-service
spec:
  replicas: 1
  selector:
    matchLabels:
      app: product-service
  template:
    metadata:
      labels:
        app: product-service
    spec:
      nodeSelector:
        "kubernetes.io/os": linux
      containers:
      - name: product-service
        image: ghcr.io/azure-samples/aks-store-demo/product-service:latest
        ports:
        - containerPort: 3002
        resources:
          requests:
            cpu: 1m
            memory: 1Mi
          limits:
            cpu: 1m
            memory: 7Mi
---
apiVersion: v1
kind: Service
metadata:
  name: product-service
spec:
  type: ClusterIP
  ports:
  - name: http
    port: 3002
    targetPort: 3002
  selector:
    app: product-service
---
apiVersion: apps/v1
kind: Deployment
metadata:
  name: store-front
spec:
  replicas: 1
  selector:
    matchLabels:
      app: store-front
  template:
    metadata:
      labels:
        app: store-front
    spec:
      nodeSelector:
        "kubernetes.io/os": linux
      containers:
      - name: store-front
        image: ghcr.io/azure-samples/aks-store-demo/store-front:latest
        ports:
        - containerPort: 8080
          name: store-front
        env: 
        - name: VUE_APP_ORDER_SERVICE_URL
          value: "http://order-service:3000/"
        - name: VUE_APP_PRODUCT_SERVICE_URL
          value: "http://product-service:3002/"
        resources:
          requests:
            cpu: 1m
            memory: 200Mi
          limits:
            cpu: 1000m
            memory: 512Mi
---
apiVersion: v1
kind: Service
metadata:
  name: store-front
spec:
  ports:
  - port: 80
    targetPort: 8080
  selector:
    app: store-front
  type: LoadBalancer

YAML マニフェストファイルの内訳については、「デプロイと YAML マニフェスト」を参照してください。

YAML ファイルをローカルに作成して保存する場合は、[ファイルのアップロード/ダウンロード] ボタンを選択し、ローカルファイルシステムからファイルを選択することで、CloudShell の既定のディレクトリにマニフェストファイルをアップロードできます。

kubectl apply コマンドを使用してアプリケーションをデプロイし、ご利用の YAML マニフェストの名前を指定します。

kubectl apply -f aks-store-quickstart.yaml

次の出力例は、デプロイとサービスを示しています。

deployment.apps/rabbitmq created
service/rabbitmq created
deployment.apps/order-service created
service/order-service created
deployment.apps/product-service created
service/product-service created
deployment.apps/store-front created
service/store-front created

アプリケーションをテストする

kubectl get pods コマンドを使って、デプロイされたポッドの状態を確認します。続行する前に、すべてのポッドを Running の状態にします。
```
kubectl get pods
```
ストアフロントアプリケーションのパブリック IP アドレスを確認します。 kubectl get service コマンドと --watch 引数を使用して、進行状況を監視します。
```
kubectl get service store-front --watch
```
store-front サービスの [EXTERNAL-IP] の出力は、最初は pending と表示されます。
```
NAME          TYPE           CLUSTER-IP    EXTERNAL-IP   PORT(S)        AGE
store-front   LoadBalancer   10.0.100.10   <pending>     80:30025/TCP   4h4m
```
EXTERNAL-IP アドレスが保留中から実際のパブリック IP アドレスに変わったら、CTRL-C を使用して kubectl ウォッチプロセスを停止します。

次の出力例は、サービスに割り当てられている有効なパブリック IP アドレスを示しています。
```
NAME          TYPE           CLUSTER-IP    EXTERNAL-IP    PORT(S)        AGE
store-front   LoadBalancer   10.0.100.10   20.62.159.19   80:30025/TCP   4h5m
```
Azure Store アプリが動作していることを確認するには、Web ブラウザーを開いてサービスの外部 IP アドレスにアクセスします。

クラスターを削除する

「AKS チュートリアル」を実行しない場合は、Azure の課金を回避するために不要なリソースをクリーンアップします。

Azure CLI
Azure PowerShell

az group delete コマンドを呼び出して、リソースグループ、コンテナーサービス、およびすべての関連リソースを削除します。

az group delete --name myResourceGroup --yes --no-wait

Remove-AzResourceGroup コマンドレットを呼び出して、リソースグループ、コンテナーサービス、すべての関連リソースを削除します

Remove-AzResourceGroup -Name myResourceGroup

Note

AKS クラスターは、本クイックスタートの既定の ID オプションであるシステム割り当てマネージド ID を使用して作成されています。この ID はプラットフォームによって管理されるため、手動で削除する必要はありません。

次のステップ

このクイックスタートでは、Kubernetes クラスターをデプロイし、シンプルな複数コンテナーアプリケーションをそこにデプロイしました。このサンプルアプリケーションはデモ専用であり、Kubernetes アプリケーションのすべてのベストプラクティスを表すわけではありません。実稼動用に AKS を使用した完全なソリューションを作成するうえでのガイダンスについては、AKS ソリューションガイダンスに関する記事を参照してください。

AKS の詳細を確認し、完全なコードからデプロイの例までを確認するには、Kubernetes クラスターのチュートリアルに進んでください。

AKS チュートリアル

クイック スタート: ARM テンプレートを使用して Azure Kubernetes Service (AKS) クラスターをデプロイする

開始する前に

SSH キー ペアを作成する

テンプレートを確認する

テンプレートのデプロイ

クラスターに接続する

アプリケーションの配置

アプリケーションをテストする

クラスターを削除する

次のステップ

その他のリソース

クイックスタート: ARM テンプレートを使用して Azure Kubernetes Service (AKS) クラスターをデプロイする

SSH キーペアを作成する