Skip to content

Commit

Permalink
Remove legacy Archiver and backup api (#605)
Browse files Browse the repository at this point in the history
* Remove legacy Archiver and backup api

* Avoid remote data commit for local index

* Review comments
  • Loading branch information
aprudhomme authored Jan 3, 2024
1 parent 83ee570 commit 8b0e255
Show file tree
Hide file tree
Showing 59 changed files with 2,536 additions and 5,582 deletions.
42 changes: 0 additions & 42 deletions clientlib/src/main/proto/yelp/nrtsearch/luceneserver.proto
Original file line number Diff line number Diff line change
Expand Up @@ -282,21 +282,6 @@ service LuceneServer {

}

/* backs up a resource (index) and it associated metadata e.g. settings, schema to s3 */
rpc backupIndex (BackupIndexRequest) returns (BackupIndexResponse) {
option (google.api.http) = {
post: "/v1/backup_index"
body: "*"
};
}

rpc deleteIndexBackup (DeleteIndexBackupRequest) returns (DeleteIndexBackupResponse) {
option (google.api.http) = {
post: "/v1/delete_index_backup"
body: "*"
};
}

/* Backup warming queries to S3 */
rpc backupWarmingQueries (BackupWarmingQueriesRequest) returns (BackupWarmingQueriesResponse) {
option (google.api.http) = {
Expand Down Expand Up @@ -831,19 +816,6 @@ message GetAllSnapshotGenResponse {
repeated int64 indexGens = 1; // list of snapshotted index gens
}

message BackupIndexRequest {
string indexName = 1; //name of the index to backup
string serviceName = 2; // remote storage namespace qualifier for service
string resourceName = 3; //remote storage namespace qualifier for resource e.g. indexName
bool completeDirectory = 4; // backup complete directory including all current snapshots if true (may backup corrupt segments if backup is created while indexing is happening), otherwise only backup the required segments and segment files
bool stream = 5; // if the built tar should be directly streamed to s3, instead of being written to a file first (experimental)
}

message BackupIndexResponse {
string dataVersionHash = 1; //version identifier for data on s3
string metadataVersionHash = 2; //version identifier for metadata on s3
}

message BackupWarmingQueriesRequest {
string index = 1; // Index whose warming queries to backup
string serviceName = 2; // remote storage namespace qualifier for service
Expand All @@ -854,20 +826,6 @@ message BackupWarmingQueriesRequest {
message BackupWarmingQueriesResponse {
}

message DeleteIndexBackupRequest {
string indexName = 1; //name of the index to backup
string serviceName = 2; // remote storage namespace qualifier for service
string resourceName = 3; //remote storage namespace qualifier for resource e.g. indexName
int32 nDays = 4; //backups older than nDays will be deleted from s3
}

message DeleteIndexBackupResponse {
repeated string deletedResourceDataHashes = 1; // version hashes of deleted backups from {resource}_data folder
repeated string deletedResourceMetadataHashes = 2; // version hashes of deleted metadata of backups from {resource}_metadata folder
repeated string deletedDataVersions = 3; // versions of deleted backup data from _version/{resource}_data folder
repeated string deletedMetadataVersions = 4; // versions of deleted backup data from _version/{resource}_metadata folder
}

message IndicesRequest {
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,4 @@ bucketName: "nrtsearch-bucket"
archiveDirectory: "/user/app/primary_index_archiver"
serviceName: "nrtsearch-service-test"
restoreState: False
restoreFromIncArchiver: "true"
backupWithIncArchiver: "true"
downloadAsStream: "true"
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,4 @@ bucketName: "nrtsearch-bucket"
archiveDirectory: "/user/app/replica_index_archiver"
serviceName: "nrtsearch-service-test"
restoreState: False
restoreFromIncArchiver: "true"
backupWithIncArchiver: "true"
downloadAsStream: "true"
12 changes: 0 additions & 12 deletions docs/server_configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,6 @@ Example server configuration
archiveDirectory: "/user/app/primary_index_archiver"
serviceName: "nrtsearch-service-test"
restoreState: False
restoreFromIncArchiver: "true"
backupWithIncArchiver: "true"
downloadAsStream: "true"
Expand Down Expand Up @@ -101,16 +99,6 @@ Example server configuration
- Enables loading state from external storage on startup
- false

* - restoreFromIncArchiver
- bool
- If enabled, uses the incremental archiver when restoring index data and state
- false

* - backupWithIncArchiver
- bool
- If enabled, uses the incremental archiver for backups
- false

* - deadlineCancellation
- bool
- Enables gRPC deadline based cancellation of requests. A request is cancelled early if it exceeds the deadline. Currently only supported by the search endpoint.
Expand Down
Loading

0 comments on commit 8b0e255

Please sign in to comment.