{ "componentChunkName": "component---src-templates-issues-tsx", "path": "/issues/551", "result": {"data":{"issuesJson":{"id":"7c0420fa-ddf5-59bb-b98b-b3411e1a17f8","title":"telepresenceio/telepresence: 面向远程 Kubernetes 或 OpenShift 集群的本地开发工具","number":551,"bodyHTML":"

\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Repos	telepresenceio/telepresence
Views	$\"views\"$
Stars	$\"stars\"$
Forks	$\"forks\"$
License	$\"license\"$
UpdatedAt	$\"last-commit\"$
CreatedAt	$\"create-at\"$

\n\n

\n

\n

\n

Telepresence: fast, efficient local development for Kubernetes microservices

\n

\n

$\"Artifact$ $\"Gurubase\"$

\n

Telepresence gives developers infinite scale development environments for Kubernetes.

\n

Key benefits

\n

With Telepresence:

\n

You run your services locally, using your favorite IDE and other tools
Your workstation is connected to the cluster and can access to its services

\n

This gives developers:

\n

A fast local dev loop, with no waiting for a container build / push / deploy
Ability to use their favorite local tools (IDE, debugger, etc.)
Ability to run large-scale applications that can't run locally

\n

Quick Start

\n

A few quick ways to start using Telepresence:

\n

Telepresence Quick Start: Quick Start
Install Telepresence: Install
Contributor's Guide: Guide
Meetings: Check out our community meeting schedule for opportunities to interact with Telepresence developers

\n

Walkthrough

\n

Install something in the cluster that Telepresence can engage with:

\n

Start with an empty cluster:

\n

$ kubectl create deploy hello --image=k8s.gcr.io/echoserver:1.9\ndeployment.apps/hello created\n$ kubectl expose deploy hello --port 80 --target-port 8080\nservice/hello exposed\n$ kubectl get ns,svc,deploy,po\nNAME                        STATUS   AGE\nnamespace/default           Active   4d19h\nnamespace/kube-node-lease   Active   4d19h\nnamespace/kube-public       Active   4d19h\nnamespace/kube-system       Active   4d19h\n\nNAME                 TYPE        CLUSTER-IP      EXTERNAL-IP   PORT(S)   AGE\nservice/hello        ClusterIP   10.98.148.129   <none>        80/TCP    112s\nservice/kubernetes   ClusterIP   10.96.0.1       <none>        443/TCP   4d19h\n\nNAME                    READY   UP-TO-DATE   AVAILABLE   AGE\ndeployment.apps/hello   1/1     1            1           2m47s\n\nNAME                        READY   STATUS    RESTARTS   AGE\npod/hello-87f7f548f-djc8v   1/1     Running   0          1m47s

\n

Check telepresence version

\n

$ telepresence version\nOSS Client : v2.23.0\nRoot Daemon: not running\nUser Daemon: not running

\n

Setup Traffic Manager in the cluster

\n

Install Traffic Manager in your cluster. By default, it will reside in the ambassador namespace:

\n

$ telepresence helm install\n\nTraffic Manager installed successfully

\n

Establish a connection to the cluster (outbound traffic)

\n

Let telepresence connect:

\n

$ telepresence connect\n ✔ Connected to context rancher-desktop, namespace default (https://127.0.0.1:6443)       2.4s

\n

A session is now active and outbound connections will be routed to the cluster. I.e. your laptop is logically \"inside\"
\na namespace in the cluster.

\n

Since telepresence connected to the default namespace, all services in that namespace can now be reached directly
\nby their name. You can of course also use namespaced names, e.g. curl hello.default.

\n

$ curl hello\n\nHostname: hello-87f7f548f-djc8v\n\nPod Information:\n\t-no pod information available-\n\nServer values:\n\tserver_version=nginx: 1.13.3 - lua: 10008\n\nRequest Information:\n\tclient_address=10.1.5.190\n\tmethod=GET\n\treal path=/\n\tquery=\n\trequest_version=1.1\n\trequest_scheme=http\n\trequest_uri=http://hello:8080/\n\nRequest Headers:\n\taccept=*/*\n\thost=hello\n\tuser-agent=curl/8.9.1\n\nRequest Body:\n\t-no body in request-

\n

Intercept the service. I.e. redirect traffic to it to our laptop (inbound traffic)

\n

Add an intercept for the hello deployment on port 9000. Here, we also start a service listening on that port:

\n

$ telepresence intercept hello --port 9000 -- python3 -m http.server 9000\n ✔ Intercepted                                                                              2.1s \nUsing Deployment hello\n   Intercept name    : hello\n   State             : ACTIVE\n   Workload kind     : Deployment\n   Intercepting      : 10.1.5.196 -> 127.0.0.1\n       8080 -> 9000 TCP\n   Volume Mount Point: /tmp/telfs-629530207\nServing HTTP on 0.0.0.0 port 9000 (http://0.0.0.0:9000/) ...

\n

The python -m httpserver is now started on port 9000 and will run until terminated by <ctrl>-C. Access it from a browser using http://hello/ or use curl from another terminal. With curl, it presents a html listing from the directory where the server was started. Something like:

\n

$ curl hello\n<!DOCTYPE HTML>\n<html lang=\"en\">\n<head>\n<meta charset=\"utf-8\">\n<title>Directory listing for /</title>\n</head>\n<body>\n<h1>Directory listing for /</h1>\n<hr>\n<ul>\n<li><a href=\"file1.txt\">file1.txt</a></li>\n<li><a href=\"file2.txt\">file2.txt</a></li>\n</ul>\n<hr>\n</body>\n</html>

\n

Observe that the python service reports that it's being accessed:

\n

127.0.0.1 - - [03/Apr/2025 09:44:57] \"GET / HTTP/1.1\" 200 -\n

\n

Clean-up and close daemon processes

\n

End the service with <ctrl>-C and then try curl hello or http://hello again. The intercept is gone, and the echo service responds as normal.

\n

Now end the session too. Your desktop no longer has access to the cluster internals.

\n

$ telepresence quit\n ✔ Disconnected                                                                           0.1s \n$ curl hello\ncurl: (6) Could not resolve host: hello

\n

The telepresence daemons are still running in the background, which is harmless. You'll need to stop them before you
\nupgrade telepresence. That's done by passing the option -s (stop all local telepresence daemons) to the
\nquit command.

\n

$ telepresence quit -s\n ✔ Quit                                                                                   0.3s

\n

What got installed in the cluster?

\n

Telepresence installs the Traffic Manager in your cluster if it is not already present. This deployment remains unless you uninstall it.

\n

Telepresence injects the Traffic Agent as an additional container into the pods of the workload you intercept, and will optionally install
\nan init-container to route traffic through the agent (the init-container is only injected when the service is headless or uses a numerical
\ntargetPort). The modifications persist unless you uninstall them.

\n

At first glance, we can see that the deployment is installed ...

\n

$ kubectl get svc,deploy,pod\nNAME                 TYPE        CLUSTER-IP      EXTERNAL-IP   PORT(S)   AGE\nservice/hello        ClusterIP   10.102.244.61   <none>        80/TCP    10m\nservice/kubernetes   ClusterIP   10.96.0.1       <none>        443/TCP   4d20h\n\nNAME                    READY   UP-TO-DATE   AVAILABLE   AGE\ndeployment.apps/hello   1/1     1            1           11m\n\nNAME                        READY   STATUS    RESTARTS   AGE\npod/hello-87f7f548f-mdg8d   2/2     Running   0          6m36s

\n

... and that the traffic-manager is installed in the \"ambassador\" namespace.

\n

$ kubectl -n ambassador get svc,deploy,pod\nNAME                      TYPE        CLUSTER-IP      EXTERNAL-IP   PORT(S)    AGE\nservice/agent-injector    ClusterIP   10.107.17.143   <none>        443/TCP    31m\nservice/traffic-manager   ClusterIP   None            <none>        8081/TCP   31m\n\nNAME                              READY   UP-TO-DATE   AVAILABLE   AGE\ndeployment.apps/traffic-manager   1/1     1            1           31m\n\nNAME                                   READY   STATUS    RESTARTS   AGE\npod/traffic-manager-7cc6668576-hmlzz   1/1     Running   0          31m

\n

The traffic-agent is installed too, in the hello pod. Here together with an init-container, because the service is using a numerical
\ntargetPort.

\n

$ kubectl describe pod hello-774455b6f5-6x6vs\nName:             hello-87f7f548f-mdg8d\nNamespace:        default\nPriority:         0\nService Account:  default\nNode:             lima-rancher-desktop/192.168.65.3\nStart Time:       Thu, 03 Apr 2025 09:43:37 +0200\nLabels:           app=hello\n                  pod-template-hash=87f7f548f\n                  telepresence.io/workloadEnabled=true\n                  telepresence.io/workloadKind=Deployment\n                  telepresence.io/workloadName=hello\nAnnotations:      telepresence.io/agent-config:\n                    {\"agentName\":\"hello\",\"namespace\":\"default\",\"logLevel\":\"debug\",\"workloadName\":\"hello\",\"workloadKind\":\"Deployment\",\"managerHost\":\"traffic-ma...\n                  telepresence.io/inject-traffic-agent: enabled\nStatus:           Running\nIP:               10.1.5.196\nIPs:\n  IP:           10.1.5.196\nControlled By:  ReplicaSet/hello-87f7f548f\nInit Containers:\n  tel-agent-init:\n    Container ID:  docker://f3203943fb97414bee8c3ad4b11237895a8165df7aa39a8f88741b4093e491be\n    Image:         local/tel2:2.23.0-alpha.0\n    Image ID:      docker-pullable://tel2@sha256:0f81a553bb223f4cfe97973d585586439451e120eb2ed8e35d0fe9266b22fd6d\n    Port:          <none>\n    Host Port:     <none>\n    Args:\n      agent-init\n    State:          Terminated\n      Reason:       Completed\n      Exit Code:    0\n      Started:      Thu, 03 Apr 2025 09:43:38 +0200\n      Finished:     Thu, 03 Apr 2025 09:43:38 +0200\n    Ready:          True\n    Restart Count:  0\n    Environment:\n      LOG_LEVEL:     debug\n      AGENT_CONFIG:   (v1:metadata.annotations['telepresence.io/agent-config'])\n      POD_IP:         (v1:status.podIP)\n    Mounts:\n      /var/run/secrets/kubernetes.io/serviceaccount from kube-api-access-zgfs5 (ro)\nContainers:\n  echoserver:\n    Container ID:   docker://2ccc7a81bfe7d1f666af7b17c6415631af2f1bfdb6cb147a0ef7a345f528ac49\n    Image:          registry.k8s.io/echoserver:1.9\n    Image ID:       docker-pullable://registry.k8s.io/echoserver@sha256:10f4dbc8eeeb8806d9b3a261b2473b77ca357b290a15d91ce5a0ca5e6164b535\n    Port:           <none>\n    Host Port:      <none>\n    State:          Running\n      Started:      Thu, 03 Apr 2025 09:43:39 +0200\n    Ready:          True\n    Restart Count:  0\n    Environment:    <none>\n    Mounts:\n      /var/run/secrets/kubernetes.io/serviceaccount from kube-api-access-zgfs5 (ro)\n  traffic-agent:\n    Container ID:  docker://b4f2279e58aacdf3426c80381c29f7cc214729a7d44a40acd1a566d778d84cfa\n    Image:         local/tel2:2.23.0-alpha.0\n    Image ID:      docker-pullable://tel2@sha256:0f81a553bb223f4cfe97973d585586439451e120eb2ed8e35d0fe9266b22fd6d\n    Port:          9900/TCP\n    Host Port:     0/TCP\n    Args:\n      agent\n    State:          Running\n      Started:      Thu, 03 Apr 2025 09:43:39 +0200\n    Ready:          True\n    Restart Count:  0\n    Readiness:      exec [/bin/stat /tmp/agent/ready] delay=0s timeout=1s period=10s #success=1 #failure=3\n    Environment:\n      AGENT_CONFIG:         (v1:metadata.annotations['telepresence.io/agent-config'])\n      _TEL_AGENT_POD_IP:    (v1:status.podIP)\n      _TEL_AGENT_POD_UID:   (v1:metadata.uid)\n      _TEL_AGENT_NAME:     hello-87f7f548f-mdg8d (v1:metadata.name)\n    Mounts:\n      /tel_app_exports from export-volume (rw)\n      /tel_app_mounts/echoserver/var/run/secrets/kubernetes.io/serviceaccount from kube-api-access-zgfs5 (ro)\n      /tmp from tel-agent-tmp (rw)\n      /var/run/secrets/kubernetes.io/serviceaccount from kube-api-access-zgfs5 (ro)\nConditions:\n  Type                        Status\n  PodReadyToStartContainers   True \n  Initialized                 True \n  Ready                       True \n  ContainersReady             True \n  PodScheduled                True \nVolumes:\n  kube-api-access-zgfs5:\n    Type:                    Projected (a volume that contains injected data from multiple sources)\n    TokenExpirationSeconds:  3607\n    ConfigMapName:           kube-root-ca.crt\n    ConfigMapOptional:       <nil>\n    DownwardAPI:             true\n  export-volume:\n    Type:       EmptyDir (a temporary directory that shares a pod's lifetime)\n    Medium:     \n    SizeLimit:  <unset>\n  tel-agent-tmp:\n    Type:        EmptyDir (a temporary directory that shares a pod's lifetime)\n    Medium:      \n    SizeLimit:   <unset>\nQoS Class:       BestEffort\nNode-Selectors:  <none>\nTolerations:     node.kubernetes.io/not-ready:NoExecute op=Exists for 300s\n                 node.kubernetes.io/unreachable:NoExecute op=Exists for 300s\nEvents:\n  Type    Reason     Age    From               Message\n  ----    ------     ----   ----               -------\n  Normal  Scheduled  8m     default-scheduler  Successfully assigned default/hello-87f7f548f-mdg8d to lima-rancher-desktop\n  Normal  Pulled     7m59s  kubelet            Container image \"local/tel2:2.23.0-alpha.0\" already present on machine\n  Normal  Created    7m59s  kubelet            Created container: tel-agent-init\n  Normal  Started    7m59s  kubelet            Started container tel-agent-init\n  Normal  Pulled     7m58s  kubelet            Container image \"registry.k8s.io/echoserver:1.9\" already present on machine\n  Normal  Created    7m58s  kubelet            Created container: echoserver\n  Normal  Started    7m58s  kubelet            Started container echoserver\n  Normal  Pulled     7m58s  kubelet            Container image \"local/tel2:2.23.0-alpha.0\" already present on machine\n  Normal  Created    7m58s  kubelet            Created container: traffic-agent\n  Normal  Started    7m58s  kubelet            Started container traffic-agent

\n

Uninstalling

\n

You can uninstall the traffic-agent from specific deployments or from all deployments. Or you can choose to uninstall everything in which
\ncase the traffic-manager and all traffic-agents will be uninstalled.

\n

$ telepresence helm uninstall

\n

will remove everything that was automatically installed by telepresence from the cluster.

\n

$ telepresence uninstall hello

\n

will remove the traffic-agent and the configmap entry.

\n

Troubleshooting

\n

The telepresence background processes daemon and connector both produces log files that can be very helpful when problems are
\nencountered. The files are named daemon.log and connector.log. The location of the logs differ depending on what platform that is used:

\n

macOS ~/Library/Logs/telepresence
Linux ~/.cache/telepresence/logs
Windows \"%USERPROFILE%\\AppData\\Local\\logs\"

\n

How it works

\n

When Telepresence 2 connects to a Kubernetes cluster, it:

\n

Ensures Traffic Manager is installed in the cluster.
Looks for the relevant subnets in the kubernetes cluster.
Creates a Virtual Network Interface (VIF).
Assigns the cluster's subnets to the VIF.
Binds itself to VIF and starts routing traffic to the traffic-manager, or a traffic-agent if one is present.
Starts listening for, and serving DNS requests, by passing a selected portion to the traffic-manager or traffic-agent.

\n

When a locally running application makes a network request to a service in the cluster, Telepresence will resolve the name to an address within the cluster.
\nThe operating system then sees that the TUN device has an address in the same subnet as the address of the outgoing packets and sends them to tel0.
\nTelepresence is on the other side of tel0 and picks up the packets, injecting them into the cluster through a gRPC connection with Traffic Manager.

\n

Troubleshooting

\n

Visit the troubleshooting section in the Telepresence documentation for more advice:
\nTroubleshooting

\n

Or discuss with the community in the CNCF Slack in the #telepresence-oss channel.

","updatedAt":"2025-05-22T01:50:14Z","upvoteCount":null,"author":{"login":"eryajf","avatarUrl":"https://avatars.githubusercontent.com/u/33259379?u=e4a4090a38ac2473aaed4ef9945233636776c6c3&v=4","url":"https://github.com/eryajf"},"category":null,"labels":{"edges":[{"node":{"name":"更多","color":"25B472"}},{"node":{"name":"K8S-Tools","color":"2d411a"}},{"node":{"name":"telepresenceio","color":"0d02a4"}}]},"comments":{"edges":[]}}},"pageContext":{"number":551,"previous":{"title":"influxdata/telegraf: 用于收集、处理、聚合和写入指标、日志和其他任意数据的代理，提供超过 300 个插件的综合套件，涵盖系统监控、云服务和消息传递等广泛功能","number":550},"next":{"title":"grafana/tempo: Grafana Tempo 是一个高容量、最小依赖的分布式跟踪后端。","number":552}}}, "staticQueryHashes": ["151096407","2861350382"]}