커넥터 에이전트 실행하기
Satellite 커넥터를 생성한 후, 다음 단계를 완료하여 에이전트를 생성하고 설정을 마무리하십시오.
전제조건
- Satellite 커넥터를 작성하십시오.
- CLI를 설치하십시오.
- 선택사항: 서비스 ID를 작성하십시오. 개별 사용자 신임 정보를 사용하는 것보다 서비스 ID가 권장됩니다.
- 에이전트를 실행하는 사용자 또는 서비스 ID가 IAM에서 Viewer 플랫폼 역할 Satellite를 가지고 있는지 확인합니다.
- 사용자 고유의 로그인 또는 서비스 ID를 사용하여 API키를 작성 하십시오. 이 API키는 커넥터 에이전트에서 사용됩니다.
- 컴퓨팅 환경이 에이전트 이미지를 실행하기 위한 최소 요구사항 을 충족하는지 확인하십시오.
- 에이전트 매개변수를 검토하십시오.
에이전트 매개변수 검토
다음 환경 변수를 통해 에이전트에 구성 정보가 제공됩니다. 이러한 환경 변수를 값으로 직접 설정하거나 값을 포함하는 파일의 경로로 설정할 수 있습니다. 경로 값은 컨테이너 내에서 액세스 가능해야 하며 따라서 호스트의 로컬 경로가 아닌 마운트 포인트를 기반으로 합니다. 예시는 다음 표를 참조하십시오.
| 환경 변수 | 필수 | 설명 |
|---|---|---|
SATELLITE_CONNECTOR_ID |
예 | 에이전트가 바인드되는 Satellite 커넥터의 ID입니다. Satellite 콘솔 에서 또는 ibmcloud sat connector ls 명령을 실행하여 커넥터 ID를 찾을 수 있습니다. |
SATELLITE_CONNECTOR_IAM_APIKEY |
예 | IAM API 키. 보안을 위해, IAM API키를 파일에 저장한 후 이 값에 파일을 제공하는 것을 고려한다. 참고: Windows 환경에서는 파일 경로에서 슬래시를 이스케이프해야 합니다. |
SATELLITE_CONNECTOR_TAGS |
아니오 | 에이전트를 식별하는 데 도움이 될 수 있는 사용자 정의 문자열입니다. 이 문자열은 유용한 값일 수 있습니다. 값은 256자 이하여야 하며 256자 이상이면 잘립니다. 다음 문자들이 제거됩니다: <>/{}%[]?,;@$&. |
SATELLITE_CONNECTOR_DIRECT_LINK_INGRESS |
아니오 | 에이전트 트래픽을 전달할 Satellite 터널 인그레스 서버입니다. 내부 인그레스를 지정하면 에이전트와 터널 서버 간의 모든 트래픽이 프라이빗 네트워크에 유지됩니다. |
LOG_LEVEL |
아니오 | 에이전트에 대해 수신할 로깅 세부사항의 레벨을 설정하십시오. fatal, error, warn, debug, info 또는 trace 중 하나를 지정할 수 있습니다. 기본 레벨은 info 입니다. 일반적으로 debug 및 trace 레벨은 디버깅 시에만 사용됩니다. |
PRETTY_LOG |
아니오 | Windows 환경만 해당됩니다. 로그를 예쁜 형식으로 표시하려면 ' true '을 지정하고, 로그를 JSON 형식으로 표시하려면 ' false '를 지정합니다. |
컨테이너 플랫폼에서 에이전트 실행
시작하기 전에 최소 요구 사항 를 검토하세요.
1단계: 로컬 구성 파일 작성
에이전트 구성 환경 변수 정보를 컨테이너에 전달하는 여러 가지 방법이 있습니다. 다음 예제는 구성 파일을 사용합니다. 그러나 docker run --env 명령을 사용하여 값을 지정할 수도 있습니다.
API키와 함께 --env 를 사용하는 경우 API키가 컨테이너 환경에 노출되고 docker inspect 명령의 출력에 표시됩니다. API키를 파일에 저장한 후 환경 변수에서 파일 이름을 사용할 수 있다. 파일 이름을 사용하도록 선택하는 경우, 환경 변수에 지정하는 파일 경로가 다음 예제에 표시된 대로 컨테이너의 파일 경로에 마운트되어 있는지 확인해야 합니다.
다음 단계에 표시된 파일 이름은 예제이며 사용자 환경에 맞게 조정할 수 있습니다.
-
구성 파일의 디렉토리를 작성하십시오 (이 예제에서는
~/agent/env-files). -
Satellite 커넥터에 액세스할 수 있는 IBM Cloud API키의 단일 라인 값을 사용하여
apikey라는~/agent/env-files디렉토리에 파일을 작성하십시오. -
다음 값을 사용하여
env.txt라는~/agent/env-files디렉토리에 파일을 작성하십시오. 'SATELLITE_CONNECTOR_ID' 변수를 Satellite 수정합니다 커넥터 ID로 수정합니다.SATELLITE_CONNECTOR_ID=<Your Satellite Connector ID> SATELLITE_CONNECTOR_IAM_APIKEY=/agent-env-files/apikey SATELLITE_CONNECTOR_TAGS=sample tag -
이 시점에서 디렉토리에는 두 개의 파일이 포함되며 다음 예제와 유사합니다.
env-files$ ls apikey env.txt -
다음 절의 단계를 완료하여 에이전트 이미지를 가져오십시오.
2단계: 에이전트 이미지 가져오기
-
IBM Cloud® Container Registry에 로그인하십시오. 또는 API키를 사용하여 Docker 에서 직접 저장소에 로그인하십시오.
ibmcloud cr region-set icr.iodocker login -u iamapikey -p <your apikey> icr.io -
아키텍처에 맞는 최신 버전의 공개된 이미지를 가져옵니다. 허용되는 태그 값은
latest,latest-amd64,latest-arm64,latest-ppc64le,latest-s390x입니다. IBM Satellite Connector Agent Release History 에서 공개된 버전 목록을 확인할 수 있습니다.docker pull icr.io/ibm/satellite-connector/satellite-connector-agent:latest -
에이전트 이미지를 실행하려면 다음 단계를 완료하십시오.
3단계: 에이전트 이미지 실행
-
사용 가능한 버전의 에이전트 이미지를 보려면 다음 명령을 실행하십시오.
ibmcloud cr images --include-ibm |egrep -i "tag|satellite"출력 예:
Repository Tag Digest Namesp Created Size Security status icr.io/ibm/satellite-connector/satellite-connector-agent latest 63a97392e510 ibm - 937 B - icr.io/ibm/satellite-connector/satellite-connector-agent latest-amd64 0d2b1a5773e5 ibm 1 week ago 50 MB - icr.io/ibm/satellite-connector/satellite-connector-agent latest-arm64 cb60b8d7040f ibm 1 week ago 94 MB - icr.io/ibm/satellite-connector/satellite-connector-agent latest-ppc64le 4bcf8b1f6ea7 ibm 1 week ago 107 MB - icr.io/ibm/satellite-connector/satellite-connector-agent latest-s390x 27588d9d6143 ibm 1 week ago 94 MB - icr.io/ibm/satellite-connector/satellite-connector-agent v1.1.0 5f4e42c8d53e ibm 2 years ago 124 MB - icr.io/ibm/satellite-connector/satellite-connector-agent v1.1.1 0caddb11b1c1 ibm 1 year ago 125 MB - icr.io/ibm/satellite-connector/satellite-connector-agent v1.1.10 52db33f1ec43 ibm - 937 B - icr.io/ibm/satellite-connector/satellite-connector-agent v1.1.10-amd64 90c920b580fe ibm 2 months ago 50 MB - icr.io/ibm/satellite-connector/satellite-connector-agent v1.1.10-arm64 322f92d8c373 ibm 2 months ago 94 MB - icr.io/ibm/satellite-connector/satellite-connector-agent v1.1.10-ppc64le 603b3507f20c ibm 2 months ago 107 MB - icr.io/ibm/satellite-connector/satellite-connector-agent v1.1.10-s390x afe670f04ea2 ibm 2 months ago 95 MB - -
-v옵션을 사용하여env-files디렉토리를 컨테이너의/agent-env-files디렉토리에 마운트하십시오. 최신 버전 또는 공개된 이미지의 특정 버전을 사용할 수 있습니다.환경 변수가 파일 경로를 사용하는 경우, 해당 경로는 컨테이너 내의 파일 경로여야 합니다. 파일 경로를 검색하려면
docker run명령에-v옵션을 사용하십시오.-v옵션은 로컬 환경 변수 디렉토리 경로에 의해 지정되며, 컨테이너에 마운트된 경로가 뒤에 오고:로 구분됩니다. 예를 들어,-v ~/agent/env-files:/agent-env-files입니다. 여기서~/agent/env-files은 로컬 경로이고/agent-env-files는 컨테이너의 경로입니다.docker run -d --env-file ~/agent/env-files/env.txt -v ~/agent/env-files:/agent-env-files icr.io/ibm/satellite-connector/satellite-connector-agent:latest이미지의 버전 1.1.0 을 사용하는 예제 명령은 다음 명령을 실행하십시오.
docker run -d --env-file ~/agent/env-files/env.txt -v ~/agent/env-files:/agent-env-files icr.io/ibm/satellite-connector/satellite-connector-agent:v1.1.0 -
컨테이너의 로그를 보고 터널이 커넥터에 설정되는지 확인할 수 있습니다.
docker logs CONTAINER-ID로그 시작 부분에서 다음 예제와 유사한 항목을 찾을 수 있습니다.
{"level":30,"time":"2023-06-20T16:12:20.133Z","pid":8,"hostname":"6b793f671c79","name":"agentOps","msgid":"A02","msg":"Load SATELLITE_CONNECTOR_ID value from SATELLITE_CONNECTOR_ID environment variable."} {"level":30,"time":"2023-06-20T16:12:20.138Z","pid":8,"hostname":"6b793f671c79","name":"agentOps","msgid":"A01","msg":"Load SATELLITE_CONNECTOR_IAM_APIKEY value from file /agent-env-files/apikey."} {"level":30,"time":"2023-06-20T16:12:20.140Z","pid":8,"hostname":"6b793f671c79","name":"agentOps","msgid":"A02","msg":"Load SATELLITE_CONNECTOR_TAGS value from SATELLITE_CONNECTOR_TAGS environment variable."} {"level":30,"time":"2023-06-20T16:12:20.142Z","pid":8,"hostname":"6b793f671c79","name":"connector-agent","msgid":"LA2","msg":"Connector id: U2F0ZWxsaXRlQ29ubmVjdG9yOiJjaThzdWd1ZDFwZ2RrZmUxa3UxZyI, region: us-south, release info: 20230610-dd48822928d35a84b31029a996fa9abc9d29fc93_A."} {"level":30,"time":"2023-06-20T16:12:20.392Z","pid":8,"hostname":"6b793f671c79","name":"tunneldns","msgid":"D04","msg":"DoTunnelDNSLookup DNS resolve c-01-ws.us-south.link.satellite.cloud.ibm.com to 169.61.31.178"} {"level":30,"time":"2023-06-20T16:12:21.560Z","pid":8,"hostname":"6b793f671c79","name":"utilities","msg":"MakeLinkAPICall GET /v1/connectors/U2F0ZWxsaXRlQ29ubmVjdG9yOiJjaThzdWd1ZDFwZ2RrZmUxa3UxZyI status code 200"} {"level":30,"time":"2023-06-20T16:12:21.563Z","pid":8,"hostname":"6b793f671c79","name":"agent_tunnel","msgid":"LAT03","msg":"Got configuration"} {"level":30,"time":"2023-06-20T16:12:21.565Z","pid":8,"hostname":"6b793f671c79","name":"agent_tunnel","msgid":"LAT04-wss://c-01-ws.us-south.link.satellite.cloud.ibm.com/ws","msg":"Connecting to wss://c-01-ws.us-south.link.satellite.cloud.ibm.com/ws"} {"level":30,"time":"2023-06-20T16:12:21.922Z","pid":8,"hostname":"6b793f671c79","name":"tunneldns","msgid":"D04","msg":"DoTunnelDNSLookup DNS resolve c-01-ws.us-south.link.satellite.cloud.ibm.com to 169.61.31.178"} {"level":30,"time":"2023-06-20T16:12:22.294Z","pid":8,"hostname":"6b793f671c79","name":"TunnelCore","msgid":"TC24","msg":"Tunnel open","connector_id":"U2F0ZWxsaXRlQ29ubmVjdG9yOiJjaThzdWd1ZDFwZ2RrZmUxa3UxZyI"} {"level":30,"time":"2023-06-20T16:12:22.299Z","pid":8,"hostname":"6b793f671c79","name":"connector_tunnel_base","msgid":"CTB26-U2F0ZWxsaXRlQ29ubmVjdG9yOiJjaThzdWd1ZDFwZ2RrZmUxa3UxZyI","msg":"Send connector information to tunnel server"} {"level":30,"time":"2023-06-20T16:12:22.307Z","pid":8,"hostname":"6b793f671c79","name":"connector_tunnel_base","msgid":"CTB27","msg":"Tunnel connected","connector_id":"U2F0ZWxsaXRlQ29ubmVjdG9yOiJjaThzdWd1ZDFwZ2RrZmUxa3UxZyI","cipher":{"name":"TLS_AES_256_GCM_SHA384","standardName":"TLS_AES_256_GCM_SHA384","version":"TLSv1.3"}}
에이전트를 설정한 후 엔드포인트 및 ACL을 작성하여 해당 엔드포인트에 대한 액세스를 관리할 수 있습니다. 자세한 정보는 커넥터 엔드포인트 작성 및 관리 를 참조하십시오.
Windows에서 에이전트 실행하기
Windows에서 커넥터 에이전트를 실행하려면 다음 단계를 검토하십시오.
시작하기 전에 최소 요구 사항 를 검토하세요.
1단계: CLI에서 커넥터 에이전트 파일 다운로드
-
CLI에서 다음 명령을 실행하여 에이전트
.zip파일을 다운로드하십시오.ibmcloud sat agent attach --platform windows출력 예.
Downloading agent setup tools for windows... OK Satellite connector agent for windows was successfully returned /var/folders/17/y8wr4y_x1tb4yf__g3wr6g8m0000gp/T/windows_satellite_connector_4097559421.zip -
PowerShell에서 다음 명령을 실행하여
.zip의sha512sum을 확인합니다.Get-FileHash -Algorithm SHA512 -Path c:\windows_satellite_connector_1420916628.zip -
PowerShell 에서 다음 명령을 실행하여
.zip파일 컨텐츠를 추출하십시오.Expand-Archive -Path 'C:\path\to\windows_satellite_connector_4097559421.zip' -DestinationPath ‘C:\path\to\extract' -
다음 섹션의 단계를 완료하여 추출한 구성 파일을 업데이트하십시오.
2단계: config.json 파일 업데이트
구성 정보는 이전 단계에서 추출한 config.json 파일의 다음 환경 변수를 통해 에이전트에 제공됩니다. 에이전트 이미지에 대한 다음 매개변수를 검토하십시오.
-
각 매개변수에 대해 적절한 값으로 이전에 추출한
config.json를 업데이트하십시오.파일 경로에서 슬래시를 이스케이프해야 합니다.
예시:
config.json.{ "SATELLITE_CONNECTOR_ID":"<Your Satellite Connector ID>", "SATELLITE_CONNECTOR_IAM_APIKEY":"<Your API Key>", "SATELLITE_CONNECTOR_TAGS":"sample tag", "LOG_LEVEL": "info", "PRETTY_LOG": true }채워진 값이 있는 예제
config.json.{ "SATELLITE_CONNECTOR_ID":"U2F0ZWxsaXRlQ29ubmVjdG9yOiJjanM4cnRzZjFsN2c0M3U4cmp1MBA", "SATELLITE_CONNECTOR_IAM_APIKEY":"C:\\path\\to\\apikey", "SATELLITE_CONNECTOR_TAGS":"sample tag", "LOG_LEVEL": "info", "PRETTY_LOG": true } -
파일을 저장하십시오.
-
다음 절의 단계를 완료하여 에이전트를 시작하십시오.
3단계: 에이전트 시작
-
PowerShell에서
install명령을 실행하여 에이전트를 시작하십시오..\install상담원을 시작하고 Windows
Microsoft Defender SmartScreen오류가 발생하면 이는 예상되는 것입니다. 일반 텍스트 설치 스크립트는 서명되지 않습니다. 에이전트를 다운로드한 후sha512sum확인하는 단계를 따르는 것이 좋습니다. -
PowerShell에서
Get-Service명령을 실행하여 에이전트가 설치되었는지 확인합니다.Get-Service 'SatelliteConnectorService' -
PowerShell에서
Get-Content명령을 실행하여 에이전트 로그를 보십시오.Get-Content 'C:\path\to\extract\logs\{satelliteconnectorservice_{{yyyymmdd}}.out.log}' -
선택사항: PowerShell에서
uninstall명령을 실행하여 에이전트를 중지하십시오..\uninstall
에이전트를 설정한 후 엔드포인트 및 ACL을 작성하여 해당 엔드포인트에 대한 액세스를 관리할 수 있습니다. 자세한 정보는 커넥터 엔드포인트 작성 및 관리 를 참조하십시오.
Windows에서 에이전트 업데이트하기
상담원 패키지에서 update-service 명령을 사용하여 상담원에게 구성 변경 사항을 적용할 수 있습니다. 명령을 실행하면 에이전트가 중지되고 설치 제거된 후 다시 설치됩니다. 에이전트를 업데이트하려면 다음 단계를 따르십시오.
-
업데이트하기 전에 커넥터 Windows 상담원 변경 로그 에서 변경 사항을 검토하고 현재 실행 중인 상담원보다 최신 버전이 더 최신인지 확인하세요.
현재 실행 중인 상담원의 상담원 패키지 안에 있는
version.txt파일에서 현재 버전 번호를 찾을 수 있습니다.version.txt파일이 없거나 현재 버전 번호가 최신 버전 번호보다 낮은 경우 업데이트할 수 있는 최신 버전이 있습니다. -
사용 가능한 최신 에이전트 버전이 있고 이를 사용하려면 다음 단계로 진행하기 전에 1단계: CLI에서 커넥터 에이전트 파일 다운로드 의 안내에 따라 최신 버전을 다운로드하세요.
-
config.json파일의 구성 매개변수를 수정하십시오.예시:
config.json.{ "SATELLITE_CONNECTOR_ID":"<Your Satellite Connector ID>", "SATELLITE_CONNECTOR_IAM_APIKEY":"<Your API Key>", "SATELLITE_CONNECTOR_TAGS":"<tags>", "LOG_LEVEL": "info", "PRETTY_LOG": true }채워진 값이 있는 예제
config.json.{ "SATELLITE_CONNECTOR_ID":"U2F0ZWxsaXRlQ29ubmVjdG9yOiJjanM4cnRzZjFsN2c0M3U4cmp1MBA", "SATELLITE_CONNECTOR_IAM_APIKEY":"C:\\path\\to\\apikey", "SATELLITE_CONNECTOR_TAGS":"sample tag", "LOG_LEVEL": "info", "PRETTY_LOG": true } -
PowerShell에서
update-service명령을 실행하십시오..\update-service -
PowerShell에서
Get-Service명령을 실행하여 에이전트가 설치되었는지 확인합니다.Get-Service 'SatelliteConnectorService' -
PowerShell에서
Get-Content명령을 실행하여 에이전트 로그를 보십시오.Get-Content 'C:\path\to\extract\logs\{satelliteconnectorservice_{{yyyymmdd}}.out.log}'
다음 단계
커넥터 에이전트를 작성한 후 엔드포인트를 작성하여 IBM Cloud 사설 네트워크에서 사용자 위치에서 실행 중인 자원으로 연결할 수 있습니다. 액세스 제어 목록 규칙을 작성하여 엔드포인트에 대한 액세스를 제어할 수도 있습니다. 자세한 정보는 커넥터 엔드포인트 작성 및 관리 를 참조하십시오.