package telepresence.connector
Get desktop application:
View/edit binary Protocol Buffers messages
service Connector
connector.proto:15The Connector service is responsible for connecting to the traffic manager and manage intercepts. It can only run when a Daemon is running.
rpc Version (, )
connector.proto:17Returns version information from the Connector
rpc RootDaemonVersion (, )
connector.proto:20Returns version information from the Root Daemon
Returns version information from the Traffic Manager
rpc AgentImageFQN (, )
connector.proto:26Returns the fully qualified image name of the traffic-agent that the agent-injector is configured to inject.
rpc GetIntercept (, )
connector.proto:29GetIntercept gets info from intercept name
rpc Connect (, )
connector.proto:37Connects 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.
message
connector.proto:163ConnectRequest contains the information needed to connect ot a cluster.
map<string, string> kube_flags = 1
The kubernetes flags from the telepresence connect command
map<string, string> container_kube_flag_overrides = 9
The kubernetes flags used by a containerized daemon
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
rpc Disconnect (, )
connector.proto:40Disconnects the cluster
rpc GetClusterSubnets (, )
connector.proto:43GetClusterSubnets gets the outbound info that has been set on daemon
message
connector.proto:458ClusterSubnets 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 Status (, )
connector.proto:47Status returns the status of the current connection or DISCONNECTED if no connection has been established.
rpc CanIntercept (, )
connector.proto:50Queries the connector whether it is possible to create the given intercept.
rpc Ingest (, )
connector.proto:53Starts an Ingest session.
message
connector.proto:303optional 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".
rpc GetIngest (, )
connector.proto:56Get info about an ongoing Ingest.
rpc LeaveIngest (, )
connector.proto:59Ends an Ingest session.
rpc CreateIntercept (, )
connector.proto:63Adds an intercept to a workload. Requires having already called Connect.
rpc RemoveIntercept (, )
connector.proto:67Deactivates and removes an existent workload intercept. Requires having already called Connect.
rpc UpdateIntercept (, )
connector.proto:69rpc Uninstall (, )
connector.proto:73Uninstalls traffic-agents from the cluster. Requires having already called Connect.
message
connector.proto:247UninstallRequest.UninstallType uninstall_type = 1
repeated string agents = 2
string namespace = 3
Namespace of agents to remove.
rpc List (, )
connector.proto:77Returns a list of workloads and their current intercept status. Requires having already called Connect.
message
connector.proto:277ListRequest.Filter filter = 1
string namespace = 2
Namespace to list.
rpc WatchWorkloads (, stream )
connector.proto:80Watch all workloads in the mapped namespaces
message
connector.proto:351repeated string namespaces = 1
Namespace to watch.
rpc SetLogLevel (, )
connector.proto:83SetLogLevel will temporarily change the log-level of the traffic-manager, traffic-agent, and user and root daemons.
message
connector.proto:401string 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 Quit (, )
connector.proto:86Quits (terminates) the connector process.
rpc GatherLogs (, )
connector.proto:90GatherLogs will acquire logs for the various Telepresence components in kubernetes (pending the request) and return them to the caller
message
connector.proto:417bool 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:432string 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 AddInterceptor (, )
connector.proto:94AddInterceptor tells the connector that a given process is serving a specific intercept. The connector must kill this process when the intercept ends
rpc RemoveInterceptor (, )
connector.proto:97RemoveInterceptor removes a previously added interceptor
rpc GetNamespaces (, )
connector.proto:100GetNamespaces gets the mapped namespaces with an optional prefix
message
connector.proto:443bool for_client_access = 1
string prefix = 2
message
connector.proto:448repeated string namespaces = 2
GetKnownWorkloadKinds returns the known workload kinds
RemoteMountAvailability checks if remote mounts are possible using the given mount type and returns an error if its not.
rpc GetConfig (, )
connector.proto:110GetConfig returns the current configuration
message
connector.proto:452bytes json = 1
rpc SetDNSExcludes (, )
connector.proto:113SetDNSExcludes sets the excludes field of DNSConfig.
rpc SetDNSMappings (, )
connector.proto:116SetDNSMappings sets the Mappings field of DNSConfig.
rpc GetAgentConfig (, )
connector.proto:119GetAgentConfig returns the agent configuration for a specific workload.
service ManagerProxy
connector.proto:126ManagerProxy is a small subset of the traffic-manager API that the user daemon makes available to the root daemon. This API is intended for the root daemon only and should not be used by other external processes.
rpc Version (, )
connector.proto:128Version returns the version information of the Manager.
rpc GetClientConfig (, )
connector.proto:131GetClientConfig returns the config that connected clients should use for this manager.
rpc EnsureAgent (, )
connector.proto:134EnsureAgent ensures that an agent is injected to the pods of a workload
rpc WatchClusterInfo (, stream )
connector.proto:138WatchClusterInfo returns information needed when establishing connectivity to the cluster.
rpc LookupDNS (, )
connector.proto:142LookupDNS performs a DNS lookup in the cluster. If the caller has intercepts active, the lookup will be performed from the intercepted pods.
rpc Tunnel (stream , stream )
connector.proto:150A 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.
message
connector.proto:186Used as response type in: Connector.Connect, Connector.Status
ConnectInfo.ErrType error = 1
string error_text = 2
only set for some error codes, see above
int32 error_category = 12
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
Used in:
UNSPECIFIED = 0
success
UNAUTHORIZED = 1
not authorized to connect
UNAUTHENTICATED = 5
not logged in
ALREADY_CONNECTED = 2
success
MUST_RESTART = 7
would-be-success, but kubeconfig has changed
DISCONNECTED = 3
failure: Connect has not yet been called (only returned from Status)
CLUSTER_FAILED = 4
failure: error parsing kubeconfig or talking to the cluster; error_text and error_category are set
TRAFFIC_MANAGER_FAILED = 6
failure: error talking to the in-cluster traffic-manager; error_text and error_category are set
DAEMON_FAILED = 8
failure: error talking to the on-laptop root daemon; error_text and error_category are set
message
connector.proto:265Used 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:294Used 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.
message
connector.proto:320Used 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
message
connector.proto:386Used as response type in: Connector.CanIntercept, Connector.CreateIntercept, Connector.RemoveIntercept
optional intercept_info = 1
common.InterceptError error = 2
string error_text = 3
int32 error_category = 7
string service_uid = 5
The service uid associated with the workload intercepted
string workload_kind = 6
The kind of workload in this intercept
message
connector.proto:153Used 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:358WorkloadInfo 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
message
connector.proto:382Used as response type in: Connector.List, Connector.WatchWorkloads
repeated workloads = 1