Commit Graph
17 Commits
Author SHA1 Message Date
Paul Gottschling 0fbbeff50c Replace Notices with Docusaurus syntax (#52634)
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 }' {} \;
   ```
2025-03-04 15:51:27 +00:00
Hugo ShakaandmaximumG d61d6bc46d feat(tbot): K8S Role creation is optional (#51919)
Fixes #51181.

K8S `Role` & `RoleBinding` are created by default. Their creation does not depends on the `ServiceAccount` creation anymore.

Co-authored-by: maximumG <maxime.gerges@backmarket.com>
2025-02-07 00:06:55 +00:00
Noah Stride 62c28bb692 tbot Helm Chart: Add ability to configure securityContext (#51817)
* Add ability to configure securityContext of tbot pods

* Newline at end of file
2025-02-05 09:09:57 +00:00
Hugo ShakaandTiago Silva 1b76f9743e kube-agent-update: Use the RFD-184 webapi proxy update protocol by default when possible (#50464)
* kube-agent-update: Use the RFD-184 webapi proxy update protocol by default when possible

* Update integrations/kube-agent-updater/cmd/teleport-kube-agent-updater/main.go

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

* log update group

---------

Co-authored-by: Tiago Silva <tiago.silva@goteleport.com>
2025-01-17 22:35:10 +00:00
Paul Gottschling 4a2d8916d0 Remove v13 mentions in the docs (#50831)
* Remove v13 mentions in the docs

Our policy is to remove mentions of the version prior to the most recent
deprecated version.

This change includes mentions of v13 in Helm chart values file comments.

* Clarify distroless images in Helm values

Responds to hugoShaka feedback.
2025-01-08 19:37:21 +00:00
Paul Gottschling b975c0e5f5 Correct Vale lint errors in partials (#49798)
One edge case is the `structure.architecture-h2` warning in
`docs/pages/includes/database-access/rds-proxy.mdx`. This is technically
correct, since the "How it works" section is before the "Prerequisites"
section. We can determine whether this is a bug to fix in a separate
change.
2024-12-09 19:50:55 +00:00
78fabc0ce8 [buddy] feat(charts): Give the possibility to add labels on more resources (#49624)
* 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>
2024-12-02 16:07:48 +00:00
Hugo Shaka 7aed1f6bab Add reference page for tbot Helm chart (#49131)
* Add reference page for tbot Helm chart

* Update docs/pages/reference/helm-reference/tbot.mdx

* Update docs/pages/reference/helm-reference/tbot.mdx

* Apply suggestions from code review

* fix broken link

* trick the broken markdown link checker
2024-11-18 20:53:39 +00:00
Hugo Shaka ac2d3fdce5 Make teleport container do a graceful shutdown (#48893)
* Container image should try a graceful shutdown by default

* Make grace termination period configurable in teleport-kube-agent

* re-render docs
2024-11-13 22:18:58 +00:00
Steven MartinandPaul Gottschling 45aed5896f docs: update azure postgres mysql (#48726)
* docs: update azure postgres mysql

* docs: azure postgres mysql verbiage update

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

* docs: remove admonition wrapper on instrs

* update links for generated content

---------

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2024-11-11 22:31:54 +00:00
Bernard Kim 4b008ce34e Support datadog plugin helm chart (#47075)
* Support datadog helm chart

* Support tbot integration

* Reduce doc duplication

* Remove default email

* Typo: Missing =

* Minor fixes
2024-10-18 21:28:56 +00:00
Hugo Shaka 40e4f1057e Make the Slack chart embed tbot (#46353)
* More value docs + derive the default output name

* Make the Slack chart embed tbot

* Remove vendored chart

* Try 1: avoid vendoring charts

* re-render chart ref

* Try 2: symlink subchart

* Fix helm unit tests

* Doc lint

* Fix typo

* Remove tbot.defaultOutput.secretName

* Clean Chart.yaml

* fix docs

* try to appease doc lint
2024-09-12 22:31:57 +00:00
Noah StrideandhugoShaka 3c38b4ad1b Machine ID: tbot helm chart (#44615)
* Start roughly hacking on a chart for tobt

* Start templating out the deployment spec

* Add image pull secrets

* Add more configurability to deployment spec

* Pull most config into params rather than config map

* Prefer configuring using config file

* Add to index

* Allow configuration of extraEnv

* Fix extraEnv

* Update makefile to test/lint new tbot chart

* Start adding tests for `tbot` chart

* Fix spurious newline in config mpa

* Add more tests for volumes/tolerations etc

* Appease vale linting

* Add docstrings to all values

* Add required values

* Make services/outputs manually configurable

* Use simpler storage technique

* Generate docs

* Fix linting issues

* Simple -> Basic

* Add support for fullnameoverride and nameoverride

* Add extended timeout seconds to liveness and readiness probe

* Add _config.tpl with merging

* Tweak readme for latest changes

* Allow persistence to be configured and use `secret` by default

* Further add validation

* Update snapshtos

* Fix newlining in templates

* Fixes after real testing against cluster

* More value docs + derive the default output name

* fixup! More value docs + derive the default output name

* Update cpsell

* Update Chart.yaml

* Appease prose linter

* Remove unused value

---------

Co-authored-by: hugoShaka <hugo.hervieux@goteleport.com>
2024-09-09 10:39:15 +00:00
Steven MartinandSteven Martin 44ee599303 docs: use code styling instead of shell (#46356)
Co-authored-by: Steven Martin <stevenmartin@Stevens-MBP.fios-router.home>
2024-09-06 20:41:04 +00:00
Hugo Shaka 042e85a3cf ci: Ensure Helm lint is run on helm changes (#46243)
* Lint on Helm changes rather than go changes

* Re-render Helm docs + improve out-of-sync error message

* address feedback
2024-09-04 18:20:07 +00:00
Paul Gottschling 2518243c04 Add a "generated" note to Helm ref partials (#45030)
Closes #44951

Indicate that Helm reference partials were generated and provide the
command to regenerate them.
2024-08-12 23:23:15 +00:00
Paul Gottschling dfb94c872e Simplify the docs site navigation (#44327)
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.
2024-08-05 18:04:01 +00:00