package telepresence.manager
Get desktop application:
View/edit binary Protocol Buffers messages
service Manager
manager.proto:740rpc Version (, )
manager.proto:742Version returns the version information of the Manager.
rpc GetAgentImageFQN (, )
manager.proto:745GetAgentImageFQN returns fully qualified name of the image that is injected into intercepted pods.
rpc GetAgentConfig (, )
manager.proto:748GetAgentConfig returns the agent configuration for a specific workload.
rpc GetLicense (, )
manager.proto:752GetLicense returns the License information (the license itself and domain that granted it) known to the manager.
message
manager.proto:468All of a license's fields come from the license secret
string license = 1
string host = 2
string cluster_id = 3
cluster_id is really the id of the namespace where the traffic-manager is installed.
string err_msg = 4
bool valid = 5
CanConnectAmbassadorCloud returns whether or not the cluster is able to talk to Ambassador Cloud
message
manager.proto:488bool can_connect = 1
rpc GetCloudConfig (, )
manager.proto:760GetCloudConfig returns the config (host + port) for Ambassador Cloud for use by the agents.
message
manager.proto:481The host and port used to connect to Ambassador Cloud. Used by the agents to communicate over gRPC to have Ambassador Cloud review intercepts
string host = 1
string port = 2
optional bytes proxy_ca = 3
rpc GetClientConfig (, )
manager.proto:763GetClientConfig returns the config that connected clients should use for this manager.
rpc GetTelepresenceAPI (, )
manager.proto:766GetTelepresenceAPI returns information about the TelepresenceAPI server
message
manager.proto:455int32 port = 1
The port that the TelepresenceAPI is using, or 0 if it's not enabled
rpc ArriveAsClient (, )
manager.proto:769ArriveAsClient establishes a session between a client and the Manager.
message
manager.proto:17ClientInfo is the self-reported metadata that the on-laptop Telepresence client reports whenever it connects to the in-cluster Manager.
string name = 1
user@hostname
string namespace = 6
namespace that the client is connected to
string install_id = 2
string product = 3
"telepresence"
string version = 4
string api_key = 5
rpc ArriveAsAgent (, )
manager.proto:772ArriveAsAgent establishes a session between an agent and the Manager.
rpc Remain (, )
manager.proto:776Remain indicates that the session is still valid, and potentially updates the auth token for the session.
message
manager.proto:413optional session = 1
string api_key = 2
rpc Depart (, )
manager.proto:779Depart terminates a session.
rpc SetLogLevel (, )
manager.proto:783SetLogLevel will temporarily set the log-level for the traffic-manager and all traffic-agents for a duration that is determined b the request.
rpc GetLogs (, )
manager.proto:788GetLogs will acquire logs for the various Telepresence components in kubernetes (pending the request) and return them to the caller Deprecated: Will return an empty response
message
manager.proto:427Deprecated.
bool traffic_manager = 1
Whether or not logs from the traffic-manager are desired.
string agents = 2
The traffic-agent(s) logs are desired from. Can be `all`, `False`, or substring to filter based on pod names.
bool get_pod_yaml = 3
Whether or not to get the pod yaml deployed to the cluster.
message
manager.proto:440Deprecated.
map<string, string> pod_logs = 1
The map contains assocations between <podName.namespace> and the logs from that pod.
string err_msg = 2
Errors encountered when getting logs from the traffic-manager and/or traffic-agents.
map<string, string> pod_yaml = 3
The map contains assocations between <podName.namespace> and the pod's yaml.
rpc WatchAgentPods (, stream )
manager.proto:793WatchAgentPods notifies a client of the set of known Agents from the client connections namespace that the client can connect to when port-forwards are allowed.
message
manager.proto:613repeated agents = 1
rpc WatchAgents (, stream )
manager.proto:799WatchAgents notifies a client of the set of known Agents. A session ID is required; if no session ID is given then the call returns immediately, having not delivered any snapshots.
rpc WatchAgentsNS (, stream )
manager.proto:802WatchAgentsNS is like WatchAgents but limited to a set of namespaces
message
manager.proto:321optional session = 1
repeated string namespaces = 2
rpc WatchIntercepts (, stream )
manager.proto:810WatchIntercepts notifies a client or agent of the set of intercepts relevant to that client or agent. If a session ID is given, then only intercepts associated with that session are watched. If no session ID is given, then all intercepts are watched.
rpc WatchWorkloads (, stream )
manager.proto:814WatchWorkloads notifies a client of the set of Workloads from the client connection's namespace.
message
manager.proto:717optional session_info = 1
The session_info identifies the client connection, and hence the namespace for the resulting watcher.
optional since = 2
The timestamp from which the first delta should be computed. Set to undefined to get a delta that contains everything.
string namespace = 3
The namespace to watch. Must be one of the namespaces that are managed by the traffic-manager. Defaults to the connected namespace.
message
manager.proto:709WorkloadEventDelta contains the changes made to the subscribed namespace since the time given in the timestamp. A watcher can rely on that received deltas are consecutive.
optional since = 1
The timestamp from which this delta is computed. Typically equal to the time when the previous delta was sent.
repeated events = 2
rpc WatchClusterInfo (, stream )
manager.proto:818WatchClusterInfo returns information needed when establishing connectivity to the cluster.
rpc EnsureAgent (, )
manager.proto:822EnsureAgent ensures that an agent is injected to the pods of a workload and returns the agents, sorted by pod name.
rpc PrepareIntercept (, )
manager.proto:826Request that the traffic-manager makes the preparations necessary to create the given intercept.
message
manager.proto:345string error = 1
int32 error_category = 2
string namespace = 3
string service_uid = 4
string service_name = 5
string service_port_name = 6
int32 service_port = 7
string workload_kind = 8
string agent_image = 9
string protocol = 10
TCP or UDP
string container_name = 11
int32 container_port = 12
repeated string pod_ports = 13
rpc CreateIntercept (, )
manager.proto:833CreateIntercept lets a client create an intercept. It will be created in the "WATING" disposition, and it will remain in that state until the Agent (the app-sidecar) calls ReviewIntercept() to transition it to the "ACTIVE" disposition (or one of the error dispositions).
rpc RemoveIntercept (, )
manager.proto:836RemoveIntercept lets a client remove an intercept.
rpc UpdateIntercept (, )
manager.proto:838rpc GetIntercept (, )
manager.proto:841GetIntercept gets info from intercept name
rpc ReviewIntercept (, )
manager.proto:846ReviewIntercept lets an agent approve or reject an intercept by changing the disposition from "WATING" to "ACTIVE" or to an error, and setting a human-readable status message.
message
manager.proto:382optional session = 1
string id = 2
InterceptDispositionType disposition = 3
string message = 4
string pod_ip = 5
pod IP and sftp port to use when doing sshfs mounts
int32 sftp_port = 6
int32 ftp_port = 12
string mount_point = 10
The directory where the intercept mounts can be found in the agent
string mechanism_args_desc = 7
A human-friendly description of what the InterceptSpec.mechanism_args say.
map<string, string> headers = 8
Headers used by the workstation API-server
map<string, string> metadata = 9
Metadata used by the workstation API-server
map<string, string> environment = 11
The environment of the intercepted container
map<string, int32> mounts = 13
Map of mount path -> MountPolicy of the engaged container
GetKnownWorkloadKinds returns the known workload kinds that the manager can handle. This set may include Deployment, StatefulSet, ReplicaSet, Rollout (Argo Rollouts) as configured in the manager's Helm values.
rpc LookupDNS (, )
manager.proto:855LookupDNS performs a DNS lookup in the cluster. If the caller has intercepts active, the lookup will be performed from the intercepted pods.
AgentLookupHostResponse lets an agent respond for lookup requests
message
manager.proto:520optional session = 1
Agent session
optional request = 2
DNSRequest is the request that this is a response to
optional response = 3
The response, which might be nil in case no address was found
rpc WatchLookupDNS (, stream )
manager.proto:861WatchLookupHost lets an agent receive lookup requests
rpc WatchLogLevel (, stream )
manager.proto:864WatchLogLevel lets an agent receive log-level updates
rpc Tunnel (stream , stream )
manager.proto:872A Tunnel represents one single connection where the client or traffic-agent represents one end (the client-side) and the traffic-manager represents the other (the server side). The first message that a client sends when the tunnel is established is will always contain the session ID, connection ID, and timeouts used by the dialer endpoints.
rpc ReportMetrics (, )
manager.proto:876ReportMetrics is used by a traffic-agent to report metrics for streams established when clients connect directly to traffic-agents using port-forward.
message
manager.proto:626string client_session_id = 1
uint64 ingress_bytes = 2
Number of bytes sent from the client to the traffic-agent.
uint64 egress_bytes = 3
Number of bytes sent from traffic-agent to the client.
rpc WatchDial (, stream )
manager.proto:886WatchDial makes it possible for the client side to receive DialRequests from the traffic-manager. Requests are sent when an intercepted traffic-agent creates a Tunnel that needs to be extended to the Telepresence client on the workstation, or the other way around, when that client creates a tunnel that needs to be extended to an intercepted traffic agent. The receiver of the request dials a connection and responds with a Tunnel. The manager then connects the two tunnels.
rpc UninstallAgents (, )
manager.proto:890UninstallAgents will uninstall the traffic-agent from the given workloads (or all workloads if the list is empty).
message
manager.proto:731optional session_info = 1
The session_info identifies the client connection, and hence the namespace for the resulting watcher.
repeated string agents = 2
The agents to install. Empty means all agents in the connected namespace.
message
manager.proto:617Used as request type in: connector.Connector.GetAgentConfig, Manager.GetAgentConfig
optional session = 1
string name = 2
message
manager.proto:622Used as response type in: connector.Connector.GetAgentConfig, Manager.GetAgentConfig
bytes data = 1
message
manager.proto:599Used as response type in: connector.Connector.AgentImageFQN, Manager.GetAgentImageFQN
string f_q_n = 1
message
manager.proto:28AgentInfo is the self-reported metadata that an Agent (app-sidecar) reports at boot-up when it connects to the Telepresence Manager.
Used as request type in: Manager.ArriveAsAgent
Used as field type in:
string name = 1
name of the Workload
string kind = 13
string namespace = 7
namespace of the Workload
string pod_name = 8
Pod name (from metadata.name)
string pod_ip = 2
Pod IP (from status.podIP)
string pod_uid = 14
Pod UID
int32 api_port = 9
Port number for the agent gRPC API
int32 sftp_port = 10
Port number for the agent SFTP server
int32 ftp_port = 11
Port number for the agent FTP server
string product = 3
distinguish open source, our closed source, someone else's thing
string version = 4
repeated mechanisms = 5
This is a list of the mechanisms that the Agent advertises that it supports.
map<string, > containers = 12
message
manager.proto:62Used in:
map<string, string> environment = 1
The container environment
string mount_point = 4
The directory where the intercept mounts can be found in the agent
map<string, int32> mounts = 13
Map of mount -> MountPolicy
message
manager.proto:52"Mechanisms" are the ways that an Agent can decide handle incoming requests, and decide whether to send them to the in-cluster service, or whether to intercept them. The "tcp" mechanism is the only one in Telepresence open source, and handles things at the TCP-level and either intercepts all TCP streams or doesn't intercept anything. Other Agents than the Telepresence one may implement more mechanisms, such as Ambassador Labs' "Service Preview" Agent which implements the "http" mechanism which handles th "http" mechanism, which handles things at the HTTP-request-level and can decide to intercept individual HTTP requests based on the request headers.
Used in:
string name = 1
"tcp" or "http" or "grpc" or ...
string product = 2
distinguish open source, our closed source, someone else's thing
string version = 3
message
manager.proto:326Used as response type in: connector.ManagerProxy.EnsureAgent, Manager.EnsureAgent, Manager.WatchAgents, Manager.WatchAgentsNS
repeated agents = 1
message
manager.proto:603Used in:
string pod_id = 7
string pod_name = 1
string namespace = 2
bytes pod_ip = 3
int32 api_port = 4
bool intercepted = 5
string workload_name = 6
message
manager.proto:594Used as response type in: connector.ManagerProxy.GetClientConfig, Manager.GetClientConfig
bytes config_yaml = 1
config_yaml is a yaml blob containing the client config.
message
manager.proto:539ClusterInfo contains information that the root daemon needs in order to establish outbound traffic to the cluster.
Used as response type in: connector.ManagerProxy.WatchClusterInfo, Manager.WatchClusterInfo
optional service_subnet = 2
service_subnet is the Kubernetes service subnet
repeated pod_subnets = 3
pod_subnets are the subnets used for Kubenetes pods.
bytes manager_pod_ip = 5
manager_pod_ip is the ip address of the traffic manager
int32 manager_pod_port = 8
manager_pod_port is the port of the traffic manager
bytes injector_svc_ip = 9
injector_svc_ip is the ip address of the traffic manager's agent injector service
int32 injector_svc_port = 10
injector_svc_port is the port of the traffic manager's agent injector service
string injector_svc_host = 11
injector_svc_host is the http host of the traffic manager's agent injector service
optional routing = 6
Router configuration
optional dns = 7
DNS configuration
bytes kube_dns_ip = 1
kube_dns_ip is the IP address of the kube-dns.kube-system service, Deprecated: Use dns.kube_ip
string cluster_domain = 4
cluster_domain is the domain of the cluster, ending with a dot, e.g. "cluster.local." Deprecated: Use dns.cluster_domain
message
manager.proto:334Used as request type in: Manager.CreateIntercept, Manager.PrepareIntercept
optional session = 1
optional intercept_spec = 2
string api_key = 3
message
manager.proto:582Used in:
repeated string include_suffixes = 1
repeated string exclude_suffixes = 2
bytes kube_ip = 3
kube_dns_ip is the IP address of the kube-dns.kube-system service, Deprecated: No longer used by clients >= 2.8.0
string cluster_domain = 4
cluster_domain is the domain of the cluster, ending with a dot, e.g. "cluster.local."
message
manager.proto:505LookupHost request sent from a client
Used as request type in: connector.ManagerProxy.LookupDNS, Manager.LookupDNS
Used as response type in: Manager.WatchLookupDNS
Used as field type in:
optional session = 1
Client session
string name = 2
uint32 type = 3
message
manager.proto:512Used as response type in: connector.ManagerProxy.LookupDNS, Manager.LookupDNS
Used as field type in:
int32 r_code = 1
DNS return code
bytes rrs = 2
rrs is an array of packed RR records
message
manager.proto:497Used as response type in: agent.Agent.WatchDial, Manager.WatchDial
bytes conn_id = 1
int64 roundtrip_latency = 2
int64 dial_timeout = 3
message
manager.proto:340Used as request type in: connector.ManagerProxy.EnsureAgent, Manager.EnsureAgent
optional session = 1
string name = 2
message
manager.proto:377Used as request type in: connector.Connector.GetIntercept, Manager.GetIntercept
optional session = 1
string name = 2
message
manager.proto:532IPNet is a subnet. e.g. 10.43.0.0/16
Used in: , ,
bytes ip = 1
int32 mask = 2
message
manager.proto:232Used in:
string host = 1
The layer-3 host
int32 port = 2
The layer-4 port
bool use_tls = 3
Whether or not to use TLS on the port
string l5host = 4
The layer-5 host
Used in: ,
UNSPECIFIED = 0
ACTIVE = 1
WAITING = 2
REMOVED = 9
NO_CLIENT = 3
What does "NO_CLIENT" mean? The Manager garbage-collects the intercept if the client goes away.
NO_AGENT = 4
NO_AGENT indicates that there are no currently-running agents that can service the intercept, or that there is a inconsistency between the agents that are running. This may be an ephemeral state, such as inconsistency between agents during the middle of a rolling update.
NO_MECHANISM = 5
NO_MECHANISM indicates that the agent(s) that would handle this intercept do not report that they support the mechanism of the intercept. For example, if you are running the OSS agent but ask for an intercept using the "http" mechanism, which requires the Ambassador Telepresence agent.
NO_PORTS = 6
NO_PORT indicates that the manager was unable to allocate a port to act as the rendezvous point between the client and the agent.
AGENT_ERROR = 7
AGENT_ERROR indicates that the intercept was submitted to an agent, but that the agent rejected it (by calling ReviewIntercept).
BAD_ARGS = 8
BAD_ARGS indicates that something about the mechanism_args is invalid.
message
manager.proto:254InterceptInfo contains information about a live intercept in an agent
Used as response type in: connector.Connector.GetIntercept, connector.Connector.UpdateIntercept, Manager.CreateIntercept, Manager.GetIntercept, Manager.UpdateIntercept
Used as field type in: , ,
optional spec = 1
string id = 5
optional client_session = 6
string api_key = 13
api_key is the api_key provided by the user's machine if they are logged in. This is used by extensions to authenticate with external APIs, such as SystemA.
string preview_domain = 7
preview_domain is the SystemA domain that will proxy in traffic to this intercept, and preview_ingress is where it will get proxied to. They both get set by the manager when the client makes a call to UpdateIntercept with add_preview_domain set.
optional preview_spec = 9
InterceptDispositionType disposition = 3
The current intercept state; a status code and a human-friendly message to go along with the status code. These may be set manager itself, or may be set by the agent's call to ReviewIntercept.
string message = 4
string pod_name = 19
Name and port to use when establishing port-forward to the pod's gRPC API.
int32 api_port = 20
string pod_ip = 10
int32 sftp_port = 11
int32 ftp_port = 18
string client_mount_point = 2
The directory where the client mounts the remote mount_point. Only set when obtaining InterceptInfo from the user daemon.
string mount_point = 16
The directory where the intercept mounts can be found in the agent
string mechanism_args_desc = 12
A human-friendly description of what the spec.mechanism_args say. This is set by the agent's call to ReviewIntercept.
map<string, string> headers = 14
Headers used by the workstation API-server
map<string, string> metadata = 15
Metadata used by the workstation API-server
map<string, string> environment = 17
The environment of the intercepted app
map<string, int32> mounts = 22
Map of mount path -> MountPolicy
optional modified_at = 21
Timestamp for last modification made by traffic-manager
message
manager.proto:330Used as response type in: Manager.WatchIntercepts
Used as field type in:
repeated intercepts = 1
message
manager.proto:86InterceptSpec contains static information about an intercept. It is shared by all running agent instances.
Used in: , ,
string name = 1
A human-friendly name for this intercept. This is usually the same as the agent name below; the name/namespace of the Workload, but it could be something else. It is invalid for the same client to attempt to create multiple intercepts with the same name.
string client = 2
Same as ClientInfo.Name; "user@hostname".
string agent = 3
Same as AgentInfo.Name of the Workload.
string workload_kind = 13
Kind of the Workload
string namespace = 8
Same as AgentInfo.Namespace of the Workload
string mechanism = 4
How to decide which subset of requests to that agent to intercept.
repeated string mechanism_args = 9
Additional mechanism-specific arguments. This is passed as list of CLI-style --flags. See the documentation for github.com/telepresenceio/telepresence/v2/pkg/client/cli/extensions for more information about writing an extension descriptor file to control what these values are.
string target_host = 6
The host that the target_ports are routed to.
repeated string pod_ports = 5
Ports that will be forwarded from the intercepting pod's IP address to the target_host, using the following syntax: PORT = port-decl ["/" protocol ] port-decl = port-spec [ ":" uint16 ] protocol = "TCP" | "UDP" port-spec = name | uint16 If two numbers are used, they signify source:destination.
repeated string local_ports = 18
Ports that will be forwarded from the intercepting client's localhost to the intercepted pod. Uses the same syntax as target_ports.
string port_identifier = 10
Identifier for the service or container port: either the name or port number optionally followed by a "/TCP" or "/UDP"
string service_port_name = 19
The resolved service port name
int32 service_port = 20
The resolved service port
string service_uid = 12
.uid.metadata of service associated with intercept
string service_name = 14
name of the aforementioned service
string protocol = 21
The resolved protocol used by the container port
TCP or UDP
string container_name = 24
Name of container that provides environment and mounts. This is normally the container that owns the container_port, but in some cases it will differ because the container_port is owned by some kind of routing mechanism (such as nginx).
int32 container_port = 23
The resolved container port that is intercepted.
int32 target_port = 7
The port on the workstation that the intercepted container_port is redirected to.
int64 roundtrip_latency = 16
The delay imposed by a call roundtrip between the traffic-agent and the client on the workstation. This delay is added to the dial_timeout when the workstation performs a dial on behalf of the traffic-agent.
int64 dial_timeout = 17
The dial timeout to use when a dial is made on the intercepting workstation.
repeated int32 extra_ports = 15
Extra ports that will be forwarded from the intercepting client's localhost to the intercepted pod. Deprecated: use local_ports instead
bool replace = 22
Whether to replace the running container.
bool wiretap = 26
place a wiretap on intercepted ports instead of redirecting them
bool no_default_port = 25
Intercept desire no default port.
message
manager.proto:636Used as response type in: connector.Connector.GetKnownWorkloadKinds, Manager.GetKnownWorkloadKinds
repeated WorkloadInfo.Kind kinds = 1
message
manager.proto:418Used as request type in: daemon.Daemon.SetLogLevel, Manager.SetLogLevel
Used as response type in: Manager.WatchLogLevel
string log_level = 1
optional duration = 2
The time that this log-level will be in effect before falling back to the configured log-level.
message
manager.proto:79PortMapping describes a mapping from a port number in the intercepted container to a port on the client for --from-pod and or vice versa when using --to-pod.
int32 from = 1
int32 to = 2
message
manager.proto:246Used in: ,
optional ingress = 1
bool display_banner = 2
string pull_request_url = 3
map<string, string> add_request_headers = 4
message
manager.proto:372Used as request type in: connector.Connector.RemoveIntercept, Manager.RemoveIntercept
optional session = 1
string name = 2
message
manager.proto:576Used in:
repeated also_proxy_subnets = 1
repeated never_proxy_subnets = 2
repeated allow_conflicting_subnets = 3
message
manager.proto:315Used as request type in: agent.Agent.WatchDial, connector.ManagerProxy.WatchClusterInfo, Manager.Depart, Manager.GetKnownWorkloadKinds, Manager.WatchAgentPods, Manager.WatchAgents, Manager.WatchClusterInfo, Manager.WatchDial, Manager.WatchIntercepts, Manager.WatchLookupDNS
Used as response type in: Manager.ArriveAsAgent, Manager.ArriveAsClient
Used as field type in: , , , , , , , , , , , , , , ,
string session_id = 1
string manager_install_id = 2
optional string install_id = 3
message
manager.proto:493TunnelMessage is a message sent over a Tunnel. First byte indicates type of message
Used as request type in: agent.Agent.Tunnel, connector.ManagerProxy.Tunnel, Manager.Tunnel
Used as response type in: agent.Agent.Tunnel, connector.ManagerProxy.Tunnel, Manager.Tunnel
bytes payload = 1
message
manager.proto:362Used as request type in: connector.Connector.UpdateIntercept, Manager.UpdateIntercept
optional session = 1
string name = 2
oneof preview_domain_action
add_preview_domain = 5
bool remove_preview_domain = 4
message
manager.proto:462VersionInfo2 is different than telepresence.common.VersionInfo in that it is limited to just name and version.
Used as response type in: agent.Agent.Version, connector.ManagerProxy.Version, Manager.Version
Used as field type in:
string name = 1
string version = 2
message
manager.proto:696Used in:
WorkloadEvent.Type type = 1
optional workload = 2
Used in:
ADDED_UNSPECIFIED = 0
MODIFIED = 1
DELETED = 2
message
manager.proto:642WorkloadInfo contains information about a workload (typically a Deployment).
Used in:
WorkloadInfo.Kind kind = 1
string name = 2
string namespace = 3
string uid = 7
WorkloadInfo.AgentState agent_state = 4
repeated intercept_clients = 5
WorkloadInfo.State state = 6
Used in:
NO_AGENT_UNSPECIFIED = 0
Workload has never been intercepted, so no agent has been installed.
INSTALLED = 1
An agent has been installed into workload's pods, but it is not currently intercepted.
INTERCEPTED = 2
The workload (or rather its pods) is currently intercepted.
message
manager.proto:680Used in:
string client = 1
name of intercepting client
Used in: ,
UNSPECIFIED = 0
DEPLOYMENT = 1
REPLICASET = 2
STATEFULSET = 3
ROLLOUT = 4
Used in:
UNKNOWN_UNSPECIFIED = 0
The state of this workload is not known.
AVAILABLE = 1
Available means the deployment is available, ie. at least the minimum available replicas required are up and running for at least minReadySeconds.
PROGRESSING = 2
Progressing means the workload is progressing. Progress for a workload is considered when a new replica set is created or adopted, and when new pods scale up or old pods scale down. Progress is not estimated for paused workloads or when progressDeadlineSeconds is not specified.
FAILURE = 3
FAILURE means that one of its pods fails to be created or deleted.