@@ -20,14 +20,14 @@ for GitHub repositories.
20
20
GitHub Enterprise provides a security feature to bring your own SSH certificate
21
21
authorities (CA). Once a CA is added, your organization can sign short-lived
22
22
client SSH certificates to access organization resources on GitHub. You can
23
- also require your memebers to use these SSH certificates, which disables Git
23
+ also require your members to use these SSH certificates, which disables Git
24
24
access using personal tokens.
25
25
26
26
The concept of short-lived SSH certificates to access organization resources
27
27
aligns well with Teleport, where a Teleport user begins their day with a 'tsh'
28
28
session, accessing only what their roleset permits. Teleport can also easily
29
29
provide the capability to issue of short-lived client SSH certificates for
30
- GitHub organzations so Teleport customers do not need to implement a separate
30
+ GitHub organizations so Teleport customers do not need to implement a separate
31
31
system for issuing these certificates.
32
32
33
33
Teleport also offers other GitHub-related features, such as [ GitHub IAM
@@ -185,14 +185,14 @@ $ tsh git clone git@github.com:my-org/my-repo.git
185
185
186
186
The first `git` command (including the `clone`) will open a browser window to
187
187
trigger the GitHub OAuth flow for Teleport to grab Bob's GitHub ID and
188
- username. Once Bob sees "Login Successful" from the brower and goes back to his
188
+ username. Once Bob sees "Login Successful" from the browser and goes back to his
189
189
terminal.
190
190
191
191
The repo is cloned by now, and Bob can `cd` into the directory and perform regular
192
192
` git` commands naturally, without using `tsh`. Bob can also find the
193
193
" authorized" GitHub username in `tsh status` or `tsh git ls`.
194
194
195
- On the second day (as the `tsh` session expiress ), when Bob tries to `git
195
+ On the second day (as the `tsh` session expires ), when Bob tries to `git
196
196
fetch` from the repo, the command prompts to login into Teleport. The command
197
197
proceeds as usual once Teleport login is successful.
198
198
@@ -264,7 +264,7 @@ Charlie is an auditor and is able to see the audit events from Web UI:
264
264
#### Alice wants to understand the available break glass options
265
265
266
266
Alice, a system administrator, manages the Teleport cluster by checking
267
- Terrafrom scripts and values into various GitHub repos. CI/CD then picks the
267
+ Terraform scripts and values into various GitHub repos. CI/CD then picks the
268
268
changes and apply to the Teleport cluster.
269
269
270
270
A change to the Terraform script may break the Teleport cluster and the GitHub
@@ -275,7 +275,7 @@ at the organization level and does not want to allow it for security purpose.
275
275
276
276
Alice still has a few options to access the organization repos when the GitHub
277
277
proxy is unavailable:
278
- - Alice can still logs into GitHub through a browser and make chnages there if
278
+ - Alice can still logs into GitHub through a browser and make changes there if
279
279
necessary.
280
280
- Alice can manually sign an user certificate according to [ GitHub
281
281
spec] ( https://docs.github.com/en/enterprise-cloud@latest/organizations/managing-git-access-to-your-organizations-repositories/about-ssh-certificate-authorities#issuing-certificates ) .
@@ -471,7 +471,7 @@ matched against the hidden label from the `git_server` resources.
471
471
# ### SSH transport
472
472
473
473
Existing [SSH
474
- transprt ](https://github.com/gravitational/teleport/blob/master/rfd/0100-proxy-ssh-grpc.md)
474
+ transport ](https://github.com/gravitational/teleport/blob/master/rfd/0100-proxy-ssh-grpc.md)
475
475
is used for proxying Git commands.
476
476
477
477
No change is necessary on the client side or on the GRPC protocol to support
@@ -509,7 +509,7 @@ message GenerateGitHubUserCertRequest {
509
509
bytes public_key = 2;
510
510
// UserID is the GitHub user ID.
511
511
string user_id = 3;
512
- // KeyId is the certficate ID, usually the Teleport username.
512
+ // KeyId is the certificate ID, usually the Teleport username.
513
513
string key_id = 4;
514
514
// Ttl is the duration the certificate will be valid for.
515
515
google.protobuf.Duration ttl = 5;
@@ -548,7 +548,7 @@ hint: use 'tsh git clone <git-clone-ssh-url>' to clone a new repository
548
548
To forward SSH traffic from `git` to Teleport, the Git repo will be configured
549
549
with
550
550
[`core.sshCommand`](https://git-scm.com/docs/git-config#Documentation/git-config.txt-coresshCommand)
551
- set to `tsh git ssh --githb -org <my-org>`. The `core.sshCommand` makes `git` to
551
+ set to `tsh git ssh --github -org <my-org>`. The `core.sshCommand` makes `git` to
552
552
call this command instead of `ssh`.
553
553
554
554
` tsh git ssh` is a hidden command that basically does `tsh ssh
@@ -565,7 +565,7 @@ In addition, `tsh` provides two helper commands to automatically configures
565
565
make a clone. Before cloning, the GitHub organization is parsed from the
566
566
` <git-url>` , and a GitHub proxy server with its logins is retrieved matching
567
567
the GitHub organization. If more than one GitHub logins are available, users
568
- can expliclitly specify one using `--username` when running `tsh git clone`.
568
+ can explicitly specify one using `--username` when running `tsh git clone`.
569
569
570
570
` tsh git config` checks Teleport-related configurations in the current Git dir
571
571
by running `git config --local --default "" --get core.sshCommand`.
@@ -633,7 +633,7 @@ message GitCommandAction {
633
633
634
634
There is no heartbeats for `git_server` with subkind `github` (yet).
635
635
636
- Exising `SessionStartEvent` will be expanded to include git metadata with
636
+ Existing `SessionStartEvent` will be expanded to include git metadata with
637
637
`session_type` of `git` :
638
638
` ` ` grpc
639
639
// SessionStartGitMetadata contains additional information about git commands.
@@ -752,7 +752,7 @@ integration on each Auth service and combines all the keys.
752
752
Support for Git servers should be implemented similar to how SSH is supported
753
753
today for Machine ID.
754
754
755
- As mentinoned earlier, since services like GitHub actions are not affected by
755
+ As mentioned earlier, since services like GitHub actions are not affected by
756
756
this feature (by not using Teleport), Machine ID supported can be added after
757
757
the MVP.
758
758
0 commit comments