Skip to content
OtterScale

GetAgentManifest

POST
/otterscale.link.v1.LinkService/GetAgentManifest

GetAgentManifest returns a multi-document YAML manifest for installing the otterscale agent on a target Kubernetes cluster. The manifest includes a Namespace, ServiceAccount, ClusterRoleBinding (binding the caller to cluster-admin), and a Deployment running the agent.

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “Header Parameters ”
Connect-Protocol-Version
required
Connect-Protocol-Version

Define the version of the Connect protocol

number
Allowed values: 1
Connect-Timeout-Ms
Connect-Timeout-Ms

Define the timeout, in ms

number

Request Body required

Section titled “Request Body required ”
GetAgentManifestRequest

GetAgentManifestRequest identifies the target cluster for which the agent installation manifest should be generated.

object
cluster
cluster

The cluster name the agent will register under.

string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Success

GetAgentManifestResponse

GetAgentManifestResponse contains the multi-document YAML manifest that can be applied via kubectl to install the agent.

object
manifest
manifest

Multi-document YAML containing Namespace, ServiceAccount, ClusterRoleBinding, and Deployment resources.

string
url
url

URL with an embedded HMAC token that serves the manifest as raw YAML. Users can run kubectl apply -f <url> directly.

string

default

Section titled “default ”

Error

Connect Error
object
code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

string
Allowed values: canceled unknown invalid_argument deadline_exceeded not_found already_exists permission_denied resource_exhausted failed_precondition aborted out_of_range unimplemented internal unavailable data_loss unauthenticated
message

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

string
details

A list of messages that carry the error details. There is no limit on the number of messages.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message, with an additional debug field for ConnectRPC error details.

object
type

A URL that acts as a globally unique identifier for the type of the serialized message. For example: type.googleapis.com/google.rpc.ErrorInfo. This is used to determine the schema of the data in the value field and is the discriminator for the debug field.

string
value

The Protobuf message, serialized as bytes and base64-encoded. The specific message type is identified by the type field.

string format: binary
debug
One of: discriminator: type
Any

Detailed error information.

object
key
additional properties
any
key
additional properties
any
key
additional properties
any