Closes#41443
The VarList component has failed to render for a long time (at least six
months). Since the component has not received widespread adoption in
docs pages, remove instances of the component in preparation for
removing the component itself from the docs engine.
* document creating SSH servers via IAC
* add links and index page
* Apply suggestions from code review
Co-authored-by: Roman Tkachenko <roman@goteleport.com>
* address feedback + fix Var XML tags
* test tctl flow and fill tctl command outputs
* fix kubernetes and terraform documentation
* make docs linter happy
---------
Co-authored-by: Roman Tkachenko <roman@goteleport.com>
* Fix RBAC issues in the host user creation guide
Closes#38801
Edit the Teleport RBAC section of the guide to ensure a working setup:
- Add a label to the node to enable host user creation.
- Edit the role we tell the reader to create in order to allow access to
nodes with the host user creation label.
- Add a new user with only the role we tell the reader to create.
To clean up the role-related section, this guide also moves information
about host user creation role fields into a `Details` box if they are
not required to complete the guide.
* Respond to r0mant feedback
* Add a Discovery Service section
Closes#38741
Add a dedicated sidebar section for the Teleport Discovery Service.
Since the Discovery Service is a separate agent service from the SSH
Service, Kubernetes Service, etc., it makes sense to add a dedicated
section for this service. In the future, we can include configuration
guides, architecture guides, etc. in this section.
To create the new section, this change moves existing auto-discovery
guides from other sections of the docs.
* Respond to hugoShaka feedback
- Move the Kubernetes application discovery docs
- Edit the "Kubernetes Access" intro to include a link to Kubernetes
auto-discovery
Fix an incorrect sitemap link. The Teleport docs engine generates the
sitemap based on the contents of `docs/pages`. This directory tree
included a file called `docs/pages/server-access/guides/openssh.mdx`,
but the `config.json` for the docs content included a redirect from this
page to `docs/pages/server-access/guides/openssh/openssh.mdx`, meaning
that a page in the sitemap became inaccessible.
This change fixes the `/server-access` section of the docs to resolve
the sitemap issue. To do so, it creates the `server-access/openssh`
directory and moves OpenSSH guides into this directory. It updates
`config.json` and the Server Access menu page accordingly.
This change also adds a missing meta description to the self-hosted
Access Graph guide.
We removed this feature in v15, so remove the guide from the docs and
add a redirect. v14 users can refer to v14 of the docs, which includes
the guide along with a deprecation notice.
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.
* Remove "Preview" designation
Teleport is moving away from the concept of a preview feature. This
change reflects this move on the docs site.
* Respond to zmb3 feedback
Restore the "Preview" note to the AI Assist page.
* Explain template variables wherever they appear
Closes#13377
Wherever a page in the docs mentions the `internal` or `external`
template variables as they apply to Teleport roles, link to the Teleport
Access Controls Reference
(docs/pages/access-controls/reference.mdx#roles).
A separate change (#32696) will expand the Access Controls Reference to
include more information on the `external` and `internal` template
variables.
* Respond to zmb3 feedback
Refer to `internal` and `external` as traits instead of template
variables.
* Apply suggestions from code review
Co-authored-by: Gus Luxton <gus@goteleport.com>
* Linter fixes
---------
Co-authored-by: Gus Luxton <gus@goteleport.com>
* Reduce the use of capitalized trusted clusters and a few other fixes
* fix a typo
* Modify the description of trusted clusters in core concepts
* Lower case cluster, add root and leaf to the description for self-hosted
* OpenSSH split into two topics
* New branch without the extraneous files
* Clarify file system permissions, add x-ref
* Fixes and clarifications from Paul's review
* wording changes, remove code from output snippet
* Typo and spelling update
* Missing file extension
* Updates from Zac's review
* typo faila > fails
* Update docs/pages/server-access/troubleshooting-server.mdx
Co-authored-by: Steven Martin <steven@goteleport.com>
---------
Co-authored-by: Steven Martin <steven@goteleport.com>
This change adds the `client_id` optio nto the Discovery Service for
Azure VMs, which sets the client ID of the managed identity for discovered
nodes to use when joining the cluster. This allows the discovered nodes
to be discovered while having multiple managed identities assigned.
* re-add agentless node manual installation docs
* fix linter issues
* Add missing closing paren
Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
* use tabs in manual install guide
* removed more ScopedBlocks I missed
* add note about upgrading to v14
* add redirect and notes linking the two guides to one another
* addressed feedback
* Apply suggestions from code review
Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
* fix links
---------
Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
This change fixes some issues with the Azure VM auto-discovery docs:
- Clarify how Teleport interacts with multiple managed identities.
- Clarify prerequisites for identities on discovered VMs.
- Add extra troubleshooting info.
This change fixes multiple issues in GCP auto-discovery docs:
- Fix mismatch between GCP token names in code and docs.
- Fix awk quote escaping in sample script.
- Rename tags to labels in matchers and config (tags is still
available for backwards compatibility).
Addresses: #31382
Fixes a malformed script in our documentation that exposes a GCP VM's
public host keys as custom metadata. The original script was poorly
escaped and would not run as written.
This patch removes the issue by replacing the string tokenisation with
`read` rather than `sed`, also simplifying the script.
See-Also: #31382
Changelog: None
* return an error when attempting to join a session of an OpenSSH node
* remove item from test plan and note to docs
* add test coverage to integration test
* fix integration test
* fixed linter issue
Fixes#23145
Clarify how to run the Teleport SSH Service in a Kubernetes environment
by editing the architecture information in the server access "Getting
Started" guide. This is an appropriate place for this information, since
this is the guide that provides instructions on protecting a server with
Teleport.
To make this clarification, mention the Teleport SSH Service and Proxy
Service explicitly, explaining how they interact. Then explain how this
setup works in a Kubernetes environment.
The documentation we have on revoking access somehow ended up buried
in a guide specific to agentless OpenSSH mode.
These concepts apply to all parts of Teleport and are not tied to
OpenSSH, so the content has been moved to the security section.
Closes#9888
* Replace multi-line ScopedBlocks with Tabs
Contributes to #30268
The documentation scope switcher tends to confuse users, and the
ScopedBlock component hides docs content based on the scope switcher. To
help remove ScopedBlocks from the docs site, this change replaces
multi-line ScopedBlocks with Tabs components if they include variations
for different scopes.
While most multi-line ScopedBlocks function like Tabs, there are a few
edge cases, which this change addresses individually.
Note that this change does not intend to remove all ScopedBlocks that
are placed inline within a paragraph. That will be the goal of a
separate change.
* Remove more ScopedBlocks (#30623)
This builds on the work done in #30616 and contributes to #30616.
* docs: include openssh instrs
* spacing
Co-authored-by: Alex Fornuto <github@alexf.co>
* replaced Node references with server
* Update notes
---------
Co-authored-by: Alex Fornuto <github@alexf.co>
Fixes#29957
Improves the page load performance of our CLI reference documentation by
splitting up the long CLI reference page. This also has other benefits,
including:
- **SEO**: Users don't need to search for the Teleport CLI reference
(and don't need to know that this page exists), but can search for a
specific tool they want reference docs for.
- **In-page search:** Users searching within a specific page will get
results for the tool they are researching, not all of Teleport's CLI
tools.
Fix messed up spelling
add missing punctuation, fir wording
Docs: Ordered and unordered list changes for lint update (#29094)
* Ordered and unordered list chnages for lint update
* Fixes from Alex's review
Docs: numbering lint warnings batch 2 (#29093)
* Change ordered and unordered lists to squash lint warnings
* Change ordered and unordered lists to squash lint warnings
* Changes for lint update
additional lint fixes
Additional fixes for linter
* Fix lint warning, make these unordered lists
* Change numbered steps, make a couple of edits
* Update the versions mentioned in the upgrade sequence
* Changed to bullets because these aren't discrete steps in the traditional sense
* Remove extra lines
* Fix lint issue
Paul Gottschling