Skip to content

Add Teleport Team docs#26523

Merged
ptgott merged 7 commits intomasterfrom
paul.gottschling/2023-05-team
May 19, 2023
Merged

Add Teleport Team docs#26523
ptgott merged 7 commits intomasterfrom
paul.gottschling/2023-05-team

Conversation

@ptgott
Copy link
Copy Markdown
Contributor

@ptgott ptgott commented May 18, 2023

No description provided.

ptgott added 4 commits May 18, 2023 14:27
- Remove the Teleport Enterprise Cloud Getting Started guide, since this
  assumes that you have signed up for an Enterprise Cloud trial.
  Instead, users will sign up for a Team trial to add their first
  resource and follow a new guide to using Teleport Team.
- Move references to Teleport Team first in lists of Teleport editions,
  since this is the intended first step for self-service users.
- Update screenshots
- Move Docker instructions to a Details box and make Docker optional,
  with the idea that Linux and macOS users could join their workstations
  to their Teleport cluster.
In this test environment, there was no support for ARM on macOS.
Requiring a container ensures consistency between environments.
Comment thread docs/config.json Outdated
Comment thread docs/pages/choose-an-edition/introduction.mdx
Comment thread docs/pages/choose-an-edition/introduction.mdx Outdated
Teleport Team makes it easier for small organizations to get started with
enabling secure access to their infrastructure. It includes a subset of Teleport
Enterprise Cloud features, and teams can switch to Teleport Enterprise Cloud
as they scale up their Teleport usage.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Alternate option.

Suggested change
as they scale up their Teleport usage.
as they scale up their infrastructure.

Since it's their own environment that will scale, and Teleport scales with it..

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Ah, nice. I'll change to "scale up" in general, since it can imply adding users

Comment thread docs/pages/choose-an-edition/teleport-team.mdx Outdated
Comment thread docs/pages/choose-an-edition/teleport-team.mdx Outdated
Comment on lines +95 to +97
The rest of the guide assumes that you will run it as a non-`root` user, but the
shell in the container you created earlier is running as root. Alias `sudo` to
override this:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This sounds odd to me. If it's "the guide" which we wrote, then we could write it to not use sudo. Instead, can we rephrase this to say that the Teleport web UI provides example commands assuming a non-root user?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

To make this clearer/simpler, I've moved this text just before the instructions to copy the installation script:

The Teleport installation script uses `sudo`, which is not installed on your
Docker container. Alias `sudo` in your container terminal to override this:

```code
$ alias sudo=""
```

Copy the script and paste it into the shell you opened earlier on your Docker
container.

Comment thread docs/pages/choose-an-edition/teleport-team.mdx Outdated
Comment thread docs/pages/choose-an-edition/teleport-team.mdx Outdated
Comment thread docs/pages/includes/edition-comparison.mdx Outdated
@ptgott ptgott requested a review from alexfornuto May 19, 2023 20:00
@ptgott ptgott enabled auto-merge May 19, 2023 20:15
@ptgott ptgott added this pull request to the merge queue May 19, 2023
Merged via the queue into master with commit 1296b06 May 19, 2023
@ptgott ptgott deleted the paul.gottschling/2023-05-team branch May 19, 2023 20:32
@public-teleport-github-review-bot
Copy link
Copy Markdown

@ptgott See the table below for backport results.

Branch Result
branch/v11 Failed
branch/v12 Failed
branch/v13 Create PR

ptgott added a commit that referenced this pull request May 19, 2023
Backports #26523

* Add documentation for Teleport Team

- Remove the Teleport Enterprise Cloud Getting Started guide, since this
  assumes that you have signed up for an Enterprise Cloud trial.
  Instead, users will sign up for a Team trial to add their first
  resource and follow a new guide to using Teleport Team.
- Move references to Teleport Team first in lists of Teleport editions,
  since this is the intended first step for self-service users.

* Update the Teleport Team guide

- Update screenshots
- Move Docker instructions to a Details box and make Docker optional,
  with the idea that Linux and macOS users could join their workstations
  to their Teleport cluster.

* Require a Docker container again

In this test environment, there was no support for ARM on macOS.
Requiring a container ensures consistency between environments.

* Add a diagram

* Fix links

* Linter fixes

* Respond to alexfornuto feedback
ptgott added a commit that referenced this pull request May 22, 2023
Backports #26523

* Add documentation for Teleport Team

- Remove the Teleport Enterprise Cloud Getting Started guide, since this
  assumes that you have signed up for an Enterprise Cloud trial.
  Instead, users will sign up for a Team trial to add their first
  resource and follow a new guide to using Teleport Team.
- Move references to Teleport Team first in lists of Teleport editions,
  since this is the intended first step for self-service users.

* Update the Teleport Team guide

- Update screenshots
- Move Docker instructions to a Details box and make Docker optional,
  with the idea that Linux and macOS users could join their workstations
  to their Teleport cluster.

* Require a Docker container again

In this test environment, there was no support for ARM on macOS.
Requiring a container ensures consistency between environments.

* Add a diagram

* Fix links

* Linter fixes

* Respond to alexfornuto 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.

3 participants