diff --git a/.github/workflows/dependency-review.yml b/.github/workflows/dependency-review.yml index 77374be6f8..f239e2e846 100644 --- a/.github/workflows/dependency-review.yml +++ b/.github/workflows/dependency-review.yml @@ -27,4 +27,4 @@ jobs: - name: "Dependency Review" uses: actions/dependency-review-action@5bbc3ba658137598168acb2ab73b21c432dd411b # v4.2.5 with: - config-file: "nginxinc/k8s-common/dependency-review-config.yml@main" + config-file: "nginx/k8s-common/dependency-review-config.yml@main" diff --git a/docs/proto/proto.md b/docs/proto/proto.md index 2f92aca70d..702dd2518b 100644 --- a/docs/proto/proto.md +++ b/docs/proto/proto.md @@ -18,6 +18,9 @@ - [AgentConnectStatus.StatusCode](#f5-nginx-agent-sdk-AgentConnectStatus-StatusCode) - [AgentLogging.Level](#f5-nginx-agent-sdk-AgentLogging-Level) +- [command_svc.proto](#command_svc-proto) + - [Commander](#f5-nginx-agent-sdk-Commander) + - [command.proto](#command-proto) - [AgentActivityStatus](#f5-nginx-agent-sdk-AgentActivityStatus) - [ChunkedResourceChunk](#f5-nginx-agent-sdk-ChunkedResourceChunk) @@ -39,9 +42,6 @@ - [NginxConfigStatus.Status](#f5-nginx-agent-sdk-NginxConfigStatus-Status) - [UploadStatus.TransferStatus](#f5-nginx-agent-sdk-UploadStatus-TransferStatus) -- [command_svc.proto](#command_svc-proto) - - [Commander](#f5-nginx-agent-sdk-Commander) - - [common.proto](#common-proto) - [CertificateDates](#f5-nginx-agent-sdk-CertificateDates) - [CertificateName](#f5-nginx-agent-sdk-CertificateName) @@ -341,6 +341,34 @@ Log level enum + +
+ +## command_svc.proto + + + + + + + + + + + +### Commander +Represents a service used to sent command messages between the management server and the agent. + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| CommandChannel | [Command](#f5-nginx-agent-sdk-Command) stream | [Command](#f5-nginx-agent-sdk-Command) stream | A Bidirectional streaming RPC established by the agent and is kept open | +| Download | [DownloadRequest](#f5-nginx-agent-sdk-DownloadRequest) | [DataChunk](#f5-nginx-agent-sdk-DataChunk) stream | A streaming RPC established by the agent and is used to download resources associated with commands The download stream will be kept open for the duration of the data transfer and will be closed when its done. The transfer is a stream of chunks as follows: header -> data chunk 1 -> data chunk N. Each data chunk is of a size smaller than the maximum gRPC payload | +| Upload | [DataChunk](#f5-nginx-agent-sdk-DataChunk) stream | [UploadStatus](#f5-nginx-agent-sdk-UploadStatus) | A streaming RPC established by the agent and is used to upload resources associated with commands | + + + + + @@ -652,34 +680,6 @@ Transfer status enum - - - -## command_svc.proto - - - - - - - - - - - -### Commander -Represents a service used to sent command messages between the management server and the agent. - -| Method Name | Request Type | Response Type | Description | -| ----------- | ------------ | ------------- | ------------| -| CommandChannel | [Command](#f5-nginx-agent-sdk-Command) stream | [Command](#f5-nginx-agent-sdk-Command) stream | A Bidirectional streaming RPC established by the agent and is kept open | -| Download | [DownloadRequest](#f5-nginx-agent-sdk-DownloadRequest) | [DataChunk](#f5-nginx-agent-sdk-DataChunk) stream | A streaming RPC established by the agent and is used to download resources associated with commands The download stream will be kept open for the duration of the data transfer and will be closed when its done. The transfer is a stream of chunks as follows: header -> data chunk 1 -> data chunk N. Each data chunk is of a size smaller than the maximum gRPC payload | -| Upload | [DataChunk](#f5-nginx-agent-sdk-DataChunk) stream | [UploadStatus](#f5-nginx-agent-sdk-UploadStatus) | A streaming RPC established by the agent and is used to upload resources associated with commands | - - - - -