Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Opened in error #13285

Closed
wants to merge 499 commits into from
Closed

Opened in error #13285

wants to merge 499 commits into from

Conversation

webvictim
Copy link
Contributor

ptgott and others added 30 commits April 13, 2022 20:00
This change aims to make the Cloud Downloads page a bit neater
looking.
Backport #11882
Documentation for SQL Backend #11048.
Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
…gistered names. (#11800) (#11884)

* Include the possible connector values if supplied value is invalid.

* Update messaging for auth flag.

* Return error message from failed ping response.

* Collect the connector names in the existing loops.
457a99e0 update webapps to support more MySQL audit events (gravitational/webapps#729) (gravitational/webapps#737) gravitational/webapps@457a99e0

[source: -w teleport-v9] [target: -t branch/v9]
* Move MySQL packet parsing to individual functions (#10430)

* Add audit logging for more MySQL commands (#11914)
Backports #11838

* Edit four Access Controls guides for Cloud users

See #10638

Per-session MFA

- Add scoped Tabs to the Prerequisites section
- Add a ScopedBlock so Cloud users don't see the option to enable
  per-session MFA via static config
- Minor copy-edits and organization edits. For example, turn a section
  that refers to an example in another section into an Admonition.

Dual Authorization

- Add scoped Tabs to the Prerequisites
- Use a scoped Notice for the edition warning
- Style/clarity/grammar edits
- Hide the Troubleshooting section for Cloud users

Moderated Sessions

- Change the edition warning to a scoped Notice. Since this guide
  is a conceptual guide rather than a step-by-step tutorial, there's no
  other scope-irrelevant information to hide.

Impersonation

- Add scoped Tabs to the Prerequisites
- Used ScopedBlocks to hide minor scope-irrelevant details
- Minor style/grammar/clarity edits

* Respond to PR feedback

* Respond to PR feedback
See #10633

Labels

- Turn the Prerequisites into a Tabs box for different editions.
  This means that users of one edition will not need to see
  information intended for users of another edition.

- Add misc. clarity, grammar, and style edits.

Local Users

- Use Tabs for the Prerequisites so users of one edition don't see
  information for another edition
- SSO was briefly mentioned without elaboration, so I added this to a
  Further Reading section with scoped tabs
- Use Tabs for Proxy connection instructions

Troubleshooting

- Add a note re: the relevance of the guide for Cloud users
- Add Tabs for the Getting help section so commercial or OSS users
  don't see irrelevant information
- General clarity, grammar, and style tweaks

Graceful Restarts

- Add a notice indicating how this guide is relevant for Cloud users
- Misc clarity, grammar, and style tweaks
Since we can now adjust the visibility of Admonitions based on scope,
this change explains how the `scope` and `scopeOnly` attributes work
in the Admonition component within the docs UI reference.
Fix race condition reported by TestIntegrations - Disconnection

Backport of #11737
#10817 states in the docs that the default for `authenticationSecondFactor.secondfactor` is `otp`, but it didn't actually update the values.yaml file to make this change the default. This PR addresses that mistake and brings the chart in-line with the docs.
* Delete app sessions on logout (#9873)

* feat: delete app web sessions during logout

* Apply suggestions from code review

Co-authored-by: Roman Tkachenko <roman@goteleport.com>

* refactor(auth): add VerbList action to delete user app sessions

Co-authored-by: Roman Tkachenko <roman@goteleport.com>

* test(local): change `newIdentityService` arguments

Co-authored-by: Roman Tkachenko <roman@goteleport.com>
Using the OIDC connector with Okta would fail due to an issue in our
fork of go-oidc. Update this dependency to get the fix.

Additionally, clean up the logic for syncing the connector
configuration, which was using a context.Context in order to implement
a timeout. This can be expressed in a simpler way with time.After()
* Edit the Database Access GUI guide for Cloud users

See #10637

- Add a Prerequisites section with tabs for different scopes
- Use a ScopedBlock so the "Get connection information" section only
  shows connection options that are relevant to a particular scope.
- Where the guide refers to a particular "tsh" command that doesn't
  apply to all scopes, refer to the "Get connection information"
  section instead.
- Light copy-edits for style, clarity, and grammar

* Respond to PR feedback
Backports #11710

While editing guides in certain sections to accommodate Cloud users
(#10631), I introduced some inconsistencies into the way the
Prerequisites sections in these guides provide instructions for users
of Cloud, Open Source, and Enterprise Teleport.

This change adds a partial that provides tabbed instructions to users
of different Teleport editions when a guide requires a running Auth and
Proxy Service. It then includes this partial where relevant in guides
that fall under the scope of #10631.

This helps ensure that cross-edition instructions are consistent in our
guides, and makes it easier to edit additional guides to accommodate
users of different editions.

Caveats:

- Since this change covers a lot of guides, it aims to be as small as
  possible. While all of these guides included links in their
  Prerequisites sections, for example, replacing these links with full
  instructions was out of the scope of this guide. This change should
  still make it easier to make further edits, e.g., in response to
  #11538.

- We still need to change other elements of some guides to accommodate
  Cloud users. The current change only aims to standardize the
  Prerequisites section.
This is the docs counterpart to #11718

Backports #11948 

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

* Prepare five guides for Cloud users

Configuration reference

- Add a tabbed warning box, which incorporates the existing warnings
  into a single Admonition (to avoid Admonition clutter) and add
  instructions for Cloud users.

Backends

  Add a compatibility note for Cloud users. There is little else we
  can do at this point since it is not currently possible to adjust
  the visibility of an entire page of the docs site based on the scope
  selector.

EC2 node labels guide

- Add Tabs to the Prerequisites section so users don't see scope-
  irrelevant content.

- Misc. clarity/style/grammar edits.

Audit Logs guide

- Prevent Cloud, Enterprise, or OSS users from seeing scope-irrelevant
  information by using Tabs.

- Note that this change does not attempt to update the list of audit
  event types, since doing so would exceed the time I allotted for
  updating this guide.

Docker setup guide

- Remove the image.mdx partial, since it is only used once.
- Create a partial for the Enterprise Docker image table.
- Use Tabs to display different instructions for users of different
  Teleport editions.

* Respond to PR feedback

* Respond to PR feedback
These tests are regularly registering false failures, likely due to rate limiting on the web hosts which are serving the external links.
* Edit three guides to support Cloud users

See #10633

Upgrading

- Misc. grammar/style/clarity tweaks
- Add details re: checking the Cloud Proxy/Auth versions for Cloud
  users
- Add a scoped Tabs component for the upgrade sequence
- Remove the "upgrading to Teleport 4.0+" section since we no longer
  support this version

Backup and restore

- Add scoped Tabs components where instructions vary between editions
- Misc clarity/grammar/style improvements

Authentication

Use Tabs to ensure that readers who have selected one scope don't see
content that is relevant only for other scopes.

* Respond to PR feedback

* Respond to PR feedback
* Edit three Setup guides for Cloud users

Teleport Daemon

- Use a Notice for a warning re: the Auth Service scoped to
  self-hosted users
- Misc grammar/style/clarity tweaks

Move the Enterprise License File page

The page does not belong in the Setup section, since it does not
apply to Cloud and OSS users. I have moved the page into the
Enterprise section.

Networking guide

- Add tabbed instructions so users who have selected a given scope
  don't see content for other scopes.

- Mention auth_service.proxy_listener_mode instead of
  tls_routing_enabled for self-hosted readers

- Misc grammar, style, and clarity edits

Scaling

  We already added an edition warning in a Details box, but I thought
  a Notice would be more prominent. I've also added some minor grammar,
  style, and clarity tweaks.

* Address PR feedback

- Imply that there are non-Auth/Proxy services beside Nodes
- Remove "shell" where it is unnecessary
- Revert the "HTTP CONNECT" section to where it was before this
  change. The copy-edits were inaccurate, but I don't have time
  to perform the edits agin more carefully.

* Address PR feedback

Simplify the HTTP CONNECT section by bringing the example closer
to the explanation of this functionality and removing some
ambiguity over whether one or both of HTTPS_PROXY and HTTP_PROXY are
required. The original text suggested that either is required, then
that both are required. The new text says to assign both, then
explains why.
* Prepare more Setup guides for Cloud users

TLS Routing Migration

  Added a compatibility note for Cloud users. Unfortunately there is
  nothing else we can do until we can come up with a way to adjust
  the visibility of whole pages based on the scope picker.

Running Teleport on GCP and IBM Cloud

  Both of these guides assume throughout that you are deploying the
  Auth Service, Proxy Service, and Auth Service storage backend. There
  is very little relevant information for Cloud users.

  Since making these guides relevant for Cloud users would require
  research and rewriting, which is out of scope for issue #10633, this
  change adds a Notice component to these guides explaining their
  relevance.

Reducing the Blast Radius

  This guide already includes instructions for Cloud users. This
  change includes the tctl.mdx partial to ensure that Cloud users
  know to log in first before running tctl commands.

Resources reference

- Add Tabs in the introduction where guidance differs for Cloud and
  Self-Hosted users.

- Include the tctl.mdx partial in the Introduction so users know how
  to connect to their Teleport cluster in order to perform tctl
  commands.

- Edit the introductory sections of the post for clarity and style.

  Note that this change does not attempt to fill in missing dynamic
  resource types within the reference list, as this would be outside
  the time I allotted to work on issue #10633.

CLI reference

- Add instructions for Cloud users via a Notice above the roles table
  and tabbed instructions above the tctl section.
- Add an entry for the Windows Desktop Service in the roles table.
- Perform some light copy editing, e.g., removing somewhat confusing
  links from H4 headings and making minor style tweaks. A comprehensive
  refresh of the CLI reference is out of scope of my work on issue
  #10633.

* Respond to PR feedback

* Address PR feedback
stevenGravy and others added 28 commits June 1, 2022 11:32
* Demonstrate usage of `golden` for tbot template generation tests. (#12898)

* Refactor tbot (#12855)

* start refactoring tbot to have a core struct

* refactor tbot into lib/

* move `tbot` subpackages to `lib/tbot`

* remove mutex pointer

* move `tshwrap` to `lib/` from `/tool/tbot/`

* move new template ssh client render test to lib/

* address pr feedback

* add request changed
* Make the Daemon guide easier to follow

See #11841

This change organizes the Daemon guide into a step-by-step tutorial
that users can follow more easily.

- Clarify the title a bit more.
- Remove the table of commands. This is covered more fully in the CLI
  reference (which this links to) and isn't strictly relevant to the
  purpose of this guide, setting up Teleport as a systemd unit.
- Add a Prerequisites section.
- Organize body sections into steps.
- Add installation and "teleport configure" commands, which are
  necessary for the systemd service to run.

* Respond to PR feedback
Signed-off-by: Michael McAllister <michael.mcallister@goteleport.com>
* docs: remove mention of Teleport Pro from FAQ (#12702)

Closes #7626

* docs: remove _ from valid subdomain characters (#12697)

Fixes #10137

* docs: add missing whitespace (#12696)

Fixes #10337
This change fixes a bug in EC2 labels (#12593) involving concurrent writes to the labels map. This is fixed by making EC2.Get() return a copy instead of the actual label map.
The instance metadata client added in #12593 significantly slows down integration tests. This change adds a disabled client to integration tests to improve performance.
This change skips over EC2 tag keys that aren't valid Teleport label keys.
* Make the Adding Nodes guide more usable

See: #11841

This change makes the Adding Nodes guide more usable for self-hosted
clusters based on manual testing.

- Make it clearer that you can use tctl on your local machine with
  a self-hosted cluster. For convenience, all instructions in this guide
  assume you are using tctl from a local machine.

- Misc. minor edits for clarity.

- Move different methods of using tokens into Details boxes, since
  following the guide only requires the first "tctl nodes add" command.

- Use environment variables to store the CA pin, invite token, and
  Proxy/Auth address, making it slightly more convenient to copy the
  "teleport start" command and run it on the Node.

- Turn the Node Tunneling section into a Details box below the
  instruction to assign the Auth/Proxy address to an environment
  variable, and better integrate the text into the guide. Previously,
  the Node Tunneling section also advised the reader to create
  a token, which they would have doe already at this point in the guide.

* Respond to PR feedback

Also remove some erroneous command output
If a reader uses the docs version picker to select "Older Versions",
they will navigate to a page where the current version is still
the version they had previously selected. This change adds a link to
the main docs site to make navigation easier.

This is a provisional solution to tide us over until we have a better
way to handle unsupported versions in our docs version picker.
* Flesh out CAP instructions

Closes #11840

Since Cloud accounts begin with a cluster_auth_preference resource,
you need to obtain your current resource via tctl get and make changes,
rather than creating a fresh one. This changes Cloud instructions in
several guides to reflect this.

Also use the same instructions for self-hosted users. If a CAP does
not exist on the backend, the shell redirection used in the
"tctl get" command will result in an empty file, which follows the
existing instructions with minimal changes.

Also update the instructions related to u2f in the Reducing the
Blast Radius guide.

* Respond to PR feedback
Backports #12525

* Edit tctl instructions to clarify remote login

Closes #11464

- Ensure that all example tctl commands are accompanied either by
  instructions to log in to the cluster or the tctl.mdx partial.

- Edit the guides in the Architecture section to remove notes that
tctl can only be used locally to the Auth Service.

- Edit the user-client-rereqs partial to mention tctl for all
  editions, since you can log in to tctl remotely for all editions.

Not editing guides where:

- tctl is run via kubectl exec
- tctl is not mentioned in a code block, i.e., only in passing, and
  a reader isn't expected to run the command on their own while
  following the guide.
- The user is already expected to run tctl on the Auth Service. The
  docker-compose Getting Started guide is an example of this.

* Respond to PR feedback

- Provide more context on authenticating with tctl in the CLI reference
- Update the link to more information re: tctl in the architecture
  overview, and indicate that tctl users must authenticate.
- Minor tweaks.

* Respond to PR feedback

- Rephrase the authentication paragraph in the Architecture Overview.
#11684 added support for proxy protocol v2 for SSH and Postgres but MySQL uses different code path and it was missing. This change fixes that.
It also adds tests for v2 protocol support for MySQL, Postgres, Mongo and Redis

(cherry picked from commit 17fc073)
Currently, the main body content of the docs home page links to
sections related to individual resources (Server Access, Application
Access, etc.). For users visiting the docs for the first time, it's
difficult to determine what is involved in getting started with
Teleport.

This change organizes the docs landing page to imply that there is a
progression from one stage of the user's setup to the next.

See #12787

- Add headings for different stages of setting up Teleport.
- Add links to a Getting Started guide for each edition that includes a
  "scope" query so users are given the appropriate scope (this partially
  addresses #12773).
- Edit the initial list of Teleport benefits to be more general and
  encompass more functionality.
- Very light copy-editing of the text in the tile lists at the bottom
  of the page.
* Label desktops based on the content of LDAP attributes

This allows users to configure an optional set of LDAP attributes
which will be included in all LDAP queries. Teleport uses these
attributes when labeling desktops.

Updates #12326
* docs: Fix proxy config for GCP

* Additional proxy config, plus ACME

* Update docs/pages/setup/deployments/gcp.mdx
Searched for all locations where s3:ListBucketMultipartUploads is currently required and added it.

Co-authored-by: Gus Luxton <gus@goteleport.com>
bbb35a39 Fix null role response from users fetch (gravitational/webapps#871) (gravitational/webapps#872) gravitational/webapps@bbb35a39

[source: -w teleport-v9] [target: -t branch/v9]
The PodSecurityPolicy specifies `MustRunAsNonRoot` but the image runs as root.
`Error: container has runAsNonRoot and image will run as root (pod: "<redacted>", container: teleport).`
We expose the securityContext to allow forcing to run as a non-root user such as 99 (nobody) and respect the psp.

Co-authored-by: daquinoaldo <aldd@bendingspoons.com>
@webvictim webvictim closed this Jun 8, 2022
@webvictim webvictim changed the title gus/v9/backport 13016 Opened in error Jun 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet