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

rfd updates #50099

Merged
merged 1 commit into from
Dec 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion rfd/0054-passwordless-macos.md
Original file line number Diff line number Diff line change
Expand Up @@ -389,7 +389,7 @@ allowed by Apple). It is likely possible to make use of those APIs for Teleport
Cloud, but we would need a solution for other installations regardless.

A final consequence of the above is that Passkey support (aka iCloud-stored
credentials) for CLIs is out of the roadmap for the forseeable future (but
credentials) for CLIs is out of the roadmap for the foreseeable future (but
Passkeys _can_ be used for Safari-based access).

References:
Expand Down
4 changes: 2 additions & 2 deletions rfd/0162-machine-id-token-join-method-bot-instance.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Terminology:
- Bot instance: A single instance of `tbot` running on a host.

This RFD proposes improvements to the management of fleets of Machine ID Bots.
These improvements are mostly targetted at on-prem deployments, where the
These improvements are mostly targeted at on-prem deployments, where the
delegated join methods are not available.

The improvements will focus on three points:
Expand Down Expand Up @@ -564,7 +564,7 @@ Existing analytics for join, renewal and certificate generation should be
extended to include the BotInstance ID anonymized. This will allow them to be
linked together.

### Migration/Compatability
### Migration/Compatibility

The "create if not exists" behaviour of the BotInstance resource will mean that
existing Bot instances will have a BotInstance resource created on their first
Expand Down
2 changes: 1 addition & 1 deletion rfd/0167-debug-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ $ teleport debug profile heap,goroutine > profile.tar.gz
### Security

Items listed on this section are have their impact limited due to the fact that
the service will not be exposed outsite the machine/container running the
the service will not be exposed outside the machine/container running the
Teleport instance.

#### CPU and Memory consumption during profiling
Expand Down
2 changes: 1 addition & 1 deletion rfd/0173-terraform-machine-id.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ $ terraform apply ...
Please check if you have the rights to create role, bot and token resources. You might need to re-log in for new rights to take effect.
(tsh logout --proxy="mytenant.teleport.sh:443" --user="[email protected]")
```
- run a one-shot tbot to retrieve certificates via the bot for the terraformn role
- run a one-shot tbot to retrieve certificates via the bot for the terraform role
- set the environment variable `TF_TELEPORT_IDENTITY_FILE_BASE64`
- echo a user-friendly message containing the bot name and the certificate validity

Expand Down
24 changes: 12 additions & 12 deletions rfd/0178-github-proxy.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,14 @@ for GitHub repositories.
GitHub Enterprise provides a security feature to bring your own SSH certificate
authorities (CA). Once a CA is added, your organization can sign short-lived
client SSH certificates to access organization resources on GitHub. You can
also require your memebers to use these SSH certificates, which disables Git
also require your members to use these SSH certificates, which disables Git
access using personal tokens.

The concept of short-lived SSH certificates to access organization resources
aligns well with Teleport, where a Teleport user begins their day with a 'tsh'
session, accessing only what their roleset permits. Teleport can also easily
provide the capability to issue of short-lived client SSH certificates for
GitHub organzations so Teleport customers do not need to implement a separate
GitHub organizations so Teleport customers do not need to implement a separate
system for issuing these certificates.

Teleport also offers other GitHub-related features, such as [GitHub IAM
Expand Down Expand Up @@ -185,14 +185,14 @@ $ tsh git clone [email protected]:my-org/my-repo.git

The first `git` command (including the `clone`) will open a browser window to
trigger the GitHub OAuth flow for Teleport to grab Bob's GitHub ID and
username. Once Bob sees "Login Successful" from the brower and goes back to his
username. Once Bob sees "Login Successful" from the browser and goes back to his
terminal.

The repo is cloned by now, and Bob can `cd` into the directory and perform regular
`git` commands naturally, without using `tsh`. Bob can also find the
"authorized" GitHub username in `tsh status` or `tsh git ls`.

On the second day (as the `tsh` session expiress), when Bob tries to `git
On the second day (as the `tsh` session expires), when Bob tries to `git
fetch` from the repo, the command prompts to login into Teleport. The command
proceeds as usual once Teleport login is successful.

Expand Down Expand Up @@ -264,7 +264,7 @@ Charlie is an auditor and is able to see the audit events from Web UI:
#### Alice wants to understand the available break glass options

Alice, a system administrator, manages the Teleport cluster by checking
Terrafrom scripts and values into various GitHub repos. CI/CD then picks the
Terraform scripts and values into various GitHub repos. CI/CD then picks the
changes and apply to the Teleport cluster.

A change to the Terraform script may break the Teleport cluster and the GitHub
Expand All @@ -275,7 +275,7 @@ at the organization level and does not want to allow it for security purpose.

Alice still has a few options to access the organization repos when the GitHub
proxy is unavailable:
- Alice can still logs into GitHub through a browser and make chnages there if
- Alice can still logs into GitHub through a browser and make changes there if
necessary.
- Alice can manually sign an user certificate according to [GitHub
spec](https://docs.github.com/en/enterprise-cloud@latest/organizations/managing-git-access-to-your-organizations-repositories/about-ssh-certificate-authorities#issuing-certificates).
Expand Down Expand Up @@ -471,7 +471,7 @@ matched against the hidden label from the `git_server` resources.
#### SSH transport

Existing [SSH
transprt](https://github.com/gravitational/teleport/blob/master/rfd/0100-proxy-ssh-grpc.md)
transport](https://github.com/gravitational/teleport/blob/master/rfd/0100-proxy-ssh-grpc.md)
is used for proxying Git commands.

No change is necessary on the client side or on the GRPC protocol to support
Expand Down Expand Up @@ -509,7 +509,7 @@ message GenerateGitHubUserCertRequest {
bytes public_key = 2;
// UserID is the GitHub user ID.
string user_id = 3;
// KeyId is the certficate ID, usually the Teleport username.
// KeyId is the certificate ID, usually the Teleport username.
string key_id = 4;
// Ttl is the duration the certificate will be valid for.
google.protobuf.Duration ttl = 5;
Expand Down Expand Up @@ -548,7 +548,7 @@ hint: use 'tsh git clone <git-clone-ssh-url>' to clone a new repository
To forward SSH traffic from `git` to Teleport, the Git repo will be configured
with
[`core.sshCommand`](https://git-scm.com/docs/git-config#Documentation/git-config.txt-coresshCommand)
set to `tsh git ssh --githb-org <my-org>`. The `core.sshCommand` makes `git` to
set to `tsh git ssh --github-org <my-org>`. The `core.sshCommand` makes `git` to
call this command instead of `ssh`.

`tsh git ssh` is a hidden command that basically does `tsh ssh
Expand All @@ -565,7 +565,7 @@ In addition, `tsh` provides two helper commands to automatically configures
make a clone. Before cloning, the GitHub organization is parsed from the
`<git-url>`, and a GitHub proxy server with its logins is retrieved matching
the GitHub organization. If more than one GitHub logins are available, users
can expliclitly specify one using `--username` when running `tsh git clone`.
can explicitly specify one using `--username` when running `tsh git clone`.

`tsh git config` checks Teleport-related configurations in the current Git dir
by running `git config --local --default "" --get core.sshCommand`.
Expand Down Expand Up @@ -633,7 +633,7 @@ message GitCommandAction {

There is no heartbeats for `git_server` with subkind `github` (yet).

Exising `SessionStartEvent` will be expanded to include git metadata with
Existing `SessionStartEvent` will be expanded to include git metadata with
`session_type` of `git`:
```grpc
// SessionStartGitMetadata contains additional information about git commands.
Expand Down Expand Up @@ -752,7 +752,7 @@ integration on each Auth service and combines all the keys.
Support for Git servers should be implemented similar to how SSH is supported
today for Machine ID.

As mentinoned earlier, since services like GitHub actions are not affected by
As mentioned earlier, since services like GitHub actions are not affected by
this feature (by not using Teleport), Machine ID supported can be added after
the MVP.

Expand Down
2 changes: 1 addition & 1 deletion rfd/0182-multi-port-tcp-app-access.md
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ ports.

##### Embedding the port within SNI or an ALPN protocol

The port number could be included within TLS config on the client side, either as a special sudomain
The port number could be included within TLS config on the client side, either as a special subdomain
in the SNI, e.g. `app-teleport-proxy-target-port-1337.teleport.cluster.local`, or a new ALPN
protocol, say `teleport-tcp@1337`.

Expand Down
2 changes: 1 addition & 1 deletion rfd/0184-agent-auto-updates.md
Original file line number Diff line number Diff line change
Expand Up @@ -1656,7 +1656,7 @@ $ ls -l /usr/local/bin/teleport
$ ls -l /usr/local/bin/teleport-update
/usr/local/teleport/clusterA/bin/teleport-update -> /var/lib/teleport/install/clusterA/versions/15.0.0/bin/teleport-update
$ ls -l /usr/local/lib/systemd/system/teleport-clusterA.service
/usr/local/lib/systemd/system/teleport-clutserA.service -> /var/lib/teleport/install/clusterA/versions/15.0.0/etc/systemd/teleport.service
/usr/local/lib/systemd/system/teleport-clusterA.service -> /var/lib/teleport/install/clusterA/versions/15.0.0/etc/systemd/teleport.service
```

##### update.yaml
Expand Down
Loading