Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit9af6a85

Browse files
authored
Cap user authorize access (#245)
* Update git token processes* Update token topicsUpdated reference and user settings topics for git token (pending new screesnhots)* Update content* Update git-tokens.md* Update git-tokens.md* Update tokens* Update user-settings.md* Update user-settings.md
1 parent30314e1 commit9af6a85

File tree

27 files changed

+151
-672
lines changed

27 files changed

+151
-672
lines changed

‎_docs/administration/user-settings.md‎

Lines changed: 106 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,19 @@ As a user in Codefresh, you can manage your account by authorizing access to you
1313
* Authorize Git providers
1414
The Git personal token is a user-specific access token, required to authenticate Git-based actions from Codefresh clients, per provisioned runtime.
1515

16-
The authorization method depends on the Git provider and on what authorization has been set up by ypur adin.
16+
17+
The authorization method depends on the Git provider and on what authorization has been set up by your account admin.
18+
19+
1720
If your admin has set up authentication with OAuth2, you can authorize access using OAuth2.
1821
Or, you can always generate a personal access token from your Git provider and then add the same to Codefresh to authorize access.
1922

2023
>If you have access to more than one runtime, you can use the same token for multiple runtimes.
21-
You must however authorize access individually for each runtime.
24+
You must however authorize access individually for each runtime.
25+
26+
{::nomarkdown}
27+
</br>
28+
{:/}
2229

2330
###Enable access for Codefresh support
2431
Enable Codefresh support personnel to access your user account. Access to your account is useful for visibility during troubleshooting.
@@ -40,87 +47,137 @@ You can disable this security setting at any time.
4047
max-width="50%"
4148
%}
4249

43-
###Authorize Git access with OAuth or personal access tokens
44-
Authorize Git access with OAuth2 if your account admin has set up Codefresh as an OAuth application, or alternatively through personal access tokens from your Git provider.
45-
* For OAuth2: The adminstrator pre-configures the permissions and expiry date. Once you supply your credentials for authorization, you are automatically directed to the Git Personal Tokens page.
46-
47-
####Generate personal access token for GitHub
48-
49-
####Authorize access for Bitbucket
50-
Bitbucket requires your Bitbucket account name and a personal access token to authorize access.
51-
52-
**Generate personal access token**
53-
54-
1. Log in to your Bitbucket Cloud or Server account.
55-
1. Select**Manage account > Account settings > Personal access tokens**.
56-
1. Select these scopes:`repository write`,`Project read`.
57-
1. Copy the personal access token generated as you will need it to authorize access.
58-
59-
**How to**
60-
1. In the Codefresh UI, go to[User Settings](https://g.codefresh.io/2.0/user-settings){:target="\_blank"}.
61-
1. Select the runtime, and then select one of the following:
62-
* To add a token, select**Add Token**.
63-
* To update an existing token by replacing it with a new token, select**Update Token**.
64-
1. From the**Select Git provider** drop-down, select**Bitbucket**.
65-
1. In the**Bitbucket username field**, enter the username of your Bitbucket account.
66-
1. In the**Bitbucket Personal Access Token** field, paste the token you generated.
67-
68-
<!---add new screenshot>-->
50+
{::nomarkdown}
51+
</br>
52+
{:/}
6953

54+
###Authorize Git access in Codefresh
55+
Authorize Git access with OAuth2 if your account admin has set up Codefresh as an OAuth application, or alternatively through personal access tokens from your Git provider.
56+
>Notes:
57+
For OAuth2: The adminstrator pre-configures the permissions and expiry date. Once you supply your credentials for authorization, you are automatically directed to the Git Personal Tokens page.
7058

71-
{:start="6"}
72-
1. Click**Add Token**.
73-
In the Git Personal Access Tokens list, you can see that the new token is assigned to the runtime.
59+
**Before you begin**
7460

75-
####Authorize access for GitHub
76-
**Before you begin**
7761
Make sure you have:
7862
* For Bitbucket only, your Bitbucket account username
79-
* If needed, a_personal access token_ with the required scopes:
80-
*[GitHub]({{site.baseurl}}/docs/reference/git-tokens/#github-tokens)
81-
*[GitLab]({{site.baseurl}}/docs/reference/git-tokens/#gitlab-tokens)
82-
*[Bitbucket]({{site.baseurl}}/docs/reference/git-tokens/#bitbucket-tokens)
63+
* If needed, a_personal access token_from your Git providerwith the required scopes:
64+
*[GitHub]({{site.baseurl}}/#generate-github-personal-access-tokens)
65+
*[GitLab]({{site.baseurl}}/#generate-gitlab-personal-access-tokens)
66+
*[Bitbucket]({{site.baseurl}}/#generate-bitbucket-personal-access-tokens)
8367

8468

8569
**How to**
8670
1. In the Codefresh UI, go to[User Settings](https://g.codefresh.io/2.0/user-settings){:target="\_blank"}.
87-
1. Select the runtime, and thenselect one of the following:
71+
1. Select the runtime, and thendo one of the following:
8872
* To add a token, select**Add Token**.
8973
* To update an existing token by replacing it with a new token, select**Update Token**.
90-
1. For OAuth2:
74+
1. For**OAuth2**:
9175
>If the application is not registered, the button is disabled. Contact your admin for help.
9276
* Click**Authorize Access to GitHub**.
9377
* Enter your credentials, and select**Sign In**.
9478
* Complete the verification if required, as when two-factor authentication is configured, for example.
9579
<!---add new screenshot>-->
9680

97-
{:start="4"}
98-
1.For Git personal access tokens:
81+
82+
For**Git personal access tokens**:
9983
* Expand**Advanced authorization options**.
100-
<!---* For Bitbucket, enter your **Bitbucket username**.-->
101-
*In the**GitPersonal Access Token** field, paste the token you generated.
84+
* For Bitbucket, enter your**Bitbucket username**.
85+
* In the**Personal Access Token** field, paste the token you generated.
10286

10387
<!---add new screenshot>-->
10488

10589

10690
{:start="5"}
107-
1. Click**Add Token**.
91+
1. Click**Add Token**.
10892
In the Git Personal Access Tokens list, you can see that the new token is assigned to the runtime.
10993

94+
{::nomarkdown}
95+
</br>
96+
{:/}
97+
98+
####Generate GitHub personal access tokens
11099

111-
100+
1. Log in to your GitHub or GitHub Enterprise account.
101+
1. Select**Settings > Developer Settings > Personal Access Tokens > Tokens (classic)**.
102+
1. Define the following:
103+
* Token name
104+
* Expiration date
105+
* Select scope:`repo`
112106

107+
{% include
108+
image.html
109+
lightbox="true"
110+
file="/images/administration/user-settings/github-pat-scopes.png"
111+
url="/images/administration/user-settings/github-pat-scopes.png"
112+
alt="GitHub personal access token scopes"
113+
caption="GitHub personal access token scopes"
114+
max-width="50%"
115+
%}
113116

114-
{::nomarkdown}
115-
<br>
117+
{:start="4"}
118+
1. Copy the personal access token generated as you will need it to authorize access.
119+
120+
{::nomarkdown}
121+
</br>
116122
{:/}
117123

124+
####Generate GitLab personal access tokens
118125

119-
126+
1. Log in to your GitLab Cloud or Server account.
127+
1. Select**User settings > Access tokens**.
128+
1. Define the following:
129+
* Token name
130+
* Expiration date
131+
* Select these scopes:`read_api', 'read_user`,`read_repository`
120132

133+
{% include
134+
image.html
135+
lightbox="true"
136+
file="/images/administration/user-settings/gitlab-pat-scopes.png"
137+
url="/images/administration/user-settings/gitlab-pat-scopes.png"
138+
alt="GitLab personal access token scopes"
139+
caption="GitLab personal access token scopes"
140+
max-width="50%"
141+
%}
142+
143+
{:start="4"}
144+
1. Copy the personal access token generated as you will need it to authorize access.
121145

122146

123147

124-
148+
149+
{::nomarkdown}
150+
</br>
151+
{:/}
152+
153+
####Generate Bitbucket personal access tokens
154+
155+
156+
1. Log in to your Bitbucket Cloud or Server account.
157+
1. Select**Personal Settings > App passwords**.
158+
1. Define the**Label**.
159+
Select these scopes:
160+
***Permissions**:`Read`
161+
***Workspace membership**:`Read`
162+
***Webhooks**:`Read and write`
163+
***Repositories**:`Write`,`Admin`
164+
165+
{% include
166+
image.html
167+
lightbox="true"
168+
file="/images/administration/user-settings/bitbucket-pat-scopes.png"
169+
url="/images/administration/user-settings/bitbucket-pat-scopes.png"
170+
alt="Bitbucket personal access token scopes"
171+
caption="Bitbucket personal access token scopes"
172+
max-width="50%"
173+
%}
174+
175+
{:start="4"}
176+
1. Copy the personal access token generated as you will need it to authorize access.
177+
178+
{::nomarkdown}
179+
</br>
180+
{:/}
181+
125182
###Related articles
126183
[Git tokens in Codefresh]({{site.baseurl}}/docs/reference/git-tokens/)

‎_docs/getting-started/architecture.md‎

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -98,19 +98,6 @@ The App-Proxy performs write and state-change operations:
9898
<br>
9999
{:/}
100100

101-
####Request Routing Service
102-
The Request Routing Service is installed on the same cluster as the Codefresh Runtime in the customer environment.
103-
It receives requests from the Ingress Controller, and forwards the request URLs to the Application Proxy, and webhooks directly to the Event Sources.
104-
105-
106-
>Important:
107-
The Request Routing Service is available from runtime version 0.0.543 and higher.
108-
Older runtime versions are not affected as there is complete backward compatibility, and the Ingress Controller continues to route incoming requests.
109-
110-
{::nomarkdown}
111-
<br>
112-
{:/}
113-
114101
####Argo Project
115102

116103
The Argo Project includes:
@@ -161,11 +148,6 @@ See [Ingress controller]({{site.baseurl}}/docs/runtime/requirements/#ingress-con
161148
<br>
162149
{:/}
163150

164-
165-
166-
167-
168-
169151
####Managed clusters
170152
Managed clusters are external clusters registered to a provisioned hosted or hybrid runtime(s).
171153

‎_docs/runtime/hosted-runtime.md‎

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ toc: true
1010
If you have Codefresh's Hosted GitOps, set up your hosted environment, and you are all ready to leverage extensive CD Ops capabilities.
1111
Read about[Hosted GitOps]({{site.baseurl}}/docs/incubation/intro-hosted-runtime/).
1212

13-
1413
###Where to start with Hosted GitOps
1514
If you have not provisioned a hosted runtime, Codefresh presents you with the setup instructions in the**Home** dashboard.
1615

@@ -119,17 +118,19 @@ max-width="70%"
119118
*[Download the CLI]({{site.baseurl}}/docs/clients/csdp-cli/).
120119

121120
1. Uninstall the failed hosted runtime:
122-
`cf runtime uninstallhosted-codefresh --force`
121+
`cf runtime uninstall codefresh-hosted --force`
123122
where:
124123
`hosted-codefresh` is the name of your hosted runtime, automatically assigned by Codefresh.
125124
1. In the Codefresh UI, return to Codefresh[Home](https://g.codefresh.io/2.0/?time=LAST_7_DAYS){:target="\_blank"}.
126125
1. Refresh the page and start with_1. Provision hosted runtime_ above.
127126

128127

129128
###2. Connect Git provider
130-
Connect your hosted runtime to a Git provider for Codefresh to create the required Git repos. First authorize access to your Git provider through an OAuth token, and then select the Git organizations or accounts in which to create the required Git repos.
129+
Connect your hosted runtime to a Git provider for Codefresh to create the required Git repos. First authorize access to your Git provider through an OAuth token, and then select the Git organizations or accounts in which to create the required Git repos.
130+
131131
>Only authorized organizations are displayed in the list. To authorize organizations for the Codefresh application in GitHub, see[Authorize organizations/projects]({{site.baseurl}}/docs/administration/hosted-authorize-orgs/).
132132
133+
133134
{% include
134135
image.html
135136
lightbox="true"
@@ -140,17 +141,11 @@ caption="Step 2: Connect to Git provider"
140141
max-width="80%"
141142
%}
142143

143-
You can connect your hosted runtime to any of these Git providers:
144-
* GitHub (the default)
145-
* Bitbucket Cloud
146-
<!---* GitLab-->
147-
148-
>If the hosted runtime is the first runtime you are provisioning for your account, the Git provider you connect to is used for any hybrid runtimes you provision for the same account. This is because of the configuration repo that is created and shared by runtimes in the same account.
149144

150145
Once you authorize access, Codefresh creates two Git repositories, one to store the runtime configuration settings, and the other to store the runtime's application settings:
151146
* Shared runtime configuration repo
152147

153-
The shared runtime configuration repo is a centralized Git repository that stores configuration settings for the hosted runtime. Additional runtimes provisioned for the account point to this repo to retrieve and reuse the configuration.
148+
The shared runtime configuration repo is a centralized Git repository that stores configuration settings for the hosted runtime. Additional runtimes provisioned for the accountcanpoint to this repo to retrieve and reuse the configuration.
154149
Read about[Shared configuration repo]({{site.baseurl}}/docs/reference/shared-configuration/).
155150

156151
* Git Source application repo

‎_docs/runtime/installation-options.md‎

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -50,16 +50,13 @@ Codefresh Runtime creates three repositories in your organization's Git provider
5050

5151
* Codefresh runtime installation repository
5252
* Codefresh Git Sources
53-
* Codefresh shared configuration repository
53+
* Codefresh shared configuration repository. It does so for two types of entities:
5454

55-
<!---**Codefresh Runtime functionality**
56-
57-
58-
**Codefresh Runtime functionality**
55+
**Codefresh Runtime finctionality**
5956
The runtime:
6057
* Ensures that the installation repository and the Git Sources are always in sync, and applies Git changes back to the cluster
6158
* Receives events and information from the user's organization systems to execute workflows
62-
By default, the ingress controller directs all requests and events to the Codefresh Application Proxy. When internal and an external ingress hosts are configured, the ingress comtroller directs webhook events to the relevant Event Source and then to Argo Events (not via the Codefresh Application Proxy).-->
59+
By default, the ingress controller directs all requests and events to the Codefresh Application Proxy. When internal and an external ingress hosts are configured, the ingress comtroller directs webhook events to the relevant Event Source and then to Argo Events (not via the Codefresh Application Proxy).
6360

6461
###Hosted vs.Hybrid environments
6562

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp