Skip to content

Commit

Permalink
(feat) add adapter metadata to source health
Browse files Browse the repository at this point in the history
  • Loading branch information
tphoney committed Oct 7, 2024
1 parent 9822fbf commit 9339be3
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions account.proto
Original file line number Diff line number Diff line change
Expand Up @@ -347,6 +347,8 @@ message SourceHealth {
repeated string availableTypes = 11;
// The scopes that this source can discover
repeated string availableScopes = 12;
// AdapterMetadata is a map of metadata that the source can send to the API
repeated AdapterMetadata adapterMetadata = 13;
}

message ListAllSourcesStatusResponse {
Expand All @@ -373,6 +375,32 @@ message SubmitSourceHeartbeatRequest {
repeated string availableTypes = 8;
// The scopes that this source can discover
repeated string availableScopes = 9;
// AdapterMetadata is a map of metadata that the source can send to the API
repeated AdapterMetadata adapterMetadata = 10;
}

message AdapterMetadata {
string type = 1; // rdap-domain // computer readable
string group = 2; // aws / gcp / azure / k8s // overall source
AdapterCategory category = 3; // compute / storage / network / database / k8s / other
repeated string links = 4; // links to other Source types, eg aws_eks_node_group -> aws_eks_cluster
string name = 5; // RDAP Domain // human readable
string adapterDescription = 6; // full description of this item
string getDescription = 7; // description of the Get method
string listDescription = 8; // description of the List method
string searchDescription = 9; // description of the Search method
string terraformMethod = 10; // eg get
string terraformQueryMap = 11; // eg ap aws_eks_node_group.arn
string terraformScope = 12; // eg ${provider_mapping.cluster_name}.${values.metadata[0].namespace}
}

enum AdapterCategory {
ADAPTER_CATEGORY_UNSPECIFIED = 0;
ADAPTER_CATEGORY_COMPUTE = 1;
ADAPTER_CATEGORY_STORAGE = 2;
ADAPTER_CATEGORY_NETWORK = 3;
ADAPTER_CATEGORY_SECURITY = 4;
ADAPTER_CATEGORY_OTHER = 5;
}

message SubmitSourceHeartbeatResponse {}
Expand Down

0 comments on commit 9339be3

Please sign in to comment.