Skip to content

Commit 3aecd4b

Browse files
authored
Fix Vale warnings in three guides (#50357)
- Getting started guide for auto-discovering Kubernetes applications. - DynamoDB (as an application) guide. This change does not address one Vale warning with `tsh aws dymamodb`, which is a false positive. - Getting started guide for protecting applications.
1 parent 3497485 commit 3aecd4b

File tree

3 files changed

+39
-16
lines changed

3 files changed

+39
-16
lines changed

docs/pages/enroll-resources/application-access/getting-started.mdx

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Getting Started with Teleport Application Access
3-
description: Getting started with Teleport application access.
2+
title: Protect a Web Application with Teleport
3+
description: Provides instructions to set up the Teleport Application Service and enable secure access to a web application.
44
videoBanner: cvW4b96aPL0
55
---
66

@@ -20,6 +20,21 @@ At a high level, configuring access for applications involves the following step
2020
- Install and configure Teleport on the application host.
2121
- Add a user to verify access to the application.
2222

23+
## How it works
24+
25+
In the setup we demonstrate in this guide, the Teleport Application Service
26+
joins your Teleport cluster with a secure token. You configure the Application
27+
Service to protect a web application using a configuration file. After the
28+
Application Service joins the cluster, the Teleport Proxy Service routes
29+
requests from end users to the Teleport Application Service, and responses from
30+
the Application Serve back to end users.
31+
32+
The Application Service authenticates user requests by validating a JSON web
33+
token (JWT) in the request against a CA maintained by the Teleport Auth Service.
34+
The requesting user's roles are encoded in the JWT, allowing the Application
35+
Service to determine whether the user has permissions to make a request to a
36+
Teleport-protected application.
37+
2338
## Prerequisites
2439

2540
For this tutorial, verify your environment meets the following requirements:
@@ -179,7 +194,7 @@ $ helm install teleport-kube-agent teleport/teleport-kube-agent \
179194
- Change `apps[0].name` and `apps[0].uri` if you're configuring access to a different
180195
web application.
181196

182-
Make sure that the Teleport agent pod is running. You should see one
197+
Make sure that the Teleport Agent pod is running. You should see one
183198
`teleport-kube-agent` pod with a single ready container:
184199

185200
```code
@@ -203,8 +218,9 @@ To assign to the `access` role to a new local user named `alice`, run the follow
203218
$ tctl users add --roles=access alice
204219
```
205220

206-
The command generates an invitation URL for the new user. You can use the URL to choose
207-
a password, set up a second factor for authentication, and sign in to the Teleport Web UI.
221+
The command generates an invitation URL for the new user. You can use the URL to
222+
choose a password, set up multi-factor authentication, and sign in to the
223+
Teleport Web UI.
208224

209225
## Step 5/5. Access the application
210226

@@ -225,5 +241,5 @@ Learn more about protecting applications with Teleport in the following topics:
225241
- [Connecting applications](./guides/connecting-apps.mdx).
226242
- Integrating with [JWT tokens](./jwt/introduction.mdx).
227243
- Accessing applications with [RESTful APIs](./guides/api-access.mdx).
228-
- Setting configuration options AND running CLI commands in the [Application Access reference](../../reference/agent-services/application-access.mdx).
244+
- Setting configuration options AND running CLI commands in the [Application Service reference](../../reference/agent-services/application-access.mdx).
229245
- Using the Let's Encrypt [ACME protocol](https://letsencrypt.org/how-it-works/).

docs/pages/enroll-resources/application-access/guides/dynamodb.mdx

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,15 @@ This guide will help you to:
2222

2323
</Tabs>
2424

25-
<Admonition type="warning" title="Recommendation: Use the Teleport Database
26-
Service">
25+
## How it works
2726

2827
The Teleport Application Service enables secure access to DynamoDB via its
2928
[integration](../cloud-apis/aws-console.mdx) with the AWS management console and
3029
API. This is an alternative to accessing DynamoDB through the Teleport Database
31-
service, as described in our [Database Access with AWS
32-
DynamoDB](../../database-access/enroll-aws-databases/aws-dynamodb.mdx) guide.
30+
service, as described in our [Protect Amazon DynamoDB with
31+
Teleport](../../database-access/enroll-aws-databases/aws-dynamodb.mdx) guide.
3332

33+
<Admonition type="warning">
3434
The Application Service's integration with AWS is not designed specifically for
3535
DynamoDB, while the Database Service has a purpose-built DynamoDB integration.
3636
As a result, we recommend using the Database Service to enable secure access to
@@ -40,7 +40,6 @@ It is worth noting that the Database Service will allow you to connect with GUI
4040
clients, whereas the Application Service does not. On the other hand, a single
4141
Application Service configuration can access DynamoDB across regions, while
4242
database resources must be configured for each region with DynamoDB databases.
43-
4443
</Admonition>
4544

4645
## Prerequisites
@@ -173,6 +172,6 @@ $ tsh apps logout aws
173172
```
174173

175174
## Next steps
176-
- More information on [AWS Management and API with Teleport Application Access](../../application-access/cloud-apis/aws-console.mdx).
175+
- More information on [protecting AWS Console with Teleport](../../application-access/cloud-apis/aws-console.mdx).
177176
- Learn more about [AWS service endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html).
178177

docs/pages/enroll-resources/auto-discovery/kubernetes-applications/get-started.mdx

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,14 @@ setup step.
1111

1212
In this guide, we show you how to enable Kubernetes application auto-discovery.
1313

14+
## How it works
15+
16+
The Teleport Discovery Service queries the API server of the Kubernetes cluster
17+
in which you want to detect applications, maintaining dynamic `app` resources to
18+
match the Kubernetes services that it detects within the cluster. The Teleport
19+
Application Service queries the Teleport Auth Service to fetch `app` resources,
20+
and proxies applications based the dynamically generated configuration.
21+
1422
## Prerequisites
1523

1624
(!docs/pages/includes/edition-prereqs-tabs.mdx!)
@@ -26,7 +34,7 @@ In this guide, we show you how to enable Kubernetes application auto-discovery.
2634

2735
## Step 1/2. Create a join token
2836

29-
Create a join token for a new Teleport agent that will run the Teleport
37+
Create a join token for a new Teleport Agent that will run the Teleport
3038
Kubernetes Service, Application Service, and Discovery Service:
3139

3240
```code
@@ -40,15 +48,15 @@ Teleport applications created from discovered Kubernetes services.
4048

4149
## Step 2/2. Deploy the agent
4250

43-
If you want to install a new Teleport agent in your Kubernetes cluster, you can
44-
use the `teleport-kube-agent` Helm chart. If you already have a Teleport agent
51+
If you want to install a new Teleport Agent in your Kubernetes cluster, you can
52+
use the `teleport-kube-agent` Helm chart. If you already have a Teleport Agent
4553
installed, you can upgrade it to enable the Kubernetes Application Discovery
4654
by adding the `kube`, `app`, and `discovery` to roles as shown below.
4755

4856
<Tabs>
4957
<TabItem label="Install a new agent">
5058

51-
Deploy a new Teleport agent running your configured services by installing the
59+
Deploy a new Teleport Agent running your configured services by installing the
5260
`teleport-kube-agent` Helm chart:
5361

5462
```code

0 commit comments

Comments
 (0)