Commit graph

2050 commits

Author SHA1 Message Date
Noah Stride e64ff8732a
Remove "expires" from delegated joining docs (#21214) 2023-02-10 14:18:12 +00:00
Steven Martin 98b3de1d55
Update troubleshooting docs (#21538)
* Update troubleshooting

* verbiage change

Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com>

* remove trailing space

* Update docs/pages/management/admin/troubleshooting.mdx

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>

---------

Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com>
Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-02-09 21:19:07 +00:00
Steven Martin c117091201
Correct namespace name in k8s doc (#21559) 2023-02-09 21:10:39 +00:00
Alex Fornuto ce07345443
fix link in troubleshooting guide (#21569) 2023-02-09 20:46:10 +00:00
Alex Fornuto fe5295b239
Remove version warnings for EOL Teleport versions (#21539) 2023-02-09 15:18:35 +00:00
Steven Martin d6c6796c5e
Fix k8s docs links (#21534)
Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com>
2023-02-09 15:06:32 +00:00
STeve (Xin) Huang 23481cd831
Update database config samples (#21480) 2023-02-09 14:20:26 +00:00
Hugo Shaka cddd09960c
helm: allow to set security contexts in teleport-kube-agent (#21076)
* helm: allow to set `initSecurityContext` in `teleport-kube-agent`

* Apply suggestions from code review

Co-authored-by: Gus Luxton <gus@goteleport.com>

* fixup! helm: allow to set `initSecurityContext` in `teleport-kube-agent`

---------

Co-authored-by: Gus Luxton <gus@goteleport.com>
2023-02-08 22:28:00 +00:00
Grzegorz Zdunek e8de43e634
Add docs for Connect usage reporting (#21294)
* Add docs for Connect usage reporting

* reuse telemetry specifics in partial file

* copy edits

* Apply suggestions from code review

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>

* Add Zac's suggestion

Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>

* Apply suggestions

* Add "Assuming an Access Request"

---------

Co-authored-by: alexfornuto <alex.fornuto@goteleport.com>
Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>
2023-02-08 17:36:05 +00:00
Paul Schisa 357c07df68
Align the Okta and Auth Connector configuration examples in Okta SSO guide (#21466)
Port `:443` is explicitly stated in the Okta configuration but not in the the Teleport auth connector example (only has <cluster-url> mentioned without 443).  This has created multiple Okta issues for users recently with mismatched configurations on the auth connector and Okta configuration.

Proposal is to align the configuration reference for the Okta and Teleport auth connector examples so users are clear these MUST match for the connector to work.  I chose to align the Okta to the Teleport example but it could go the other way too.

We may also want to consider changing the order of the Okta guide.  With IDP initiated configuration flow it makes more sense to create and name the Teleport connector first before trying to configure Okta.  But this is outside the scope of this PR for now.
2023-02-08 17:17:27 +00:00
Alex Fornuto 66f28227cc
fix partial links (#21465) 2023-02-08 16:54:29 +00:00
Alex Fornuto 2875651f32
update contribute instructions to use major version (#21455) 2023-02-08 16:12:45 +00:00
Philippe M. Chiasson f5c6b50c8b
Bump cloud version to 11.3.2 (#21442)
See: gravitational/cloud#3375
2023-02-08 15:31:00 +00:00
Paul Gottschling 09f6f94d9c
Update the version support table for v12 (#20632)
Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com>
2023-02-07 18:49:54 +00:00
Alex Fornuto 0ca0b22347
[Docs] update Desktop Access introduction for v12 (#21398)
* update Desktop Access introduction for v12

* Update docs/pages/desktop-access/introduction.mdx
2023-02-07 17:29:24 +00:00
Alex Fornuto ca5932e672
single-source access control guides list (#21161) 2023-02-07 17:19:28 +00:00
Steven Martin 3fd05fe1dd
fix k8s docs links (#21403)
Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com>
2023-02-07 17:01:31 +00:00
djohns7 e8a1abf897
Update okta.mdx (#19526)
* Update okta.mdx

* added compressed image to commit and updated okta doc to reflect file location

---------

Co-authored-by: Dan Johns <djohns@macbook-pro-dan.lan>
Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com>
2023-02-07 16:44:47 +00:00
Alex Fornuto 29e846c337
properly resolve conflict (#21360) 2023-02-07 16:29:14 +00:00
Steven Martin 0b4a9958dd
Spelling fix and app access link fix (#21393) 2023-02-07 14:54:04 +00:00
STeve (Xin) Huang e2fbeacf97
Docs: AWS RDS Proxy Guide (#21322)
* init RDS proxy guide

* update diagram

* update doc

* add missing png

* copy edits...

Minor phrasing adjustment, replaced scoped blocks for cloud with Vars, fixed code fencing for commands and json

* RDS Proxies -> RDS Proxy instances

* database agent -> Database Service instance

---------

Co-authored-by: alexfornuto <alex.fornuto@goteleport.com>
2023-02-07 14:32:26 +00:00
Alex Fornuto 644d111f7e
use Enterprise over Commercial (#20644) 2023-02-07 00:16:55 +00:00
Evan Corkrean 88aff2a2b6
correct tsh scp docs (#20235)
the -P flag is unnecessary
2023-02-06 23:55:05 +00:00
Steven Martin c8c1ea5fc8
Show enterprise installs for Cloud scope MacOS Installs (#19669)
* Recommends enterprise version for MacOS cloud installs that matches to the Cloud Downloads

* lint fix

* copy edits...

Shortened Homebrew section and consolidated, updated direct download links

* uncomment command output

* verbiage change

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>

* Fix tabs

* remove homebrew include

---------

Co-authored-by: alexfornuto <alex.fornuto@goteleport.com>
Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-02-06 23:39:33 +00:00
Gus Luxton 11db697c4c
helm-docs: Separate cert-manager and ACM values for clarity in AWS guide (#21340)
* helm-docs: Separate cert-manager and ACM values for clarity in AWS guide

* Remove surplus line break
2023-02-06 22:48:21 +00:00
Alex Fornuto e5dfcb9668
fix lint-breaking spacing (#21351) 2023-02-06 22:44:02 +00:00
Hugo Shaka 66104e65a9
docs: fix helm reference (#21325)
Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com>
2023-02-06 19:02:09 +00:00
Paul Gottschling 6119236310
Explain Kubernetes RBAC more comprehensively (#20730)
* Explain Kubernetes RBAC more comprehensively

Closes #18230

This change explains Teleport's RBAC system in relation to the Teleport
Kubernetes Service. The docs didn't leave me with a readily available
place to put this information, since explanations of Kubernetes-related
role fields are scattered in asides throughout various pages.

As a result, I have added a more comprehensive, focused explanation of
Teleport's Kubernetes RBAC system in two places:

- A new how-to guide for setting up Kubernetes RBAC with Teleport using
  a local `minikube` cluster.
- A reference guide that explains the Kubernetes-related fields within a
  Teleport role as well as the logic that the Kubernetes Service uses to
  evaluate these fields. This replaces the existing Kubernetes Access
  Controls guide.

To make room for the RBAC how-to guide, I've reorganized the other
guides into a logical sequence: enabling auto-discovery, manually
registering clusters, and setting up access controls.

I've also edited the Resource Access Requests guides to explain role
fields for the different resources you can restrict access to via
`search_as_roles`, including `pods`.

* Partially respond to PR feedback

- Add `kubernetes_labels` to example snippets
- Rename a misleading H5 in the Resource Requests guide
- Make the description of impersonation more accurate in the Access
  Controls guide
- Move a Notice in the Access Controls guide
- Add an example role to the warning re: namespace restrictions in the
  Access Controls guide
- Make resource filtering info more accurate in the CLI reference

* Change the RBAC how-to guide

Use Deployments in the demo cluster instead of Pods, showcasing the use
of regular expressions in per-pod RBAC.

This responds to PR feedback.

* Provide an example of internal traits

This responds to PR feedback

* Add notes about regex support

Responds to PR feedback

* Explain multiple values in labels

Responds to PR feedback

* Document progressively enabling access to pods

In response to PR feedback

* unbreak redirect

* copy edits

* more copy edits

* Respond to alexfornuto feedback

---------

Co-authored-by: alexfornuto <alex.fornuto@goteleport.com>
2023-02-06 19:00:30 +00:00
STeve (Xin) Huang 62777235d8
[doc] add missing comment for db dynamic resources config (#21293) 2023-02-06 18:59:22 +00:00
Alex Fornuto 40a1af7a4f
fix redirects pointing at removed guide (#21310) 2023-02-06 17:51:13 +00:00
Alex Fornuto 757a80e75f
Desktop Access without Active Directory (#19311)
* rename manual to active directory manual

* rename getting started to active directory

* update titles and descriptions

* first draft of non-AD getting started

Note: I have images but did not yet include them in the commit history. No need to bloat the repo if those steps will be invalidated by a new installer

* update draft

* update links for new paths

* Update based on review feedback

* update config reference

* Apply suggestions from code review

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>

* post-review edits

* note non-AD as enterprise feature

* expand manual AD process adminition

* Apply suggestions from code review

Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>
Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>

* disable default services for Desktop node

* document cli access, clarify non-AD listing of hosts

* add join token for new node

* update screenshot for new UI

* copy edit...

Based on https://github.com/gravitational/teleport/pull/19311\#discussion_r1095187559

* name and link for windows exe

* Update download link

* note zip format

---------

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>
2023-02-06 17:22:21 +00:00
Hugo Shaka 03708a8011
helm: disable PSPs on 1.23 and document PSA usage (#21258)
* helm: disbale PSPs on 1.23 and document PSA usage

In 1.25 Kubernetes removes PSP support, this has 2 consequences:
- Helm will break after upgrading if PSPs are deployed
- We cannot set security policies anymore

This commit documents those two behaviours and makes the chart disable
PSPs on 1.23 and higher to ensure a smooth upgrade path.

* helm: Remove stale 'migrate from legacy charts' guide
2023-02-06 15:39:01 +00:00
Steven Martin ddce494766
spell and spacing fixes (#21265) 2023-02-06 01:05:34 +00:00
Paul Gottschling 06bf633ab5
Remove Auth/Proxy instructions from DB guides (#20308)
* Remove Auth/Proxy instructions from DB guides

Closes #11538

A number of our Database Service guides instruct the user to install the
Auth Service and the Proxy Service. For users who have already set up
these services, these instructions add friction. For users who have
_not_ set up these services, Teleport has existing instructions that
users can follow instead.

This change edits our Database Access guides to require the user to have
a running Teleport cluster as a prerequisite, in line with how-to guides
in other sections of the docs.

Note that, while the issue this change closes is to add Auth/Proxy
Service setup instructions to _more_ places in the docs, this change
follows our style guide recommendation (#20024) to add steps to the
Prerequisites section if we have them documented elsewhere and they
don't directly pertain to the goal of a how-to guide.

* Respond to PR feedback

Change H3s to H2s

---------

Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com>
2023-02-03 23:22:57 +00:00
Paul Gottschling c0db988b85
Improve the Teleport Cloud Getting Started guide (#20837)
* Improve the Teleport Cloud Getting Started guide

While following the Teleport Enterprise Cloud Getting Started guide to
test v12, I made the following changes to the guide:

- Change the title of the guide--and language throughout our Cloud
  docs--to use "Teleport Enterprise Cloud" instead of "Teleport Cloud".
  This reflects the usage in our Core Concepts page.

- Add a brief architectural explanation to the guide in case users
  arrive here from a search engine.

- Restructure the guide to include a step to start a local Docker
  container. This way, we can (a) ensure that all steps are consistent
  for all users; and (b) let the user get started quickly without "real"
  infra.

- Include instructions to paste a script generated via Teleport Discover
  into the container shell.

- Update screenshots.

* Respond to alexfornuto feedback

* Minor wording change

Responding to PR feedback
2023-02-03 23:22:29 +00:00
STeve (Xin) Huang 49d254be8a
[doc] allow either role name or full ARN for AWS IAM role db_users (#21240)
* [doc] allow either role name or full ARN for AWS IAM role db_users

* update dynamodb doc
2023-02-03 21:04:29 +00:00
Alex Fornuto b882aee631
move is_flexi_server to correct config nesting (#21237)
Co-authored-by: Steven Martin <steven@goteleport.com>
2023-02-03 18:59:23 +00:00
Paul Schisa 40f5150612
docs: suggest group policy update in desktop troubleshooting section (#21225)
* Update troubleshooting.mdx

Update Disable NLA section to include troubleshooting step to force the policy update.  Similar to smartcard troubleshooting section and relevant here from customer experience

* copy edits

* Update docs/pages/desktop-access/troubleshooting.mdx

Co-authored-by: Gus Luxton <gus@goteleport.com>

---------

Co-authored-by: alexfornuto <alex.fornuto@goteleport.com>
Co-authored-by: Gus Luxton <gus@goteleport.com>
2023-02-03 18:58:23 +00:00
Alex Fornuto 816038605b
New guide: AWS DynamoDB with Database Access (#19956)
* move application-based dynamodb guide

* update and move images

* init new dynamo guide

* Apply suggestions from code review

Co-authored-by: Gavin Frazar <gavin.frazar@goteleport.com>

* updates based on review

* Add NoSQL workbench to gui clients doc

* cluster > plane

* add redirect for dynamo through app access

* gui-client cleanup

* Update docs/pages/database-access/guides/aws-dynamodb.mdx

Co-authored-by: Gavin Frazar <gavin.frazar@goteleport.com>

* Apply suggestions from code review

Co-authored-by: Gavin Frazar <gavin.frazar@goteleport.com>

* update labs link

* Apply suggestions from code review

Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>

* updates based on review

* Apply suggestions from code review

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>

* move service nodes into AWS cloud

* edits based on review feedback

* clarify AWS IAM roles

* Adjust explanation of user role

* reference generated token

* Move dynamic registration to next steps

* explain advantage to DynamoDB through App service

* merge conflict resolution

* clarify database region restrictions

---------

Co-authored-by: Gavin Frazar <gavin.frazar@goteleport.com>
Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>
Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-02-03 18:42:18 +00:00
Paul Gottschling a604a2bc1d
Document Google Cloud CLI access (#19905)
* Document Google Cloud CLI access

Closes #17584

- Add a guide to configuring and using Google Cloud CLI access via the
  Teleport Application Service.

- Since we now have three guides to setting up secure access to cloud
  APIs, create a new subsection of the "Application Access" docs section
  related to cloud provider APIs.

* Respond to PR feedback

- Capitalize "JSON Web Tokens"
- Edit the AWS guide's nav bar entry
- Fix garbled section in the App Access intro page
- Improve the service account name we use in the how-to guide
- Clarify the way the App Service uses a service account
- Add new env vars to the `tsh proxy` command output
- Other small changes in response to suggestions/comments

* Edit instructions for starting the VM

Add instructions to launch a new VM with a service account attached.
This addresses feedback on the PR.

* Use more precise terminology for service accounts

This addresses feedback on the PR

* Add information about `tsh gsutil`

This adds to both the Google Cloud API access how-to guide and the CLI
reference.

* Respond to PR feedback

* use nobr tags

* fix multiline command

---------

Co-authored-by: alexfornuto <alex.fornuto@goteleport.com>
2023-02-03 16:45:53 +00:00
Alex Fornuto a5909b016c
[Docs] Redshift Serverless Guide (#20168)
* init Redshift Serverless guide

* Apply suggestions from code review

Co-authored-by: STeve (Xin) Huang <xin.huang@goteleport.com>

* Update docs/pages/database-access/guides/redshift-serverless.mdx

* update for review feedback

* Apply suggestions from code review

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>

* update based on review feedback

* clarify ambiguous pronoun

* Apply suggestions from code review

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>

---------

Co-authored-by: STeve (Xin) Huang <xin.huang@goteleport.com>
Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-02-03 16:43:56 +00:00
Gus Luxton 97e956a53d
docs: Update Cloud install to use enterprise binaries (#21219)
Co-authored-by: Steven Martin <steven@goteleport.com>
2023-02-03 16:01:59 +00:00
Alex Fornuto e9b774f731
[Docs] Update Azure Postgres/MySQl guide for Flexi (#20504)
* update Azure identity screenshots

* update databse config partial

* Update Azure database guide for flexible servers

* modify partial for inter-page use

* Apply suggestions from code review

Co-authored-by: Gavin Frazar <gavin.frazar@goteleport.com>

* post-review edits

* Update docs/pages/database-access/guides/azure-postgres-mysql.mdx

Co-authored-by: Gavin Frazar <gavin.frazar@goteleport.com>

* Apply suggestions from code review

Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>

* Apply suggestions from code review

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
Co-authored-by: Gavin Frazar <gavin.frazar@goteleport.com>

---------

Co-authored-by: Gavin Frazar <gavin.frazar@goteleport.com>
Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>
Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-02-03 15:46:19 +00:00
STeve (Xin) Huang 8c53757aac
Require flag for dynamic resources matching "tsh db configure create" (#20966)
* Require a new flag for enabling dynamic resources matching for "tsh db configure create"

* rename flag to --dynamic-resources-labels

* make naming more consistent
2023-02-02 22:07:59 +00:00
Evan Freed 88e82c9fd4
add pull to ensure latest image is used (#20989)
Signed-off-by: Evan Freed <evan.freed@goteleport.com>
2023-02-02 20:52:36 +00:00
Alan Parra d0affe9c76
Add public docs for device trust (#20954)
* Add device trust documentation

* Link to Device Trust from Access Control pages

* Document `device_trust` authentication section

* Document the `tsh device enroll` command

* Document `tctl devices` commands

* Review: Explain macOS restriction in text

* Review: Address Alex's comments

Indents, markdown style, code block style, punctuation and missing
words.

* Review: Use diff blocks on `tctl edit` example

* Review: Use diff blocks in other examples

* Review: Use standard example names

* Review: Address Alex's comments (2)

Uppercase SERIAL, macOS enroll notice, config example tabs.

* Review: Sort `tctl devices` commands alphabetically

* Review: Use config variables for asset_tag and enroll_token

* Review: Remove '#' from code blocks in cli.mdx

* combine warning and ScopedBlock

A ScopedBlock for OSS will never render on a page not scoped for OSS. This way, it's always visible. Once the feature is out of preview, we can just remove the first line.

* clarify device trust between trusted clusters

This addition dispells any assumptions made by the reader that applying device trust to root clusters would enforece the setting on leaf clusters.

* update enterprise tctl version output

---------

Co-authored-by: alexfornuto <alex.fornuto@goteleport.com>
2023-02-02 20:43:51 +00:00
Alex Fornuto 839b7b2b60
fix enterprise binary tarball path (#21095) 2023-02-02 18:38:40 +00:00
Sam Freiberg 26c4d6a180
Update CA rotation docs (#20317)
* Update CA rotation docs

* Add openssh to --types

* Update --types warning

* Update --type verbiage

* Make --type editable instead of providing the options

* Add proper tag to code block.

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>

* Improve readability.

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>

---------

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-02-02 16:14:48 +00:00
Hugo Shaka 2b3b9f7bf8
docs: Document teleport-cluster v12 Helm chart (#19881) 2023-02-02 15:37:08 +00:00
STeve (Xin) Huang cbbb9cbc2a
[doc] Update app access reserved headers X-Teleport-* (#21000)
* Update app access reserved headers X-Teleprot-*

* Any header matching the pattern
2023-02-02 13:48:02 +00:00