Make the Installation guide more usable #12282
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
r0mant
approved these changes
Apr 28, 2022
docs/pages/installation.mdx
Outdated
|
|
||
| |Chart|Included Services|Values Reference| | ||
| |-|-|-| | ||
| |`teleport-cluster`|Auth Service<br/>Proxy Service|[Reference](kubernetes-access/helm/reference/teleport-cluster.mdx) |
There was a problem hiding this comment.
You can provide your own custom config to teleport-cluster chart and enable any of the other services too, not just auth/proxy.
Comment on lines
+132
to
+136
| The Teleport package in Homebrew is not maintained by Teleport and we can't | ||
| guarantee its reliability or security. We recommend the use of our [official | ||
| Teleport packages](https://goteleport.com/teleport/download?os=mac). |
There was a problem hiding this comment.
I would consider making this a warning admonition.
zmb3
approved these changes
Apr 29, 2022
See #11841 - Combined two H2s related to OS support - Fleshed out the Docker section: The current instructions only show a "docker pull" command. Since users will likely be using other methods to run containers from our images (e.g., a docker-compose config or "docker run", which pulls the image automatically), I added more context around the available Docker images. - Updated the latest Docker image version - Fleshed out the Helm section: Added updated information and more detail about our charts. - Cleaned up the macOS installation instructions. Use updated installer links. Combine the "Installer" and "Terminal" tabs, since both use our installer endpoints. Add instructions for checking Teleport versions to the Homebrew tab. - Move comments in the Checksums section above commands so it is possible to copy the code snippet and run the commands from a terminal. - Mention tbot - Update PowerShell installation instructions. As written, they did not work for me when I tested them.
ptgott
force-pushed
the
paul.gottschling/11841-9
branch
from
1418df9 to
5655ae1
Compare
ptgott
added a commit
that referenced
this pull request
May 2, 2022
Backports #12282 * Make the Installation guide more usable See #11841 - Combined two H2s related to OS support - Fleshed out the Docker section: The current instructions only show a "docker pull" command. Since users will likely be using other methods to run containers from our images (e.g., a docker-compose config or "docker run", which pulls the image automatically), I added more context around the available Docker images. - Updated the latest Docker image version - Fleshed out the Helm section: Added updated information and more detail about our charts. - Cleaned up the macOS installation instructions. Use updated installer links. Combine the "Installer" and "Terminal" tabs, since both use our installer endpoints. Add instructions for checking Teleport versions to the Homebrew tab. - Move comments in the Checksums section above commands so it is possible to copy the code snippet and run the commands from a terminal. - Mention tbot - Update PowerShell installation instructions. As written, they did not work for me when I tested them. * Respond to PR feedback
ptgott
added a commit
that referenced
this pull request
May 2, 2022
Backports #12282 * Make the Installation guide more usable See #11841 - Combined two H2s related to OS support - Fleshed out the Docker section: The current instructions only show a "docker pull" command. Since users will likely be using other methods to run containers from our images (e.g., a docker-compose config or "docker run", which pulls the image automatically), I added more context around the available Docker images. - Updated the latest Docker image version - Fleshed out the Helm section: Added updated information and more detail about our charts. - Cleaned up the macOS installation instructions. Use updated installer links. Combine the "Installer" and "Terminal" tabs, since both use our installer endpoints. Add instructions for checking Teleport versions to the Homebrew tab. - Move comments in the Checksums section above commands so it is possible to copy the code snippet and run the commands from a terminal. - Mention tbot - Update PowerShell installation instructions. As written, they did not work for me when I tested them. * Respond to PR feedback
ptgott
added a commit
that referenced
this pull request
May 2, 2022
Backports #12282 * Make the Installation guide more usable See #11841 - Combined two H2s related to OS support - Fleshed out the Docker section: The current instructions only show a "docker pull" command. Since users will likely be using other methods to run containers from our images (e.g., a docker-compose config or "docker run", which pulls the image automatically), I added more context around the available Docker images. - Updated the latest Docker image version - Fleshed out the Helm section: Added updated information and more detail about our charts. - Cleaned up the macOS installation instructions. Use updated installer links. Combine the "Installer" and "Terminal" tabs, since both use our installer endpoints. Add instructions for checking Teleport versions to the Homebrew tab. - Move comments in the Checksums section above commands so it is possible to copy the code snippet and run the commands from a terminal. - Mention tbot - Update PowerShell installation instructions. As written, they did not work for me when I tested them. * Respond to PR feedback
ptgott
added a commit
that referenced
this pull request
May 4, 2022
Backports #12282 * Make the Installation guide more usable See #11841 - Combined two H2s related to OS support - Fleshed out the Docker section: The current instructions only show a "docker pull" command. Since users will likely be using other methods to run containers from our images (e.g., a docker-compose config or "docker run", which pulls the image automatically), I added more context around the available Docker images. - Updated the latest Docker image version - Fleshed out the Helm section: Added updated information and more detail about our charts. - Cleaned up the macOS installation instructions. Use updated installer links. Combine the "Installer" and "Terminal" tabs, since both use our installer endpoints. Add instructions for checking Teleport versions to the Homebrew tab. - Move comments in the Checksums section above commands so it is possible to copy the code snippet and run the commands from a terminal. - Mention tbot - Update PowerShell installation instructions. As written, they did not work for me when I tested them. * Respond to PR feedback
ptgott
added a commit
that referenced
this pull request
May 4, 2022
Backports #12282 * Make the Installation guide more usable See #11841 - Combined two H2s related to OS support - Fleshed out the Docker section: The current instructions only show a "docker pull" command. Since users will likely be using other methods to run containers from our images (e.g., a docker-compose config or "docker run", which pulls the image automatically), I added more context around the available Docker images. - Updated the latest Docker image version - Fleshed out the Helm section: Added updated information and more detail about our charts. - Cleaned up the macOS installation instructions. Use updated installer links. Combine the "Installer" and "Terminal" tabs, since both use our installer endpoints. Add instructions for checking Teleport versions to the Homebrew tab. - Move comments in the Checksums section above commands so it is possible to copy the code snippet and run the commands from a terminal. - Mention tbot - Update PowerShell installation instructions. As written, they did not work for me when I tested them. * Respond to PR feedback
ptgott
added a commit
that referenced
this pull request
May 4, 2022
Backports #12282 * Make the Installation guide more usable See #11841 - Combined two H2s related to OS support - Fleshed out the Docker section: The current instructions only show a "docker pull" command. Since users will likely be using other methods to run containers from our images (e.g., a docker-compose config or "docker run", which pulls the image automatically), I added more context around the available Docker images. - Updated the latest Docker image version - Fleshed out the Helm section: Added updated information and more detail about our charts. - Cleaned up the macOS installation instructions. Use updated installer links. Combine the "Installer" and "Terminal" tabs, since both use our installer endpoints. Add instructions for checking Teleport versions to the Homebrew tab. - Move comments in the Checksums section above commands so it is possible to copy the code snippet and run the commands from a terminal. - Mention tbot - Update PowerShell installation instructions. As written, they did not work for me when I tested them. * Respond to PR feedback
ptgott
added a commit
that referenced
this pull request
May 11, 2022
Backports #12282 * Make the Installation guide more usable See #11841 - Combined two H2s related to OS support - Fleshed out the Docker section: The current instructions only show a "docker pull" command. Since users will likely be using other methods to run containers from our images (e.g., a docker-compose config or "docker run", which pulls the image automatically), I added more context around the available Docker images. - Updated the latest Docker image version - Fleshed out the Helm section: Added updated information and more detail about our charts. - Cleaned up the macOS installation instructions. Use updated installer links. Combine the "Installer" and "Terminal" tabs, since both use our installer endpoints. Add instructions for checking Teleport versions to the Homebrew tab. - Move comments in the Checksums section above commands so it is possible to copy the code snippet and run the commands from a terminal. - Mention tbot - Update PowerShell installation instructions. As written, they did not work for me when I tested them. * Respond to PR feedback
ptgott
added a commit
that referenced
this pull request
May 11, 2022
Backports #12282 * Make the Installation guide more usable See #11841 - Combined two H2s related to OS support - Fleshed out the Docker section: The current instructions only show a "docker pull" command. Since users will likely be using other methods to run containers from our images (e.g., a docker-compose config or "docker run", which pulls the image automatically), I added more context around the available Docker images. - Updated the latest Docker image version - Fleshed out the Helm section: Added updated information and more detail about our charts. - Cleaned up the macOS installation instructions. Use updated installer links. Combine the "Installer" and "Terminal" tabs, since both use our installer endpoints. Add instructions for checking Teleport versions to the Homebrew tab. - Move comments in the Checksums section above commands so it is possible to copy the code snippet and run the commands from a terminal. - Mention tbot - Update PowerShell installation instructions. As written, they did not work for me when I tested them. * Respond to PR feedback
ptgott
added a commit
that referenced
this pull request
May 11, 2022
Backports #12282 * Make the Installation guide more usable See #11841 - Combined two H2s related to OS support - Fleshed out the Docker section: The current instructions only show a "docker pull" command. Since users will likely be using other methods to run containers from our images (e.g., a docker-compose config or "docker run", which pulls the image automatically), I added more context around the available Docker images. - Updated the latest Docker image version - Fleshed out the Helm section: Added updated information and more detail about our charts. - Cleaned up the macOS installation instructions. Use updated installer links. Combine the "Installer" and "Terminal" tabs, since both use our installer endpoints. Add instructions for checking Teleport versions to the Homebrew tab. - Move comments in the Checksums section above commands so it is possible to copy the code snippet and run the commands from a terminal. - Mention tbot - Update PowerShell installation instructions. As written, they did not work for me when I tested them. * Respond to PR feedback
ptgott
added a commit
that referenced
this pull request
May 11, 2022
Backports #12282 * Make the Installation guide more usable See #11841 - Combined two H2s related to OS support - Fleshed out the Docker section: The current instructions only show a "docker pull" command. Since users will likely be using other methods to run containers from our images (e.g., a docker-compose config or "docker run", which pulls the image automatically), I added more context around the available Docker images. - Updated the latest Docker image version - Fleshed out the Helm section: Added updated information and more detail about our charts. - Cleaned up the macOS installation instructions. Use updated installer links. Combine the "Installer" and "Terminal" tabs, since both use our installer endpoints. Add instructions for checking Teleport versions to the Homebrew tab. - Move comments in the Checksums section above commands so it is possible to copy the code snippet and run the commands from a terminal. - Mention tbot - Update PowerShell installation instructions. As written, they did not work for me when I tested them. * Respond to PR feedback
ptgott
added a commit
that referenced
this pull request
May 11, 2022
Backports #12282 * Make the Installation guide more usable See #11841 - Combined two H2s related to OS support - Fleshed out the Docker section: The current instructions only show a "docker pull" command. Since users will likely be using other methods to run containers from our images (e.g., a docker-compose config or "docker run", which pulls the image automatically), I added more context around the available Docker images. - Updated the latest Docker image version - Fleshed out the Helm section: Added updated information and more detail about our charts. - Cleaned up the macOS installation instructions. Use updated installer links. Combine the "Installer" and "Terminal" tabs, since both use our installer endpoints. Add instructions for checking Teleport versions to the Homebrew tab. - Move comments in the Checksums section above commands so it is possible to copy the code snippet and run the commands from a terminal. - Mention tbot - Update PowerShell installation instructions. As written, they did not work for me when I tested them. * Respond to PR feedback
ptgott
added a commit
that referenced
this pull request
May 11, 2022
Backports #12282 * Make the Installation guide more usable See #11841 - Combined two H2s related to OS support - Fleshed out the Docker section: The current instructions only show a "docker pull" command. Since users will likely be using other methods to run containers from our images (e.g., a docker-compose config or "docker run", which pulls the image automatically), I added more context around the available Docker images. - Updated the latest Docker image version - Fleshed out the Helm section: Added updated information and more detail about our charts. - Cleaned up the macOS installation instructions. Use updated installer links. Combine the "Installer" and "Terminal" tabs, since both use our installer endpoints. Add instructions for checking Teleport versions to the Homebrew tab. - Move comments in the Checksums section above commands so it is possible to copy the code snippet and run the commands from a terminal. - Mention tbot - Update PowerShell installation instructions. As written, they did not work for me when I tested them. * Respond to PR feedback
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
See #11841
Combined two H2s related to OS support
Fleshed out the Docker section: The current instructions only show a
"docker pull" command. Since users will likely be using other methods
to run containers from our images (e.g., a docker-compose config or
"docker run", which pulls the image automatically), I added more
context around the available Docker images.
Updated the latest Docker image version
Fleshed out the Helm section: Added updated information and more
detail about our charts.
Cleaned up the macOS installation instructions. Use updated installer
links. Combine the "Installer" and "Terminal" tabs, since both use our
installer endpoints. Add instructions for checking Teleport versions to
the Homebrew tab.
Move comments in the Checksums section above commands so it is
possible to copy the code snippet and run the commands from a terminal.
Mention tbot
Update PowerShell installation instructions. As written, they did
not work for me when I tested them.