Commit Graph
107 Commits
Author SHA1 Message Date
Marco André Dinis 6496e223b2 Docs: fix TF role's <resource>_labels type (#18563)
It also adds an example for roles
2022-11-21 07:40:46 +00:00
Alex FornutoandZac Bergquist dde4af8e26 [Docs] Minor Config Reference Update (#18491)
* note disconnect_expired_cert applies to db sessions

* updates from review feedback

* Update docs/pages/reference/config.mdx

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

Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>
2022-11-18 21:05:54 +00:00
Paul Gottschlingandalexfornuto 9efa8094e7 Update the teleport-kube-agent reference (#17851)
* Update the teleport-kube-agent reference

Fixes #17578

Document values fields and behavior introduced by #13942.

Since the teleport-kube-agent chart now deploys more resources--and
deploys them based on more sophisticated logic--this change lists the
resources deployed by this chart and describes the conditions in which
this chart deploys them.

* Respond to PR feedback

- Fix the legacy behavior description at the top of the refernece. Also
  add this to its own H3 since it is getting a bit lengthy.

- Note that *-hook resources are removed after the upgrade finishes.

- Note that `serviceAccountName` is deprecated and expand the
  `serviceAccount.name` entry a bit.

- Add a note re: storage not being required to the "New chart
  installations" section.

- Clarify `storage.enabled` in relation to upgrades

* format tables

* add br tags to service table

In order to display the service name without a line break mid-word.

* adjust br tag placement

To avoid breaking the first column

Co-authored-by: alexfornuto <alex.fornuto@goteleport.com>
2022-11-16 21:29:50 +00:00
Travis Swientek bf9d0a2fd7 Add clarification as to the purpose of Metrics endpoint. (#17823)
* Add clarification as to the purpose of Metrics endpoint.

Added paragraph explaining purpose of Metrics endpoint, along with
suggested solution for capturing usage data.

* PR Feedback.

1. Adjusted verbiage.
2. Removed ScopedBlocks.
3. Linked to Elastic instructions.
2022-11-14 16:14:41 +00:00
Alex Fornuto 0dbb37f7cf [Docs] Fix rewrite key example. (#17496)
* add parent key of rewrite

* expand rewrite example config

* Update docs/pages/reference/config.mdx
2022-11-11 10:40:27 -06:00
Stephen Levine 4f341b89eb Docs: cluster_name and public_addr do not need to match (#15882) 2022-11-10 19:37:39 +00:00
Steven Martin 42dde44e1b Minor word corrections (#18307)
* Minor corrections for app access and powershell words

* GitHub camel case correction
2022-11-09 20:27:08 +00:00
Tiago Silva dea8dd7020 [docs] EKS & AKS auto-discovery docs (#17628)
Closes #17427
2022-11-07 22:48:01 +00:00
Paul Gottschling 228318d464 Document the flags for tsh kube login (#18169)
Closes #17582
2022-11-07 15:48:20 +00:00
Paul Gottschling 44e23e18c5 Remove the Jira Server Access Plugin guide (#17546)
Closes #14578

The Jira Cloud guide applies to all Jira deployments already, so we
don't need to maintain separate guides. This change renames the Jira
Cloud guide so it's about Jira in general.
2022-11-04 20:28:58 +00:00
Jeff Anderson b36efc2918 Add some info about s3 arguments 2022-11-03 10:34:00 -04:00
Gus LuxtonandPaul Gottschling ad924f4065 Add callouts to docs and Helm values for Kubernetes 1.23+ on EKS (#18006)
* Add callouts to docs and Helm values for Kubernetes 1.23+ on EKS

Kubernetes 1.23 introduced a requirement for EKS clusters to use a CSI (container storage interface) driver addon to provision EBS volumes as persistent volumes. Kubernetes 1.23 is now the default for new EKS clusters and since our chart uses persistence in its default mode, it will fail to deploy on EKS without this additional driver being installed.

* Apply suggestions from code review

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2022-11-02 20:18:39 +00:00
Steven Martin 0673d9e06b spell fixes (#17988) 2022-11-01 15:09:20 +00:00
rsyracuse 6c428e7c7d General improvement to CLI reference for Teleport daemon and more (#15974)
* General improvement to CLI reference for Teleport daemon and more

* fix link

* add tbot/fixes

* address config yaml

* broken link/incorrect command

* address comments/fixes

* broken link

* ptgott fixes

* end sentences

* [Updates} Fix broken Link

* remove header

* ptgott updates

* ptgott new addition

* replace tbot reference w/ CLI, spelling/tab error fixes

* remove cli from config.json

* fix link

* list item spacing
2022-10-27 18:38:49 -04:00
Brian Joerger 3001cfad07 Hardware Key docs (#17258) 2022-10-20 20:01:06 +00:00
153347e795 azure db discovery helm chart (#16867)
* Update teleport-kube-agent readme

* Add values.yaml and schema changes for azure dbs

* Add azure discovery helm lint

* Add azure discovery helm tests

* Fix schema and update snapshot

* Update lint

* Update helm chart docs reference

* Update readme

* Update docs/pages/reference/helm-reference/teleport-kube-agent.mdx

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

* Move yaml lint note to include snippet

* Update docs/pages/reference/helm-reference/teleport-kube-agent.mdx

Co-authored-by: Hugo Shaka <hugo.hervieux@goteleport.com>

* Update docs/pages/reference/helm-reference/teleport-kube-agent.mdx

Co-authored-by: Hugo Shaka <hugo.hervieux@goteleport.com>

* Add azureDatabases to list of required resources for db role in docs

* Update readme to link to docs

* Provide complete example yaml for azure db discovery helm chart

* s|dbResources|databaseResources|g in helm chart reference

* Remove --set tabs for aws and azure databases from chart reference

* Update lint to use secret as example too

* Update azure db discovery helm chart snapshot

* Update docs/pages/reference/helm-reference/teleport-kube-agent.mdx

Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com>

* Update docs/pages/reference/helm-reference/teleport-kube-agent.mdx

Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com>

* Update docs/pages/reference/helm-reference/teleport-kube-agent.mdx

Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com>

* Update docs/pages/reference/helm-reference/teleport-kube-agent.mdx

Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com>

* Update docs/pages/reference/helm-reference/teleport-kube-agent.mdx

Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com>

* Update docs/pages/reference/helm-reference/teleport-kube-agent.mdx

Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com>

* Remove shell vars in readme since we dont provide a command

Co-authored-by: Isaiah Becker-Mayer <isaiah@goteleport.com>
Co-authored-by: Hugo Shaka <hugo.hervieux@goteleport.com>
Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com>
2022-10-20 18:20:32 +00:00
49160f64b4 pr-buddy: helm: support join_params in teleport-kube-agent chart (#16351)
This contribution adds the following feature
- support for `joinParams` value to join using EC2 and IAM tokens

The PR contains the following fixes
- Fix previous secretName documentation that was incorect
- Reword authToken and joinParams documentation to explicit how values interact together
- Add unit test with `joinParams.method = token`
- Add unit tests checking secret creation
- Mark joinParams.method mandatory in JSONSchema
- Always use join_params to pass tokens
* Document requirements for IAM joining

Co-authored-by: Guilherme Sponda <sponda@archlinux.com.br>
Co-authored-by: Guilherme Sponda <guilherme.sponda@audibene.de>
2022-10-17 20:45:04 +00:00
William Loy 8af0bb8f10 docs: fix audit retention typo (#16921) 2022-10-17 13:43:11 +00:00
Alex Fornuto 63912254a5 correct disable_create_host_user reference (#16798) 2022-10-17 13:19:04 +00:00
rosstimothy f591236b33 Enhance diagnostics docs (#15648)
* Enhance diagnostics docs

The diagnostics docs were all in one page(`setup/reference/metrics.mdx`)
which made things a bit hard to find, and wasn't conducive to adding
new content.

Diagnostics information is now located at `setup/diagnostics` with each
section from the original `metrics.mdx` doc now having its own dedicated
page. The section will now show up in the navbar at
"Setup" > "Monitoring Your Cluster".

The content of the profiling page is expanded to include information from
https://github.com/gravitational/teleport/blob/740d184d1cfc69ae2e96c50ee738b13884fb232b/assets/monitoring/README.md#low-level-monitoring
to illustrate what the different profile types are, the information that
they capture, and how to retrieve them.

A new Distributed Tracing page is also added to instruct users on how to setup
the `tracing_service` to collect and export spans (the last open item
for #12241).
2022-10-14 20:05:07 +00:00
Ryan Clark dc8355f082 Neaten up the config comments for config v2 and above, remove config changelog (#17128) 2022-10-12 16:20:40 +01:00
Zac Bergquist 10aed927f9 docs: add CLI section for tctl alert create (#16976) 2022-10-10 22:28:01 +00:00
Paul Gottschling 82b199f2c0 Fix broken links (#17003)
Two links didn't render correctly and preserved the ".mdx" extension,
causing 404s for crawlers. This removes the scope param to get link
rendering to work.
2022-10-10 16:46:09 +00:00
Edoardo Spadolini 236b1b2f3c Remove the SQL backend (#17057)
* Revert "Azure AD authentication for the Postgres backend (#15757)"

This reverts commit 33c6d82dc3.

* Revert "SQL Backend (#11048)"

This reverts commit 06fef2abf1.

* Remove Postgres backend from the docs

* Remove the Postgres backend from the testplan
2022-10-07 10:40:44 +02:00
Andrew Burke db7fdff809 Add option for tsh to load all CAs (#15178)
This change adds an option to let tsh load CAs for all clusters when logging in, instead of just the current cluster.
2022-10-05 18:29:09 +00:00
Alex McGrath d18031ae71 Add docs for EC2 instance discovery (#16279)
* initial doc for ec2 instance discovery

* Resolve review comments

* Resolve review comments

* Resolve review comments

* resolve some review comments

* introduce discovery node in the initial paragraph

* Resolve comments
2022-10-05 14:53:39 +00:00
David Boslee 0edbc8252b Add documentation for proxy peering (#15790) 2022-10-04 11:00:37 -05:00
Ryan Clark e7b022de1d Fix incorrect proxy_servers mention in the config reference docs (#16962) 2022-10-04 14:30:43 +00:00
Lisa Kim bc81db4655 Use field hostname for node resource for predicate expr using "name" identifier (#16902)
* Predicate expressions using the "name" identifier will now use
  field "hostname" when `ls` querying for nodes, as expected by
  the user
* Change predicate expression for access request that use
  name identifier to using the actual json field names
2022-10-04 00:20:04 +00:00
Alex FornutoandPaul Gottschling 7162921bbc [Docs] Update and Align Metric Reference (#16857)
* format table

* Re-implement #14729

* Apply suggestions from code review

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

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2022-10-03 23:17:42 +00:00
Tiago Silva d3bc7bd7f4 Add option to disable the ServiceAccount creation for teleport-kube-agent chart (#16876)
When assigning AWS IAM permissions to Teleport, `eksctl create iamserviceaccount` command manages the ServiceAccount lifecycle. 

This PR allows any user to configure an existing Kubernetes ServiceAccount used by the agent.

Part of #11866
2022-10-03 16:25:51 +01:00
Zac Bergquist 88f369360a docs: add more details on audit log retention (#16730) 2022-09-28 21:14:28 +00:00
Ryan Clark 806a568ada Introduce config v3, add auth_server and proxy_server, remove auth_addresses (#15761) 2022-09-28 15:30:15 +00:00
rosstimothy e0721a1609 Leverage inventory control stream for instance version metrics (#16518)
* Leverage inventory control stream for instance version metrics

The version metrics relied on loading all resources in the cache on
each auth server to tally the counts. Unmarshalling items from the
cache can be quite expensive, especially when done every 15s for
all resources in a cluster. While auth servers are typically robust
machines the extra computation for calculating a single metric is
a bit costly and will grow with the cluster size.

Now that the inventory control stream provides a simple and efficient
manner to iterate over all connected instances we can leverage it
instead of the cache to calculate the version counts. This is a slight
breaking change however, as an auth server will now only be reporting
the versions of instances connected directly to itself, and not
versions for all instances within the cluster. This can easily be
worked around by aggregating the metric from all auth servers for
a cluster.

Closes #16429
2022-09-26 19:15:41 +00:00
Grzegorz Zdunek 6426500069 Change kube logged in message (#16368) 2022-09-26 15:31:22 +00:00
Bence Kiglics 41474a021d Add documentation for Slack Helm chart (#13726)
It includes an updated guide and the reference of the new Helm chart.
2022-09-26 10:11:17 +00:00
Hugo Shaka 1cf949e5c4 helm: add minReadySeconds to teleport-cluster chart (#16465)
Fixes #13129

This PR sets minReadySeconds to 15 by default. During a rollout we still have proxies that don't have tunnels to all agents, but at least agents don't end up with 0 active tunnels.
2022-09-23 14:20:03 +00:00
Alan Parra 9bc7ba815a Remove HOTP mention from reference config (#16590)
HOTP is a leftover from olden times.
2022-09-21 20:14:48 +00:00
Paul Gottschling c423c08fd3 Refresh the Enterprise Getting Started guide (#15780)
* Refresh the Enterprise Getting Started guide

Fixes #14249

Edit the Enterprise Getting Started guide based on manual testing to
make the guide up to date and easier to follow.

- Update the architectural description in the introduction
- Structure the guide, following out Linux Server guide for open source
  installations, to include Application Access
- Add DNS instructions rather than using the `--insecure` flag
- Add copy-pastable installation instructions
- Flesh out the license file instructions and add a screenshot of the
  customer portal
- Simplify the instructions for adding a local user
- Remove the docker-compose instructions, since we want the user to
  finish setting up a minimal Teleport cluster by the end of the guide,
  and these instructions begin a new step-by-step sequence. We also have
  a separate docker-compose guide that users can follow for a local
  demo
- Add a "Next steps" section and move relevant content there

* Respond to PR feedback
2022-09-21 16:27:36 +00:00
Zac Bergquist 15977aed4b docs: move S3 IAM policy into an include (#16464)
Prior to this change, the only place you could find a complete IAM
policy for using S3 to store session recordings was in the helm
deployment section.

Move the IAM policy into an include so that we can also include it
in the S3 section of the backends reference page.
2022-09-16 18:56:38 +00:00
Hugo ShakaandPaul Gottschling 920495c6d7 helm: allow custom CA in teleport-cluster without custom certs (#16325)
Provides a solution for #9298

This removes an unnecessary limitation of the Helm chart: `.Values.tls.existingCASecretName` can now be used without `.Values.tls.existingSecretName`. This allows users to trust their own CAs without building custom images.

Context:
- go's x509 library supports loading system certs based on the SSL_CERTS_FILE environment variable
- we are already using this in the chart to trust private CAs (teleport proxy needs to trust its own certs to start)
- users might want to trust custom CAs to
  - speak with a S3 backend (minio)
  - validate upstream app certs (unlike DB access you can't trust certs per-application)
  - trust another cluster
  - call an OIDC provider
- teleport-kube-agent chart already has the feature

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2022-09-16 15:53:35 +00:00
Alex FornutoandPaul Gottschling 68527f8520 [Docs] note S3 versioning requirement (#16423)
* note S3 versioning requirement

* expand from input on GH

* copy edits after talking with Jeff

* Update docs/pages/reference/backends.mdx

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

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2022-09-15 15:21:00 -05:00
Forrest Marshall 0b20709522 fix hb numbers in readyz docs 2022-09-14 10:44:34 -07:00
Hugo Shaka 6367c1415a docs: fix joinParams reference (#16346) 2022-09-13 21:23:32 +00:00
c67130052f helm: Add conditional creation of serviceAccount (#16337 and #11895)
Add conditional creation of `serviceAccount` in both `teleport-cluster` and `teleport-kube-agent` charts.

Signed-off-by: Hugo Hervieux <hugo.hervieux@goteleport.com>
Co-authored-by: nickolanick <biliaievnk@gmail.com>
Co-authored-by: Gus Luxton <gus@goteleport.com>
Co-authored-by: Mykola Biliaiev <mykola@firebolt.io>
2022-09-13 12:25:19 +00:00
Bence Kiglics c522b38383 Add documentation for MatterMost Helm chart (#13728)
Includes an updated guide and the reference of the new Helm chart.
2022-09-08 11:49:30 +00:00
Bence Kiglics 5e476ed17d Add documentation for PagerDuty Helm chart (#13729) 2022-08-31 15:57:20 +00:00
Gus Luxton 2723369543 docs: Add missing commands key to dynamic labels in reference (#15869)
Add missing commands key to dynamic labels

Somehow the `commands:` key got removed and so the reference was giving an incorrect structure.
2022-08-29 14:23:18 +00:00
Bence KiglicsandPaul Gottschling 6e246ab5c9 Add documentation for Jira Helm chart (#13730)
* Add documentation for Jira Helm chart

It includes an updated guide and the reference of the new Helm chart.

* Fixed some minor mistakes in the guides

* Reorganized Helm related examples

* Fixed a few minor mistakes

* Alphabetized jira.* settings

* Renamed Cloud to Executable in Testing

* Extended YAML config example with explanation

* Edit Jira Access Request plugin Helm chart docs

- Edit the configuration instructions so we don't instruct Helm users to
  use the `configure` subcommand. Also use the `Tabs` component's
  dropdown functionality so we can include both self-hosted and Teleport
  Cloud instructions for Helm and VM users.

- Minor style tweaks.

* Add Helm Chart example to Installation section

* Removed confusing (and broken) link
git push

* Fixed wrong default value

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2022-08-26 12:23:07 +00:00
Andrew LeFevre 7edf9c333f Merge pull request #15144 from gravitational/capnspacehook/file-copy-role-option
Added file copying role option and node config option
2022-08-24 20:13:41 +00:00