Geo sites API

Tier: Premium, Ultimate
Offering: Self-Managed

Geo sites API를 사용하여 Geo site 엔드포인트를 관리합니다.

필수 조건:

  • 관리자여야 합니다.

새 Geo site 생성

새 Geo site를 생성합니다. 

POST /geo_sites

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://primary.example.com/api/v4/geo_sites" \
     --request POST \
     -d "이름=himynameissomething" \
     -d "url=https://another-node.example.com/"
속성 유형 필수여부 설명
primary 부울 아니오 이 사이트를 주 서버로 지정할지 여부를 지정합니다. 기본값은 false입니다.
enabled 부울 아니오 Geo site가 활성화되어 있는지를 나타내는 플래그입니다. 기본값은 true입니다.
name 문자열 예 Geo site의 고유 식별자입니다. gitlab.rb에서geo_node_name이 설정된 경우 이에 일치해야 하며, 그렇지 않으면external_url과 일치해야 합니다.
url 문자열 예 Geo site의 사용자 대상 URL입니다.
internal_url 문자열 아니오 이 보조 사이트가 접촉할 주 사이트에서 정의한 URL입니다. 설정되지 않으면url이 반환됩니다.
files_max_capacity 정수 아니오 이 보조 사이트에 대한 최대 LFS/첨부 파일 backfill의 동시성을 제어합니다. 기본값은 10입니다.
repos_max_capacity 정수 아니오 이 보조 사이트에 대한 리포지터리 backfill의 최대 동시성을 제어합니다. 기본값은 25입니다.
verification_max_capacity 정수 아니오 이 사이트에 대한 리포지터리 확인의 최대 동시성을 제어합니다. 기본값은 100입니다.
container_repositories_max_capacity 정수 아니오 이 사이트에 대한 컨테이너 리포지터리 동기화의 최대 동시성을 제어합니다. 기본값은 10입니다.
sync_object_storage 부울 아니오 보조 Geo site가 Object Storage에 블롭을 복제해야 하는지 여부를 나타내는 플래그입니다. 기본값은 false입니다.
selective_sync_type 문자열 아니오 특정 그룹이나 샤드로만 동기화하도록 제한합니다. 유효한 값: "namespaces", "shards", 또는 null
selective_sync_shards 배열 아니오 selective_sync_type == shards 경우 동기화되는 프로젝트의 리포지터리 스토리지입니다.
selective_sync_namespace_ids 배열 아니오 selective_sync_type == namespaces면 동기화해야 하는 그룹의 ID입니다.
minimum_reverification_interval 정수 아니오 리포지터리 확인의 유효한 간격(일)입니다. 만료되면 다시 확인됩니다. 보조 사이트에서 설정된 경우 이에는 영향을 미치지 않습니다.

예시 응답: 

{
  "id": 3,
  "name": "Test Site 1",
  "url": "https://secondary.example.com/",
  "internal_url": "https://secondary.example.com/",
  "primary": false,
  "enabled": true,
  "current": false,
  "files_max_capacity": 10,
  "repos_max_capacity": 25,
  "verification_max_capacity": 100,
  "container_repositories_max_capacity": 10,
  "selective_sync_type": "namespaces",
  "selective_sync_shards": [],
  "selective_sync_namespace_ids": [1, 25],
  "minimum_reverification_interval": 7,
  "sync_object_storage": false,
  "web_edit_url": "https://primary.example.com/admin/geo/sites/3/edit",
  "web_geo_replication_details_url": "https://secondary.example.com/admin/geo/sites/3/replication/lfs_objects",
  "_links": {
     "self": "https://primary.example.com/api/v4/geo_sites/3",
     "status": "https://primary.example.com/api/v4/geo_sites/3/status",
     "repair": "https://primary.example.com/api/v4/geo_sites/3/repair"
  }
}

모든 Geo site에 대한 구성 검색 

GET /geo_sites

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://primary.example.com/api/v4/geo_sites"

예시 응답: 

[
  {
    "id": 1,
    "name": "us-site",
    "url": "https://primary.example.com/",
    "internal_url": "https://internal.example.com/",
    "primary": true,
    "enabled": true,
    "current": true,
    "files_max_capacity": 10,
    "repos_max_capacity": 25,
    "verification_max_capacity": 100,
    "container_repositories_max_capacity": 10,
    "selective_sync_type": "namespaces",
    "selective_sync_shards": [],
    "selective_sync_namespace_ids": [1, 25],
    "minimum_reverification_interval": 7,
    "web_edit_url": "https://primary.example.com/admin/geo/sites/1/edit",
    "_links": {
      "self": "https://primary.example.com/api/v4/geo_sites/1",
      "status":"https://primary.example.com/api/v4/geo_sites/1/status",
      "repair":"https://primary.example.com/api/v4/geo_sites/1/repair"
    }
  },
  {
    "id": 2,
    "name": "cn-site",
    "url": "https://secondary.example.com/",
    "internal_url": "https://secondary.example.com/",
    "primary": false,
    "enabled": true,
    "current": false,
    "files_max_capacity": 10,
    "repos_max_capacity": 25,
    "verification_max_capacity": 100,
    "container_repositories_max_capacity": 10,
    "selective_sync_type": "namespaces",
    "selective_sync_shards": [],
    "selective_sync_namespace_ids": [1, 25],
    "minimum_reverification_interval": 7,
    "sync_object_storage": true,
    "web_edit_url": "https://primary.example.com/admin/geo/sites/2/edit",
    "web_geo_replication_details_url": "https://secondary.example.com/admin/geo/sites/2/replication/lfs_objects",
    "_links": {
      "self":"https://primary.example.com/api/v4/geo_sites/2",
      "status":"https://primary.example.com/api/v4/geo_sites/2/status",
      "repair":"https://primary.example.com/api/v4/geo_sites/2/repair"
    }
  }
]

특정 Geo site에 대한 구성 검색 

GET /geo_sites/:id

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://primary.example.com/api/v4/geo_sites/1"

예시 응답: 

{
  "id": 1,
  "name": "us-site",
  "url": "https://primary.example.com/",
  "internal_url": "https://primary.example.com/",
  "primary": true,
  "enabled": true,
  "current": true,
  "files_max_capacity": 10,
  "repos_max_capacity": 25,
  "verification_max_capacity": 100,
  "container_repositories_max_capacity": 10,
  "selective_sync_type": "namespaces",
  "selective_sync_shards": [],
  "selective_sync_namespace_ids": [1, 25],
  "minimum_reverification_interval": 7,
  "web_edit_url": "https://primary.example.com/admin/geo/sites/1/edit",
  "_links": {
    "self": "https://primary.example.com/api/v4/geo_sites/1",
    "status":"https://primary.example.com/api/v4/geo_sites/1/status",
    "repair":"https://primary.example.com/api/v4/geo_sites/1/repair"
  }
}

Geo 사이트 편집

기존 Geo 사이트의 설정을 업데이트합니다. 

PUT /geo_sites/:id
속성 유형 필수 설명
id integer 예 Geo 사이트의 ID입니다.
enabled boolean 아니요 Geo 사이트가 활성화되었는지를 나타내는 플래그입니다.
name string 아니요 Geo 사이트의 고유 식별자입니다. gitlab.rb에서 geo_node_name으로 설정된 경우 external_url과 일치해야 하며, 그렇지 않은 경우 external_url과 일치해야 합니다.
url string 아니요 Geo 사이트의 사용자용 URL입니다.
internal_url string 아니요 이 보조 사이트에서 기본 사이트로 연락해야하는 URL입니다. 설정되지 않은 경우 url을 반환합니다.
files_max_capacity integer 아니요 이 보조 사이트의 LFS/첨부 파일 backfill의 최대 동시성을 제어합니다.
repos_max_capacity integer 아니요 이 보조 사이트의 리포지터리 backfill의 최대 동시성을 제어합니다.
verification_max_capacity integer 아니요 이 사이트의 검증의 최대 동시성을 제어합니다.
container_repositories_max_capacity integer 아니요 이 사이트의 컨테이너 리포지터리 동기화의 최대 동시성을 제어합니다.
selective_sync_type string 아니요 특정 그룹이나 샤드에 대해서만 동기화를 제한합니다. 유효한 값: "namespaces", "shards", 또는 null
selective_sync_shards array 아니요 selective_sync_type == shards인 경우 동기화되는 프로젝트의 리포지터리 스토리지입니다.
selective_sync_namespace_ids array 아니요 selective_sync_type == namespaces인 경우 동기화되어야 하는 그룹의 ID입니다.
minimum_reverification_interval integer 아니요 리포지터리 검증이 유효한 간격(일)입니다. 만료되면 재검증됩니다. 이는 보조 사이트에 설정되었을 때는 영향이 없습니다.

예시 응답: 

{
  "id": 1,
  "name": "us-site",
  "url": "https://primary.example.com/",
  "internal_url": "https://internal.example.com/",
  "primary": true,
  "enabled": true,
  "current": true,
  "files_max_capacity": 10,
  "repos_max_capacity": 25,
  "verification_max_capacity": 100,
  "container_repositories_max_capacity": 10,
  "selective_sync_type": "namespaces",
  "selective_sync_shards": [],
  "selective_sync_namespace_ids": [1, 25],
  "minimum_reverification_interval": 7,
  "web_edit_url": "https://primary.example.com/admin/geo/sites/1/edit",
  "_links": {
    "self": "https://primary.example.com/api/v4/geo_sites/1",
    "status": "https://primary.example.com/api/v4/geo_sites/1/status",
    "repair": "https://primary.example.com/api/v4/geo_sites/1/repair"
  }
}

Geo 사이트 삭제

Geo 사이트를 제거합니다. 

DELETE /geo_sites/:id
속성 유형 필수 설명
id integer 예 Geo 사이트의 ID

Geo 사이트 수리

기본 또는 보조 Geo 사이트 간에 OAuth 동기화 문제가 있는 경우 Geo 사이트의 OAuth 인증을 수리합니다. 이 경우 다음 메시지가 표시될 수 있습니다: 

이 Geo 노드에 대해 정의된 OAuth 애플리케이션이 없습니다.

POST /geo_sites/:id/repair

예시 응답: 

{
  "id": 1,
  "name": "us-site",
  "url": "https://primary.example.com/",
  "internal_url": "https://primary.example.com/",
  "primary": true,
  "enabled": true,
  "current": true,
  "files_max_capacity": 10,
  "repos_max_capacity": 25,
  "verification_max_capacity": 100,
  "container_repositories_max_capacity": 10,
  "web_edit_url": "https://primary.example.com/admin/geo/sites/1/edit",
  "_links": {
    "self": "https://primary.example.com/api/v4/geo_sites/1",
    "status":"https://primary.example.com/api/v4/geo_sites/1/status",
    "repair":"https://primary.example.com/api/v4/geo_sites/1/repair"
  }
}

모든 Geo 사이트의 상태 검색 

GET /geo_sites/status

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://primary.example.com/api/v4/geo_sites/status"

예시 응답: 

[ /* (내용이 너무 길어 일부 생략) */ ]

특정 Geo 사이트에 대한 상태 정보 검색 

GET /geo_sites/:id/status

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://primary.example.com/api/v4/geo_sites/2/status"

예시 응답: 

  {
  "geo_node_id": 2,
  "projects_count": 19,
  "container_repositories_replication_enabled": null,
  "lfs_objects_count": 0,
  "lfs_objects_checksum_total_count": null,
  "lfs_objects_checksummed_count": null,
  ...
  (중략)
  ...
  "namespaces": [],
  "updated_at": "2023-05-03T15:19:06.174Z",
  "storage_shards_match": true,
  "_links": {
    "self": "https://primary.example.com/api/v4/geo_sites/2/status",
    "site": "https://primary.example.com/api/v4/geo_sites/2"
  }
}
note
health_status 매개변수는 “Healthy” 또는 “Unhealthy” 상태여야 하며, health 매개변수는 비어 있거나 “Healthy”이거나 실제 오류 메시지를 포함할 수 있습니다.

현재 사이트에서 발생한 프로젝트 동기화 또는 확인 실패 사례 검색

이 기능은 보조 사이트에서만 작동합니다. 

GET /geo_sites/current/failures
속성 유형 필수 설명
type string no 실패한 객체의 유형 (repository/wiki)
failure_type string no 실패 유형 (sync/checksum_mismatch/verification)

이 엔드포인트는 페이지네이션을 사용합니다. 

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://primary.example.com/api/v4/geo_sites/current/failures"

응답 예시: 

[
  {
    "project_id": 3,
    "last_repository_synced_at": "2017-10-31 14:25:55 UTC",
    "last_repository_successful_sync_at": "2017-10-31 14:26:04 UTC",
    "last_wiki_synced_at": "2017-10-31 14:26:04 UTC",
    "last_wiki_successful_sync_at": "2017-10-31 14:26:11 UTC",
    "repository_retry_count": null,
    "wiki_retry_count": 1,
    "last_repository_sync_failure": null,
    "last_wiki_sync_failure": "Wiki 리포지터리 동기화 오류",
    "last_repository_verification_failure": "",
    "last_wiki_verification_failure": "",
    "repository_verification_checksum_sha": "da39a3ee5e6b4b0d32e5bfef9a601890afd80709",
    "wiki_verification_checksum_sha": "da39a3ee5e6b4b0d3255bfef9ef0189aafd80709",
    "repository_checksum_mismatch": false,
    "wiki_checksum_mismatch": false
  }
]