Include inlining the partial:
docs/pages/includes/machine-id/recover-circle-ci-claims.mdx
This is because it's only used by two pages and, as a partial, violates
the rule in which each Var with a given name must be used multiple
times on a single page. Since this Vale rule uses the `raw` scope, it is
not possible to ignore it with an MDX comment.
See gravitational/docs-website#91
Docusaurus uses semantic HTML tags instead of a custom Details
component. Replace instances of our Details component with the
`<details>` and `<summary>` tags so we do not need to perform a
conversion when building the docs website.
Use Docusaurus syntax for admonitions so the docs engine does not need
to replace these. This is one step toward removing the
`remark-update-tags` plugin. See: gravitational/docs-website#94
Relevant commands are included below to make reproducing this work
easier.
1. Replace all `Notice` tags with `Admonition` tags.
2. Add `type="info"` if an Admonition is missing a type.
To find instances:
```
find docs/pages -name "*.mdx" -exec awk '
BEGIN{a=0}
a==0 && /<Admonition/{ a = 1 }
a==1 && /type/{t = 1}
a==1 && />/{ a = 0; if(t == 0) print FILENAME ":" FNR }' {} \;
```
3. Replace `type="notice"` with `type="note"`.
To find instances:
```
find docs/pages -name "*.mdx" -exec awk '
BEGIN{a=0}
a==0 && /<Admonition/{ a = 1 }
a==1 && /type="notice"/{t = 1}
a==1 && />/{ a = 0; if(t == 1) print FILENAME ":" FNR }' {} \;
```
* Fix Vale warnings
Fix Vale warnings across several guides within the
`docs/pages/admin-guides` section.
* Fix Vale issues in 36 docs guides
Fix Vale warnings
Fix Vale warnings across several guides within the
`docs/pages/admin-guides` section.
This includes removing the `teleport-cluster` migration guide, which
includes some Vale issues. This was an overdue TODO item.
* feat(charts): Give the possibility to add labels on more resources
Currently it's possible to add labels on Jobs but not on Pods created by the Job. Let's allow it.
Same problem on operator subchart for deployments and pod created by the deployment.
* Fix doc indentation
* fix typo
---------
Signed-off-by: Tiago Silva <tiago.silva@goteleport.com>
Co-authored-by: emmanuel.lagree <emmanuel.lagree@mirakl.com>
Co-authored-by: Emmanuel Lagrée <36861662+elagree@users.noreply.github.com>
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.
* docs: use code instead of shell
* docs: revert generated file
* docs: update shell styling for generated file
---------
Co-authored-by: Steven Martin <stevenmartin@Stevens-MBP.fios-router.home>
- Rename misleadingly named pages related to managing Login Rules with
IaC tools.
- Organize guides into thematic subdirectories. Currently, the
Infrastructure as Code section includes all guides on one level, which
makes it difficult to navigate.
The Teleport Policy docs are currently in two sections of
`/admin-guides/access-controls` with overlapping subject areas. This
change merges the two sections into a single subsection of
`/admin-guides`.
To preserve the convention of moving all self-hosted guides into
`/admin-guides/deploy-a-cluster`, this change also moves guides to
self-hosting the Access Graph Service into
`/admin-guides/deploy-a-cluster/access-graph`.
More specific changes:
- Add a subsection of the Policy section for integrations.
- Make the Policy section a top-level section within Admin Guides, since
we add another directory, to keep the max sidebar depth at four.
- Move the contents of `/admin-guides/access-controls/access-graph` to
the `/admin-guides/teleport-policy/integrations` directory, since all
of the guides in `access-graph` had to do with integrations.
- Change the Teleport Policy Integrations page into a menu. The page
overlaps with the instructions on the AWS integration, so repurpose
the guide as an overview.
- Turn the Policy Get Started guide into a menu. The guide is a brief
overview, so it functions well as the introduction to a menu page.
- Rename the usage guide so it appears first on the auto-generated
sidebar section.
Provide a less overwhelming documentation experience for users by
condensing sidebar sections into five, organized loosely around
different audiences of the documentation:
- **Get Started:** new Teleport users, as well as users of all levels
who want to quickly look up key, frequently changing information, such
as the changelog and upcoming release information.
- **Admin Guides:** intermediate users completing a specific task. This
includes all how-to guides in the docs except those in "Get Started"
and "Enroll Resources".
- **Enroll Resources:** Admin Guides, but for our extensive library of
how-to guides for protecting infrastructure resources with Teleport.
- **References:** Advanced users looking for comprehensive reference
information and architecture guides. This includes all reference
guides in the docs.
- **User Guides:** Guides for end users looking to access resources.
Related changes:
- **Move Helm reference partials**. Use the `docs/pages/includes`
directory so we can generate the sidebar from `docs/pages/reference`.
- **Move the Architecture sidebar section** into "References", and move
architecture guides across the documentation into "Architecture".
- **Remove "Documentation Overview"** as this is out of date. Now, top-level
sidebar sections are more self explanatory.
- **Remove "Choose an Edition"**, since we want to elevate Teleport
Enterprise (Cloud), making Teleport Enterprise (Self-Hosted) available
for certain use cases.
- **Add an infrastructure as code section** to Admin Guides.
The number of sections on the left sidebar makes the documentation
difficult to navigate. This change reduces the number of sidebar
sections by creating an "Enroll Resources" section from sidebar sections
related to protecting infrastructure resources with Teleport.
This change configures the sidebar for the Enroll Resources section to
be automatically generated. Since the generator expects each
subdirectory of a section to have a corresponding table of contents
page, this change also adds missing table of contents pages.
In some cases, we can repurpose an existing section introduction page
for a section's table of contents page. In other cases, the introduction
spends too much time on providing context to make for a useful table of
contents, so this change adds a separate table of contents page. Table
of contents pages use the `(!toc!)` syntax to list links automatically
based on the file system.
This change also adds redirects based on mentions of Teleport docs URLs
in the Web UI source, and removes all other redirects to avoid exceeding
the maximum number of routes in Vercel.
* helm: Apply extraLabels to post-delete hooks
Fixes#43796
changelog: Relevant extraLabels configured in teleport-kube-agent chart values are now correctly applied to post-delete hooks
* Use extraLabels.job instead
* Re-render docs
This PR enhances teleport's intelligence by no longer assuming the cluster domain is `cluster.local`. Since many clusters use a non-default cluster domain, this assumption can disrupt app discovery access.
Fixes#39007
Signed-off-by: Tiago Silva <tiago.silva@goteleport.com>
* Add jamf_service support to the Helm chart
* Add tests for jamf_service
* Remove unnecessary comments
* Update README
* Update values schema
* Update docs
* Commit missing lint files
* Update test snapshots
* Fix Secret tests
* Update docs
* Add support for Jamf API Client Credentials
* Update snapshots
* Unify Jamf password/Client Secret into jamfSecret key in Secret
* Update snapshots
* Add lint files
* Update docs
* Update image version in tests
* Add words to a dictionary
* Apply suggestions from code review
Co-authored-by: Hugo Shaka <hugo.hervieux@goteleport.com>
* Drop support for Jamf username and password auth
---------
Co-authored-by: Hugo Shaka <hugo.hervieux@goteleport.com>
* Break up /database-access/guides/
Closes#17641
Organize the guides to enrolling databases in specific cloud providers
(or self-hosted databases) into separate subsections of the "Database
Actions" section, organized by cloud provider (or self-hosted).
We can later add general information to the index page of each
subsection about how Teleport database access works for each cloud
provider. The remaining guides in the "Guides" subsection have to do
with database-agnostic functionality of the Teleport Database Service.
This change also adds a redirect for each page it moves.
* Respond to greedy52 feedback
- In the "Database Access" intro page, move the self-hosted section
first in the list of links to database-specific guides so it's less
easy to miss.
- Change "AWS" to "Amazon" in product names.
* Fix linter issues
* Remove redirects added by the DB guide reorg
This prevents us from running into Vercel route limit issues, since the
number of redirects is large.
* dont allow disabling second factor
* update docs for 2fa change
* add environmental variable to work around disabled 2fa
* check if its cloud
* update todos
* add a test
* introduce insecure test mode
* fixes for tests
This PR allows users to set `clusterDomain` to match Kubernetes Cluster
domain address when running clusters with non default cluster domains.
Fixes#41165
Signed-off-by: Tiago Silva <tiago.silva@goteleport.com>
* Configurable podSecurityContext for auth and proxy deployments
* Lint podSecurityContext for Teleport Cluster chart
* Test podSecurityContext for auth and proxy deployments
* PodSecurityContext schema for Teleport Cluster chart
* Document podSecurityContext for Teleport Cluster chart
---------
Co-authored-by: Niek den Breeje <n.denbreeje@guardian360.nl>
* Mentioned in the documentation that we ignore "kube-system" and "kube-public" namespaces for kube app discovery.
* Use admonition
Co-authored-by: Hugo Shaka <hugo.hervieux@goteleport.com>
* Rerender kube agent docs
---------
Co-authored-by: Hugo Shaka <hugo.hervieux@goteleport.com>
* 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
* Update TAG version to 1.11.0
* Add a guide for deploying TAG using Helm
* Fix prose lint
* Add auto-generated reference for TAG Helm chart
* Apply suggestions from code review
Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
* Update TAG example role to v7
* Fix link to TAG Helm guide
* Pin TAG Helm chart version
Pins to the same version as TAG itself,
Helm chart and TAG are versioned in lockstep
* Call out the teleport Helm chart more explicitly
* Bump TAG version to 1.13.0
Expecting it to be released by the time these docs go live.
* Replace teleport-cluster parameters with Vars
* Elaborate trust of the TAG CA in Teleport
* Fix the marker style
* Fix the link to teleport-cluster reference
---------
Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
See #36816
The docs are inconsistent in using "automatic updates" vs. "automatic
upgrades". Prefer the former to be consistent with the
`teleport-ent-updater` script.
- Replace "automatic upgrade" with "automatic update" in docs pages.
- Replace "automatic upgrade" uses in the `teleport-kube-agent` chart
and regenerate the docs.
- Catch uses of "automatic upgrade" in the `consistent-terms` Vale rule
Paul Gottschling