VM に SSH 認証鍵を追加する

コンソール

Trusted Cloud コンソールを使用して公開 SSH 認証鍵をプロジェクト メタデータに追加するには、次の操作を行います。

1. Trusted Cloud コンソールで、[メタデータ] ページに移動します。

   [メタデータ] に移動

2. [SSH 認証鍵] タブをクリックします。

3. [編集] をクリックします。

4. [項目を追加] をクリックします。

5. 表示された [SSH 認証鍵] フィールドに、公開 SSH 認証鍵を追加します。鍵の形式は次のいずれかにする必要があります。

   • 有効期限のない鍵の形式:

     KEY_VALUE USERNAME

   • 有効期限のある鍵の形式:

     KEY_VALUE google-ssh {"userName":"USERNAME","expireOn":"EXPIRE_TIME"}

   次のように置き換えます。

   • KEY_VALUE: 公開 SSH 認証鍵の値
   • USERNAME: ユーザー名。例: cloudysanfrancisco、cloudysanfrancisco_gmail_com

     Linux VM の場合、root ログインを許可するように VM を構成した場合を除き、USERNAME を root にすることはできません。詳細については、root ユーザーとして Linux VM に接続するをご覧ください。

     Active Directory（AD）を使用する Windows VM の場合、ユーザー名の前に AD ドメインを DOMAIN\ 形式で追加する必要があります。たとえば、ad.example.com AD 内のユーザー cloudysanfrancisco の USERNAME は example\cloudysanfrancisco です。

   • EXPIRE_TIME: 鍵が期限切れになる時刻（ISO 8601 形式）。例: 2021-12-04T20:12:00+0000

6. [保存] をクリックします。

gcloud

In the Trusted Cloud console, activate Cloud Shell.

Activate Cloud Shell

At the bottom of the Trusted Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.

1. プロジェクト メタデータに既存の SSH 認証鍵がある場合は、gcloud CLI を使用して新しい SSH 認証鍵を追加するたびに、プロジェクト メタデータに再追加する必要があります。既存の鍵を再追加しないと、新しい鍵を追加したときに既存の鍵が消去されます。

   gcloud CLI を使用して公開 SSH 認証鍵をプロジェクト メタデータに追加する手順は、次のとおりです。

   1. プロジェクトにすでにプロジェクト全体の公開 SSH 認証鍵がある場合は、メタデータから取得して新しいファイルに追加します。

      1. gcloud compute project-info describe コマンドを実行して、プロジェクトの SSH 認証鍵を取得します。

         gcloud compute project-info describe \
          --format="value(commonInstanceMetadata[items][ssh-keys])"
         

         出力は次のようになります。

         username:ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQ... username:ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQ...
         

      2. ssh-keys メタデータ値をコピーします。

      3. ワークステーションで新しいテキスト ファイルを作成して開きます。

      4. コピーした鍵のリストをファイルに貼り付けます。

      5. 新しい鍵を次の形式でリストの末尾に追加します。

         • 有効期限のない鍵の形式:

           USERNAME:KEY_VALUE

         • 有効期限のある鍵の形式:

           USERNAME:KEY_VALUE google-ssh {"userName":"USERNAME","expireOn":"EXPIRE_TIME"}

         次のように置き換えます。

         • KEY_VALUE: 公開 SSH 認証鍵の値
         • USERNAME: ユーザー名。例: cloudysanfrancisco、cloudysanfrancisco_gmail_com

           Linux VM の場合、root ログインを許可するように VM を構成した場合を除き、USERNAME を root にすることはできません。詳細については、root ユーザーとしてのインスタンスへの接続をご覧ください。

           Active Directory（AD）を使用する Windows VM の場合、ユーザー名の前に AD ドメインを DOMAIN\ 形式で追加する必要があります。たとえば、ad.example.com AD 内のユーザー cloudysanfrancisco の USERNAME は example\cloudysanfrancisco です。

         • EXPIRE_TIME: 鍵が期限切れになる時刻（ISO 8601 形式）。例: 2021-12-04T20:12:00+0000

      6. ファイルを保存して閉じます。

   2. gcloud compute project-info add-metadata コマンドを実行して、プロジェクト全体の ssh-keys 値を設定します。

      gcloud compute project-info add-metadata --metadata-from-file=ssh-keys=KEY_FILE
      

      KEY_FILE を次のいずれかに置き換えます。

      • プロジェクトに既存の SSH 認証鍵がある場合は、前の手順で作成したファイルのパス
      • プロジェクトに既存の SSH 認証鍵がない場合は、新しい公開 SSH 認証鍵ファイルのパス

Terraform

公開 SSH 認証鍵をプロジェクト メタデータに追加するには、google_compute_project_metadata リソースを使用します。

resource "google_compute_project_metadata" "default" {
  metadata = {
    ssh-keys = <<EOF
      dev:ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAILg6UtHDNyMNAh0GjaytsJdrUxjtLy3APXqZfNZhvCeT dev
      test:ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAILg6UtHDNyMNAh0GjaytsJdrUxjtLy3APXqZfNZhvCeT test
    EOF
  }
}

REST

プロジェクト メタデータに既存の SSH 認証鍵がある場合は、Compute Engine API を使用して新しい SSH 認証鍵を追加するたびに、プロジェクト メタデータに再追加する必要があります。既存の鍵を再追加しないと、新しい鍵を追加したときに既存の鍵が消去されます。

Compute Engine API を使用して公開 SSH 認証鍵をプロジェクト メタデータに追加するには、次の手順を行います。

1. projects.get メソッドを使用して、メタデータから fingerprint と ssh-keys の値を取得します。

   GET https://compute.googleapis.com/compute/v1/projects/PROJECT_ID
   

   PROJECT_ID は、実際のプロジェクト ID に置き換えます。

   レスポンスは次の例のようになります。

   ...
   "fingerprint": "utgYE_XWtE8=",
   "items": [
   {
    "key": "ssh-keys",
    "value": "cloudysanfrancisco:ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDAu5kKQCPF...\nbaklavainthebalkans:ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQDQDx3FNVC8... google-ssh {"userName":"baklavainthebalkans","expireOn":"2021-06-14T16:59:03+0000"}"
   }
   ]
   ...
   

2. projects.setCommonInstanceMetadata メソッドを使用して、新しい ssh-keys 値を追加します。

   POST https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/setCommonInstanceMetadata
   
   {
   "items": [
    {
     "key": "ssh-keys",
     "value": "EXISTING_SSH_KEYS\nNEW_SSH_KEY"
    }
   ]
   "fingerprint": "FINGERPRINT"
   }
   

   次のように置き換えます。

   • PROJECT_ID: プロジェクト ID
   • EXISTING_SSH_KEYS: projects.get リクエストのレスポンスからの ssh-keys 鍵の値
   • FINGERPRINT: projects.get リクエストのレスポンスからの fingerprint の値

   • NEW_SSH_KEY: 新しい SSH 認証鍵。次のいずれかの形式です。

     • 有効期限のない鍵の形式:

       USERNAME:KEY_VALUE

     • 有効期限のある鍵の形式:

       USERNAME:KEY_VALUE google-ssh {"userName":"USERNAME","expireOn":"EXPIRE_TIME"}

     次のように置き換えます。

     • KEY_VALUE: 公開 SSH 認証鍵の値
     • USERNAME: ユーザー名。例: cloudysanfrancisco、cloudysanfrancisco_gmail_com

       Linux VM の場合、root ログインを許可するように VM を構成した場合を除き、USERNAME を root にすることはできません。詳細については、root ユーザーとしてのインスタンスへの接続をご覧ください。

       Active Directory（AD）を使用する Windows VM の場合、ユーザー名の前に AD ドメインを DOMAIN\ 形式で追加する必要があります。たとえば、ad.example.com AD 内のユーザー cloudysanfrancisco の USERNAME は example\cloudysanfrancisco です。

     • EXPIRE_TIME: 鍵が期限切れになる時刻（ISO 8601 形式）。例: 2021-12-04T20:12:00+0000

コンソール

Trusted Cloud コンソールを使用してインスタンスを作成すると同時に、公開 SSH 認証鍵をインスタンス メタデータに追加する手順は、次のとおりです。

1. Trusted Cloud コンソールで [インスタンスの作成] ページに移動します。

   [インスタンスの作成] に移動

2. 公開 SSH 認証鍵をインスタンス メタデータに追加するには、次の手順を行います。

   1. ナビゲーション メニューで [セキュリティ] をクリックします。

   2. [アクセスを管理] セクションを開きます。

   3. OS Login を無効にするには、[IAM 権限で VM アクセスを制御する] チェックボックスをオフにします。

   4. プロジェクト メタデータの公開 SSH 認証鍵がインスタンスにアクセスできるようにするには、[プロジェクト全体の SSH 認証鍵をブロック] チェックボックスをオフにします。

   5. [手動で生成した SSH 認証鍵の追加] セクションで、[項目を追加] をクリックします。

   6. テキスト ボックスに公開鍵を追加します。鍵の形式は、次のいずれかにする必要があります。

      • 有効期限のない鍵の形式:

        KEY_VALUE USERNAME

      • 有効期限のある鍵の形式:

        KEY_VALUE google-ssh {"userName":"USERNAME","expireOn":"EXPIRE_TIME"}

      次のように置き換えます。

      • KEY_VALUE: 公開 SSH 認証鍵の値
      • USERNAME: ユーザー名。例: cloudysanfrancisco、cloudysanfrancisco_gmail_com

        Linux VM の場合、root ログインを許可するように VM を構成した場合を除き、USERNAME を root にすることはできません。詳細については、root ユーザーとして Linux VM に接続するをご覧ください。

        Active Directory（AD）を使用する Windows VM の場合、ユーザー名の前に AD ドメインを DOMAIN\ 形式で追加する必要があります。たとえば、ad.example.com AD 内のユーザー cloudysanfrancisco の USERNAME は example\cloudysanfrancisco です。

      • EXPIRE_TIME: 鍵が期限切れになる時刻（ISO 8601 形式）。例: 2021-12-04T20:12:00+0000

3. 省略可: その他の構成オプションを指定します。詳細については、インスタンス作成時の構成オプションをご覧ください。

4. インスタンスを作成して起動するには、[作成] をクリックします。

gcloud

1. In the Trusted Cloud console, activate Cloud Shell.

   Activate Cloud Shell

   At the bottom of the Trusted Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.

2. VM を作成し、gcloud CLI を使用して公開 SSH 認証鍵をインスタンス メタデータに追加するには、gcloud compute instances create コマンドを使用します。

   gcloud compute instances create VM_NAME \
      --metadata=ssh-keys=PUBLIC_KEY
   

   次のように置き換えます。

   • VM_NAME: 新しい VM の名前

   • PUBLIC_KEY: 次のいずれかの形式の公開 SSH 認証鍵:

     • 有効期限のない鍵の形式:

       USERNAME:KEY_VALUE

     • 有効期限のある鍵の形式:

       USERNAME:KEY_VALUE google-ssh {"userName":"USERNAME","expireOn":"EXPIRE_TIME"}

     次のように置き換えます。

     • KEY_VALUE: 公開 SSH 認証鍵の値
     • USERNAME: ユーザー名。例: cloudysanfrancisco、cloudysanfrancisco_gmail_com

       Linux VM の場合、root ログインを許可するように VM を構成した場合を除き、USERNAME を root にすることはできません。詳細については、root ユーザーとしてのインスタンスへの接続をご覧ください。

       Active Directory（AD）を使用する Windows VM の場合、ユーザー名の前に AD ドメインを DOMAIN\ 形式で追加する必要があります。たとえば、ad.example.com AD 内のユーザー cloudysanfrancisco の USERNAME は example\cloudysanfrancisco です。

     • EXPIRE_TIME: 鍵が期限切れになる時刻（ISO 8601 形式）。例: 2021-12-04T20:12:00+0000

   --metadata-from-file=ssh-keys=FILE_PATH フラグを使用すると、複数の SSH 認証鍵を追加できます。このファイルに、上記のいずれかの形式でユーザー名と公開 SSH 認証鍵のリストを追加します。

Terraform

公開 SSH 認証鍵をインスタンス メタデータに追加するには、google_compute_instance リソースを使用します。

resource "google_compute_instance" "default" {
  name         = "my-vm"
  machine_type = "n1-standard-1"
  zone         = "us-central1-a"

  boot_disk {
    initialize_params {
      image = "ubuntu-1404-trusty-v20160627"
    }
  }

  # Local SSD disk
  scratch_disk {
    interface = "SCSI"
  }

  network_interface {
    network = "default"
    access_config {}
  }
  metadata = {
    "ssh-keys" = <<EOT
      dev:ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAILg6UtHDNyMNAh0GjaytsJdrUxjtLy3APXqZfNZhvCeT dev
      test:ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAILg6UtHDNyMNAh0GjaytsJdrUxjtLy3APXqZfNZhvCeT test
     EOT
  }
}

REST

VM を作成すると同時に、Compute Engine を使用して公開 SSH 認証鍵をインスタンス メタデータに追加するには、instances.insert メソッドに POST リクエストを送信します。

POST https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/zones/ZONE/instances

次のように置き換えます。

• PROJECT_ID: プロジェクト ID
• ZONE: VM のゾーン

リクエストの本文で、items プロパティにユーザー名と公開 SSH 認証鍵を入力します。

...
{
 "items": [
    {
     "key": "ssh-keys",
     "value": "PUBLIC_KEY"
    }
   ]
}
...

PUBLIC_KEY は、次のいずれかの形式の公開鍵に置き換えます。

• 有効期限のない鍵の形式:

  USERNAME:KEY_VALUE

• 有効期限のある鍵の形式:

  USERNAME:KEY_VALUE google-ssh {"userName":"USERNAME","expireOn":"EXPIRE_TIME"}

次のように置き換えます。

• KEY_VALUE: 公開 SSH 認証鍵の値
• USERNAME: ユーザー名。例: cloudysanfrancisco、cloudysanfrancisco_gmail_com

  Linux VM の場合、root ログインを許可するように VM を構成した場合を除き、USERNAME を root にすることはできません。詳細については、root ユーザーとしてのインスタンスへの接続をご覧ください。

  Active Directory（AD）を使用する Windows VM の場合、ユーザー名の前に AD ドメインを DOMAIN\ 形式で追加する必要があります。たとえば、ad.example.com AD 内のユーザー cloudysanfrancisco の USERNAME は example\cloudysanfrancisco です。

• EXPIRE_TIME: 鍵が期限切れになる時刻（ISO 8601 形式）。例: 2021-12-04T20:12:00+0000

複数の SSH 認証鍵を追加するには、鍵の間に \n を追加します。

コンソール

Trusted Cloud コンソールを使用して公開 SSH 認証鍵をインスタンス メタデータに追加するには、次の操作を行います。

1. Trusted Cloud コンソールで、[VM インスタンス] ページに移動します。

   [VM インスタンス] に移動

2. SSH 認証鍵を追加する VM の名前をクリックします。

3. [編集] をクリックします。

4. [SSH 認証鍵] で、[項目を追加] をクリックします。

5. テキスト ボックスに公開鍵を追加します。鍵の形式は次のいずれかにする必要があります。

   • 有効期限のない鍵の形式:

     KEY_VALUE USERNAME

   • 有効期限のある鍵の形式:

     KEY_VALUE google-ssh {"userName":"USERNAME","expireOn":"EXPIRE_TIME"}

   次のように置き換えます。

   • KEY_VALUE: 公開 SSH 認証鍵の値
   • USERNAME: ユーザー名。例: cloudysanfrancisco、cloudysanfrancisco_gmail_com

     Linux VM の場合、root ログインを許可するように VM を構成した場合を除き、USERNAME を root にすることはできません。詳細については、root ユーザーとして Linux VM に接続するをご覧ください。

     Active Directory（AD）を使用する Windows VM の場合、ユーザー名の前に AD ドメインを DOMAIN\ 形式で追加する必要があります。たとえば、ad.example.com AD 内のユーザー cloudysanfrancisco の USERNAME は example\cloudysanfrancisco です。

   • EXPIRE_TIME: 鍵が期限切れになる時刻（ISO 8601 形式）。例: 2021-12-04T20:12:00+0000

6. [保存] をクリックします。

gcloud

1. In the Trusted Cloud console, activate Cloud Shell.

   Activate Cloud Shell

   At the bottom of the Trusted Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.

2. インスタンス メタデータに既存の SSH 認証鍵がある場合は、gcloud CLI を使用して新しい SSH 認証鍵を追加するたびに、インスタンス メタデータに再追加する必要があります。既存の鍵を再追加しないと、新しい鍵を追加したときに既存の鍵が消去されます。

   gcloud CLI を使用して公開 SSH 認証鍵をインスタンス メタデータに追加する手順は、次のとおりです。

   1. VM にインスタンス レベルの公開 SSH 認証鍵がすでにある場合は、メタデータから取得して新しいファイルに追加します。

      1. gcloud compute instances describe コマンドを実行して、VM のメタデータを取得します。

         gcloud compute instances describe VM_NAME
         

         VM_NAME は、公開 SSH 認証鍵を追加または削除する必要がある VM の名前に置き換えます。

         出力は次のようになります。

         ...
         metadata:
         ...
         - key: ssh-keys
          value: |-
            cloudysanfrancisco:ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDAu5kKQCPF...
            baklavainthebalkans:ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQDQDx3FNVC8... google-ssh {"userName":"baklavainthebalkans","expireOn":"2021-06-14T16:59:03+0000"}
         ...
         

      2. ssh-keys メタデータ値をコピーします。

      3. ワークステーションで新しいテキスト ファイルを作成して開きます。

      4. コピーした鍵のリストをファイルに貼り付けます。

      5. 新しい鍵を次の形式でリストの末尾に追加します。

      • 有効期限のない鍵の形式:

        USERNAME:KEY_VALUE

      • 有効期限のある鍵の形式:

        USERNAME:KEY_VALUE google-ssh {"userName":"USERNAME","expireOn":"EXPIRE_TIME"}

      次のように置き換えます。

      • KEY_VALUE: 公開 SSH 認証鍵の値
      • USERNAME: ユーザー名。例: cloudysanfrancisco、cloudysanfrancisco_gmail_com

        Linux VM の場合、root ログインを許可するように VM を構成した場合を除き、USERNAME を root にすることはできません。詳細については、root ユーザーとしてのインスタンスへの接続をご覧ください。

        Active Directory（AD）を使用する Windows VM の場合、ユーザー名の前に AD ドメインを DOMAIN\ 形式で追加する必要があります。たとえば、ad.example.com AD 内のユーザー cloudysanfrancisco の USERNAME は example\cloudysanfrancisco です。

      • EXPIRE_TIME: 鍵が期限切れになる時刻（ISO 8601 形式）。例: 2021-12-04T20:12:00+0000
      1. ファイルを保存して閉じます。

   2. gcloud compute instances add-metadata コマンドを実行して、ssh-keys 値を設定します。

      gcloud compute instances add-metadata VM_NAME --metadata-from-file ssh-keys=KEY_FILE
      

      次のように置き換えます。

      • VM_NAME: SSH 認証鍵を追加する VM
      • KEY_FILE は、次のいずれかに置き換えます。
      • VM に既存の SSH 認証鍵がある場合、前の手順で作成したファイルのパス
      • VM に既存の SSH 認証鍵がない場合は、新しい公開 SSH 認証鍵ファイルのパス

REST

インスタンス メタデータに既存の SSH 認証鍵がある場合は、Compute Engine API を使用して新しい SSH 認証鍵を追加するたびに、インスタンス メタデータに再追加する必要があります。既存の鍵を再追加しないと、新しい鍵を追加したときに既存の鍵が消去されます。

Compute Engine API を使用して公開 SSH 認証鍵をインスタンス メタデータに追加するには、次の手順を行います。

1. instances.get メソッドを使用して、メタデータから fingerprint と ssh-keys の値を取得します。

   GET https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/zones/ZONE/instances/VM_NAME
   

   次のように置き換えます。

   • PROJECT_ID: プロジェクト ID
   • ZONE: SSH 認証鍵を追加する VM のゾーン
   • VM_NAME: SSH 認証鍵を追加する VM

   レスポンスは次の例のようになります。

   ...
   "fingerprint": "utgYE_XWtE8=",
   "items": [
   {
    "key": "ssh-keys",
     "value": "cloudysanfrancisco:ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDAu5kKQCPF...\nbaklavainthebalkans:ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQDQDx3FNVC8... google-ssh {"userName":"baklavainthebalkans","expireOn":"2021-06-14T16:59:03+0000"}"
   }
   ]
   ...
   

2. instances.setMetadata メソッドを使用して、新しい ssh-keys 値を追加します。

   POST https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/zones/ZONE/instances/VM_NAME/setMetadata
   
   {
   "items": [
    {
     "key": "ssh-keys",
     "value": "EXISTING_SSH_KEYS\nNEW_SSH_KEY"
    }
   ]
   "fingerprint": "FINGERPRINT"
   }
   

   次のように置き換えます。

   • PROJECT_ID: プロジェクト ID
   • EXISTING_SSH_KEYS: instances.get リクエストのレスポンスからの ssh-keys 鍵の値
   • FINGERPRINT: projects.get リクエストのレスポンスからの fingerprint

   • NEW_SSH_KEY: 新しい SSH 認証鍵。次のいずれかの形式です。

     • 有効期限のない鍵の形式:

       USERNAME:KEY_VALUE

     • 有効期限のある鍵の形式:

       USERNAME:KEY_VALUE google-ssh {"userName":"USERNAME","expireOn":"EXPIRE_TIME"}

     次のように置き換えます。

     • KEY_VALUE: 公開 SSH 認証鍵の値
     • USERNAME: ユーザー名。例: cloudysanfrancisco、cloudysanfrancisco_gmail_com

       Linux VM の場合、root ログインを許可するように VM を構成した場合を除き、USERNAME を root にすることはできません。詳細については、root ユーザーとしてのインスタンスへの接続をご覧ください。

       Active Directory（AD）を使用する Windows VM の場合、ユーザー名の前に AD ドメインを DOMAIN\ 形式で追加する必要があります。たとえば、ad.example.com AD 内のユーザー cloudysanfrancisco の USERNAME は example\cloudysanfrancisco です。

     • EXPIRE_TIME: 鍵が期限切れになる時刻（ISO 8601 形式）。例: 2021-12-04T20:12:00+0000