package telepresence.connector
Get desktop application:
View/edit binary Protocol Buffers messages
service Connector
connector.proto:14The Connector service is responsible for connecting to the traffic manager and manage intercepts. It can only run when a Daemon is running.
rpc AddInterceptor (, )
connector.proto:101AddInterceptor tells the connector that a given process is serving a specific intercept. The connector must kill this process when the intercept ends
rpc AgentImageFQN (, )
connector.proto:25Returns the fully qualified image name of the traffic-agent that the agent-injector is configured to inject.
rpc CanIntercept (, )
connector.proto:55Queries the connector whether it is possible to create the given intercept and returns an error if it's not.
rpc CheckConnect (, )
connector.proto:41Verifies that the request is aligned with the current session without altering any state. Returns an error when the configuration has drifted, and Unavailable when there is no active session.
rpc Connect (, )
connector.proto:36Connects to the cluster and connects the laptop's network (via the daemon process) to the cluster's network. A result code of UNSPECIFIED indicates that the connection was successfully initiated; if already connected, then either ALREADY_CONNECTED or MUST_RESTART is returned, based on whether the current connection is in agreement with the ConnectionRequest.
rpc CreateIntercept (, )
connector.proto:68Adds an intercept to a workload. Requires having already called Connect.
rpc Disconnect (, )
connector.proto:44Disconnects the cluster
rpc GatherLogs (, )
connector.proto:97GatherLogs will acquire logs for the various Telepresence components in kubernetes (pending the request) and return them to the caller
message
connector.proto:382bool traffic_manager = 1
Whether or not logs from the traffic-manager are desired.
bool get_pod_yaml = 2
Whether or not to get the pod yaml deployed to the cluster.
string agents = 3
The traffic-agent(s) logs are desired from. Can be `all`, `False`, or substring to filter based on pod names.
string export_dir = 4
Directory that the logs will be exported to
message
connector.proto:397string error = 1
General error that isn't associated with a pod such as failing to list the pods.
map<string, string> pod_info = 2
pod_info contains one entry per created file name name. The value is either the string "ok" indicating that the file exists, or an error string with info why it could not be created.
rpc GetAgentConfig (, )
connector.proto:126GetAgentConfig returns the agent configuration for a specific workload.
rpc GetClusterSubnets (, )
connector.proto:47GetClusterSubnets gets the outbound info that has been set on daemon
message
connector.proto:423ClusterSubnets are the cluster subnets that the daemon has detected that need to be routed
repeated pod_subnets = 1
pod_subnets are the subnets that pods go into
repeated svc_subnets = 2
svc_subnets are subnets that services go into
rpc GetConfig (, )
connector.proto:117GetConfig returns the current configuration
message
connector.proto:417bytes json = 1
rpc GetIngest (, )
connector.proto:61Get info about an ongoing Ingest.
rpc GetIntercept (, )
connector.proto:28GetIntercept gets info from intercept name
GetKnownWorkloadKinds returns the known workload kinds
rpc GetNamespaces (, )
connector.proto:107GetNamespaces gets the mapped namespaces with an optional prefix
message
connector.proto:408bool for_client_access = 1
string prefix = 2
message
connector.proto:413repeated string namespaces = 2
rpc Ingest (, )
connector.proto:58Starts an Ingest session.
message
connector.proto:270optional identifier = 1
string mount_point = 2
Desired mount point. Can be set to "true" to generated temporary mount point, "false" to prevent that mounting takes place, an explicit path to use for the mount or an empty string in combination with a non-zero local_mount_port.
int32 local_mount_port = 3
Local port where an sftp client can connect when doing docker volume mounts.
repeated string local_ports = 4
Extra ports that will be forwarded from the intercepting client's localhost to the intercepted pod. Each entry is a string containing a port number followed by an optional "/TCP" or "/UDP".
bool node_agent = 5
Serve the ingest through a node-hosted traffic-agent instead of an injected sidecar.
rpc LeaveIngest (, )
connector.proto:64Ends an Ingest session.
rpc List (, )
connector.proto:84Returns a list of workloads and their current intercept status. Requires having already called Connect.
message
connector.proto:241ListRequest.Filter filter = 1
string namespace = 2
Namespace to list.
rpc LookupIP (, )
connector.proto:133LookupIP resolves the given name using the Telepresence DNS server
rpc Quit (, )
connector.proto:93Quits (terminates) the connector process.
RemoteMountAvailability checks if remote mounts are possible using the given mount type and returns an error if its not.
rpc RemoveIntercept (, )
connector.proto:72Deactivates and removes an existent workload intercept. Requires having already called Connect.
rpc RemoveInterceptor (, )
connector.proto:104RemoveInterceptor removes a previously added interceptor
rpc RerouteLocalPort (, )
connector.proto:139RerouteLocalPort reroutes a port on localhost to a netip.AddrPort.
rpc RerouteRemotePort (, )
connector.proto:142RerouteRemotePort makes a netip.AddrPort available on a new port on the same address.
rpc ResolvePort (, )
connector.proto:136ResolvePort resolves an host:port string from into a netip.AddrPort
ResolveSyntheticIP resolves a synthetic IP into a name and optionally the first IP for that name when the daemon performs a DNS lookup.
message
connector.proto:430bytes ip = 1
The synthetic IP to be resolved.
bool name_only = 2
Resolve the IP into a name, but do not make an attempt to resolve the name through DNS.
message
connector.proto:438string name = 1
The name that the synthetic IP resolved to.
bytes resolved_ip = 2
The IP resulting from a DNS lookup using the resolved name.
rpc RevokeIntercept (, )
connector.proto:76Revokes an intercept by intercept ID. This is an administrative operation that requires RBAC permissions to modify the "traffic-manager" configmap.
message
connector.proto:446string intercept_id = 1
The full intercept ID in the format "sessionID:interceptName" This allows revoking intercepts for any client, not just the caller's own intercepts
rpc RootDaemonVersion (, )
connector.proto:19Returns version information from the Root Daemon
rpc SetDNSExcludes (, )
connector.proto:120SetDNSExcludes sets the excludes field of DNSConfig.
rpc SetDNSMappings (, )
connector.proto:123SetDNSMappings sets the Mappings field of DNSConfig.
rpc SetLogLevel (, )
connector.proto:90SetLogLevel will temporarily change the log-level of the traffic-manager, traffic-agent, and user and root daemons.
message
connector.proto:366string log_level = 1
optional duration = 2
The time that this log-level will be in effect before falling back to the configured log-level.
LogLevelRequest.Scope scope = 3
rpc Status (, )
connector.proto:51Status returns the status of the current connection or DISCONNECTED if no connection has been established.
Returns version information from the Traffic Manager
rpc Uninstall (, )
connector.proto:80Uninstalls traffic-agents from the cluster. Requires having already called Connect.
message
connector.proto:211UninstallRequest.UninstallType uninstall_type = 1
repeated string agents = 2
string namespace = 3
Namespace of agents to remove.
rpc Version (, )
connector.proto:16Returns version information from the Connector
rpc WatchWorkloads (, stream )
connector.proto:87Watch all workloads in the mapped namespaces
message
connector.proto:325repeated string namespaces = 1
Namespace to watch.
message
connector.proto:175Used as response type in: Connector.Connect, Connector.Status
string cluster_server = 3
string cluster_context = 4
optional version = 5
string connection_name = 16
The name of the connection
map<string, string> kube_flags = 17
The kubernetes flags from the telepresence connect command when the connection was established
string namespace = 6
the namespace that the connector is connected to.
string manager_install_id = 7
optional intercepts = 8
repeated ingests = 9
optional session_info = 10
optional manager_version = 19
optional daemon_status = 13
string manager_namespace = 14
repeated string mapped_namespaces = 15
repeated subnet_via_workloads = 18
bool initial = 20
Connection was established by the caller's connect call.
message
connector.proto:155ConnectRequest contains the information needed to connect ot a cluster.
Used as request type in: Connector.CheckConnect, Connector.Connect
map<string, string> kube_flags = 1
The kubernetes flags from the telepresence connect command
repeated string mapped_namespaces = 2
string name = 3
bool is_pod_daemon = 4
repeated string also_proxy = 5
protolint:disable:this REPEATED_FIELD_NAMES_PLURALIZED
repeated string never_proxy = 6
protolint:disable:this REPEATED_FIELD_NAMES_PLURALIZED
repeated string allow_conflicting_subnets = 10
repeated subnet_via_workloads = 11
string manager_namespace = 7
map<string, string> environment = 8
optional bytes kubeconfig_data = 12
Kubeconfig YAML, if not to be loaded from file.
string client_id = 13
message
connector.proto:229Used as request type in: Connector.CanIntercept, Connector.CreateIntercept
optional spec = 1
No need to set spec.client; the connector will fill that in for you.
string mount_point = 2
string agent_image = 3
bool is_pod_daemon = 4
bytes extended_info = 5
int32 local_mount_port = 6
bool mount_read_only = 7
message
connector.proto:258Used as request type in: Connector.GetIngest, Connector.LeaveIngest
Used as field type in:
string workload_name = 1
Name of the workload that holds the desire container.
string container_name = 2
The name of the desired container. Must be set when the workload contains more than one container candidate.
string namespace = 3
Namespace containing the workload. Defaults to the connected namespace when empty.
message
connector.proto:291Used as response type in: Connector.GetIngest, Connector.Ingest, Connector.LeaveIngest
Used as field type in: ,
string workload = 1
Name of ingested workload
string workload_kind = 2
string container = 3
Name of ingested container
string mount_point = 4
The directory where the intercept mounts can be found in the agent.
string pod_ip = 5
The IP of the ingested pod.
int32 sftp_port = 6
The port where the SFTP server listens.
int32 ftp_port = 7
The port where the FTP server listens.
map<string, string> environment = 8
The environment of the ingested container
string client_mount_point = 9
The directory where the client mounts the remote mount_point.
map<string, int32> mounts = 10
Map of mount path -> MountPolicy
string namespace = 11
Namespace of the ingested workload.
message
connector.proto:145Used as request type in: Connector.AddInterceptor, Connector.RemoveInterceptor
string intercept_id = 1
The ID of the intercept that is served by this interceptor process
int32 pid = 2
The pid of the interceptor process
string container_name = 3
Name or ID of container, in case the intercept handler runs in Docker
Bitmap filter
Used in:
UNSPECIFIED = 0
INTERCEPTS = 1
REPLACEMENTS = 2
INGESTS = 4
WIRETAPS = 8
INSTALLED_AGENTS = 16
EVERYTHING = 31
Used in:
UNSPECIFIED = 0
LOCAL_ONLY = 1
applies only to the local daemon processes
REMOTE_ONLY = 2
applies only to traffic-manager and traffic-agents
Used in:
UNSPECIFIED = 0
NAMED_AGENTS = 1
Uninstalls an agent from the named workloads
ALL_AGENTS = 2
Uninstalls all agents
message
connector.proto:332WorkloadInfo contains information about a workload https://kubernetes.io/docs/concepts/workloads/
Used in:
string name = 1
Name of workload
string namespace = 2
Namespace of workload
string not_interceptable_reason = 3
Reason why workload cannot be intercepted, or empty if it can.
repeated intercept_info = 4
InterceptInfo reported from the traffic manager in case the workload is currently intercepted
repeated ingest_info = 5
IngestInfo reported from the traffic manager in case the workload is currently intercepted
string workload_resource_type = 6
Workload Resource type (e.g. Deployment, ReplicaSet, StatefulSet, Rollout)
string uid = 7
string agent_version = 8
int32 desired_replicas = 9
int32 ready_replicas = 10
repeated services = 11
message
connector.proto:362Used as response type in: Connector.List, Connector.WatchWorkloads
repeated workloads = 1