AWS EC2ディスカバリ
EC2インスタンスを検出して接続
Last updated
EC2インスタンスを検出して接続
Last updated
KeeperコネクションマネージャーはAmazon AWSと連携し、自動的にEC2インスタンスを検出して接続を行います。これにより、手動で何も設定しなくても、クラウド環境内の任意のEC2インスタンスに素早く簡単に接続できるようになります。他の接続と同様に、EC2インスタンス接続は特別に許可されるもので、エンドユーザーは根底をなすクレデンシャルにアクセスできないことになります。
この連携機能を有効化すると、以下のようにEC2インスタンスがKeeperコネクションマネージャーのホーム画面に表示されます。
AWS環境でのEC2インスタンスの即時検出
定義したユーザーグループに対する権限の制限
ファイルシステムまたはKeeperボルトでPEMファイルを管理
KeeperコネクションマネージャーをAmazon AWSと連携するには、ユーザーを作成して、インスタンス情報を読み取る権限を持つロールポリシーを割り当てる必要があります。以下は権限を最小限に抑えたポリシーの例です。
ユーザーに権限を割り当てた後、アクセスキーを作成します。
環境を設定する前に、「AWS EC2 Administrators」というグループが、検出されたインスタンスにアクセスするユーザーに割り当てられているようにします。グループ名は、AWS_DISCOVERY_ADMIN_GROUP環境変数を使用してカスタマイズすることもできます。
この機能を使用するためにKeeperコネクションマネージャー環境を更新するには、/etc/kcm-setup/docker-compose.ymlにあるDocker Composeファイルを編集する必要があります。
コンテナを停止する
ローカルインスタンスに変更を加える前に、コンテナを停止しておきましょう。
Docker Composeを編集する
次に、docker composeファイル/etc/kcm-setup/docker-compose.ymlを編集し、以下のように必要な環境変数とボリュームのプロパティを追加します。
KCMでシークレットマネージャーのボルト接続を使用している場合は、pemファイルまたは秘密鍵をKeeperボルトからその都度取得できます。この方法を使用する場合、pemファイルのボリュームマウントを作成する必要はありません。詳細については、EC2 Cloud Connectorのページをご参照ください。
環境変数
AWS_DISCOVERY_ACCESS_KEY_ID
AWSでの認証に使用するAWSアカウントのアクセスキーID (必須)。
AWS_DISCOVERY_SECRET_KEY
アクセスキーに関連付けられた秘密鍵 (必須)。
AWS_DISCOVERY_REGIONS
us-west-1、us-east-1など、EC2インスタンスを照会するリージョンのカンマ区切りリスト (必須)。
AWS_DISCOVERY_INSTANCE_BASE_PATH
利便性を考慮し、EC2インスタンスを格納するために使用する組織の接続グループの名前。デフォルトでは、「Amazon EC2」になります (オプション)。
AWS_DISCOVERY_ADMIN_GROUP
検出されたEC2インスタンスを表示するために必要となるKeeperコネクションマネージャーでのユーザーグループの名前。デフォルトでは、「AWS EC2 Administrators」というグループになります。このユーザーグループは、Azure ADなどのディレクトリとの連携からプロビジョニングされたグループに割り当てることもできます。
AWS_DISCOVERY_RECORD_CONNECTIONS_BY_DEFAULT
「true」に設定すると、すべての接続で録画がデフォルトで有効になります。接続セッションの録画は、「kcm:record」というEC2インスタンスタグを使用して個々のマシンレベルで設定することもでき、「true」または「false」に設定して、接続の録画を有効化または無効化できます。
AWS_DISCOVERY_KSM_CONFIG
このKeeperシークレットマネージャーの設定で、PEMファイルを格納するためのKeeperボルトと連携します。詳細については、EC2 Cloud Connectorのページをご参照ください。
.pemファイルをguac_keysフォルダにコピーする
Docker Composeの例では、ローカルファイルの場所/var/lib/guac_keys/でボリュームのマッピングを確認できます。これはKCMホスト内のフォルダで、目的のインスタンスへの接続を確立するために必要なすべてのSSH鍵ファイルが配置されていなければなりません。Windowsインスタンスの場合は、管理者パスワードの復号化に使用される.pemファイルもコピーする必要があります。KCMはEC2インスタンスのメタデータに基づいて適切なファイルを選択し、接続を確立します。
ファイルの権限を確認し、鍵ファイルがコンテナによって確実に読み取れるようにするには、以下の鍵ファイルの権限セクションをご参照ください。
KCMでシークレットマネージャーのボルト接続を使用している場合は、pemファイルまたは秘密鍵をKeeperボルトからその都度取得できます。詳細については、EC2 Cloud Connectorのページをご参照ください。
コンテナをアップグレードする
Docker自動インストールメソッドを使用する場合、基盤となるソフトウェアをすべて更新するには、以下のコマンドを実行します。
これにより、更新後に自動的にコンテナが開始されます。
この機能を使用するためにKeeperコネクションマネージャー環境を更新するには、Docker Composeのカスタムファイルの「guacamole」セクションを編集する必要があります。
コンテナを停止する
ローカルインスタンスに変更を加える前に、docker-composeで通常行うように、コンテナを停止しておきましょう。
Docker Composeを編集する
次に、docker composeファイルを編集し、以下のように必要な環境変数とボリュームプロパティをguacamoleセクションに追加します。
環境変数
AWS_DISCOVERY_ACCESS_KEY_ID
AWSでの認証に使用するAWSアカウントのアクセスキーID (必須)。
AWS_DISCOVERY_SECRET_KEY
アクセスキーに関連付けられた秘密鍵 (必須)。
AWS_DISCOVERY_REGIONS
us-west-1、us-east-1など、EC2インスタンスを照会するリージョンのカンマ区切りリスト (必須)。
AWS_DISCOVERY_INSTANCE_BASE_PATH
利便性を考慮し、EC2インスタンスを格納するために使用する組織の接続グループの名前。デフォルトでは、「Amazon EC2」になります (オプション)。
AWS_DISCOVERY_ADMIN_GROUP
検出されたEC2インスタンスを表示するために必要となるKeeperコネクションマネージャーでのユーザーグループの名前。デフォルトでは、「AWS EC2 Administrators」というグループになります。このユーザーグループは、Azure ADなどのディレクトリとの連携からプロビジョニングされたグループに割り当てることもできます。
AWS_DISCOVERY_RECORD_CONNECTIONS_BY_DEFAULT
「true」に設定すると、すべての接続で録画がデフォルトで有効になります。接続セッションの録画は、「kcm:record」というEC2インスタンスタグを使用して個々のマシンレベルで設定することもでき、「true」または「false」に設定して、接続の録画を有効化または無効化できます。
.pemファイルをguac_keysフォルダにコピーする
Docker Composeの例では、ローカルファイルの場所/var/lib/guac_keys/でボリュームのマッピングを確認できます。これはKCMホスト内のフォルダで、目的のインスタンスへの接続を確立するために必要なすべてのSSH鍵ファイルが配置されていなければなりません。Windowsインスタンスの場合は、管理者パスワードの復号化に使用される.pemファイルもコピーする必要があります。KCMはEC2インスタンスのメタデータに基づいて適切なファイルを選択し、接続を確立します。
ファイルの権限を確認し、鍵ファイルがコンテナによって確実に読み取れるようにするには、以下の鍵ファイルの権限セクションをご参照ください。
コンテナをアップグレードする
Dockerカスタムインストールメソッドを使用して、基盤となるソフトウェアをすべて更新するには、コンテナをアップグレードします (docker-compose.ymlがカレントディレクトリにあることが前提となります)。
これにより、更新後に自動的にコンテナが開始されます。
Linuxインストールメソッドを使用してKeeperコネクションマネージャーをインストールした場合は、以下の手順でAWS EC2ディスカバリ機能を有効化します。
1. KCM Cloud Connectorパッケージをインストールする
Linuxインストールメソッドを使用している場合は、以下のように「yum install」を使用してKCM Cloud Connectorパッケージをインストールできます。
Guacamoleプロパティファイルを編集する
/etc/guacamole/guacamole.propertiesを編集して、AWS Cloud Connector機能の必須プロパティとオプションプロパティを追加します。
使用可能なプロパティ
aws-discovery-access-key-id
AWSでの認証に使用するAWSアカウントのアクセスキーID (必須)。
aws-discovery-secret-key
アクセスキーに関連付けられた秘密鍵 (必須)。
aws-discovery-regions
us-west-1、us-east-1など、EC2インスタンスを照会するリージョンのカンマ区切りリスト (必須)。
aws-discovery-instance-base-path
利便性を考慮し、EC2インスタンスを格納するために使用する必要のある組織の接続グループの名前。デフォルトでは、「Amazon EC2」になります (オプション)。
aws-discovery-admin-group
検出されたEC2インスタンスを表示するために必要となるKeeperコネクションマネージャーでのユーザーグループの名前。デフォルトでは、「AWS EC2 Administrators」というグループになります。このユーザーグループは、Azure ADなどのディレクトリとの連携からプロビジョニングされたグループに割り当てることもできます (オプション)。
aws-discovery-record-connections-by-default
「true」に設定すると、すべての接続で録画がデフォルトで有効になります (オプション)。接続セッションの録画は、「kcm:record」EC2インスタンスタグを使用して個々のマシンレベルで設定することもでき、「true」または「false」に設定して、接続の録画を有効化または無効化できます。
.pemファイルをguac_keysフォルダにコピーする
LinuxインスタンスへのアクセスまたはWindowsパスワードの復号化に使用する秘密鍵に必要なPEMファイルをすべて/etc/guacamole/cloud-connector-secrets/aws/に追加します。
Guacamoleサービスを再起動する
新しいパッケージは、ウェブアプリケーションが再起動されるまで有効になりません。
インスタンスごとに割り当てられたAWS EC2タグを使用して接続を設定し、デフォルトとメタデータを上書きおよびカスタマイズできます。
kcm:username
インスタンスに接続するときに使用するユーザー名。
このタグで、「centos」や「ec2-user」などのインスタンスのログインユーザー名を定義します。KCMは、インスタンスのAMIに基づいて正しいユーザー名を選択しようとしますが、これを使用して誤った推測を修正できます。
kcm:organize他の接続間でインスタンスを整理するために使用する接続グループのフルパス。
このタグにより、すべてのインスタンスを含む接続グループの範囲を超えてEC2インスタンスをさらに整理できます。デフォルトでは、検出されたすべてのインスタンスは、「Amazon EC2」という最上位の接続グループ内に配置されますが、それ以上の整理は行われません。たとえば、kcm:organizeを「Databases」のように設定すると、そのインスタンスは、「Amazon EC2」の下の「Databases」接続グループ内に配置されます。同様に、kcm:organizeを「Databases/MySQL」に設定すると、そのインスタンスは「Amazon EC2」の下にある「Databases」の中の「MySQL」接続グループに配置されます。
これらの接続グループはすでに存在している必要はなく、実際にはメモリ内にのみ存在します (EC2サポートによって維持されます)。
kcm:recordインスタンス接続セッションを記録するか否かを示すフラグ。
このタグは、KCM環境プロパティ aws-discovery-record-connections-by-default のデフォルトの画面録画設定を上書きします。このタグが存在し、その値が「true」に設定されている場合、接続は録画されます。「false」に設定されている場合は、接続は録画されません。このタグが存在しない場合、または他の値に設定されている場合は、設定済みのデフォルトの録画動作が使用されます。
鍵ファイルの名前は、MyServerなどEC2コンソールの表示どおり正確に付ける必要があります。
鍵ファイルの名前には、MyServer.pemなどファイル拡張子.pemを付ける必要があります。
「guacamole」dockerコンテナ内のサービスは、「guacamole」ユーザーによって実行されます。「guacamole」ユーザーが共有鍵ファイルに読み取りアクセスできるように、ボリュームマウントでファイルのアクセス権限を適切に設定する必要があります。
例えば、ホスト上の /var/lib/guac_keys/ フォルダ内のファイルは、ec2-user または設定したユーザーによって所有されている場合があります。
コンテナ内でのファイルの所有者は、「1000」またはその他のユーザーIDが表示されている場合があります。
ホストとguacamoleコンテナ間のファイルのアクセス権限を解決する方法は2つあります。
guacamole docker定義の環境変数GUACAMOLE_UIDとGUACAMOLE_GIDを使用して、アクセス権限をマッピングします。
この変更の結果は以下のようになります。
既存のファイルの所有権が、guacamoleユーザーの古いUIDから指定した値に更新されます。
コンテナ内のguacamoleユーザーのUIDをその値に一致するように更新されます。
ホストからファイルに対する読み取り許可をより広いグループまたはその他すべてに設定できますが、これは環境とセキュリティ設定に基づいて判断します。
変更を反映するには、必ずコンテナをアップグレードしてください。
(kcm-setup.run upgradeまたはdocker-compose up -d)
.pemキーがパスフレーズで暗号化されている場合は、宛先への接続を確立するときにパスフレーズの入力を求められます。