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

Commita40377e

Browse files
authored
Service accounts (codefresh-io#1018)
* Create service-accounts.md* Update service-accounts.mdAdded content to article* Update service-accounts.md* Update service-accounts.md* Update nav.ymlAdded service accounts entry* Update service-accounts.md* Update service-accounts.md* Update service accountImplemented feedback and added screenshots* Update service-accounts.md* Update service-accounts.md* Update service-accounts.md* Update add-service-account.png
1 parentc1f7b33 commita40377e

File tree

5 files changed

+111
-0
lines changed

5 files changed

+111
-0
lines changed

‎_data/nav.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -536,6 +536,8 @@
536536
url:"/create-codefresh-account"
537537
-title:Adding users and teams
538538
url:"/add-users"
539+
-title:Create service accounts
540+
url:"/service-accounts"
539541
-title:Configuring access control for pipelines
540542
url:"/access-control"
541543
-title:Configuring access control for GitOps
Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
---
2+
title:"Managing service accounts"
3+
description:"Manage access and permissions with service accounts"
4+
group:administration
5+
sub_group:account-user-management
6+
toc:true
7+
---
8+
9+
##Service accounts overview
10+
11+
>**NOTE**
12+
This feature is currently in Beta.
13+
14+
A service account is an identity that provides automated processes, applications, and services with the necessary permissions to interact securely with your infrastructure. Service accounts can manage access and permissions programmatically, ensuring secure and efficient operations within your environment.
15+
16+
Coderfesh supports creating service accounts and assigning them to teams with RBAC (Role-Based Access Control) compliance for CI pipelines. See[Create service accounts](#create-service-accounts).
17+
Each service account can hold multiple API keys, making it easy to manage access for different purposes. See[Generate API keys for service accounts](#generate-api-keys-for-service-accounts).
18+
19+
20+
##Create service accounts
21+
Create service accounts in Codefresh to manage processes, integrations, at the account level.
22+
Assign teams to service accounts to ensure RBAC access for those teams and their users (see[Access control for pipelines]({{site.baseurl}}/docs/administration/account-user-management/access-control)).
23+
Note that service account creation is not supported via CLI and Terraform.
24+
25+
26+
#####Before you begin
27+
* Make sure you have created one or more[teams]({{site.baseurl}}/docs/administration/account-user-management/add-users/#create-a-team-in-codefresh)
28+
29+
#####How to
30+
31+
1. In the Codefresh UI, on the toolbar, click the**Settings** icon, and then from the sidebar, select**Service Accounts**.
32+
1. Click**Add Service Account**.
33+
1. Do the following:
34+
1.**Name**: Enter a name for the service account according to the requirements.
35+
1.**Team**: Assign this service account to one or more of the teams available.
36+
1.**Assign Admin role to service account**: Optional. Automatically assign admin permissions to this service account.
37+
38+
{% include image.html
39+
lightbox="true"
40+
file="/images/administration/service-accounts/add-service-account.png"
41+
url="/images/administration/service-accounts/add-service-account.png"
42+
alt="Add service account"
43+
caption="Add service account"
44+
max-width="60%"
45+
%}
46+
47+
{:start="4"}
48+
1. Continue with[Generate API keys for service accounts](#generate-api-keys-for-service-accounts).
49+
50+
51+
52+
##Generate API keys for service accounts
53+
Generate API keys for a service account after creating it. The procedure is similar to generating API keys for individual users.
54+
There is no limit to the number of API keys you can generate for a single service account.
55+
56+
After generating API keys, you can modify the scopes defined for the API key, or delete it.
57+
58+
59+
1. In the Codefresh UI, on the toolbar, click the**Settings** icon, and then from the sidebar, select**Service Accounts**.
60+
1. Select the service account for which to generate API keys.
61+
1. Click**Generate API Key**.
62+
1. In the Generate Codefresh API key form, do the following:
63+
1. Enter the**Key Name**.
64+
1. Click**Generate**.
65+
Codefresh generates the key and pastes it in the API Key field.
66+
1. If required, copy the key to the clipboard and save it in a safe location.
67+
68+
{% include image.html
69+
lightbox="true"
70+
file="/images/administration/service-accounts/api-keys-service-account.png"
71+
url="/images/administration/service-accounts/api-keys-service-account.png"
72+
alt="API keys for service account"
73+
caption="API keys for service account"
74+
max-width="60%"
75+
%}
76+
77+
{:start="5"}
78+
1. Select the required scopes.
79+
1. Click**OK**.
80+
81+
82+
##View service accounts
83+
The Service Accounts page shows the list of service accounts defined for the account.
84+
85+
86+
{% include image.html
87+
lightbox="true"
88+
file="/images/administration/service-accounts/service-account-list.png"
89+
url="/images/administration/service-accounts/service-account-list.png"
90+
alt="Service account list"
91+
caption="Service account list"
92+
max-width="60%"
93+
%}
94+
95+
96+
{: .table .table-bordered .table-hover}
97+
| Service Account Setting| Description|
98+
| ------------------------| ----------------|
99+
|**Name**| The name of the service account. <br>The**Admin** label to the right of the name indicates that the service account has been assigned an admin role. NIMA: what is the added value of admin role?|
100+
|**API Keys**| The number of API keys assigned to the service account. <br>Selecting a service account displays the API keys generated for that account. Modify selected scopes by clicking Edit, or delete the API key.|
101+
|**Teams**| The names of the teams the service account is assigned to.|
102+
|**Status**| Indicates if the service account is currently active (**Enabled**) or inactive (**Disabled**). You may want to disable a service account to invalidate its API keys without having to remove the service account, and simply reenable when needed.|
103+
|**Actions**| The options available to manage the service account through its context menu: {::nomarkdown}<ul><li><b>Edit</b>: Modify the settings of the service account, including adding/removing teams, enabling/disabling admin role.</li><li><b>Delete</b>: Delete the service account, including all the API keys defined for the account. This means that actions through the Codefresh API or CLI that require these keys will fail.</li></ul>{:/}|
104+
105+
106+
##Related articles
107+
[Access control for pipelines]({{site.baseurl}}/docs/administration/account-user-management/access-control/)
108+
109+
40.1 KB
Loading
132 KB
Loading
72 KB
Loading

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp