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

Migrate from self-hosted to Teleport-enterprise cloud #40172

Merged

Conversation

oshati
Copy link
Contributor

@oshati oshati commented Apr 3, 2024

Documentation guide for Migrating from a self-hosted Teleport deployment to the Teleport Cloud

Copy link

github-actions bot commented Apr 3, 2024

🤖 Vercel preview here: https://docs-pbczgg62a-goteleport.vercel.app/docs/ver/preview

Copy link

github-actions bot commented Apr 5, 2024

🤖 Vercel preview here: https://docs-mhvlm5inf-goteleport.vercel.app/docs/ver/preview

Copy link
Contributor

@webvictim webvictim left a comment

Choose a reason for hiding this comment

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

Great work! There's lots of little nits here and it seems like a lot, but I promise I'm saving you time when this goes to docs review!

docs/pages/migrating.mdx Outdated Show resolved Hide resolved
docs/pages/migrating.mdx Outdated Show resolved Hide resolved
docs/pages/migrating.mdx Outdated Show resolved Hide resolved
docs/pages/migrating.mdx Outdated Show resolved Hide resolved
docs/pages/migrating.mdx Outdated Show resolved Hide resolved
docs/pages/migrating.mdx Outdated Show resolved Hide resolved
docs/pages/migrating.mdx Outdated Show resolved Hide resolved
docs/pages/migrating.mdx Outdated Show resolved Hide resolved
docs/pages/migrating.mdx Outdated Show resolved Hide resolved
docs/pages/migrating.mdx Outdated Show resolved Hide resolved
oshati and others added 20 commits June 13, 2024 15:51
* Edit the Enterprise migration guide

**Edit the guide for structure and style:**
   - Use title case in the title.
   - Wrap lines at 80 chars.
   - Begin H2s with "Step n/d"
   - Move the Conclusion text to the intro. How-to guides do not include
     conclusions in our docs, and this information is valuable at the start
     of the guide.
   - Use numbered steps for instructions.
   - Use relative file paths for links.
   - Minor style edits.

**Remove the "Verify connectivity" step:** This repeats instructions
from the step to deploy a cloud-hosted cluster.

**Add a note on migrating plugins and Machine ID Bots:** the guide only
includes instructions for migrating agents in the section on migrating
services. This change suggests linking to docs on migrating plugins and
Bots.

**Edit the navigation:**
  - Add a link to the navigation sidebar.
  - Edit the "Choose a Teleport Edition" intro page to (a) imply that
    cloud-hosted is the recommended solution and (b) link to the
    migration guide.

* Respond to webvictim feedback

- Reduce the overuse of `Teleport Enterprise (cloud|self-hosted)`.
- Move the note re: trusted clusters to the Prerequisites.
- Mention the `--auth` flag in `tsh login` commands.
- Fix typo.
- Add a note about the `proxy_server` field
@ptgott ptgott force-pushed the oo-Migrate-from-self-hosted-to-Teleport-enterprise-cloud branch from 76090fd to d899a18 Compare June 13, 2024 19:56
@ptgott ptgott added this pull request to the merge queue Jun 13, 2024
Copy link

🤖 Vercel preview here: https://docs-2mvfx4a8m-goteleport.vercel.app/docs/ver/preview

Merged via the queue into master with commit 7a781b0 Jun 13, 2024
38 checks passed
@ptgott ptgott deleted the oo-Migrate-from-self-hosted-to-Teleport-enterprise-cloud branch June 13, 2024 20:20
@public-teleport-github-review-bot

@oshati See the table below for backport results.

Branch Result
branch/v15 Create PR
branch/v16 Create PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants