package pluginv2

Get desktop application:
View/edit binary Protocol Buffers messages

Admission control is a service based on the kubernetes admission webhook patterns. This service can be used to verify if objects are valid and convert between versions See: https://github.com/kubernetes/kubernetes/blob/v1.30.0/pkg/apis/admission/types.go#L41 And: https://github.com/grafana/grafana-app-sdk/blob/main/resource/admission.go#L14

• rpc ValidateAdmission (AdmissionRequest, ValidationResponse)

  backend.proto:329

  Validate a resource -- the response is a simple yes/no

  message ValidationResponse

  backend.proto:370

  Check if an object can be admitted

  • bool allowed = 1

    Allowed indicates whether or not the admission request was permitted.

  • optional StatusResult result = 2

    Result contains extra details into why an admission request was denied. This field IS NOT consulted in any way if "Allowed" is "true". +optional

  • repeated string warnings = 3

    warnings is a list of warning messages to return to the requesting API client. Warning messages describe a problem the client making the API request should correct or be aware of. Limit warnings to 120 characters if possible. Warnings over 256 characters and large numbers of warnings may be truncated. +optional

• rpc MutateAdmission (AdmissionRequest, MutationResponse)

  backend.proto:332

  Return a modified copy of the request that can be saved or a descriptive error

  message MutationResponse

  backend.proto:388

  Return a mutated copy of the object in a form that can be admitted

  • bool allowed = 1

    Allowed indicates whether or not the admission request was permitted.

  • optional StatusResult result = 2

    Result contains extra details into why an admission request was denied. This field IS NOT consulted in any way if "Allowed" is "true". +optional

  • repeated string warnings = 3

    warnings is a list of warning messages to return to the requesting API client. Warning messages describe a problem the client making the API request should correct or be aware of. Limit warnings to 120 characters if possible. Warnings over 256 characters and large numbers of warnings may be truncated. +optional

  • bytes object_bytes = 4

    Mutated object bytes

• rpc QueryData (QueryDataRequest, QueryDataResponse)

  backend.proto:126

  message QueryDataRequest

  backend.proto:144

  QueryDataRequest

  • optional PluginContext pluginContext = 1

  • map<string, string> headers = 2

    Environment info

  • repeated DataQuery queries = 3

    List of data queries

  message QueryDataResponse

  backend.proto:154

  • map<string, DataResponse> responses = 1

    Map of refId to response

• rpc CheckHealth (CheckHealthRequest, CheckHealthResponse)

  backend.proto:184

  message CheckHealthRequest

  backend.proto:200

  • optional PluginContext pluginContext = 1

  • map<string, string> headers = 2

    Environment info

  message CheckHealthResponse

  backend.proto:207

  • CheckHealthResponse.HealthStatus status = 1

  • string message = 2

  • bytes jsonDetails = 3

• rpc CollectMetrics (CollectMetricsRequest, CollectMetricsResponse)

  backend.proto:185

  message CollectMetricsRequest

  backend.proto:188

  • optional PluginContext pluginContext = 1

  message CollectMetricsResponse

  backend.proto:192

  • optional CollectMetricsResponse.Payload metrics = 1

• rpc CallResource (CallResourceRequest, stream CallResourceResponse)

  backend.proto:94

  message CallResourceRequest

  backend.proto:101

  • optional PluginContext pluginContext = 1

  • string path = 2

  • string method = 3

  • string url = 4

  • map<string, StringList> headers = 5

  • bytes body = 6

  message CallResourceResponse

  backend.proto:110

  • int32 code = 1

    Maps to raw HTTP status codes when passed over HTTP

  • map<string, StringList> headers = 2

    Raw HTTP headers sent to the client

  • bytes body = 3

    Raw HTTP body bytes sent to the client

ResourceConversion is a service that can be used to convert resources between versions See: https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definition-versioning/#webhook-request-and-response

• rpc ConvertObjects (ConversionRequest, ConversionResponse)

  backend.proto:416

  Convert objects to a target version

  message ConversionRequest

  backend.proto:434

  ConversionRequest supports converting objects from one version to another

  • optional PluginContext pluginContext = 1

    NOTE: this may not include app or datasource instance settings depending on the request

  • string uid = 2

    uid is an identifier for the individual request/response. It allows distinguishing instances of requests which are otherwise identical (parallel requests, etc). The UID is meant to track the round trip (request/response) between the Kubernetes API server and the webhook, not the user request. It is suitable for correlating log entries between the webhook and apiserver, for either auditing or debugging.

  • repeated RawObject objects = 3

    Objects to convert +listType=atomic

  • optional GroupVersion target_version = 4

    Target converted version

  message ConversionResponse

  backend.proto:454

  ConversionResponse contains the converted objects

  • string uid = 1

    uid is an identifier for the individual request/response. This should be copied over from the corresponding `request.uid`.

  • optional StatusResult result = 2

    result contains extra details into why an admission request was denied.

  • repeated RawObject objects = 3

    objects is the list of converted version of `request.objects` if the `result` is successful, otherwise empty. +listType=atomic

• rpc SubscribeStream (SubscribeStreamRequest, SubscribeStreamResponse)

  backend.proto:228

  SubscribeStream called when a user tries to subscribe to a plugin/datasource managed channel path – thus plugin can check subscribe permissions and communicate options with Grafana Core. When the first subscriber joins a channel, RunStream will be called.

  message SubscribeStreamRequest

  backend.proto:243

  • optional PluginContext pluginContext = 1

  • string path = 2

    path part of channel.

  • bytes data = 3

    optional raw data. May be used as an extra payload supplied upon subscription. For example, can contain JSON query object.

  • map<string, string> headers = 4

    Environment info

  message SubscribeStreamResponse

  backend.proto:256

  • SubscribeStreamResponse.Status status = 1

    status of subscribe response.

  • bytes data = 2

    JSON-encoded data to return to a client in a successful subscription result. For data frame streams this can be a JSON-encoded frame schema.

• rpc RunStream (RunStreamRequest, stream StreamPacket)

  backend.proto:235

  RunStream will be initiated by Grafana to consume a stream. RunStream will be called once for the first client successfully subscribed to a channel path. When Grafana detects that there are no longer any subscribers inside a channel, the call will be terminated until next active subscriber appears. Call termination can happen with a delay.

  message RunStreamRequest

  backend.proto:301

  • optional PluginContext pluginContext = 1

  • string path = 2

    path part of a channel.

  • bytes data = 3

    optional raw data. May be used as an extra payload supplied upon subscription. For example, can contain JSON query object.

  • map<string, string> headers = 4

    Environment info

  message StreamPacket

  backend.proto:314

  • bytes data = 1

    JSON-encoded data to publish into a channel.

• rpc PublishStream (PublishStreamRequest, PublishStreamResponse)

  backend.proto:240

  PublishStream called when a user tries to publish to a plugin/datasource managed channel path. Here plugin can check publish permissions and modify publication data if required.

  message PublishStreamRequest

  backend.proto:271

  • optional PluginContext pluginContext = 1

  • string path = 2

    path part of a channel.

  • bytes data = 3

    data that user wants to publish into a stream (only JSON-encoded at the moment).

  • map<string, string> headers = 4

    Environment info

  message PublishStreamResponse

  backend.proto:284

  • PublishStreamResponse.Status status = 1

    status of publish response.

  • bytes data = 2

    JSON-encoded data to publish into a channel. This can be unmodified data from a PublishRequest or any modified data. If empty data returned here then Grafana won't publish data to a channel itself but will return a successful result to a client (supposing plugin published data to a channel itself).

AdmissionRequest contains information from a kubernetes Admission request and decoded object(s).

Used as request type in: AdmissionControl.MutateAdmission, AdmissionControl.ValidateAdmission

• optional PluginContext pluginContext = 1

  NOTE: this may not include app or datasource instance settings depending on the request

• AdmissionRequest.Operation operation = 2

  The requested operation

• optional GroupVersionKind kind = 3

  The object kind

• bytes object_bytes = 4

  Object is the object in the request. This includes the full metadata envelope.

• bytes old_object_bytes = 5

  OldObject is the object as it currently exists in storage. This includes the full metadata envelope.

Operation is the type of resource operation being checked for admission control https://github.com/kubernetes/kubernetes/blob/v1.30.0/pkg/apis/admission/types.go#L158

Used in: AdmissionRequest

• CREATE = 0

• UPDATE = 1

• DELETE = 2

Used in: PluginContext

• bytes jsonData = 3

• map<string, string> decryptedSecureJsonData = 4

• int64 lastUpdatedMS = 5

• string apiVersion = 6

  The API version when the settings were saved NOTE: this may be an older version than the current apiVersion

Used in: CheckHealthResponse

• UNKNOWN = 0

• OK = 1

• ERROR = 2

Used in: CollectMetricsResponse

• bytes prometheus = 1

Used in: QueryDataRequest

• string refId = 1

• int64 maxDataPoints = 2

• int64 intervalMS = 3

• optional TimeRange timeRange = 4

• bytes json = 5

• string queryType = 6

Used in: QueryDataResponse

• repeated bytes frames = 1

  Arrow encoded DataFrames Frame has its own meta, warnings, and repeats refId

• string error = 2

  Error message

• bytes jsonMeta = 3

  Currently not used and not exposed in the frontend

• int32 status = 4

  When errors exist or a non 2XX status, clients will be passed a 207 HTTP error code in /ds/query The status codes should match values from standard HTTP status codes If not set explicitly, it will be marshaled to 200 if no error exists, or 500 if one does

• string errorSource = 5

  Error source

Used in: PluginContext

• int64 id = 1

  Deprecatd: Internal ID, do not use this for anythign important

• string name = 2

• string url = 3

• string user = 4

• string database = 5

• bool basicAuthEnabled = 6

• string basicAuthUser = 7

• bytes jsonData = 8

• map<string, string> decryptedSecureJsonData = 9

• int64 lastUpdatedMS = 10

  timestamp when the settings where last changed

• string uid = 11

  Datasoruce unique ID (within an org/stack namespace)

• string apiVersion = 12

  The API version when the settings were saved. NOTE: this may be an older version than the current apiVersion

GroupVersion represents the API group and version of a resource.

Used in: ConversionRequest

• string group = 1

• string version = 2

Identify the Object properties

Used in: AdmissionRequest

• string group = 1

• string version = 2

• string kind = 3

Used in: AdmissionRequest, CallResourceRequest, CheckHealthRequest, CollectMetricsRequest, ConversionRequest, PublishStreamRequest, QueryDataRequest, RunStreamRequest, SubscribeStreamRequest

• int64 orgId = 1

  The Grafana organization id the request originates from.

• string pluginId = 2

  The unique identifier of the plugin the request is targeted for.

• optional User user = 3

  The Grafana user the request originates from. Will not be provided if Grafana backend initiated the request.

• optional AppInstanceSettings appInstanceSettings = 4

  App plugin instance settings is the configured app instance settings. In Grafana an app instance is an enabled app plugin in a Grafana organization. Will only be set if request targeting an app instance.

• optional DataSourceInstanceSettings dataSourceInstanceSettings = 5

  Data source instance settings is the configured data source instance settings. In Grafana a data source instance is a created data source in a Grafana organization. Will only be set if request targeting a data source instance.

• map<string, string> grafanaConfig = 6

  The grafana configuration as a map of key/value pairs.

• string pluginVersion = 7

  The version of the plugin the request is targeted for.

• string userAgent = 8

  The user agent of the Grafana server that initiated the gRPC request.

• string apiVersion = 9

  The API version that initiated a request

Used in: PublishStreamResponse

• OK = 0

• NOT_FOUND = 1

• PERMISSION_DENIED = 2

RawObject contains a resource serialized into a byte array with a content type

Used in: ConversionRequest, ConversionResponse

• bytes raw = 1

  Raw is the serialized object

• string content_type = 2

  ContentType is the media type of the raw object

Status structure is copied from: https://github.com/kubernetes/apimachinery/blob/v0.30.1/pkg/apis/meta/v1/generated.proto#L979

Used in: ConversionResponse, MutationResponse, ValidationResponse

• string status = 1

  Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status +optional

• string message = 2

  A human-readable description of the status of this operation. +optional

• string reason = 3

  A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it. +optional

• int32 code = 4

  Suggested HTTP return code for this status, 0 if not set. +optional

Used in: CallResourceRequest, CallResourceResponse

• repeated string values = 1

Used in: SubscribeStreamResponse

• OK = 0

• NOT_FOUND = 1

• PERMISSION_DENIED = 2

Used in: DataQuery

• int64 fromEpochMS = 1

• int64 toEpochMS = 2

Used in: PluginContext

• string login = 1

• string name = 2

• string email = 3

• string role = 4