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

Prepare five guides for Cloud users #10920

Merged
merged 3 commits into from
Apr 14, 2022
Merged

Prepare five guides for Cloud users #10920

merged 3 commits into from
Apr 14, 2022

Conversation

ptgott
Copy link
Contributor

@ptgott ptgott commented Mar 7, 2022

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.

@github-actions github-actions bot requested review from r0mant, xinding33 and zmb3 March 7, 2022 20:09
@ptgott ptgott force-pushed the paul.gottschling/10633-7 branch 2 times, most recently from 8689c83 to 0cae238 Compare March 10, 2022 20:56
@russjones russjones added the cloud Cloud label Mar 11, 2022
@ptgott ptgott force-pushed the paul.gottschling/10633-7 branch from 0cae238 to c6d46bf Compare March 14, 2022 21:24
Copy link
Contributor

@ulysseskan ulysseskan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I read through each of the changed files and everything looks good to me with the exception of one tiny grammar mistake mentioned above. I'm ready to approve once that's fixed, if other reviewer(s) are in agreement.

@ptgott ptgott force-pushed the paul.gottschling/10633-7 branch from c6d46bf to e39c0ea Compare March 16, 2022 18:56
@ptgott ptgott requested a review from ulysseskan March 16, 2022 18:56
Copy link
Contributor

@ulysseskan ulysseskan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@ptgott ptgott force-pushed the paul.gottschling/10633-7 branch 2 times, most recently from 598b3cf to 1b448cb Compare March 18, 2022 20:57
@russjones russjones added cloud-docs and removed cloud Cloud labels Mar 18, 2022
@ptgott ptgott force-pushed the paul.gottschling/10633-7 branch 2 times, most recently from 3f813c9 to 8bac803 Compare March 28, 2022 19:49
@ptgott ptgott force-pushed the paul.gottschling/10633-7 branch 3 times, most recently from 22eabf6 to bdbc746 Compare April 5, 2022 19:24
@ptgott ptgott force-pushed the paul.gottschling/10633-7 branch 3 times, most recently from b0e9044 to fabfb13 Compare April 12, 2022 18:39

```code
$ docker version
# Client: Docker Engine - Community
# Version: (=docker.version=)
```

- The Enterprise edition of the `tsh` client tool, which ships with the `teleport` binary. Visit the [customer portal](https://dashboard.gravitational.com/web/login) to download Teleport.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is no such thing as the enterprise edition of tsh. Only tctl and teleport have enterprise editions.

title: EC2 Tags as Teleport node labels
description: How to setup Teleport node labels based on EC2 tags
h1: Sync EC2 Tags and Teleport node labels
title: EC2 Tags as Teleport Node Labels
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a note - we'll be adding a first-class feature to Teleport that does this in Teleport 10 or 11, at which point this guide will become deprecated.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Created an issue to remove this when needed: #11929


1. **Cluster Events:** Teleport logs events like successful user logins along
with metadata like remote IP address, time, and the session ID.
2. **Recorded Sessions:** Every SSH or Kubernetes shell session is recorded and
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This also applies to desktop sessions.

@ptgott ptgott requested a review from zmb3 April 13, 2022 21:14
@ptgott ptgott enabled auto-merge (squash) April 14, 2022 16:30
ptgott added 3 commits April 14, 2022 12:30
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.
@ptgott ptgott force-pushed the paul.gottschling/10633-7 branch from 0f8b6a4 to 7e41607 Compare April 14, 2022 16:30
@ptgott ptgott merged commit c9a4627 into master Apr 14, 2022
@ptgott ptgott deleted the paul.gottschling/10633-7 branch April 14, 2022 16:35
ptgott added a commit that referenced this pull request Apr 14, 2022
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
ptgott added a commit that referenced this pull request Apr 14, 2022
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
ptgott added a commit that referenced this pull request Apr 14, 2022
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
ptgott added a commit that referenced this pull request Apr 15, 2022
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
ptgott added a commit that referenced this pull request Apr 15, 2022
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
ptgott added a commit that referenced this pull request Apr 15, 2022
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
ptgott added a commit that referenced this pull request Apr 15, 2022
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
ptgott added a commit that referenced this pull request Apr 15, 2022
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
ptgott added a commit that referenced this pull request Apr 15, 2022
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants