From eeea1d1ab431b7cc522fdf183e8088e985accac5 Mon Sep 17 00:00:00 2001 From: Paul Gottschling Date: Tue, 9 May 2023 09:25:55 -0400 Subject: [PATCH 1/2] Refresh Kubernetes Access Getting Started diagram Closes #14485 - Use a Mermaid diagram instead of an image (see #25883) - Update terms used in the diagram - Ensure that the name of the Teleport cluster is consistent between the diagram and the body text --- .../kubernetes-access/getting-started.mdx | 22 ++++++++++++++----- 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/docs/pages/kubernetes-access/getting-started.mdx b/docs/pages/kubernetes-access/getting-started.mdx index d4d674ff720df..946ae11ffa596 100644 --- a/docs/pages/kubernetes-access/getting-started.mdx +++ b/docs/pages/kubernetes-access/getting-started.mdx @@ -29,8 +29,8 @@ Standalone Teleport Cluster](./register-clusters/static-kubeconfig.mdx). ## Deployment overview -In this guide, we deploy the Teleport Kubernetes Service, which connects -Kubernetes cluster `cookie` to Teleport cluster `tele.example.com`: +In this guide, we deploy the Teleport Kubernetes Service, which connects a +Kubernetes cluster to a Teleport cluster: @@ -39,9 +39,19 @@ domain name, e.g., `mytenant.teleport.sh`, rather than `teleport.example.com`. -
- ![Kubernetes agent](../../img/k8s/agent.svg) -
+```mermaid +flowchart TB +subgraph priv[Private Network] + telekube[Teleport Kubernetes Service]--> kube[Kubernetes API Server] +end + +subgraph pub[Public Network] + Users-- "kubectl get pods (mTLS)" -->proxy[Teleport Proxy Service\nteleport.example.com] +end + +telekube-- Encrypted Tunnel -->proxy + +``` ## Step 1/3. Get a join token @@ -73,7 +83,7 @@ commands, assigning `PROXY_ADDR` to the address of your Auth Service or Proxy Service. ```code -$ PROXY_ADDR=tele.example.com:443 +$ PROXY_ADDR=teleport.example.com:443 # Install Kubernetes agent. It dials back to the Teleport cluster at $PROXY_ADDR $ CLUSTER=cookie From 2bd9533435106adfacaa1f2330625dc01e0b7f92 Mon Sep 17 00:00:00 2001 From: Alex Fornuto Date: Tue, 16 May 2023 11:05:31 -0500 Subject: [PATCH 2/2] Docs: Apply Styling to Graph (#26154) * apply styling to graph * remove unused image --- docs/img/k8s/agent.svg | 1 - docs/pages/kubernetes-access/getting-started.mdx | 7 ++++--- 2 files changed, 4 insertions(+), 4 deletions(-) delete mode 100644 docs/img/k8s/agent.svg diff --git a/docs/img/k8s/agent.svg b/docs/img/k8s/agent.svg deleted file mode 100644 index c1569fb15296d..0000000000000 --- a/docs/img/k8s/agent.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/pages/kubernetes-access/getting-started.mdx b/docs/pages/kubernetes-access/getting-started.mdx index 946ae11ffa596..f84340e25e32e 100644 --- a/docs/pages/kubernetes-access/getting-started.mdx +++ b/docs/pages/kubernetes-access/getting-started.mdx @@ -42,15 +42,16 @@ domain name, e.g., `mytenant.teleport.sh`, rather than `teleport.example.com`. ```mermaid flowchart TB subgraph priv[Private Network] - telekube[Teleport Kubernetes Service]--> kube[Kubernetes API Server] + ks[Teleport Kubernetes Service]<--> kube[Kubernetes API Server] end -subgraph pub[Public Network] +subgraph pub[ ] Users-- "kubectl get pods (mTLS)" -->proxy[Teleport Proxy Service\nteleport.example.com] end -telekube-- Encrypted Tunnel -->proxy +style pub fill:#0000,stroke:#0000; +ks<-- Encrypted Tunnel -->proxy ``` ## Step 1/3. Get a join token