You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
* Update admin bucket articles for argohubEdited and updated content for all articles in Administration bucket for Enterprise and Argohub flavors* Update nav.yml* Update account-user-management.md* Update* Update account-user-management.md* Update administration-overview.md* Update condition syntax for topicsUpdated condition syntax for == and != layouts for argohub
* Configure access control for[pipelines]({{site.baseurl}}/docs/administration/account-user-management/access-control/) and for[GitOps]({{site.baseurl}}/docs/administration/account-user-management/gitops-abac/)
15
+
* Configure access control for[GitOps]({{site.baseurl}}/docs/administration/account-user-management/gitops-abac/)
14
16
*[Configure Single Sign-On (SSO)]({{site.baseurl}}/docs/administration/single-sign-on/)
15
17
* Get[audit logs]({{site.baseurl}}/docs/administration/account-user-management/audit/) for runtimes (hosted or private)
16
18
* Learn[which IP addresses]({{site.baseurl}}/docs/administration/platform-ip-addresses/) are used for SAAS runtimes
17
19
18
-
For on-premises environments, see[On-premises account and user setup]({{site.baseurl}}/docs/installation/on-premises/on-prem-configuration/).
20
+
For on-premises environments, see[On-premises account and user setup]({{site.baseurl}}/docs/installation/on-premises/on-prem-configuration/).
21
+
{% endif %}
22
+
23
+
{% if page.layout == "argohub" %}
24
+
*[Add users and teams]({{site.baseurl}}/docs/administration/account-user-management/add-users/)
25
+
* Configure access control for[GitOps]({{site.baseurl}}/docs/administration/account-user-management/gitops-abac/)
26
+
*[Configure Single Sign-On (SSO)]({{site.baseurl}}/docs/administration/single-sign-on/)
Copy file name to clipboardExpand all lines: _docs/administration/account-user-management/add-users.md
+22-12Lines changed: 22 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,10 @@ redirect_from:
11
11
toc:true
12
12
---
13
13
14
-
Once you have created a Codefresh account, you can add any number of users to collaborate on repositories, workflows, and pipelines, and teams of users. For Codefresh on-premises, see[On-premises account & user setup]({{site.baseurl}}/docs/installation/on-premises/on-prem-configuration/).
14
+
Once you have created a Codefresh account, you can add any number of users to collaborate on repositories, entities, and processes.
15
+
{% if page.layout != "argohub" %}
16
+
For Codefresh on-premises, see[On-premises account & user setup]({{site.baseurl}}/docs/installation/on-premises/on-prem-configuration/).
17
+
{% endif %}
15
18
16
19
You can then create teams in Codefresh to group users who share a common denominator, such as the same permissions, access to the same functionality, or roles. Teams make it easy for administrators to both define and manage items shared by multiple users in an orgranization.
17
20
@@ -20,16 +23,17 @@ You can then create teams in Codefresh to group users who share a common denomin
20
23
Adding a user to an account requires assigning a role to define access to account resources, and optionally, selecting an SSO provider for the user:
21
24
22
25
***Role**: Defines the user's access level to the resources in the account.
23
-
***User**: The default. With this role, users can work with your repositories and pipelines, but cannot change settings
24
-
on clusters, docker registries, git integrations, shared configurations etc.
26
+
***User**: The default. With this role, users can work with repositories and entities, but cannot change configuration settings.
25
27
***Administrator**: With this role, users have full access to accounts, and can change all settings, so make sure that they are trusted colleagues.
26
-
For guidelines on access control, see[Access control]({{site.baseurl}}/docs/administration/account-user-management/access-control/).
27
-
***SSO**: By default, SSO is not enabled for users. If required, explicitly select the SSO provider. For an overview of SSO, see[Single Sign on]({{site.baseurl}}/docs/administration/single-sign-on/).
28
+
For guidelines on access control, see {% if page.layout != "argohub" %}[Access control for pipelines]({{site.baseurl}}/docs/administration/account-user-management/access-control/){% endif %}{% if page.layout == "argohub" %}
29
+
[Configuring access control for GitOps]({{site.baseurl}}/docs/administration/account-user-management/gitops-abac/)
30
+
{% endif %}.
31
+
***SSO**: By default, SSO is not enabled for users. If required, explicitly select the SSO provider. For an overview of SSO, see[About Federated Single Sign-on]({{site.baseurl}}/docs/administration/single-sign-on/).
28
32
29
33
###Add a user to a Codefresh account
30
34
31
35
1. In the Codefresh UI, on the toolbar, click the**Settings** icon and then select**Account Settings**.
32
-
1.On the sidebar, from Access & Collaborationselect[**Users & Teams**](https://g.codefresh.io/account-admin/collaborators/users){:target="\_blank"}.
36
+
1.From the sidebarselect**Users & Teams**.
33
37
1. Select**Users**, and then select**+[Add User]**.
34
38
1. Type the**User's email address**, and click**Invite**.
35
39
<!---add screenshot-->
@@ -55,20 +59,22 @@ By default, there are two teams:
55
59
56
60
* Users
57
61
* Admins with users[invited as collaborators](#assign-a-user-to-a-team)
58
-
62
+
<!--- is this correct?-->
59
63
>**NOTE**
60
64
>Only Enterprise customers can add new teams. Other Codefresh plans can only use the predefined*Users* and*Admin* teams.[Contact us](https://codefresh.io/contact-us/){:target="\_blank"} to upgrade to an Enterprise plan.
61
65
66
+
{% if page.layout != "argohub" %}
62
67
###Automatically creating projects for teams
63
68
64
69
As part of the global pipeline settings for an account, when creating a team, you can also automatically create a project and a project tag with the same name as that of the team. Enabling**auto-create projects for teams** (disabled by default), simplifies permissions setup for pipelines and projects, as it also creates a Read rule for the project. See[Auto-create projects for teams]({{site.baseurl}}/docs/pipelines/configuration/pipeline-settings/#auto-create-projects-for-teams).
70
+
{% endif %}
65
71
66
72
###Create a team in Codefresh
67
73
68
74
Create a team in Codefresh and then assign users to the team. You can assign the same user to multiple teams, as in most companies, users have overlapping roles.
69
75
70
76
1. In the Codefresh UI, on the toolbar, click the**Settings** icon and then select**User Management**.
71
-
1. From the sidebar,from Access & Collaboration,select[**Users & Teams**](https://g.codefresh.io/account-admin/collaborators/users){:target="\_blank"}.
77
+
1. From the sidebar, select**Users & Teams**.
72
78
1. Select**Teams**, and then select**Create a Team**.
73
79
1. Enter the**Team Name**.
74
80
>**NOTE**
@@ -100,7 +106,7 @@ As an administrator, you can optionally define session timeouts to automatically
100
106
>The maximum duration for inactivity is 30 days. Inactive users are warned 15 minutes before they are logged out.
101
107
102
108
1. In the Codefresh UI, on the toolbar, click the**Settings** icon, and then select**Account Settings**.
103
-
1.On the sidebar,from Access & Collaboration,select[**Users & Teams**](https://g.codefresh.io/account-admin/collaborators/users){:target="\_blank"}.
109
+
1.From the sidebar, select**Users & Teams**.
104
110
1. Select**Security**.
105
111
1. For**User Session**, add the timeout duration in minutes/hours/days.
106
112
1. To restrict invitations to specific email domains, below User Invitations, turn on**Restrict inviting additional users..** and then in the**Email domains**, type in the domains to allow, one per line.
@@ -125,7 +131,11 @@ As an administrator, you can optionally define session timeouts to automatically
125
131
1. If this issue persists, please know that our support team is here for you.[Contact](https://support.codefresh.io/hc/en-us/requests/new) them with as many details as you have, and they will assist you promptly.
For Codefresh on-premises, see[On-premises account & user setup]({{site.baseurl}}/docs/installation/on-premises/on-prem-configuration/).
26
+
<!--- Creating an account provides access to the Codefresh platform, where you can install Runtimes, and create and manage GitOps entities.
27
+
After you select the IdP (identity provider), Codefresh requests permission to access your basic details, and for Git providers, to access your Git repositories.
28
+
29
+
The permissions requested by Codefresh are needed in order to build and deploy your projects.-->
28
30
29
-
##Step 1: Select your Identity Provider
30
-
As the first step in setting up your account in Codefresh, select the identity provider (IdP) to use.
31
+
##Supported IdPs
31
32
Codefresh currently supports the following IdPs:
32
33
* GitHub
33
34
* Bitbucket
@@ -36,139 +37,91 @@ Codefresh currently supports the following IdPs:
36
37
* Google
37
38
* LDAP
38
39
39
-
If you need an IdP that is not in the list, please[contact us](https://codefresh.io/contact-us/) with the details.
40
+
If you need an IdP that is not in the list, please[contact us](https://codefresh.io/contact-us/){:target="\_blank"} with the details.
40
41
41
-
>**NOTE**
42
-
For Git repositories, the login method is less important, as you can Git repositories through[Git integrations]({{site.baseurl}}/docs/integrations/git-providers/), regardless of your sign-up process.
43
42
44
-
If you have multiple sign-up methods, as long as you use the same email address for all sign-ups, Codefresh automatically redirects you to the account dashboard.
43
+
>**NOTE**
44
+
For Git repositories, the login method is less important, as you can access Git repositories through Git integrations, regardless of your sign-up process. <br><br>
45
+
If you have multiple sign-up methods, as long as you use the same email address in all the sign-ups, Codefresh automatically redirects you to the account dashboard.
45
46
46
-
1. Go to the[Codefresh Sign Up page](https://g.codefresh.io/signup){:target="\_blank"}.<!---need to change the URL and the screenshot-->
47
+
##Create Codefresh account
48
+
1. Go to the[Codefresh Sign Up page](https://g.codefresh.io/signup).<!---need to change the URL and the screenshot-->
1. Continue with[Step 2: Accept the permissions request](#step2-accept-the-permissions-request).
62
-
63
-
64
-
65
-
##Step 2: Accept the permissions request
66
-
67
-
After you select the IdP (identity provider), Codefresh requests permission to access your basic details, and for Git providers, to access your Git repositories. The Permissions window that is displayed differs according to the IdP selected in the previous step.
68
-
69
-
Don't worry, Codefresh will not do anything without your explicit approval. Codefresh needs the permissions to build and deploy your projects.
70
-
71
-
1. Do any of the following:
72
-
* For GitHub: To continue, click**Authorize codefresh-io**.
Once you confirm the permissions for your Git provider, Codefresh automatically connects to your Git provider and fetches your basic account details, such as your email.
98
69
70
+
{:start="4"}
71
+
1. In the Verification screen, do the following:
72
+
1. Select the required country code, enter your phone number, and then click**Send**.
73
+
1. Enter the verification code you received, and click**Next**.
Once you confirm the permissions for your Git provider, Codefresh automatically connects to your Git provider and fetches your basic account details, such as your email.