Commit Graph
214 Commits
Author SHA1 Message Date
Jakub NyckowskiandRoman Tkachenko 98d6e2765d Update Access Graph Docs (#41307)
* Update TAG docs

* Update images

* Update docs

* Update images
Add EC2 instances to supported AWS types

* Linter fixes

* Update docs/pages/access-controls/access-graph.mdx

Co-authored-by: Roman Tkachenko <roman@goteleport.com>

* Update TAG version

---------

Co-authored-by: Roman Tkachenko <roman@goteleport.com>
2024-05-13 20:07:35 +00:00
Ben ArentandPaul Gottschling 2f774fd4f9 Docs: Teleport Panther Guide (#40736)
* wip Panther guide

* extra formatting and content updates

* Apply suggestions from code review

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

* extra content updates, note machine id can't impersonate

* Update Panther Docs and Image

* Extra copy tweaks

* Update Var Fomatting

* switch to code to show formatting

* cluster vars isn't working for this code segment, change back

* Fix cspell lint

* switchout image

* Apply suggestions from code review

---------

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2024-05-06 20:26:32 +00:00
Roman Tkachenko 65d05fd28b Remove standalone Okta service docs (#40799) 2024-04-23 15:27:27 +00:00
Paul Gottschling 20e6037acd Refresh the AWS app access guide (#37857)
* Refresh the AWS app access guide

Issues closed:
--------------

Add a statement of benefits, a brief architecture overview, more
troubleshooting information, and a summary of IAM resources created in
this guide.

Closes #10853

Add troubleshooting re: trust relationships and
checking logs.

Closes #17880

Add more explicit trust relationship guidance and uses
CLI examples instead of console screenshots.

Closes #34167

Add more context re: the trust relationship
instructions.

Closes #11797

Add instructions that a user can follow to deploy the
Application Service on EKS.

Closes #24373

Other changes to make the guide easier to follow:
-------------------------------------------------

- Only show one IAM role. Remove the `ExamplePowerUser` role for
  simplicity.
- Use the `aws` CLI for creating IAM resources. This is faster to follow
  than the current approach, takes up less page real estate, and doesn't
  require screenshots. Using the CLI  also makes the trust relationship
  instructions more explicit.
- Move external links to a "Further reading" section so readers can get
  through the guide more quickly.
- Remove the video, since it's long out of date.
- Reduce the number of steps: Convert steps into H3s in order to make it
  easier to form a mental model of the guide and make the step count
  less intimidating.
- Add EC2 instance profile instructions.
- Add a quick boto3 python example for `tsh proxy aws`

* Respond to greedy52 feedback

- Say "EKS" instead of just "Kubernetes" in the prerequisites.
- Edit the trust policy for the `ExampleReadOnlyAccess` role in the
  cross-account use case to include an external ID and require a
  specific role for the principal.

* Respond to kimlisa feedback

- Fix unclear subsection intro sentence.
- Fix a potentially confusing reference to Step 1.
- Fix an unclear use of "configuration".
- Clarify a heading.
- Minor clarity/accuracy improvements.
- Use a Var component for the Proxy Service address in the Linux server
  config file snippet.
2024-04-08 14:22:55 +00:00
Sakshyam Shah 4148a46675 docs: GCP Workforce Identity Federation with Teleport SAML IdP (#39997)
* initial draft

* manual config flow

* add workforce identity federation reference page to application access category

* remove web console page and have directl link to saml docs. Add link to cloud-apis index page

* add gcp workforce discovery and initial config screenshot

* fix typo

* fix markdown linter
2024-03-29 22:50:47 +00:00
0b01cf5c1f Fix opsgenie plugin to use correct annotation to determine whether or not to create alerts (#38435)
* Fix bug in opsgenie plugin mixing up notify-services and schedules

* Update docs for opsgenie plugin to use correct schedules

* Remove accidental change to opsgenie client

* Update opsgenie client tests

* Update opsgneie plugin behaviour for determining recipients

* Update docs with correct screenshot of role creation

* Stop Opsgenie plugin sending alerts when /schedules label is set

* Change rawRecipients initialisation in opsgenie bot

* Remove opsgenie add role example image from docs

* Update integrations/access/accessrequest/app.go

Co-authored-by: Roman Tkachenko <roman@goteleport.com>

* Update docs/pages/access-controls/access-request-plugins/opsgenie.mdx

Co-authored-by: Roman Tkachenko <roman@goteleport.com>

* Make variable Opsgenie plugin var names more consistent

* Update changelog with opsgenie breaking changes

* Rename ReqAnnotationSchedulesLabel for consistency

* Fix opsgenie getOnCall

* Add opsgenie approval tests + add approval user configuration

* Appease linter

* Add back in opsgenie client fix

* Appease linter

* Add in clarifying comment for alert request retry behaviour

* Add missing opsgenie endpoint mocks

---------

Co-authored-by: Roman Tkachenko <roman@goteleport.com>
Co-authored-by: Hugo Hervieux <hugo.hervieux@goteleport.com>
2024-03-27 13:44:25 +00:00
Marek Smoliński 9e927a85a7 Docs: Access Monitoring (#38255) 2024-03-20 15:56:36 +00:00
STeve (Xin) Huang b043372f40 [docs] GCP MySQL IAM authentication support (#38943)
* [docs] GCP MySQL IAM authentication support

* review comments

* remove legacy OTP flow

* address review comments
2024-03-07 20:40:15 +00:00
20cfeb2fd1 Add in documentation for Okta access list synchronization. (#38355)
* Add in documentation for Okta access list synchronization.

Documentation has been added for Okta access list synchronization.

* Apply suggestions from code review

Co-authored-by: Lisa Kim <lisa@goteleport.com>

* Reword default owners blurb.

* Apply suggestions from code review

Co-authored-by: Lisa Kim <lisa@goteleport.com>

* Consistently capitalize Access Lists, reduce images, tweak wording.

* Apply suggestions from code review

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

* Update docs/pages/application-access/okta/hosted-guide.mdx

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

* Remove yaml config bits, clarify hosted guide.

* Correct spelling.

* Correct emphasis.

---------

Co-authored-by: Lisa Kim <lisa@goteleport.com>
Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>
2024-02-29 19:59:53 +00:00
STeve (Xin) Huang 056e2ec498 [docs] update TLS routing conn upgrade with WebSocket support (#38167)
* [docs] update TLS routing conn upgrade

* remove "now"
2024-02-22 15:53:32 +00:00
Trent Clarke eb8396b73f [docs] Updates Okta SSO docs to include sync service (#36398)
* [docs] Updates Okta SSO docs to include SCIM & sync service

Expanded to cover:
 * Running Okta as a hosted integration
 * SCIM configuration
 * Okta to Teleport user conversons
 * Updated enrolment screenshot
 * Gotchas

* linter appeasement

* Linter appeasement
2024-02-19 11:29:10 +00:00
Hugo ShakaandPaul Gottschling 90c5ea6e5b Document managing users, roles and accesslists through IaC (#36622)
* Document managing users, roles and accesslists through IaC

* reformat docs/config.json

* address feedback

* Apply suggestions from code review

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

* Apply suggestions from code review

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

* align label names

* address feedback

* update teleportrole version

---------

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2024-02-13 20:04:04 +00:00
dec9de9e4f Add a guide for setting up Access Graph on-prem (#37661)
* Add a guide for setting up Access Graph on-prem

* Update docs/pages/access-graph/getting-started-on-prem.mdx

Co-authored-by: Tiago Silva <tiago.silva@goteleport.com>

* Update minimum required Teleport version

* Address review suggestions

* Note support for Amazon RDS

* Add a note about Teleport Policy

* Move license requirement to "Prerequisites"

* Bump TAG version in docs

* Address review comments

* Update docs/pages/access-graph/getting-started-on-prem.mdx

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

* Update Access Graph menu item image

* Update wording in Teleport Team notice

* Expand on requirements for the TLS certificate

* Apply suggestions from code review

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

* Move access-graph pages under access-controls

* Get rid of extraneous tags

* Add a short introduction to the guide

* Elaborate where the TAG config should live

* nit

* Rename the TAG self-hosted guide

* Fix image paths after access-graph renaming

---------

Co-authored-by: Tiago Silva <tiago.silva@goteleport.com>
Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>
Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2024-02-08 16:18:17 +00:00
STeve (Xin) Huang c26314652a [docs] IAM-auth-as-IAM-roles for Redshift (#34940)
* [docs] IAM-auth-as-IAM-roles for Redshift

* new section for iam role auth

* clarify two methods

* review comments

* fix spelling, thanks to docs lint!
2024-02-01 16:52:50 +00:00
Paul Gottschling 6c074b4ed0 Update the index page for v15 (#37124)
- Fix a minor error in the Prerequisites section that refers to the
  "prerequisites above" when they are, in fact, below.
- Update the resource view screenshot.
- Update the explanation of the UI flow for enrolling a new resource.
2024-02-01 15:28:56 +00:00
Rafał Cieślak 5d4b01231d Update Connect screenshots to match look of v15 (#37522) 2024-01-30 17:21:25 +00:00
Paul Gottschling 969ad63063 Update the Team Getting Started guide (#37340)
- Update instructions and images to match the v15 UI.
- Minor readability improvements.
- Replace `mytenant` with `example` in example URLs since we're phasing
  out the "tenant" language.
2024-01-26 17:52:03 +00:00
Nic Klaassen 8cbb77f442 docs: testplan updates (#37069)
* update EAS screenshot

* minor improvements to CloudHSM instructions
2024-01-24 01:00:39 +00:00
Steven Martin 875e9337e0 docs: updates for GCP discovery instructions (#36952)
* docs: updates for GCP discovery instructions

* Include required permissions
2024-01-23 17:41:53 +00:00
Ryan ClarkandPaul Gottschling 2644ad4e03 Update Access Graph docs with the new UI (#36336)
* Update Access Graph docs with the new UI

* Re-record the access path gif

* Swap the keys

* Change wording to graph node

* Update docs/pages/access-graph.mdx

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

---------

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2024-01-22 20:18:53 +00:00
Zac Bergquist f02b4adbf0 docs: update license download page (#36673)
Going forward, self-hosted licenses will include an anonymization
key that is not known to Teleport. Customers who run multiple
Teleport clusters can use the same license file on each cluster,
and Teleport will de-duplicate users to ensure that usage is
tracked properly.

This anonymization key is generated each time a license is downloaded,
so it's important to download the license once and reuse it rather
than performing multiple downloads.
2024-01-19 22:34:01 +00:00
Paul Gottschling 6377114afd Remove misleading diagram (#36618)
Closes #35337

The diagram in the "Getting Started" page of the "Application Access"
section has been misleading to users, as it does not indicate which
Teleport components are involved in application routing.

There is now a diagram in the Introduction page of the section that is
clearer in terms of which components are involved in Teleport
application access and how they interact. This change removes the
diagram in the "Getting Started" page.

Note that the Introduction page diagram could use some improvement--it's
pretty overwhelming--but since users who put in the effort can still use
it to identify interactions between Teleport components, we can clarify
the diagram in a future change rather than in this one.
2024-01-12 19:15:37 +00:00
Paul Gottschling d34368483f Correct trusted cluster diagram (#35981)
Closes #35709

The diagram shows leaf clusters dialing back to another leaf cluster.
The cluster on the left should be a root cluster.
2024-01-02 18:42:53 +00:00
Paul Gottschling 9b870be4b6 Add architecture diagrams to the docs (#36187)
Closes #19190

Ensure that all "\<Resource\> Access" sections of the docs include an
architecture diagram by adding diagrams to the "Server Access" and
"Application Access" sections.

The intro page of the Application Access section currently includes a
demo video. There is no elegant way to include both the demo video and
the architecture diagram. This change removes the demo video since it is
out of date.
2024-01-02 18:40:37 +00:00
Paul Gottschling c179809f18 Add Machine ID and Kubernetes access diagrams (#36024)
See #19190

This change adds architecture diagrams to the introduction pages of the
"Machine ID" and "Kubernetes Access" sections of the docs.

Making this change to the Kubernetes Access section presented an issue,
since there isn't an elegant way to include both the illustration video
that is currently on the page and the new architecture diagram. This
change replaces the video with the diagram since users tend not to spend
much time on the page.
2023-12-27 15:38:59 +00:00
caec5f35cf Ironrdp (#26874)
* adds ironrdp client and has it connect, alongside rdp-rs

* Integrates IronRDP client into the TDP png-response system. Instead of sending back chunks of the screen, its sends the full screen every time, and this is my running hypothesis for the current sticking point: a "Maximum call stack size exceeded" from the tdp client in the react app

* Changes arrayBufferToBase64 to use reduce, which fixes the "Maximum call stack size exceeded" bug

* removes convert_bgra_to_rgba which isn't needed with the bitmaps being produced by IronRDP

* Adds support for updating only a specific image region

* removes mistaken read_rdp_output_inner call from connect_rdp_inner

* Adds support for mouse input. I believe this code has race conditions for client.write_frame though this requires more research.

* Patches things up with the new IronRDP structure

Requires some modifications to IronRDP, see the corresponding commit hash
for IronRDP in lib/srv/desktop/rdp/rdpclient/Cargo.toml.

Started getting call stack overflows when manual testing again, but I'm
going to ignore those for now and focus on the version of this architecture
that passes the remoteFX encoded messages over TDP.

* Adds RemoteFX Frame to the backend

* Proof of concept for integrating a wasm module into the frontend

Building the wasm module still needs to be done manually, this was
just to get to a point where tools are configured and it can be successfully
called in both dev and prod modes.

Required that I comment out "default-src 'self'" in the CSP, this will
need to be figured out later.

We're also using a package called vite-plugin-wasm-pack whereas ironrdp
uses vite-plugin-wasm. I'm not sure why, I'm going to look into this and
swap out to vite-plugin-wasm if possible.

* Swaps out vite-plugin-wasm-pack for vite-plugin-wasm and adds build-wasm script to the teleport package.json.

vite-plugin-wasm-pack looks relatively unmaintained in comparison
to vite-plugin-wasm-pack.

build-wasm script is needed to build the wasm binary before calling vite [build]

* Adds backend structure for RPC PoC

Untested as of yet and it isn't pretty, but this more or less imitates the
RPC approach we have for directory sharing.

* hack solution which calls everything 'static. THIS IS VERY UNSAFE, WE SHOULD DO SOMETHING ELSE

* Gets the full display working end to end
with a particular commit of IronRDP. Unfortunately this commit is now
well out of date, and IronRDP had some bugs that were preventing RemoteFX
frames from being sent back.

* Full display working end to end with the updated IronRDP

* updates init_wasm_log to enable logging in the console

* updates hardcoded io_channel_id and user_channel_id

* Uses specific IronRDP sub-crates (i.e. ironrdp-session, ironrdp-tokio, etc.) rather than relying on whatever is re-exported from the ironrdp sub-crate itself

* Gets FastPathFrameResponse up to speed and the PoC is now working

* deletes all the rpc stuff which it turns out we don't need

* more cleanup including consolidating the FastPathFrame message between wasm and js, adding some comments

* Updates the documentation string for top level Client in lib.rs

* Removes hardcoded rdp server address, screen size, and username

* Swaps to online IronRDP repo

* Updates the TDP RFD with new messages
renaming them to be precise.

* remove hardcoded ip

* creates asRustBackedSlice

* removing some old todos

* Add cleanup for wasm-pack build artifacts to make clean

* Fix wasm in production builds (#27428)

* Converts the default Content-Security-Policy representation to a map
which makes it easier to programmatically add-to/overwrite the defaults
for special cases.

Also adds tests for the various custom CSPs.

* Alphabetize CSP directives for ease of testing/debugging in the future

* makes maps more easily composable

* removes commented code, and topLevelAwait() which was causing production builds to break

* Adds 'wasm-unsafe-eval' to the script-src section of the Content-Security-Policy
when a desktop session's url is detected.

The app already enforces no caching via the Cache-Control, Pragma, and
Expires headers (SetNoCacheHeaders), which means that any time the app
is requested in a new tab, the browser will always request a new index.html
which can be sent back with a new Content-Security-Policy header.

Since the only way to get to a desktop session is to either
click a link in the app which opens a new tab, or to open a new tab and
navigate to the url manually (this differs from most components, which can
be navigated to without a page reload using React Router), we can reliably
check each index.html request for a characteristic desktop session url path,
and only include the 'wasm-unsafe-eval' directive when strictly necessary
(in the spirit of the principle of least privilege).

* Removes vite-plugin-top-level-await from package.json

* moves regex to global so that it only need be compiled once

* CR fixes
updates Cargo.lock
removes commented feature flag
removes -framework SystemConfiguration
fixes makefile comment

* unsafe.SliceData

* fixes phrasing

* changes to docstring

* changes handle_tdp_fast_path_response to handle_tdp_rdp_response_pdu
so that its name is in line with its definition in RFD 0037 and
adds a more descriptive docstring.

* small fixes to comments

* preallocate RDPFastPathPDU Encode buffer

* updating comments

* Adds a detailed discussion of the Go/Rust Interface to the README (#29762)

* Aligns the codebase with the Go/Rust interface principles in the README (#29764)

* Move client functionality into Client (#29765)

* Adds the RDP Channel IDs TDP message (#27514)

* Refactoring `rdpclient` (#29766)

* Ironrdp recording playback (#28228)

* httplib.SetIndexContentSecurityPolicyWithWasm for recordings as well as desktop sessions so that the ironrdp wasm client can be used for recording playback

* Adds desktopplayback path to websocket proxy definitions so that it can be used with the dev server

* adds tdp.TypeRDPFastPathPDU as a tdp message to be recorded

* With this commit, recordings can be played back with the FastPathProcessor

Refactors tdp Client and subclass PlayerClient
such that now the classes are always constructed the same way,
and the internal representation of the screen size (the FastPathProcessor)
is either:

1. Created upon the call to Client.connect(spec) when spec is !undefined.
This is the case when the Client is being used for a desktop session.

2. Created when a client screen spec is received from the server. This is
the case when PlayerClient is being used for playback.

* Switches from sending the width/height via ur parameter string
to sending it via the client screen spec tdp message.

* changes tdpCli* to client* and adds a canvas* to the canvas related functions

* Static tokio (#30066)

* Beginnings of RdpdrBackend integration (#32814)

* Adds handling for the EstablishContextCall (#32971)

* Adds support for `ListReadersCall` and `ListReadersReturn` (#33004)

* Adds support for `GetStatusChangeCall`/`GetStatusChangeReturn` (#33056)

* Adds support for ConnectCall and ConnectReturn (#33136)

* Better error handling (#32925)

This change removes couple of unwrap that could cause panics on the Rust side and prevents panics from invalid cgo handle on the Go side.
It also sends error message from IronRDP to UI and cleans up a little final sequence of closing various goroutines in case of error or sessions end.

* Adds support for `HCardAndDispositionCall` with `ScardIoCtlCode::BeginTransaction` (#33192)

* `TransmitCall` and `TransmitReturn` (#33282)

* `StatusCall` and `StatusReturn` (#33284)

* `ReleaseContext` and refactor `handle_scard_call` (#33434)

* IronRDP clipboard sharing (#33335)

This change adds clipboard sharing to our IronRDP migration using ironrdp_cliprdr crate with out TDP-based backend (reused from rdp-rs times)

* Adds EndTransaction, Disconnect, Cancel, and IsValidContext (#33612)

* Adds support for `GetDeviceTypeId` (#33613)

* Adds support for `ReadCacheW` (#33618)

* `WriteCacheW` (#33620)

* Smartcard Login (#33712)

* `GetReaderIcon` (#33779)

* Update to IronRDP latest commit

* Removes a bunch of old deprecated code (including `rdp-rs`) (#33786)

* Pipes in `SharedDirectoryAnnounce` (#33911)

* Use tokio-boring for TLS upgrade (#33900)

This change switches TLS upgrade in our new RDP approach to tokio-boring in FIPS-compliant builds.
It also adds runtime check for FIPS mode.

Tested locally in custom Docker image.

* Update sspi (#34558)

* Break up rdpdr.rs, add support for the first directory sharing pdus (#34009)

* Adds support for `SharedDirectoryCreateRequest` and `SharedDirectoryCreateResponse`. (#34011)

* `SharedDirectoryDeleteRequest` and `SharedDirectoryDeleteResponse` (#34051)

* remove leftover code

* Server drive query information request (#34082)

* Rdp client refactor (#34122)

* Add handling for `DeviceCloseRequest` (#34139)

* Updates to `IronRDP` latest (#34744)

* Updates to IronRDP latest with a slightly different API

* remove defunct comment

* `ServerDriveQueryDirectoryRequest` and `SharedDirectoryListRequest/Response` (#34746)

* `ServerDriveQueryVolumeInformationRequest` and `ClientDriveQueryVolumeInformationResponse` (#34871)

* `DeviceControlRequest` (#34898)

* `Read` (#34914)

* `Write` (#34919)

* `SetInformation` (#35092)

* `LockControl` (#35146)

* Stack pr feedback and other cleanup (#35306)

* Adds desktop access websocket pattern to vite config

* Updates IronRDP to latest, removes manual context strings in favor of automatically generated (by this latest IronRDP commit) (#35392)

* Small line fixes, comment removal, changing license to AGPL

* Update Go/Rust interface section of README (#35590)

* Ironrdp manual docs (#35455)

* Remove unnecessary whitespace

* Refactor navigation paths in Active Directory documentation for clarity

Replaced textual descriptions with formatted paths using `>` symbols for better readability.

Having been subject to going through many such tutorials myself, I find this to be a more
user-friendly way of presenting the information. It's very common to need to go back and
forth between the documentation and the group policy manager, and having these paths in a
format that can catch the eye quickly is a big help. This also appears to be common practice
e.g.

- https://softwarekeep.com/help-center/how-to-enable-remote-desktop-on-windows
- https://www.helpwire.app/blog/remote-desktop-group-policy/

* Add instructions for enabling RemoteFX

* Add an optional step to the end of each GPO update subsection

This lets us point users to subsections individually without worrying
about reminding them that they need to run a `gpupdate /force` each
time (because its already right there in the subsection).

* lowercase "open"

* Updates configuration script to enable RemoteFX (#35461)

* Restructure Cargo workspace (#35591)

* Update `IronRDP` to latest, fix key log leak (#35707)

Updates IronRDP to latest with the changes necessary to keep up with the changes in https://github.com/Devolutions/IronRDP/pull/328. We select the `"rustls"` feature explicitly now, this is in line with our implicit choice of it as [the default](https://github.com/Devolutions/IronRDP/pull/325/files#diff-1f64036f3e460819b2b1e954803b7f266feca0e2787ca0614ae1253323944f59L19) before these latest changes.

Also creates a custom debug for `ScardBackend` so as to not leak `key_der` in the logs.

* Don't leak pin in the logs

* Updates CI to fix broken checks and builds caused by WASM introduction (#35401)

* removes SystemConfiguration framework (not sure why it was there).

* Updates cspell

* fixes TestSetRedirectPageContentSecurityPolicy

* Updates e ref to a currently-draft-PR ref.

* Fix per session mfa (#35902)

* Updating e-ref to tip of `master`

* dependency-review: Ignore cargo dependencies with invalid license specifications

* Updates OSS build-macos.yaml to support wasm-pack

---------

Co-authored-by: Przemko Robakowski <przemko.robakowski@goteleport.com>
Co-authored-by: Mike Jensen <mike.jensen@goteleport.com>
2023-12-20 23:21:14 +00:00
Paul Gottschling 9ff60d63b2 Refresh the Jira Access Request plugin guide (#35635)
Closes #14580
Closes #17528

Get the Jira guide to follow the structure of other Access Request
plugin guides, including instructions for Teleport Cloud and Machine ID
users.

Also make some small adjustments for clarity and readability:
- Flesh out the intro to include sarchitectural information.
- Make the prerequisites list more comprehensive.
- Fix the list of columns required in the project board, which is out of
  date.
- Mention the `/status` endpoint of the webhook.
2023-12-19 21:39:53 +00:00
Krzysztof Skrzętnicki 71fd30e251 Add Vitess guide (MySQL protocol) (#35650)
* Add Vitess guide (MySQL protocol)

* Update cspell
2023-12-13 11:57:22 +00:00
Nic KlaassenandPaul Gottschling 7f6314f609 docs: External Audit Storage (#35447)
* docs: External Audit Storage

* add section get started

* mention release version

* Edits for readability

- Clarify the introduction
- Move all prerequisites into a single section
- Move all how-to instructions into two "Step n/d" sections.
- Move the IAM policy example into a `Details` box.
- Separate the migration section to clarify the difference between
  enabling and disabling the feature.

---------

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-12-07 20:16:53 +00:00
Jakub NyckowskiandPaul Gottschling ef1d275e56 Add "Access Graph" docs (#35154)
* Add "Access Graph" docs

Access Graph docs have been added under slug /access-graph/. This document provides details about the Teleport Access Graph. Currently, this feature is only available to Teleport Cloud Team users and is in its preview stage.

Signed-off-by: Jakub Nyckowski <jakub.nyckowski@goteleport.com>

* Add images

Signed-off-by: Jakub Nyckowski <jakub.nyckowski@goteleport.com>

* Fix typo

Signed-off-by: Jakub Nyckowski <jakub.nyckowski@goteleport.com>

* Updated docs for Teleport Access Graph feature

Expanded documentation for Teleport Access Graph feature to include more detailed information about the usage and functionality. Additional visual aids were added to provide a clearer understanding of the concept. Also, specific instructions were included to spotlight the versatility of the feature for advanced user control and management.

Signed-off-by: Jakub Nyckowski <nyckowski.jakub@gmail.com>

* Add detailed description of Graph paths in Teleport Access Graph doc

Included detailed explanations about the allow paths and deny paths in the Teleport Access Graph documentation. This change provides users with clearer insights about accessing and managing resources. Also added imagery to visually reinforce the concepts of the Access Graph.

Signed-off-by: Jakub Nyckowski <nyckowski.jakub@gmail.com>

* Normalize the size images

Signed-off-by: Jakub Nyckowski <nyckowski.jakub@gmail.com>

* Update Access Graph documentation for clarity

This commit refines the Access Graph section of the Teleport documentation. It provides a clearer sequence of paths, detailing how they proceed from Users to Resources. Also, the description of how User Groups are created, either from Roles or accepted access requests, has been enhanced for more clarity. This aims to improve user understanding of Teleport functionalities.

Signed-off-by: Jakub Nyckowski <nyckowski.jakub@gmail.com>

* Address review comments

Signed-off-by: Jakub Nyckowski <nyckowski.jakub@gmail.com>

* Update user import details in access-graph.mdx

This update adds important information about user importation in the Teleport documentation. It specifies that local users are imported as soon as they are created, while external users are only imported when they log in for the first time.

Signed-off-by: Jakub Nyckowski <nyckowski.jakub@gmail.com>

* Refine explanation and structure of access-graph.mdx

The Teleport Access Graph documentation is updated to improve clarity and accuracy. It now explains more clearly how it visualizes access to infrastructure, expands the main components from five to eight, and refines the explanation on User Groups. Additionally, the Access Graph section is relocated within the documentation structure for better organization.

Signed-off-by: Jakub Nyckowski <nyckowski.jakub@gmail.com>

* Refine explanation and structure of access-graph.mdx

The Teleport Access Graph documentation is updated to improve clarity and accuracy. It now explains more clearly how it visualizes access to infrastructure, expands the main components from five to eight, and refines the explanation on User Groups. Additionally, the Access Graph section is relocated within the documentation structure for better organization.

Signed-off-by: Jakub Nyckowski <nyckowski.jakub@gmail.com>

* Refine explanation and structure of access-graph.mdx

The Teleport Access Graph documentation is updated to improve clarity and accuracy. It now explains more clearly how it visualizes access to infrastructure, expands the main components from five to eight, and refines the explanation on User Groups. Additionally, the Access Graph section is relocated within the documentation structure for better organization.

Signed-off-by: Jakub Nyckowski <nyckowski.jakub@gmail.com>

* Update docs/pages/access-graph.mdx

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

* Fix linter errors

Signed-off-by: Jakub Nyckowski <nyckowski.jakub@gmail.com>

---------

Signed-off-by: Jakub Nyckowski <jakub.nyckowski@goteleport.com>
Signed-off-by: Jakub Nyckowski <nyckowski.jakub@gmail.com>
Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-12-07 16:37:09 +00:00
Paul Gottschling 683d99a0c8 Update diagrams in the docs (#35143)
* Update diagrams in the docs

Closes #31324

We introduced a new Lucidchart library for adding diagrams to docs
pages. This change:

- Replaces all MermaidJS diagrams with ones that use the new library,
  which enables us to phase out the `remark-mermaid` plugin.
- Replaces some other diagrams with the new library.

* Minor tweaks to diagram images

Responds to strongeron feedback
2023-12-04 21:50:09 +00:00
Paul Gottschling 5cb625bb80 Create a guide to using Teleport with Spacelift (#28690)
* Add a guide to Teleport+Spacelift

Closes #25421

* Respond to alexfornuto feedback

* Spell fix

* Fix linter errors
2023-11-02 15:49:38 +00:00
lsgunn-teleport b1eb339d1f Replace mermaid diagram, add guided instructions, remove includes wit… (#33554)
* Replace mermaid diagram, add guided instructions, remove includes with the get context command

* Change strings to pass linter

* Update diagram text, collapse sign in steps, add Kubernetes where missing.

* Remove manual enrollment, add new next steps, modify wording around running commands

* Rename Getting Started to Enroll s Kubernetes Cluster

* Change link to registering clusters toppic
2023-10-26 18:11:50 +00:00
lsgunn-teleport 239c534a9c Remove SSL and details UI component (#33887)
* Remove SSL and details UI component

* Remove SSL from diagram
2023-10-26 18:11:25 +00:00
Paul GottschlingandIsaiah Becker-Mayer 1c72af1b93 Add hosted plugin docs (#31371)
* Add hosted Access Request plugin docs

See #29979

For the most part, the documentation for the Teleport Access Request
plugins assumes that a user is self-hosting their plugins, and contains
information for installing and configuring the plugin that is not
relevant to a user of hosted plugins.

This change edits the menu page of the Access Request plugin subsection
of the docs to add instructions for enrolling hosted Access Request
plugins. It also adds a note to the top of each guide for an Access
Request plugin with a hosted counterpart that a user can enable the
hosted version of that plugin. This anticipates a separate change to add
more detailed instructions to the hosted Access Request plugin
enrollment workflow within the Web UI.

* Update docs/pages/application-access/okta/guide.mdx

Co-authored-by: Isaiah Becker-Mayer <isaiah@goteleport.com>

---------

Co-authored-by: Isaiah Becker-Mayer <isaiah@goteleport.com>
2023-10-23 21:48:11 +00:00
Paul Gottschling 8d8e85a386 Remove unused docs image (#33266) 2023-10-23 21:32:21 +00:00
Edward Dowling 1428db0885 Update opsgenie docs (#32730)
* Update opsgenie docs

* Update config forScope for opsgenie plugin docs
2023-10-10 12:08:19 +00:00
Rafał Cieślak 26814c72aa Add missing Connect My Computer docs commits from #32798 (#33151)
* Reduce instances of "just"

* agent lifecycle -> the lifecycle of the agent

* proxy version -> Teleport Proxy Service version

* Simplify sentence about local user requirement

* Add screenshots of Connect My Computer

* Update screenshots of Connect UI
2023-10-10 08:17:38 +00:00
Gus Luxton 5930977eb2 docs: Add WinSCP to PuTTY client instructions (#32868)
* docs: Add WinSCP to PuTTY client instructions

* Restore validity section

* Restore validity section

* Formatting tweaks

* Merge lists

* Change title

* Fix docs link title to match page

* Bump tsh version for WinSCP support

* Whitelist WinSCP in spellcheck

* putty.mdx -> putty-winscp.mdx
2023-10-06 18:55:58 +00:00
Edward DowlingandZac Bergquist 23f8e2ce03 Add initial ServiceNow plugin docs (#31890)
* Add initial servicenow docs

* Add servicenow to config.json

* Clarify servicenow docs permissions

* Resize screenshot of integration page

* Remove ending admonition

* Change requester role to demo-requester

* Remove request role screenshot

* Crop add user screenshot

* Update docs/pages/access-controls/access-request-plugins/servicenow.mdx

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

* Update docs/pages/access-controls/access-request-plugins/servicenow.mdx

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

* Remove instucitons for adding users

---------

Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>
2023-09-20 20:04:53 +00:00
Paul Gottschling 732b9bbf58 Remove unused images from the docs (#32164)
Used the following command to find unused images. This lists all image
files in the docs and, for each image, searches all docs pages for
references to the image file (which include the `/img` path segment but
usually not `docs`). If there are no matches, it prints the image file
name:

```bash
$ find docs/img -name "*.png" | sed -E "s|docs/(.*)|\1|" | xargs -I{} bash -c '
grep -qR "{}" docs/pages; if [ $? -ne 0 ]; then echo {}; fi'
```

Also fixes a minor linter error that did not come up in earlier commits.
2023-09-20 18:12:08 +00:00
lsgunn-teleport fd6a9d105a Revise desktop access-Active Directory script-driven (#31389)
* Revise desktop access-Active Directory automatic

* Update title, text, and image

* tested steps

* Change the existing server description

* Fix typos

* Make the linter happy

* Updated from Paul's suggestions

* Make the linter happy
2023-09-18 20:01:54 +00:00
lsgunn-teleport b3258cafc5 docs: rewrite trusted clusters overview, how-to, and related topics (#31046)
* trusted cluster revision WIP

* Complete rewrite of trusted clusters under management/admin section

* Replace images, miscellaneous fixes

* Remove single root cluster statement

* Move the jq command examples to a separate topic

* Move lookup commands to a separate file

* Fix some spelling issues

* Some fixes and clarification

* Add leaf cluster Auth Server > Proxy service on th eroot cluster

* Add service interaction diagram

* Updates from review

* Update image

* Add an example

* Add direct and remove security vulnerability clause
2023-09-18 19:23:15 +00:00
lsgunn-teleport fbbe702384 docs: Update the desktop access introduction (#31599)
* Update the desktop introduction

* Updates from review, keep old file names and locations for now

* Replace mermaid diagram

* Update diagram

* Remove reference to Desktop Access
2023-09-18 19:19:10 +00:00
lsgunn-teleport 21369536ab docs: Desktop access: Move local Windows users content changes to a new version of the gett… (#31678)
* Move local Windows users content changes to a new version of the getting-started.mdx

* Update from review comments, remove diagram

* Remove joined to domain from the descriptions and modify next steps

* Add suffix to link
2023-09-18 19:15:01 +00:00
def6c97d22 Add Access List documentation. (#31781)
* Add Access List documentation.

Access List documentation has been added, providing a reference for Access
Lists for Teleport v14.

* Reword things, clarify unclear things, remove copy paste error.

* Migrate CLI docs.

* Show user creation via the GUI.

* Make the dumper app the concrete example in the access list guide.

* Remove references to running resources in prerequisites.

* Update docs/pages/access-controls/access-lists/reference.mdx

Co-authored-by: Roman Tkachenko <roman@goteleport.com>

* Add in admonition about audit reviews not being in Teleport yet.

* Remove language surrounding missed audit reviews leading to expired access.

* Apply suggestions from code review

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

* Make the requirements fields more clear.

* Correct typo.

---------

Co-authored-by: Roman Tkachenko <roman@goteleport.com>
Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>
2023-09-15 16:53:57 +00:00
Marek Smoliński 70238be048 [docs] Self-hosted ClickHouse Database Access (#28460) 2023-09-12 22:32:38 +00:00
Sakshyam Shah 699f1c23ad Update device trust docs (#30821)
* add dedicated page for device management and enforcement
- remove auto enrollment page
- update config.json

* update guide page to getting started, update copy to focus on day 1 usage

* update base device-trust doc with concepts.
- content is borrowed and expanded from existing doc

* update copy and links

* fix links, run linter write

* add reference to hosted Jamf plugin

* resolve review comments:
- multiple grammar update
- auto enrollment -> auto-enrollment
- add signed prereqs in enforcing ddevice trust page

* accomodate new preset roles and default auto-enrollment:
- udpated getting started guide to use preset require-trusted-device role
- minor grammar and code formating

* fix typo udpate -> update

* remove auto-enrollment default enabled admonition

* address review suggestions:
- adds resolved comments

* add clusterDefaults variable for generic code reference

* add troubleshooting to guide and enforcment page

* reference tctl edit role/access and add tsh relogin

* fix typo

* mention required role for auto-enrollment and minimum requirements

* add  in  command

* fix typo
2023-08-31 20:09:21 +00:00
STeve (Xin) Huang d617f1cb91 [docs] add Discovery Service to Database Access architecture page (#30569)
* [docs] add discovery service to Database Access architecture page

* code review comments
2023-08-18 13:42:26 +00:00
Edward Dowling 1db4f175ff Add initial rough opsgenie docs (#29309)
* Add initial rough opsgenie docs

* Add image for api key creation to opsgenie docs

* Add remaining images

* Add missing image to opsgenie docs

* Fix minor erros and remove unnecessary sections from opsgenie docs

* Add opsgenie docs to doc side menu

* Add more images and clarity to opsgenie docs

* Clarify alert behaviour in opsgenie docs

* Add example role to opsgenie docs

* Fix minor grammer and formatting mistakes

* Rename opsgenie docs page

* Add instructions to docs for creating a user via the ui

* Add explanation of annotation

* Remove unnecessary image form opsgneie docs and fix formating

* Add image for creating role in opsgenie docs

* Add back example role yaml and remove unused image

* Remove extra newline to fix linting
2023-08-16 15:22:44 +00:00