Skip to content

Commit

Permalink
(from getambassador.io) Merge pull request #463 from datawire/docs/tp…
Browse files Browse the repository at this point in the history
…_qs_python_fastapi

Change TP quick start titles
  • Loading branch information
mattmcclure-dw authored Feb 24, 2021
2 parents de1fd32 + 456774a commit a69a967
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 12 deletions.
4 changes: 2 additions & 2 deletions quick-start/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import QSCards from './qs-cards'

# Telepresence Quick Start - NodeJS

<Alert severity="info">While Telepresence works with any language, this guide uses a sample app written in Node.js. We have versions in <a href="qs-go/">Go</a>, <a href="qs-python/">Python using Flask</a>, and <a href="qs-python-fastapi/">Python using FastAPI</a> if you prefer.</Alert>
<Alert severity="info">While Telepresence works with any language, this guide uses a sample app written in NodeJS. We have versions in <a href="qs-go/">Go</a>, <a href="qs-python/">Python (Flask)</a>, and <a href="qs-python-fastapi/">Python (FastAPI)</a> if you prefer.</Alert>

## Prerequisites
You’ll need `kubectl` installed and configured to use a Kubernetes cluster, preferably an empty test cluster. You must have RBAC permissions in the cluster to create and update deployments and services.
Expand Down Expand Up @@ -72,7 +72,7 @@ Telepresence connects your local workstation to a remote Kubernetes cluster.

Your local workstation may not have the compute or memory resources necessary to run all the services in a multi-service application. In this example, we’ll show you how Telepresence can give you a fast development loop, even in this situation.

<Alert severity="info">While Telepresence works with any language, this guide uses a sample app written in Node.js. We have versions in <a href="qs-go/">Go</a>, <a href="qs-python/">Python using Flask</a>, and <a href="qs-python-fastapi/">Python using FastAPI</a> if you prefer.</Alert>
<Alert severity="info">While Telepresence works with any language, this guide uses a sample app written in NodeJS. We have versions in <a href="qs-go/">Go</a>, <a href="qs-python/">Python (Flask)</a>, and <a href="qs-python-fastapi/">Python (FastAPI)</a> if you prefer.</Alert>

1. Start by installing a sample application that consists of multiple services:
`kubectl apply -f https://raw.githubusercontent.com/datawire/edgey-corp-nodejs/main/k8s-config/edgey-corp-web-app-no-mapping.yaml`
Expand Down
4 changes: 2 additions & 2 deletions quick-start/qs-go.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import QSCards from './qs-cards'

# Telepresence Quick Start - Go

<Alert severity="info">While Telepresence works with any language, this guide uses a sample app written in Go. We have versions in <a href="../">Node</a>, <a href="../qs-python/">Python using Flask</a>, and <a href="../qs-python-fastapi/">Python using FastAPI</a> if you prefer.</Alert>
<Alert severity="info">While Telepresence works with any language, this guide uses a sample app written in Go. We have versions in <a href="../qs-python/">Python (Flask)</a>, <a href="../qs-python-fastapi/">Python (FastAPI)</a>, and <a href="../">NodeJS</a> if you prefer.</Alert>

## Prerequisites
You’ll need `kubectl` installed and configured to use a Kubernetes cluster, preferably an empty test cluster. You must have RBAC permissions in the cluster to create and update deployments and services.
Expand Down Expand Up @@ -71,7 +71,7 @@ Telepresence connects your local workstation to a remote Kubernetes cluster.

Your local workstation may not have the compute or memory resources necessary to run all the services in a multi-service application. In this example, we’ll show you how Telepresence can give you a fast development loop, even in this situation.

<Alert severity="info">While Telepresence works with any language, this guide uses a sample app written in Go. We have versions in <a href="../">Node</a>, <a href="../qs-python/">Python using Flask</a>, and <a href="../qs-python-fastapi/">Python using FastAPI</a> if you prefer.</Alert>
<Alert severity="info">While Telepresence works with any language, this guide uses a sample app written in Go. We have versions in <a href="../qs-python/">Python (Flask)</a>, <a href="../qs-python-fastapi/">Python (FastAPI)</a>, and <a href="../">NodeJS</a> if you prefer.</Alert>

1. Start by installing a sample application that consists of multiple services:
`kubectl apply -f https://raw.githubusercontent.com/datawire/edgey-corp-go/main/k8s-config/edgey-corp-web-app-no-mapping.yaml`
Expand Down
10 changes: 5 additions & 5 deletions quick-start/qs-python-fastapi.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ import Alert from '@material-ui/lab/Alert';
import QSTabs from './qs-tabs'
import QSCards from './qs-cards'

# Telepresence Quick Start - Python using FastAPI
# Telepresence Quick Start - Python (FastAPI)

<Alert severity="info">While Telepresence works with any language, this guide uses a sample app written in Python using the FastAPI framework. We have versions in <a href="../qs-go/">Go</a>, <a href="../">Node</a>, and <a href="../qs-python/">Python using Flask</a> if you prefer.</Alert>
<Alert severity="info">While Telepresence works with any language, this guide uses a sample app written in Python using the FastAPI framework. We have versions in <a href="../qs-python/">Python (Flask)</a>, <a href="../qs-go/">Go</a>, and <a href="../">NodeJS</a> if you prefer.</Alert>

## Prerequisites
You’ll need `kubectl` installed and configured to use a Kubernetes cluster, preferably an empty test cluster. You must have RBAC permissions in the cluster to create and update deployments and services.
Expand Down Expand Up @@ -53,11 +53,11 @@ Telepresence connects your local workstation to a remote Kubernetes cluster.

<Alert severity="success"><b>Congratulations! You’ve just accessed your remote Kubernetes API server, as if you were on the same network!</b> With Telepresence, you’re able to use any tool that you have locally to connect to any service in the cluster.</Alert>

## 3. Install a sample FastAPI application
## 3. Install a sample Python application

Your local workstation may not have the compute or memory resources necessary to run all the services in a multi-service application. In this example, we’ll show you how Telepresence can give you a fast development loop, even in this situation.

<Alert severity="info">While Telepresence works with any language, this guide uses a sample app written in Python using the FastAPI framework. We have versions in <a href="../qs-go/">Go</a>, <a href="../">Node</a>, and <a href="../qs-python/">Python with Flask</a> if you prefer.</Alert>
<Alert severity="info">While Telepresence works with any language, this guide uses a sample app written in Python using the FastAPI framework. We have versions in <a href="../qs-python/">Python (Flask)</a>, <a href="../qs-go/">Go</a>, and <a href="../">NodeJS</a> if you prefer.</Alert>

1. Start by installing a sample application that consists of multiple services:
`kubectl apply -f https://raw.githubusercontent.com/datawire/edgey-corp-python-fastapi/main/k8s-config/edgey-corp-web-app-no-mapping.yaml`
Expand Down Expand Up @@ -152,7 +152,7 @@ Next, we’ll create an intercept. An intercept is a rule that tells Telepresenc

2. Go to the frontend service again in your browser. Since the service is now intercepted it can be reached directly by its service name at [http://verylargejavaservice:8080](http://verylargejavaservice:8080). You will now see the <span style="color:blue" class="bold">blue</span> elements in the app.

<Alert severity="success"><b>The frontend’s request to DataProcessingService is being intercepted and rerouted to the Python FastAPI server on your laptop!</b></Alert>
<Alert severity="success"><b>The frontend’s request to DataProcessingService is being intercepted and rerouted to the Python server on your laptop!</b></Alert>

## 6. Make a code change
We’ve now set up a local development environment for the DataProcessingService, and we’ve created an intercept that sends traffic in the cluster to our local environment. We can now combine these two concepts to show how we can quickly make and test changes.
Expand Down
6 changes: 3 additions & 3 deletions quick-start/qs-python.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ import Alert from '@material-ui/lab/Alert';
import QSTabs from './qs-tabs'
import QSCards from './qs-cards'

# Telepresence Quick Start - Python using Flask
# Telepresence Quick Start - Python (Flask)

<Alert severity="info">While Telepresence works with any language, this guide uses a sample app written in Python using Flask. We have versions in <a href="../qs-python-fastapi/">Python using FastAPI</a>, <a href="../qs-go/">Go</a>, and <a href="../">Node</a> if you prefer.</Alert>
<Alert severity="info">While Telepresence works with any language, this guide uses a sample app written in Python using the Flask framework. We have versions in <a href="../qs-python-fastapi/">Python (FastAPI)</a>, <a href="../qs-go/">Go</a>, and <a href="../">Node</a> if you prefer.</Alert>

## Prerequisites
You’ll need `kubectl` installed and configured to use a Kubernetes cluster, preferably an empty test cluster. You must have RBAC permissions in the cluster to create and update deployments and services.
Expand Down Expand Up @@ -67,7 +67,7 @@ Telepresence connects your local workstation to a remote Kubernetes cluster.

Your local workstation may not have the compute or memory resources necessary to run all the services in a multi-service application. In this example, we’ll show you how Telepresence can give you a fast development loop, even in this situation.

<Alert severity="info">While Telepresence works with any language, this guide uses a sample app written in Python using Flask. We have versions in <a href="../qs-python-fastapi/">Python using FastAPI</a>, <a href="../qs-go/">Go</a>, and <a href="../">Node</a> if you prefer.</Alert>
<Alert severity="info">While Telepresence works with any language, this guide uses a sample app written in Python using the Flask framework. We have versions in <a href="../qs-python-fastapi/">Python (FastAPI)</a>, <a href="../qs-go/">Go</a>, and <a href="../">Node</a> if you prefer.</Alert>

1. Start by installing a sample application that consists of multiple services:
`kubectl apply -f https://raw.githubusercontent.com/datawire/edgey-corp-python/master/k8s-config/edgey-corp-web-app-no-mapping.yaml`
Expand Down

0 comments on commit a69a967

Please sign in to comment.