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

docs: add information about token scope #517

Merged
merged 1 commit into from
Oct 5, 2023
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
12 changes: 0 additions & 12 deletions docs/common/git-auth.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,6 @@ import GitHubTokens from '../common/partials/github/_tokens.mdx'
import GitLabTokens from '../common/partials/gitlab/_tokens.mdx'
import * as config from "../constants.js"

<div
style={{
display: "flex",
justifyContent: "flex-end",
alignItems: "center",
}}
>
<div>
<img src={config.AWS_LOGO_URL} height="50" width="120" />
</div>
</div>

<Tabs groupId="git_provider" defaultValue="github" queryString>
<TabItem
attributes={{className: styles.github}}
Expand Down
4 changes: 4 additions & 0 deletions docs/common/partials/github/_tokens.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ kubefirst issue GitHub Tokens at the beginning of the installation using [GitHub
kubefirst uses the following scopes to provision the kubefirst platform:
![GitHub Token Scopes](../../../img/common/github/scopes.png)

:::info
Unfortunately, those are the minimum require scopes we need for the token as we need to be able to create two Git repository, add an SSH key, crate groups (only in GitLab)... If you feel unease with that, we suggest you create a new GitHub or GitLab user for the sake of testing kubefirst.
:::

## How to create a GitHub Token

There are different ways to create a GitHub token. The easiest way is to start the kubefirst installer, and follow the screen instructions. It will guide you to issue a token with the list of scope described above.
Expand Down
4 changes: 4 additions & 0 deletions docs/common/partials/gitlab/_tokens.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ kubefirst uses the following scopes to provision the kubefirst platform:

![GitLab Token Scopes](../../../img/common/gitlab/scopes.png)

:::info
Unfortunately, those are the minimum require scopes we need for the token as we need to be able to create two Git repository, add an SSH key, crate groups (only in GitLab)... If you feel unease with that, we suggest you create a new GitHub or GitLab user for the sake of testing kubefirst.
:::

## How to create a GitLab Token

There are different ways to create a GitLab token. The easiest way is to start the kubefirst installer, and follow the screen instructions. It will guide you to issue a token with the list of scope described above.
Expand Down