기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.
GitHub
GitHub 버전 제어와 함께 코드 저장 및 관리 서비스를 제공하는 소프트웨어 개발을 위한 웹 기반 호스팅 서비스입니다. GitHub 엔터프라이즈 클라우드 (SaaS) 및 GitHub 엔터프라이즈 서버 (온프레미스) 리포지토리 파일을 인덱싱하고, 요청 및 풀 리퀘스트를 발행하고, 풀 리퀘스트 코멘트를 발행하고, 풀 리퀘스트 코멘트 첨부 파일을 발행하는 데 사용할 Amazon Kendra 수 있습니다. 또한 특정 파일을 포함하거나 제외하도록 선택할 수 있습니다.
참고
Amazon Kendra 이제 업그레이드된 GitHub 커넥터를 지원합니다.
콘솔이 자동으로 업그레이드되었습니다. 콘솔에서 새로 만드는 모든 커넥터는 업그레이드된 아키텍처를 사용합니다. 를 API 사용하는 경우 이제 TemplateConfiguration개체 대신 개체를 사용하여 커넥터를 구성해야 합니다. GitHubConfiguration
이전 콘솔과 API 아키텍처를 사용하여 구성한 커넥터는 구성된 대로 계속 작동합니다. 하지만 편집하거나 업데이트할 수는 없습니다. 커넥터 구성을 편집하거나 업데이트하려면 새 커넥터를 만들어야 합니다.
커넥터 워크플로를 업그레이드된 버전으로 마이그레이션하는 것이 좋습니다. 이전 아키텍처를 사용하여 구성된 커넥터에 대한 지원은 2024년 6월에 종료될 예정입니다.
Amazon Kendra 콘솔과 Amazon Kendra
Amazon Kendra GitHub 데이터 소스 커넥터 문제 해결에 대한 자세한 내용은 을 참조하십시오데이터 소스 문제 해결.
지원되는 기능
Amazon Kendra GitHub 데이터 소스 커넥터는 다음 기능을 지원합니다.
-
필드 매핑
-
사용자 액세스 제어
-
포함/제외 필터
-
전체 및 점진적 콘텐츠 동기화
-
가상 사설 클라우드 () VPC
사전 조건
GitHub 데이터 원본을 Amazon Kendra 인덱싱하는 데 사용하려면 먼저 GitHub 및 AWS 계정에서 다음과 같이 변경하십시오.
GitHub에서 다음이 있는지 확인하세요.
-
GitHub 조직에 대한 관리자 권한을 가진 GitHub 사용자를 생성했습니다.
-
Git Hub에서 개인 액세스 토큰을 인증 자격 증명으로 사용하도록 구성했습니다. 개인용 액세스 토큰 생성 GitHub 문서를
참조하십시오. 참고
보안 인증 정보와 보안 암호를 정기적으로 새로 고치거나 교체하는 것이 좋습니다. 보안을 위해 필요한 액세스 수준만 제공하세요. 데이터 소스, 커넥터 버전 1.0 및 2.0(해당하는 경우) 간에 보안 인증 정보와 보안 암호를 재사용하지 않는 것이 좋습니다.
-
권장 사항: 인증 자격 증명을 위한 OAuth 토큰을 구성했습니다. API스로틀 제한 및 커넥터 성능을 높이려면 OAuth 토큰을 사용하십시오. OAuth권한 부여 GitHub 설명서를 참조하십시오.
-
사용하는 GitHub 서비스 유형에 URL 대한 GitHub 호스트를 기록했습니다. 예를 들어 URL GitHub 클라우드용 호스트는 다음과 같을 수 있습니다.
https://api.github.com
GitHub 서버의 호스트는 다음과 URL 같을 수 있습니다.https://on-prem-host-url/api/v3/
. -
연결하려는 GitHub 엔터프라이즈 클라우드 (SaaS) 계정 또는 GitHub 엔터프라이즈 서버 (온-프레미스) 계정의 조직 이름을 기록해 두었습니다. GitHub GitHub 데스크톱에 로그인하고 프로필 사진 드롭다운에서 내 조직을 선택하여 조직 이름을 찾을 수 있습니다.
-
선택 사항 (서버만 해당): SSL 인증서를 생성하고 Amazon S3 버킷에 저장된 인증서의 경로를 복사했습니다. 보안 SSL 연결이 필요한 GitHub 경우 이를 사용하여 연결할 수 있습니다. Open을 사용하여 모든 컴퓨터에서 자체 서명된 X509 인증서를 간단히 생성할 수 있습니다. SSL SSLOpen을 사용하여 X509 인증서를 만드는 예제는 X509 인증서 만들기 및 서명을 참조하십시오.
-
다음 권한을 추가했습니다.
GitHub 엔터프라이즈 클라우드 (SaaS) 용
-
repo:status
— 퍼블릭 및 프라이빗 리포지토리의 커밋 상태에 대한 읽기/쓰기 액세스 권한을 부여합니다. 이 범위는 코드에 대한 액세스 권한을 부여하지 않고 다른 사용자나 서비스에 비공개 리포지토리 커밋 상태에 대한 액세스 권한을 부여하는 데에만 필요합니다. -
repo_deployment
— 퍼블릭 및 프라이빗 리포지토리의 배포 상태에 대한 액세스 권한을 부여합니다. 이 범위는 코드에 대한 액세스 권한을 부여하지 않고 다른 사용자나 서비스에 배포 상태에 대한 액세스 권한을 부여하는 데에만 필요합니다. -
public_repo
— 공용 리포지토리에 대한 액세스를 제한합니다. 여기에는 코드에 대한 읽기/쓰기 권한, 커밋 상태, 리포지토리 프로젝트, 공동 작업자, 공용 리포지토리 및 조직의 배포 상태가 포함됩니다. 공용 리포지토리를 시작하는 데에도 필요합니다. -
repo:invite
— 저장소에서 공동 작업하라는 초대에 대한 수락/거부 기능을 부여합니다. 이 범위는 코드에 대한 액세스 권한을 부여하지 않고 다른 사용자나 서비스에 초대에 대한 액세스 권한을 부여하는 데에만 필요합니다. -
security_events
— 권한 부여: 코드 스캐닝의 보안 이벤트에 대한 읽기 및 쓰기 액세스 권한. API 이 범위는 코드에 대한 액세스 권한을 부여하지 않고 다른 사용자나 서비스에 보안 이벤트에 대한 액세스 권한을 부여하는 데에만 필요합니다. -
read:org
— 조직 멤버십, 조직 프로젝트 및 팀 멤버십에 대한 읽기 전용 액세스. -
user:email
— 사용자의 이메일 주소에 대한 읽기 권한을 부여합니다. 크롤링하려면 Amazon Kendra가 필요합니다. ACLs -
user:follow
— 다른 사용자를 팔로우하거나 언팔로우할 수 있는 액세스 권한을 부여합니다. 크롤링하려면 Amazon Kendra가 필요합니다. ACLs -
read:user
— 사용자의 프로필 데이터를 읽을 수 있는 액세스 권한을 부여합니다. 크롤링하려면 Amazon Kendra가 필요합니다. ACLs -
workflow
— GitHub 작업 워크플로 파일을 추가하고 업데이트할 수 있는 권한을 부여합니다. 경로와 컨텐트가 같은 같은 파일이 같은 저장소의 다른 분기에 있는 경우 이 범위 없이 워크플로 파일을 커밋할 수 있습니다.
자세한 내용은 GitHub 문서의 OAuth앱 범위를
참조하십시오. GitHub 엔터프라이즈 서버용 (온프레미스)
-
repo:status
— 공용 및 개인 저장소의 커밋 상태에 대한 읽기/쓰기 액세스 권한을 부여합니다. 이 범위는 코드에 대한 액세스 권한을 부여하지 않고 다른 사용자나 서비스에 비공개 리포지토리 커밋 상태에 대한 액세스 권한을 부여하는 데에만 필요합니다. -
repo_deployment
— 퍼블릭 및 프라이빗 리포지토리의 배포 상태에 대한 액세스 권한을 부여합니다. 이 범위는 코드에 대한 액세스 권한을 부여하지 않고 다른 사용자나 서비스에 배포 상태에 대한 액세스 권한을 부여하는 데에만 필요합니다. -
public_repo
— 공용 리포지토리에 대한 액세스를 제한합니다. 여기에는 코드에 대한 읽기/쓰기 권한, 커밋 상태, 리포지토리 프로젝트, 공동 작업자, 공용 리포지토리 및 조직의 배포 상태가 포함됩니다. 공용 리포지토리를 시작하는 데에도 필요합니다. -
repo:invite
— 저장소에서 공동 작업하라는 초대에 대한 수락/거부 기능을 부여합니다. 이 범위는 코드에 대한 액세스 권한을 부여하지 않고 다른 사용자나 서비스에 초대에 대한 액세스 권한을 부여하는 데에만 필요합니다. -
security_events
— 권한 부여: 코드 스캐닝의 보안 이벤트에 대한 읽기 및 쓰기 액세스 권한. API 이 범위는 코드에 대한 액세스 권한을 부여하지 않고 다른 사용자나 서비스에 보안 이벤트에 대한 액세스 권한을 부여하는 데에만 필요합니다. -
read:user
— 사용자의 프로필 데이터를 읽을 수 있는 액세스 권한을 부여합니다. ACLs크롤링하려면 Amazon Q 비즈니스에서 필요합니다. -
user:email
— 사용자의 이메일 주소에 대한 읽기 액세스 권한을 부여합니다. ACLs크롤링하려면 Amazon Q 비즈니스에서 필요합니다. -
user:follow
— 다른 사용자를 팔로우하거나 언팔로우할 수 있는 액세스 권한을 부여합니다. ACLs크롤링하려면 Amazon Q 비즈니스에서 필요합니다. -
site_admin
— 사이트 관리자에게 GitHub 엔터프라이즈 서버 관리 API 엔드포인트에 대한 액세스 권한을 부여합니다. -
workflow
— GitHub 작업 워크플로 파일을 추가하고 업데이트할 수 있는 권한을 부여합니다. 경로와 컨텐트가 같은 같은 파일이 같은 저장소의 다른 분기에 있는 경우 이 범위 없이 워크플로 파일을 커밋할 수 있습니다.
자세한 내용은 GitHub 문서의 앱 범위 및 Developer의 OAuth 앱
범위 이해를 참조하십시오. OAuth GitHub -
-
동일한 색인에 사용하려는 다른 데이터 소스에서 각 문서가 고유한지 확인했습니다. GitHub 인덱스에 사용하려는 각 데이터 소스에는 데이터 소스 전체에서 동일한 문서가 포함되어서는 안 됩니다. 문서는 IDs 인덱스 전체에 적용되며 인덱스별로 고유해야 합니다.
에 다음이 있는지 확인하십시오. AWS 계정
-
Amazon Kendra 색인을 만들고 를 사용하는 경우 색인 ID를 기록해 두었습니다. API
-
데이터 원본에 대한 IAM 역할을 만들고 를 사용하는 API 경우 해당 IAM 역할을 기록해 둡니다. ARN
참고
인증 유형과 자격 증명을 변경하는 경우 올바른 AWS Secrets Manager 암호 ID에 액세스하려면 IAM 역할을 업데이트해야 합니다.
-
GitHub 인증 자격 증명을 AWS Secrets Manager 비밀에 저장하고, 를 사용하는 경우 API 비밀번호를 기록해 ARN 두었습니다.
참고
보안 인증 정보와 보안 암호를 정기적으로 새로 고치거나 교체하는 것이 좋습니다. 보안을 위해 필요한 액세스 수준만 제공하세요. 데이터 소스, 커넥터 버전 1.0 및 2.0(해당하는 경우) 간에 보안 인증 정보와 보안 암호를 재사용하지 않는 것이 좋습니다.
기존 IAM 역할이나 암호가 없는 경우 GitHub 데이터 원본을 연결할 때 콘솔을 사용하여 새 IAM 역할과 Secrets Manager 암호를 만들 수 Amazon Kendra있습니다. 를 API 사용하는 경우 기존 IAM 역할 및 Secrets Manager 암호와 인덱스 ID를 제공해야 합니다. ARN
연결 지침
GitHub 데이터 Amazon Kendra 원본에 연결하려면 데이터에 액세스할 Amazon Kendra 수 있도록 GitHub 데이터 원본의 필수 세부 정보를 제공해야 합니다. 아직 구성하지 않은 경우 GitHub 을 Amazon Kendra참조하십시오사전 조건.
자세히 알아보기
GitHub 데이터 Amazon Kendra 소스와의 통합에 대해 자세히 알아보려면 다음을 참조하십시오.