Skip to content

Commit

Permalink
(from getambassador.io) Phase out qs-tabs (QSTabs) for Platform
Browse files Browse the repository at this point in the history
  • Loading branch information
LukeShu committed Aug 24, 2021
1 parent ff4ba47 commit 1d580b5
Show file tree
Hide file tree
Showing 11 changed files with 390 additions and 168 deletions.
56 changes: 54 additions & 2 deletions howtos/intercepts.md
Expand Up @@ -3,7 +3,7 @@ description: "Start using Telepresence in your own environment. Follow these ste
---

import Alert from '@material-ui/lab/Alert';
import QSTabs from '../quick-start/qs-tabs'
import Platform from '@src/components/Platform';
import QSCards from '../quick-start/qs-cards'

# Intercept a service in your own environment
Expand Down Expand Up @@ -39,7 +39,59 @@ This guide assumes you have a Kubernetes deployment and service accessible publi

## 1. Install the Telepresence CLI

<QSTabs/>
<Platform.TabGroup>
<Platform.MacOSTab>

```shell
# Install via brew:
brew install datawire/blackbird/telepresence

# OR install manually:
# 1. Download the latest binary (~60 MB):
sudo curl -fL https://app.getambassador.io/download/tel2/darwin/amd64/$dlVersion$/telepresence -o /usr/local/bin/telepresence

# 2. Make the binary executable:
sudo chmod a+x /usr/local/bin/telepresence
```

</Platform.MacOSTab>
<Platform.GNULinuxTab>

```shell
# 1. Download the latest binary (~50 MB):
sudo curl -fL https://app.getambassador.io/download/tel2/linux/amd64/$dlVersion$/telepresence -o /usr/local/bin/telepresence

# 2. Make the binary executable:
sudo chmod a+x /usr/local/bin/telepresence
```

</Platform.GNULinuxTab>
<Platform.WindowsTab>

```powershell
# Windows is in Developer Preview, here is how you can install it:
# Make sure you run the following from Powershell as Administrator
# 1. Download the latest windows zip containing telepresence.exe and its dependencies (~50 MB):
curl -fL https://app.getambassador.io/download/tel2/windows/amd64/$dlVersion$/telepresence.zip -o telepresence.zip
# 2. Unzip the zip file to a suitable directory + cleanup zip
Expand-Archive -Path telepresence.zip
Remove-Item 'telepresence.zip'
cd telepresence
# 3. Run the install-telepresence.ps1 to install telepresence's dependencies. It will install telepresence to
# C:\telepresence by default, but you can specify a custom path $path with -Path $path
Set-ExecutionPolicy Bypass -Scope Process
.\install-telepresence.ps1
# 4. Remove the unzipped directory
cd ..
Remove-Item telepresence
# 5. Close your current Powershell and open a new one. Telepresence should now be usable as telepresence.exe
```

</Platform.WindowsTab>
</Platform.TabGroup>

## 2. Test Telepresence

Expand Down
56 changes: 54 additions & 2 deletions install/index.md
@@ -1,12 +1,64 @@
import QSTabs from '../quick-start/qs-tabs'
import Platform from '@src/components/Platform';
import OldVersionTabs from './old-version-tabs'
import NightlyVersionTabs from './nightly-version-tabs'

# Install

Install Telepresence by running the commands below for your OS.

<QSTabs/>
<Platform.TabGroup>
<Platform.MacOSTab>

```shell
# Install via brew:
brew install datawire/blackbird/telepresence

# OR install manually:
# 1. Download the latest binary (~60 MB):
sudo curl -fL https://app.getambassador.io/download/tel2/darwin/amd64/$dlVersion$/telepresence -o /usr/local/bin/telepresence

# 2. Make the binary executable:
sudo chmod a+x /usr/local/bin/telepresence
```

</Platform.MacOSTab>
<Platform.GNULinuxTab>

```shell
# 1. Download the latest binary (~50 MB):
sudo curl -fL https://app.getambassador.io/download/tel2/linux/amd64/$dlVersion$/telepresence -o /usr/local/bin/telepresence

# 2. Make the binary executable:
sudo chmod a+x /usr/local/bin/telepresence
```

</Platform.GNULinuxTab>
<Platform.WindowsTab>

```powershell
# Windows is in Developer Preview, here is how you can install it:
# Make sure you run the following from Powershell as Administrator
# 1. Download the latest windows zip containing telepresence.exe and its dependencies (~50 MB):
curl -fL https://app.getambassador.io/download/tel2/windows/amd64/$dlVersion$/telepresence.zip -o telepresence.zip
# 2. Unzip the zip file to a suitable directory + cleanup zip
Expand-Archive -Path telepresence.zip
Remove-Item 'telepresence.zip'
cd telepresence
# 3. Run the install-telepresence.ps1 to install telepresence's dependencies. It will install telepresence to
# C:\telepresence by default, but you can specify a custom path $path with -Path $path
Set-ExecutionPolicy Bypass -Scope Process
.\install-telepresence.ps1
# 4. Remove the unzipped directory
cd ..
Remove-Item telepresence
# 5. Close your current Powershell and open a new one. Telepresence should now be usable as telepresence.exe
```

</Platform.WindowsTab>
</Platform.TabGroup>

## <img class="os-logo" src="../images/logo.png"/> What's Next?

Expand Down
23 changes: 11 additions & 12 deletions quick-start/demo-node.md
Expand Up @@ -3,17 +3,16 @@ description: "Claim a remote demo cluster and learn to use Telepresence to inter
---

import {DemoClusterMetadata, ExpirationDate} from '../../../../../src/components/DemoClusterMetadata';
import {
EmojivotoServicesList,
DCPLink,
Login,
LoginCommand,
DockerCommand,
import {
EmojivotoServicesList,
DCPLink,
Login,
LoginCommand,
DockerCommand,
PreviewUrl,
ExternalIp
} from '../../../../../src/components/Docs/Telepresence';
import Alert from '@material-ui/lab/Alert';
import QSTabs from './qs-tabs';
import QSCards from './qs-cards';
import { UserInterceptCommand } from '../../../../../src/components/Docs/Telepresence';

Expand Down Expand Up @@ -53,7 +52,7 @@ Telepresence connects your local workstation with a remote Kubernetes cluster. I
<EmojivotoServicesList/>

<Alert severity="success">
The Service Catalog gives you a consolidated view of all your services across development, staging, and production.
The Service Catalog gives you a consolidated view of all your services across development, staging, and production.
</Alert>

<ExpirationDate/>
Expand All @@ -65,7 +64,7 @@ The remote cluster is running the Emojivoto application, which consists of three
1. Go to the <ExternalIp/> and vote for some emojis.

2. Now, click on the 🍩 emoji. You'll see that a bug is present, and voting 🍩 doesn't work. We're going to use Telepresence shortly to fix this bug, as everyone should be able to vote for 🍩!

<Alert severity="success">
<strong>Congratulations!</strong> You've successfully accessed the Emojivoto application on your remote cluster.
</Alert>
Expand Down Expand Up @@ -98,7 +97,7 @@ A common use case for Telepresence is to connect your local development environm

You will be asked for your ingress layer 3 address; specify the front end service: `ambassador.ambassador`
Then, when asked for the port, type `80`, for "use TLS", type `n`. The default for the fourth value is correct so hit enter to accept it.

<UserInterceptCommand/>

<Alert severity="success">
Expand All @@ -110,12 +109,12 @@ A common use case for Telepresence is to connect your local development environm
Preview URLs enable you to safely share your development environment with anyone. For example, you may want your UX designer to take a quick look at what you're developing, before you commit the code. Preview URLs enable this easy collaboration.

2. If you access the Emojivoto application on <ExternalIp> your remote cluster </ExternalIp> and vote for the 🍩 emoji, you'll see the bug is still present.

1. Vote for the 🍩 emoji using the <PreviewUrl>Preview URL</PreviewUrl> obtained in the previous step, and you will see that the bug is fixed, since traffic is being routed to the fixed version running locally.
<Alert severity="success">
Now you're able to share your fix in your local environment with your team!
</Alert>

<Alert severity="info">
To get more information regarding Preview URLs and intercepts, visit the <DCPLink>Developer Control Plane </DCPLink>.
</Alert>
Expand Down
1 change: 0 additions & 1 deletion quick-start/demo-react.md
Expand Up @@ -3,7 +3,6 @@ description: "Install Telepresence and learn to use it to intercept services run
---

import Alert from '@material-ui/lab/Alert';
import QSTabs from './qs-tabs';
import QSCards from './qs-cards';
import { DownloadDemo } from '../../../../../src/components/Docs/DownloadDemo';
import { UserInterceptCommand } from '../../../../../src/components/Docs/Telepresence';
Expand Down
56 changes: 54 additions & 2 deletions quick-start/qs-go.md
Expand Up @@ -3,7 +3,7 @@ description: "Install Telepresence and learn to use it to intercept services run
---

import Alert from '@material-ui/lab/Alert';
import QSTabs from './qs-tabs'
import Platform from '@src/components/Platform';
import QSCards from './qs-cards'

<div class="docs-language-toc">
Expand Down Expand Up @@ -53,7 +53,59 @@ If you have used Telepresence previously, please first reset your Telepresence d

## 1. Install the Telepresence CLI

<QSTabs/>
<Platform.TabGroup>
<Platform.MacOSTab>

```shell
# Install via brew:
brew install datawire/blackbird/telepresence

# OR install manually:
# 1. Download the latest binary (~60 MB):
sudo curl -fL https://app.getambassador.io/download/tel2/darwin/amd64/$dlVersion$/telepresence -o /usr/local/bin/telepresence

# 2. Make the binary executable:
sudo chmod a+x /usr/local/bin/telepresence
```

</Platform.MacOSTab>
<Platform.GNULinuxTab>

```shell
# 1. Download the latest binary (~50 MB):
sudo curl -fL https://app.getambassador.io/download/tel2/linux/amd64/$dlVersion$/telepresence -o /usr/local/bin/telepresence

# 2. Make the binary executable:
sudo chmod a+x /usr/local/bin/telepresence
```

</Platform.GNULinuxTab>
<Platform.WindowsTab>

```powershell
# Windows is in Developer Preview, here is how you can install it:
# Make sure you run the following from Powershell as Administrator
# 1. Download the latest windows zip containing telepresence.exe and its dependencies (~50 MB):
curl -fL https://app.getambassador.io/download/tel2/windows/amd64/$dlVersion$/telepresence.zip -o telepresence.zip
# 2. Unzip the zip file to a suitable directory + cleanup zip
Expand-Archive -Path telepresence.zip
Remove-Item 'telepresence.zip'
cd telepresence
# 3. Run the install-telepresence.ps1 to install telepresence's dependencies. It will install telepresence to
# C:\telepresence by default, but you can specify a custom path $path with -Path $path
Set-ExecutionPolicy Bypass -Scope Process
.\install-telepresence.ps1
# 4. Remove the unzipped directory
cd ..
Remove-Item telepresence
# 5. Close your current Powershell and open a new one. Telepresence should now be usable as telepresence.exe
```

</Platform.WindowsTab>
</Platform.TabGroup>

## 2. Test Telepresence

Expand Down
56 changes: 54 additions & 2 deletions quick-start/qs-java.md
Expand Up @@ -3,7 +3,7 @@ description: "Install Telepresence and learn to use it to intercept services run
---

import Alert from '@material-ui/lab/Alert';
import QSTabs from './qs-tabs'
import Platform from '@src/components/Platform';
import QSCards from './qs-cards'

<div class="docs-language-toc">
Expand Down Expand Up @@ -53,7 +53,59 @@ If you have used Telepresence previously, please first reset your Telepresence d

## 1. Install the Telepresence CLI

<QSTabs/>
<Platform.TabGroup>
<Platform.MacOSTab>

```shell
# Install via brew:
brew install datawire/blackbird/telepresence

# OR install manually:
# 1. Download the latest binary (~60 MB):
sudo curl -fL https://app.getambassador.io/download/tel2/darwin/amd64/$dlVersion$/telepresence -o /usr/local/bin/telepresence

# 2. Make the binary executable:
sudo chmod a+x /usr/local/bin/telepresence
```

</Platform.MacOSTab>
<Platform.GNULinuxTab>

```shell
# 1. Download the latest binary (~50 MB):
sudo curl -fL https://app.getambassador.io/download/tel2/linux/amd64/$dlVersion$/telepresence -o /usr/local/bin/telepresence

# 2. Make the binary executable:
sudo chmod a+x /usr/local/bin/telepresence
```

</Platform.GNULinuxTab>
<Platform.WindowsTab>

```powershell
# Windows is in Developer Preview, here is how you can install it:
# Make sure you run the following from Powershell as Administrator
# 1. Download the latest windows zip containing telepresence.exe and its dependencies (~50 MB):
curl -fL https://app.getambassador.io/download/tel2/windows/amd64/$dlVersion$/telepresence.zip -o telepresence.zip
# 2. Unzip the zip file to a suitable directory + cleanup zip
Expand-Archive -Path telepresence.zip
Remove-Item 'telepresence.zip'
cd telepresence
# 3. Run the install-telepresence.ps1 to install telepresence's dependencies. It will install telepresence to
# C:\telepresence by default, but you can specify a custom path $path with -Path $path
Set-ExecutionPolicy Bypass -Scope Process
.\install-telepresence.ps1
# 4. Remove the unzipped directory
cd ..
Remove-Item telepresence
# 5. Close your current Powershell and open a new one. Telepresence should now be usable as telepresence.exe
```

</Platform.WindowsTab>
</Platform.TabGroup>

## 2. Test Telepresence

Expand Down

0 comments on commit 1d580b5

Please sign in to comment.