Skip to content

Commit

Permalink
review comment
Browse files Browse the repository at this point in the history
  • Loading branch information
greedy52 committed Jan 7, 2025
1 parent 3f799da commit dfdce24
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 27 deletions.
26 changes: 12 additions & 14 deletions docs/pages/admin-guides/management/guides/github-integration.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: GitHub Integration
title: Git Access with GitHub
description: How to use Teleport's short-lived SSH certificates with the GitHub Certificate Authority.
---

Expand All @@ -10,7 +10,7 @@ In this guide, you will:
- Create a GitHub OAuth application.
- Configure SSH certificate authorities for your GitHub organizations.
- Create Teleport resources for the GitHub integration.
- Run Git commands through Teleport
- Run Git commands through Teleport.

## How it works

Expand All @@ -33,11 +33,11 @@ opening a browser window for the user to log in with their GitHub credentials.
![GitHub SSH certificate authorities](../../../../img/management/how-it-works-github-proxy.svg)

Note that Teleport proxies Git commands through SSH but the users should
continue to access github.com website regularly through their browsers.
continue to access GitHub through their browsers.

## Prerequisites

(!docs/pages/includes/edition-prereqs-tabs-enterprise.mdx version="17.2"!)
(!docs/pages/includes/commercial-prereqs-tabs.mdx version="17.2"!)
- Access to GitHub Enterprise and permissions to modify GitHub's SSH certificate
authorities and configure OAuth applications.
- (!docs/pages/includes/tctl.mdx!)
Expand Down Expand Up @@ -85,13 +85,13 @@ Replace `my-github-org` with the organization name, and replace
previous step.

To create the resource with `tctl`, run:
```bash
tctl create -f github_integration.yaml
```code
$ tctl create -f github_integration.yaml
```

Once the integration resource is created, export the CA to be used for GitHub:
```bash
tctl auth export --type github --integration github-<Var name="my-github-org"/>
```code
$ tctl auth export --type github --integration github-<Var name="my-github-org"/>
```

Now go to the "Authentication Security" page of your GitHub organization. Click
Expand All @@ -116,8 +116,8 @@ spec:
```

To create the resource with `tctl`, run:
```bash
tctl create -f git_server.yaml
```code
$ tctl create -f git_server.yaml
```

The user role must have `github_permissions` configured to allow access to your
Expand All @@ -126,7 +126,7 @@ GitHub organization. For example:
# role_with_github_permissions.yaml
kind: role
metadata:
name: github-<Var name="my-github-org"/>
name: github-access
spec:
allow:
github_permissions:
Expand All @@ -135,9 +135,7 @@ spec:
version: v7
```

You can either create a new role as shown above or add `github_permissions` to an
existing role. Ensure the role is assigned to the appropriate Teleport users who
will access Git repositories through Teleport.
(!docs/pages/includes/add-role-to-user.mdx role="github-access"!)

## Step 4/4. Connect

Expand Down
7 changes: 5 additions & 2 deletions docs/pages/includes/commercial-prereqs-tabs.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
- A running Teleport cluster. If you want to get started with Teleport, [sign
up](https://goteleport.com/signup) for a free trial.
{{ version="(=teleport.version=)" }}

- A running Teleport Enterprise cluster version {{ version }} or above. If you
want to get started with Teleport, [sign up](https://goteleport.com/signup)
for a free trial.

- The `tctl` admin tool and `tsh` client tool.

Expand Down
11 changes: 0 additions & 11 deletions docs/pages/includes/edition-prereqs-tabs-enterprise.mdx

This file was deleted.

0 comments on commit dfdce24

Please sign in to comment.