* Reorganize the feature matrix
This change organizes the feature matrix according to the latest product
categorization scheme, and moves the feature matrix into its own guide
to make it more discoverable. While there is opportunity to rework the
rows within the feature matrix, this change minimizes the scope of the
first iteration by reorganizing the existing rows while leaving them for
the most part unchanged.
In the new feature matrix page, each Teleport product has its own
H2-level section. Product descriptions come from official Marketing
language, focusing on concrete statements about what each product
comprises and how it works and leaving out statements of value (which
are not typically found in documentation). This change does not include
sections for categories with no rows in the current table.
* Respond to zmb3 feedback
Add minor wording tweaks.
* Align cells across feature matrix tables
Make it easier for a user to follow a single column across multiple
tables of the feature matrix. Since the style sets cells to 25% width,
which assumes a table that is four cells wide, use a `style` tag so the
style only applies to the tables in the `teleport-editions.mdx` guide.
Closesgravitational/docs-website#134
* Update the MWI section of the feature matrix
Indicate that it is available for Community Edition users.
* Edit index.mdx
Apply changes made to identical language in teleport-editions.mdx.
* Respond to eglenn-teleport feedback
- Move the Community Edition column to the final place, rather than the
first, since we now want to de-emphasize Community Edition and elevate
the commercial offering.
- Edit the text to de-emphemphasize "editions", moving the description
of editions to the end of the page and linking to this from the
heading of relevant feature matrix columns.
- Remove section intro paragraphs, since the same information is
on the home page of the docs.
* Add a Teleport Identity Security section
Co-authored-by: Ben Arent <ben@goteleport.com>
* Rename MWI features
---------
Co-authored-by: Ben Arent <ben@goteleport.com>
* Add CLI reference
* Start fleshing out pages for new docs
* Link out to Terraform provider information
* Start putting together workload-identiyt-api svc reference
* Minor adjustments
* Keep hacking on reference for resource
* Keep hacking on reference
* Add to list of templating supported fields
* Add TOC
* Add rules to the example yaml
* Flesh out workload-identity-api docs page
* Add some todos
* Add skeleton of attributes page
* ADd comments
* Cross page links
* Retitle page
* Link one reference to another
* Add template for selector
* SPAG
* Fix link
* Fix TODO link
* ADd tbot start workload-identity-jwt to cli reference
* Add `workload-identity-x509` to config reference
* Start documenting join attributes
* Finish last batch of join attrs
* Add some short exsplanations/summaries
* Start explaining rules
* Shorter explanation
* Add opener to Workload Identity API and Workload Attestationreference
* SPAG
* Add docs for selector
* Fill out migration guide
* rename/reorg
* Add short note on SPIFFE Workload API
* SPAG
* Fix links
Moderated sessions are a bit confusing because we combined an existing
OSS feature (joining sessions), with an Enterprise-only feature
(requiring session join policies).
I've expanded the scope of the moderated sessions guide to make it a
"joining sessions" guide instead, and added some extra details around
RBAC for active sessions.
Updates #51116
The dots cause issues with our hosting infrastructure, which returns
404s when users make requests for Kubernetes operator reference pages
with no trailing slash.
This change returns a filename from the format function in the CRD/CRD
docs generator so we can return different file names for CRDs and their
docs. It also renames CRD docs pages to include hyphens instead of dots
and underscores, and adds redirects.
Links on Teleport-owned sites point to the default version of the docs.
Reduce the number of redirects to obey Vercel route limits by removing
redirects from `master`.
Docusaurus [sidebar
generation](https://docusaurus.io/docs/next/sidebar/autogenerated)
expects category index pages to have one of three file path conventions:
- `section/index.mdx`
- `section/README.mdx`
- `section/section.mdx`
This change standardizes category index paths on the third convention so
Docusaurus sidebar generation succeeds. We can then add checks to the
current docs site to prevent additional menu pages from violating this
convention.
This change also adds redirects to the new category index pages, and
updates internal links to pages that were moved.
Note that this change does not move all relevant menu pages. We still
need to reorganize the `reference/terraform-provider` section. Since
this section is automatically generated, we need another approach to
restructuring it.
- Add index pages to top-level docs sections. These pages do not appear
in the sidebar of the current docs engine, but are required for the
Docusaurus site to render properly. We can build them into fully
developed introductory pages in subsequent changes.
- Remove duplicate redirects.
- Remove redirect that points away from an existing page.
* update links for helm charts
* docs: update redirect links for those used in tctl, teleport
---------
Co-authored-by: Steven Martin <stevenmartin@Stevens-MacBook-Pro.local>
* Document how to use the TF provider
* fix config.json
* fixup! fix config.json
* Address first feedback wave
* Apply suggestions from code review
Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
* fix lint docs
* re-render TF docs
* workaround the broken vars in hcl code blocks
* Edits after testing the GCP docs
* Edits after testing the AWS docs
* Edits after testing the GHA docs
* Edits after testing the GitLab docs
* Edits after testing the CircleCI docs
* lint
* lint pt .2
* fix link after rebase + move resource import
---------
Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
* Add a two-part Terraform starter guide
Closes#41055
Add a learning series for users who wants to get started with managing
Teleport resources using Terraform. The guide takes the user through
some fundamental cluster setup tasks: deploying Agents, enrolling
resources, adding labels, configuring roles, and setting up SSO. The
series includes two guides:
- Part One: Enrolling resources
- Part Two: Configuring RBAC
Part One of the series is based on the "Deploy Agents with Terraform"
guide. This change adds instructions to the guide to label
infrastructure resources so the user can access those resources with the
roles configured in Part Two.
Other changes:
- Rename `agent-pool-terraform` to `terraform-starter`.
- Rename the "Dynamic Resources" guide to be more explicitly about
Infrastructure as Code. Organize this section into subsections to make
room for the new starter guide.
- Edit the Further Reading discussion in Part One. Move the static
resource discussion to Further Reading because, otherwise, there is
too much explanatory text between instructions. Also mention
auto-discovery.
* Respond partially to hugoShaka feedback
- Fix link syntax.
- Set expectations that the child modules downloaded in the two guides
are examples.
- Remove diagram with outdated logo.
- Use purpose-oriented names for TF files instead of `main.tf`
- Use `tctl terraform env` to get credentials
* Only deploy SSH Service in enroll-resources.mdx
Responds to hugoShaka feedback.
Resources that are not SSH servers registered via the SSH Service have
some complexities that don't make sense to cover in this guide. Instead,
for simplicity, the guide has the user deploy SSH Service instances,
then includes the possibility of enrolling other kinds of resources in a
"Next steps" section.
Changes:
- Remove the `agent_roles` input in the
`terraform-starter/agent-installation` module.
- Only deploy a token for the Node role, and configure the Agents
deployed by the module to only enable the SSH Service.
- Add an agent_labels input to the `agent-installation` module.
- Move non-server deployment instructions to "Next steps".
* Respond to thedevelopnik feedback
Note that you can skip the SSO step in the RBAC guide. Include links to
relevant docs.
* Respond to bernardjkim feedback
Closes#3683
We do not have a guide for moving from Community Edition to Enterprise.
The steps are nearly identical to those presented in the guide to
migrating from Enterprise (Self-Hosted) to Enterprise (Cloud). This
change repurposes the Cloud migration guide so it applies to migrations
between Teleport plans in general.
This change also moves the migration guide to the root of Admin Guides,
since it's a procedure that we want to make prominent as we encourage
OSS users to move to Enterprise.
Paul Gottschling