GitHub - Amazon Kendra

기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

GitHub

GitHub 버전 제어와 함께 코드 저장 및 관리 서비스를 제공하는 소프트웨어 개발을 위한 웹 기반 호스팅 서비스입니다. GitHub 엔터프라이즈 클라우드 (SaaS) 및 GitHub 엔터프라이즈 서버 (온프레미스) 리포지토리 파일을 인덱싱하고, 요청 및 풀 리퀘스트를 발행하고, 풀 리퀘스트 코멘트를 발행하고, 풀 리퀘스트 코멘트 첨부 파일을 발행하는 데 사용할 Amazon Kendra 수 있습니다. 또한 특정 파일을 포함하거나 제외하도록 선택할 수 있습니다.

참고

Amazon Kendra 이제 업그레이드된 GitHub 커넥터를 지원합니다.

콘솔이 자동으로 업그레이드되었습니다. 콘솔에서 새로 만드는 모든 커넥터는 업그레이드된 아키텍처를 사용합니다. 를 API 사용하는 경우 이제 TemplateConfiguration개체 대신 개체를 사용하여 커넥터를 구성해야 합니다. GitHubConfiguration

이전 콘솔과 API 아키텍처를 사용하여 구성한 커넥터는 구성된 대로 계속 작동합니다. 하지만 편집하거나 업데이트할 수는 없습니다. 커넥터 구성을 편집하거나 업데이트하려면 새 커넥터를 만들어야 합니다.

커넥터 워크플로를 업그레이드된 버전으로 마이그레이션하는 것이 좋습니다. 이전 아키텍처를 사용하여 구성된 커넥터에 대한 지원은 2024년 6월에 종료될 예정입니다.

Amazon Kendra 콘솔과 Amazon Kendra 를 사용하여 GitHub 데이터 원본에 연결할 수 있습니다. TemplateConfigurationAPI

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참조하십시오사전 조건.

Console

Amazon Kendra 연결하려면 GitHub

  1. 에 AWS Management Console 로그인하고 Amazon Kendra 콘솔을 엽니다.

  2. 왼쪽 탐색 창에서 인덱스를 선택한 다음 인덱스 목록에서 사용할 인덱스를 선택합니다.

    참고

    인덱스 설정에서 사용자 액세스 제어 설정을 구성하거나 편집할 수 있습니다.

  3. 시작하기 페이지에서 데이터 소스 추가를 선택합니다.

  4. 데이터 원본 추가 페이지에서 커넥터를 선택한 다음 GitHub 커넥터 추가를 선택합니다. 버전 2 (해당하는 경우) 를 사용하는 경우 “V2.0" 태그가 있는 GitHub 커넥터를 선택하십시오.

  5. 데이터 소스 세부 정보 지정 페이지에서 다음 정보를 입력합니다.

    1. 이름 및 설명에서 데이터 소스 이름에 데이터 소스의 이름을 입력합니다. 하이픈은 포함할 수 있지만 공백은 포함할 수 없습니다.

    2. (선택 사항) 설명 - 데이터 소스에 대한 선택적 설명을 입력합니다.

    3. 기본 언어 - 문서를 필터링하여 색인에 사용할 언어를 선택합니다. 달리 지정하지 않는 한, 언어는 영어로 기본 설정됩니다. 문서 메타데이터에 지정된 언어가 선택한 언어보다 우선합니다.

    4. 태그의 새 태그 추가 - 리소스를 검색 및 필터링하거나 비용을 추적할 수 있는 선택적 태그를 포함합니다. AWS

    5. Next(다음)를 선택합니다.

  6. 액세스 및 보안 정의 페이지에서 다음 정보를 입력합니다.

    1. GitHub출처 GitHub —엔터프라이즈 클라우드와 GitHub엔터프라이즈 서버 중에서 선택하세요.

    2. GitHub 호스트 URL —예를 들어 URL GitHub 클라우드용 호스트는 다음과 같을 수 있습니다.https://api.github.com GitHub 서버의 호스트는 다음과 URL 같을 수 있습니다.https://on-prem-host-url/api/v3/.

    3. GitHub 조직 이름 - GitHub 조직 이름을 입력합니다. GitHub 계정에서 조직 정보를 찾을 수 있습니다.

      참고

      GitHub 커넥터는 데이터 원본 커넥터 인스턴스당 단일 조직 크롤링을 지원합니다.

    4. 권한 부여 - 문서에 대한 액세스 제어 목록 (ACL) 정보가 있고 액세스 제어에 사용하려는 경우 해당 정보를 켜거나 끕니다. ACL 는 사용자와 그룹이 액세스할 수 있는 문서를 ACL 지정합니다. 이 ACL 정보는 문서에 대한 사용자 또는 그룹의 액세스 권한을 기준으로 검색 결과를 필터링하는 데 사용됩니다. 자세한 내용은 사용자 컨텍스트 필터링을 참조하세요.

    5. AWS Secrets Manager 비밀 - 기존 암호를 선택하거나 새 Secrets Manager 암호를 만들어 GitHub 인증 자격 증명을 저장합니다. 새 암호를 만들기로 선택하면 AWS Secrets Manager 보안 암호 창이 열립니다.

      1. AWS Secrets Manager 보안 암호 생성 창에 다음 정보를 입력합니다.

        1. 보안 암호 이름 - 보안 암호의 이름. 암호 이름에 접두사 AmazonKendra '- GitHub -'가 자동으로 추가됩니다.

        2. GitHub토큰의 경우 - 에 구성된 인증 자격 증명 값을 입력합니다. GitHub

      2. 암호를 저장하고 추가합니다.

    6. 가상 사설 클라우드 (VPC) - 사용을 선택할 수 있습니다. VPC 그렇다면 서브넷과 VPC 보안 그룹을 추가해야 합니다.

    7. 아이덴티티 크롤러 - 아이덴티티 크롤러를 활성화할지 여부를 지정합니다. Amazon Kendra ID 크롤러는 문서에 대한 액세스 제어 목록 (ACL) 정보를 사용하여 문서에 대한 사용자 또는 그룹의 액세스 권한을 기준으로 검색 결과를 필터링합니다. 문서에 해당 문서를 사용하기로 선택한 경우 ID 크롤러를 Amazon Kendra켜서 검색 결과에 ACL 대한 사용자 컨텍스트 필터링을 구성할 수도 있습니다. ACL 그렇지 않으면 ID 크롤러를 끄면 모든 문서를 공개적으로 검색할 수 있습니다. 문서에 대한 액세스 제어를 사용하고 싶은데 ID 크롤러가 꺼져 있는 경우 를 사용하여 사용자 컨텍스트 필터링을 위한 사용자 및 그룹 액세스 정보를 PutPrincipalMappingAPI업로드할 수도 있습니다.

    8. IAM 역할 - 기존 역할을 선택하거나 새 IAM IAM 역할을 생성하여 리포지토리 자격 증명에 액세스하고 콘텐츠를 인덱싱합니다.

      참고

      IAM 색인에 사용되는 역할은 데이터 원본에 사용할 수 없습니다. 기존 역할을 인덱스에 사용하는지 확실하지 않은 경우 새 역할 생성을 선택하여 오류를 방지하십시오. FAQ

    9. Next(다음)를 선택합니다.

  7. 동기화 설정 구성 페이지에 다음 정보를 입력합니다.

    1. 리포지토리 선택 —모든 리포지토리를 크롤링하도록 선택하거나 선택합니다.

      선택한 리포지토리를 크롤링하기로 선택한 경우 리포지토리의 이름을 추가하고 선택적으로 특정 분기의 이름을 추가합니다.

    2. 콘텐츠 유형 - 파일, 이슈, 풀 리퀘스트 등에서 크롤링하려는 콘텐츠 유형을 선택합니다.

    3. 정규식 패턴 - 특정 페이지 및 자산을 포함하거나 제외하기 위한 정규 표현식 패턴을 추가합니다.

    4. 동기화 모드 - 데이터 소스 콘텐츠가 변경될 때 인덱스를 업데이트하는 방법을 선택합니다. 데이터 원본을 처음으로 동기화하는 경우 Amazon Kendra 기본적으로 모든 콘텐츠가 크롤링되고 색인됩니다. 동기화 모드 옵션으로 전체 동기화를 선택하지 않더라도 초기 동기화에 실패한 경우 데이터의 전체 동기화를 실행해야 합니다.

      • 전체 동기화: 모든 콘텐츠를 새로 인덱싱하여 데이터 소스가 색인과 동기화될 때마다 기존 콘텐츠를 대체합니다.

      • 신규, 수정된 동기화: 데이터 소스가 색인과 동기화될 때마다 새 콘텐츠와 수정된 콘텐츠만 인덱싱합니다. Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

      • 새 콘텐츠, 수정된 콘텐츠, 삭제된 동기화: 데이터 원본이 색인과 동기화될 때마다 새 콘텐츠, 수정된 콘텐츠, 삭제된 콘텐츠만 색인화합니다. Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

    5. 빈도에 대한 동기화 실행 일정 —데이터 원본 콘텐츠를 동기화하고 색인을 업데이트하는 빈도를 선택합니다.

    6. Next(다음)를 선택합니다.

  8. 필드 매핑 설정 페이지에 다음 정보를 입력합니다.

    1. 기본 데이터 원본 필드 - Amazon Kendra 생성된 기본 데이터 원본 필드 중에서 색인에 매핑하려는 필드를 선택합니다.

    2. 필드 추가 - 사용자 지정 데이터 소스 필드를 추가하려면 매핑할 인덱스 필드 이름과 필드 데이터 유형을 만듭니다.

    3. Next(다음)를 선택합니다.

  9. 검토 및 생성 페이지에서 입력한 정보가 정확한지 확인한 다음 데이터 소스 추가를 선택합니다. 이 페이지에서 정보를 편집하도록 선택할 수도 있습니다. 데이터 소스가 성공적으로 추가된 후 데이터 소스 페이지에 데이터 소스가 표시됩니다.

API

Amazon Kendra 연결하려면 GitHub

를 사용하여 데이터 소스 스키마를 지정해야 합니다 TemplateConfigurationAPI. JSON 다음 정보를 제공해야 합니다.

  • 데이터 원본 - TemplateConfigurationJSON스키마를 사용할 GITHUB 때와 같이 데이터 원본 유형을 지정합니다. 또한 를 TEMPLATE 호출할 때와 같이 데이터 원본을 지정하십시오. CreateDataSourceAPI

  • GitHub유형 —유형을 SAAS 또는 ON_PREMISE 로 지정합니다.

  • 호스트 URL - GitHub 호스트 URL 또는 API 엔드포인트를 지정합니다. URL 예를 들어 GitHub SaaS/엔터프라이즈 클라우드를 사용하는 경우 호스트는 다음과 같을 URL 수 있고https://api.github.com, GitHub 온프레미스/엔터프라이즈 서버의 경우 호스트가 다음과 같을 수 있습니다. URL https://on-prem-host-url/api/v3/

  • 조직 이름 - 계정의 조직 이름을 지정합니다. GitHub GitHub 데스크톱에 로그인하고 프로필 사진 드롭다운에서 내 조직을 선택하면 조직 이름을 찾을 수 있습니다.

  • 동기화 모드 - 데이터 원본 콘텐츠가 변경될 때 색인을 업데이트하는 방법을 Amazon Kendra 지정합니다. 데이터 원본을 처음으로 동기화하는 경우 기본적으로 모든 콘텐츠가 크롤링되고 색인됩니다. Amazon Kendra 동기화 모드 옵션으로 전체 동기화를 선택하지 않더라도 초기 동기화에 실패한 경우 데이터의 전체 동기화를 실행해야 합니다. 다음 중에서 선택할 수 있습니다.

    • FORCED_FULL_CRAWL모든 콘텐츠를 새로 인덱싱하려면 데이터 원본이 색인과 동기화될 때마다 기존 콘텐츠를 교체해야 합니다.

    • FULL_CRAWL데이터 원본이 색인과 동기화될 때마다 새 콘텐츠, 수정된 콘텐츠, 삭제된 콘텐츠만 색인화하도록 합니다. Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

    • CHANGE_LOG데이터 소스가 색인과 동기화될 때마다 새 콘텐츠와 수정된 콘텐츠만 인덱싱합니다. Amazon Kendra 데이터 원본의 메커니즘을 사용하여 콘텐츠 변경 사항을 추적하고 마지막 동기화 이후 변경된 콘텐츠를 인덱싱할 수 있습니다.

  • 아이덴티티 크롤러 - 아이덴티티 크롤러를 활성화할지 여부를 지정합니다. Amazon Kendra ID 크롤러는 문서에 대한 액세스 제어 목록 (ACL) 정보를 사용하여 문서에 대한 사용자 또는 그룹의 액세스 권한을 기준으로 검색 결과를 필터링합니다. 문서에 해당 문서를 사용하기로 선택한 경우 ID 크롤러를 Amazon Kendra켜서 검색 결과에 ACL 대한 사용자 컨텍스트 필터링을 구성할 수도 있습니다. ACL 그렇지 않으면 ID 크롤러를 끄면 모든 문서를 공개적으로 검색할 수 있습니다. 문서에 대한 액세스 제어를 사용하고 싶은데 ID 크롤러가 꺼져 있는 경우 를 사용하여 사용자 컨텍스트 필터링을 위한 사용자 및 그룹 액세스 정보를 PutPrincipalMappingAPI업로드할 수도 있습니다.

  • 비밀 Amazon 리소스 이름 (ARN) - GitHub 계정의 인증 자격 증명이 포함된 Secrets Manager 암호의 Amazon 리소스 이름 (ARN) 을 입력합니다. 암호는 다음 키가 있는 JSON 구조로 저장됩니다.

    { "personalToken": "token" }
  • IAM 역할 - CreateDataSource Secrets Manager 비밀에 액세스할 수 있는 권한을 IAM 역할에 제공하고 GitHub 커넥터 및 Amazon Kendra에 필요한 퍼블릭을 호출하기 APIs 위해 호출할 RoleArn 시기를 지정합니다. 자세한 내용은 GitHub 데이터 원본의IAM 역할을 참조하십시오.

다음 선택적 기능도 추가할 수 있습니다.

  • 가상 사설 클라우드 (VPC) - VpcConfiguration CreateDataSource 호출할 때 지정합니다. 자세한 내용은 구성 Amazon Kendra 사용하려면 Amazon VPC 단원을 참조하십시오.

    참고

    GitHub 서버를 사용하는 경우 a를 사용하여 GitHub 서버에 Amazon VPC 연결해야 합니다.

  • 리포지토리 필터 - 이름 및 브랜치 이름을 기준으로 리포지토리를 필터링합니다.

  • 문서/콘텐츠 유형 - 리포지토리 문서, 이슈, 이슈 코멘트, 코멘트 첨부 파일 발행, 풀 리퀘스트, 풀 리퀘스트 코멘트, 풀 리퀘스트 코멘트 첨부 파일을 크롤링할지 여부를 지정합니다.

  • 포함 및 제외 필터 - 특정 파일 및 폴더를 포함할지 또는 제외할지 여부를 지정합니다.

    참고

    대부분의 데이터 소스는 필터라고 하는 포함 또는 제외 패턴인 정규 표현식 패턴을 사용합니다. 포함 필터를 지정하는 경우 포함 필터와 일치하는 콘텐츠만 인덱싱됩니다. 포함 필터와 일치하지 않는 문서는 인덱싱되지 않습니다. 포함 및 제외 필터를 지정하는 경우 제외 필터와 일치하는 문서는 포함 필터와 일치하더라도 인덱싱되지 않습니다.

  • 액세스 제어 목록 (ACL) - 문서에 대한 ACL 정보가 있고 액세스 제어에 사용하려는 경우 해당 정보를 크롤링할지 여부를 지정합니다. ACL 는 사용자와 그룹이 액세스할 수 있는 문서를 ACL 지정합니다. 이 ACL 정보는 문서에 대한 사용자 또는 그룹의 액세스 권한을 기준으로 검색 결과를 필터링하는 데 사용됩니다. 자세한 내용은 사용자 컨텍스트 필터링을 참조하세요.

  • 필드 매핑 — GitHub 데이터 원본 필드를 인덱스 필드에 매핑하도록 Amazon Kendra 선택합니다. 문서, 커밋, 이슈, 이슈 첨부 파일, 이슈 코멘트, 풀 리퀘스트, 풀 리퀘스트 첨부, 풀 리퀘스트 코멘트 등의 필드를 포함할 수 있습니다. 자세한 내용을 알아보려면 데이터 소스 필드 매핑을 참조하세요.

    참고

    Amazon Kendra에서 문서를 검색하려면 문서 본문 필드 또는 문서에 해당하는 문서 본문이 필요합니다. 데이터 소스의 문서 본문 필드 이름을 인덱스 필드 이름에 매핑해야 합니다. _document_body 다른 모든 필드는 선택 사항입니다.

구성해야 할 기타 중요 JSON 키 목록은 GitHub템플릿 스키마를 참조하십시오.

자세히 알아보기

GitHub 데이터 Amazon Kendra 소스와의 통합에 대해 자세히 알아보려면 다음을 참조하십시오.