diff --git a/docs/en/guides/How-to-connect-remote-service.md b/docs/en/guides/How-to-connect-remote-service.md new file mode 100644 index 000000000..5edf15e82 --- /dev/null +++ b/docs/en/guides/How-to-connect-remote-service.md @@ -0,0 +1,33 @@ +# Connect to remote service with telepresence + +Telepresence is an open source tool that lets you run a single service locally, while connecting that service to a remote Kubernetes cluster. + +We can use telepresence to help us run kubesphere apiserver locally. + + +## 1. Install telepresence + +You can read the [official installation documentation](https://www.telepresence.io/reference/install.html) to install telepresence. + +## 2. Run telepresence + +Open your command line and run the command `telepresence`, telepresence will help you to enter a bash connected to a remote kubernetes cluster. + +Test telepresence with KubeSphere apigateway: +```bash + +@kubernetes-admin@cluster.local|bash-3.2$ curl http://ks-apigateway.kubesphere-system + +401 Unauthorized +``` + +## 3. Run your module in bash + +Now your module can easily connect to remote services. + +```bash +go run cmd/ks-apiserver/apiserver.go +``` +## 4. Further more + +You can use telepresence to replace services in the cluster for debugging. For more information, please refer to the [official documentation](https://www.telepresence.io/discussion/overview). diff --git a/docs/en/guides/How-to-run-KubeSphere-core.md b/docs/en/guides/How-to-run-KubeSphere-core.md index 30d697d76..9a1c4d309 100644 --- a/docs/en/guides/How-to-run-KubeSphere-core.md +++ b/docs/en/guides/How-to-run-KubeSphere-core.md @@ -33,6 +33,10 @@ During the development of KubeSphere apiserver, you must configure at least the Below is a sample configuration of Kubesphere apiserver: +> Note: In the default configuration, we use kubernetes service name to access the service. +> In a remote cluster, you may need to use external network exposure to connect to the cluster's internal services. +> Or you can refer to the [documentation](How-to-connect-remote-service.md) to use `telepresence` to connect to remote services + ```yaml kubernetes: kubeconfig: "/Users/kubesphere/.kube/config"