Skip to content

Commit

Permalink
(from getambassador.io) Revert "add Docs article feedback"
Browse files Browse the repository at this point in the history
  • Loading branch information
DromeroUnosquare authored Jul 30, 2021
1 parent 4c45480 commit 6de63bb
Show file tree
Hide file tree
Showing 23 changed files with 421 additions and 294 deletions.
9 changes: 7 additions & 2 deletions doc-links.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,11 @@
items:
- title: Architecture
link: /reference/architecture
- title: Networking through Virtual Network Interface
link: /reference/tun-device
- title: Client reference
link: /reference/client
items:
- title: login
link: /reference/client/login
- title: Laptop-side configuration
link: /reference/config
- title: Cluster-side configuration
Expand All @@ -64,6 +65,10 @@
link: /reference/dns
- title: RBAC
link: /reference/rbac
- title: Networking through Virtual Network Interface
link: /reference/tun-device
- title: Connection Routing
link: /reference/routing
- title: Using Telepresence with Linkerd
link: /reference/linkerd
- title: FAQs
Expand Down
31 changes: 19 additions & 12 deletions howtos/intercepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,25 +165,32 @@ You can now:
## 4. Create a preview URL to only intercept certain requests to your service
When working on a development environment with multiple engineers, you don't want your intercepts to impact your
teammates. Ambassador Cloud automatically generates a preview URL when creating an intercept if you are logged in. By
doing so, Telepresence can route only the requests coming from that preview URL to your local environment; the rest will
be routed to your cluster as usual.
When working on a development environment with multiple engineers, you
don't want your intercepts to impact your teammates. If you are
[logged in](../../reference/client/login/), then when creating an
intercept, by default Telpresence will automatically talk to
Ambassador Cloud to generate a preview URL. By doing so, Telepresence
can route only the requests coming from that preview URL to your local
environment; the rest will be routed to your cluster as usual.
1. Clean up your previous intercept by removing it:
`telepresence leave <service name>`
2. Login to Ambassador Cloud, a web interface for managing and sharing preview URLs:
`telepresence login`
2. Log in to Ambassador Cloud, a web interface for managing and
sharing preview URLs:
```
$ telepresence login

Launching browser authentication flow...
<browser opens, login and choose your org>
Login successful.
```console
$ telepresence login
Launching browser authentication flow...
<web browser opens, log in and choose your organization>
Login successful.
```

If you are in an environment where Telepresence cannot launch a
local browser for you to interact with, you will need to pass the
[`--apikey` flag to `telepresence
login`](../../reference/client/login/).

3. Start the intercept again:
`telepresence intercept <service-name> --port <local-port>[:<remote-port>] --env-file <path-to-env-file>`

Expand Down
30 changes: 20 additions & 10 deletions howtos/preview-urls.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,17 +32,21 @@ Need a sample app to try with preview URLs? Check out the <a href="../../quick-

* If the service is in a different namespace, specify it with the `--namespace` flag

2. Login to Ambassador Cloud where you can manage and share preview URLs:
`telepresence login`

```
$ telepresence login
Launching browser authentication flow...
<browser opens, login and choose your org>
Login successful.
2. Log in to Ambassador Cloud where you can manage and share preview
URLs:

```console
$ telepresence login
Launching browser authentication flow...
<web browser opens, log in and choose your organization>
Login successful.
```

If you are in an environment where Telepresence cannot launch a
local browser for you to interact with, you will need to pass the
[`--apikey` flag to `telepresence
login`](../../reference/client/login/).

3. Start the intercept:
`telepresence intercept <service-name> --port <TCP-port> --env-file <path-to-env-file>`

Expand Down Expand Up @@ -118,7 +122,13 @@ Need a sample app to try with preview URLs? Check out the <a href="../../quick-

7. Share with a teammate.

You can collaborate with teammates by sending your preview URL to them. They will be asked to log in to Ambassador Cloud if they are not already. Upon log in they must select the same identity provider and org as you are using; that is how they are authorized to access the preview URL (see the [list of supported identity providers](../../faqs/#idps)). When they visit the preview URL, they will see the intercepted service running on your laptop.
You can collaborate with teammates by sending your preview URL to
them. They will be asked to log in to Ambassador Cloud if they are
not already. Upon login they must select the same identity
provider and org as you are using; that is how they are authorized
to access the preview URL (see the [list of supported identity
providers](../../faqs/#idps)). When they visit the preview URL,
they will see the intercepted service running on your laptop.

<Alert severity="success">
<strong>Congratulations!</strong> You have now created a dev environment and shared it with a teammate! While you and your partner work together to debug your service, the production version remains unchanged to the rest of your team until you commit your changes.
Expand Down
Binary file added images/apikey-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/apikey-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/apikey-4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 6de63bb

Please sign in to comment.