Commit d1c38b5b authored by Jacques Erasmus's avatar Jacques Erasmus

Merge branch 'eread/fix-administrator-role-instances' into 'master'

Fix references to Administrator role and other improvements

See merge request gitlab-org/gitlab!79489
parents 9f26f0bb 3e210ae4
......@@ -26,10 +26,10 @@
= render_if_exists 'admin/users/auditor_access_level_radio', f: f, disabled: editing_current_user
- help_text = s_('AdminUsers|Administrators have access to all groups, projects and users and can manage all features in this installation.')
- help_text += ' ' + s_('AdminUsers|You cannot remove your own admin rights.') if editing_current_user
- help_text = s_('AdminUsers|The user has unlimited access to all groups, projects, users, and features.')
- help_text += ' ' + s_('AdminUsers|You cannot remove your own administrator access.') if editing_current_user
= f.gitlab_ui_radio_component :access_level, :admin,
s_('AdminUsers|Admin'),
s_('AdminUsers|Administrator'),
radio_options: { disabled: editing_current_user },
help_text: help_text
......
......@@ -22,6 +22,3 @@ swap:
repo: repository
timezone: time zone
utilize: use
administrator permission: the administrator access level
administrator permissions: the administrator access level
administrator role: the administrator access level
......@@ -38,6 +38,12 @@ swap:
can sign-in: can sign in
x509: X.509
yaml: YAML
admin user: administrator
admin users: administrators
administrator permission: administrator access
administrator permissions: administrator access
administrator role: administrator access
the administrator access level: administrator access
developer access: the Developer role
developer permission: the Developer role
developer permissions: the Developer role
......
......@@ -64,7 +64,7 @@ To create an Auditor user:
1. Select **Create user** or **Save changes** if you created a new user or
edited an existing one respectively.
To revoke Auditor permissions from a user, make them a regular user by
To revoke Auditor permissions from a user, make them a Regular user by
following the previous steps.
Additionally users can be set as an Auditor using [SAML groups](../integration/saml.md#auditor-groups).
......
......@@ -382,7 +382,7 @@ the following are true:
- The configured `admin_group` in the `gitlab.rb` is a CN, rather than a DN or an array.
- This CN falls under the scope of the configured `group_base`.
- The members of the `admin_group` have already signed into GitLab with their LDAP
credentials. GitLab only grants the Administrator role to the users whose
credentials. GitLab only grants administrator access to the users whose
accounts are already connected to LDAP.
If all the above are true and the users are still not getting access,
......
......@@ -108,7 +108,7 @@ appears next to requests with warnings.
The performance bar is disabled by default for non-administrators. To enable it
for a given group:
1. Sign in as a user with Administrator [role](../../../user/permissions.md).
1. Sign in as a user with administrator access.
1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Settings > Metrics and profiling**
(`admin/application_settings/metrics_and_profiling`), and expand
......
......@@ -8,7 +8,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
To enable the GitLab Prometheus metrics:
1. Log in to GitLab as a user with Administrator [role](../../../user/permissions.md).
1. Log in to GitLab as a user with administrator access.
1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Settings > Metrics and profiling**.
1. Find the **Metrics - Prometheus** section, and select **Add link to Prometheus**.
......
......@@ -1332,7 +1332,7 @@ cluster = Clusters::Cluster.find_by(name: 'cluster_name')
Delete cluster without associated resources:
```ruby
# Find users with the Administrator role
# Find users with the administrator access
user = User.find_by(username: 'admin_user')
# Find the cluster with the ID
......
......@@ -9,7 +9,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
## List all deploy keys **(FREE SELF)**
Get a list of all deploy keys across all projects of the GitLab instance. This
endpoint requires an administrator role and is not available on GitLab.com.
endpoint requires administrator access and is not available on GitLab.com.
```plaintext
GET /deploy_keys
......
......@@ -10,7 +10,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/21811) in GitLab 12.9.
Get a list of all deploy tokens across the GitLab instance. This endpoint requires the Administrator role.
Get a list of all deploy tokens across the GitLab instance. This endpoint requires administrator access.
```plaintext
GET /deploy_tokens
......
......@@ -832,7 +832,8 @@ curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
## Transfer project to group
Transfer a project to the Group namespace. Available only to instance administrators, although an [alternative API endpoint](projects.md#transfer-a-project-to-a-new-namespace) is available which does not require instance administrator role. Transferring projects may fail when tagged packages exist in the project's repository.
Transfer a project to the Group namespace. Available only to instance administrators, although an [alternative API endpoint](projects.md#transfer-a-project-to-a-new-namespace)
is available which does not require administrator access on the instance. Transferring projects may fail when tagged packages exist in the project's repository.
```plaintext
POST /groups/:id/projects/:project_id
......
......@@ -16,8 +16,7 @@ With [instance-level Kubernetes clusters](../user/instance/clusters/index.md),
you can connect a Kubernetes cluster to the GitLab instance and use the same cluster across all of
the projects within your instance.
NOTE:
Users need the Administrator role to use these endpoints.
Users need administrator access to use these endpoints.
## List instance clusters
......
......@@ -12,7 +12,7 @@ The GitLab Pages feature must be enabled to use these endpoints. Find out more a
## Unpublish pages
Remove pages. The user must have the Administrator role.
Remove pages. The user must have administrator access.
```plaintext
DELETE /projects/:id/pages
......
......@@ -12,7 +12,7 @@ The GitLab Pages feature must be enabled to use these endpoints. Find out more a
## List all Pages domains
Get a list of all Pages domains. The user must have the administrator role.
Get a list of all Pages domains. The user must have administrator access.
```plaintext
GET /pages/domains
......
......@@ -13,8 +13,7 @@ The plan limits API allows you to maintain the application limits for the existi
The existing plans depend on the GitLab edition. In the Community Edition, only the plan `default`
is available. In the Enterprise Edition, additional plans are available as well.
NOTE:
The Administrator role is required to use this API.
Administrator access is required to use this API.
## Get current plan limits
......
......@@ -246,7 +246,7 @@ curl "https://gitlab.com/api/v4/projects/1/snippets/2/files/master/snippet%2Erb/
## Get user agent details
Available only for users with the Administrator role.
Available only for users with administrator access.
```plaintext
GET /projects/:id/snippets/:snippet_id/user_agent_detail
......
......@@ -98,7 +98,7 @@ Example response:
## List all runners **(FREE SELF)**
Get a list of all runners in the GitLab instance (specific and shared). Access
is restricted to users with the administrator role.
is restricted to users with administrator access.
```plaintext
GET /runners/all
......
......@@ -109,7 +109,7 @@ GET /users
| `sort` | string | no | Return users sorted in `asc` or `desc` order. Default is `desc` |
| `two_factor` | string | no | Filter users by Two-factor authentication. Filter values are `enabled` or `disabled`. By default it returns all users |
| `without_projects` | boolean | no | Filter users without projects. Default is `false`, which means that all users are returned, with and without projects. |
| `admins` | boolean | no | Return only admin users. Default is `false` |
| `admins` | boolean | no | Return only administrators. Default is `false` |
| `saml_provider_id` **(PREMIUM)** | number | no | Return only users created by the specified SAML provider ID. If not included, it returns all users. |
```json
......@@ -1546,7 +1546,7 @@ Please refer to the [Events API documentation](events.md#get-user-contribution-e
## Get all impersonation tokens of a user
> Requires administrator permissions.
Requires administrator access.
It retrieves every impersonation token of the user. Use the pagination
parameters `page` and `per_page` to restrict the list of impersonation tokens.
......@@ -1720,8 +1720,8 @@ Example response:
## Create an impersonation token
> Requires administrator permissions.
> Token values are returned once. Make sure you save it - you can't access it again.
Requires administrator access. Token values are returned once. Make sure you save it because you can't access
it again.
It creates a new impersonation token. Only administrators can do this.
You are only able to create impersonation tokens to impersonate the user and perform
......@@ -1765,7 +1765,7 @@ Example response:
## Revoke an impersonation token
> Requires administrator permissions.
Requires administrator access.
It revokes an impersonation token.
......
......@@ -260,7 +260,7 @@ You can delete a single job, which also removes the job's
artifacts and log. You must be:
- The owner of the job.
- A Maintainer of the project.
- A user with at least the Maintainer role for the project.
To delete a job:
......
......@@ -387,7 +387,7 @@ time.
## Debug a job locally
The following commands are run without root privileges. You should be
able to run Docker with your regular user account.
able to run Docker with your user account.
First start with creating a file named `build_script`:
......
......@@ -233,7 +233,7 @@ inherited.
> - [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/issues/299879) in GitLab 13.11.
To make a CI/CD variable available to all projects and groups in a GitLab instance,
add an instance CI/CD variable. You must have the Administrator access level.
add an instance CI/CD variable. You must have administrator access.
You can define instance variables via the UI or [API](../../api/instance_level_ci_variables.md).
......
......@@ -58,11 +58,7 @@ Capitalize these words when you refer to the UI. Otherwise use lowercase.
## administrator
Use **administrator** instead of **admin** when talking about a user's access level.
Use lowercase unless you are referring to the **Admin** access level you select in the UI.
To view the administrator access level, in the GitLab UI, go to the Admin Area and select
**Users**. Then select **New user**.
Use **administrator access** instead of **admin** when talking about a user's access level.
![admin access level](img/admin_access_level.png)
......@@ -71,7 +67,7 @@ An **administrator** is not a [role](#roles) or [permission](#permissions).
Use:
- To do this thing, you must be an administrator.
- To do this thing, you must have the administrator access level.
- To do this thing, you must have administrator access.
Instead of:
......
......@@ -45,7 +45,7 @@ many groups or projects, and the access level (including guest, developer, or
maintainer) to groups and projects determines what users can see and
what they can access.
Users with the administrator role can access all projects and even impersonate
Users with administrator access can access all projects and even impersonate
users.
#### Sharding and partitioning
......
......@@ -84,7 +84,7 @@ Registration is not yet required for participation, but will be added in a futur
#### Enable Registration Features
1. Sign in as a user with the [Administrator](../../user/permissions.md) role.
1. Sign in as a user with administrator access.
1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Settings > Metrics and profiling**.
1. Expand the **Usage statistics** section.
......@@ -96,7 +96,7 @@ Registration is not yet required for participation, but will be added in a futur
You can view the exact JSON payload sent to GitLab Inc. in the Admin Area. To view the payload:
1. Sign in as a user with the [Administrator](../../user/permissions.md) role.
1. Sign in as a user with administrator access.
1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Settings > Metrics and profiling**.
1. Expand the **Usage statistics** section.
......@@ -118,7 +118,7 @@ configuration file.
To disable Service Ping in the GitLab UI:
1. Sign in as a user with the [Administrator](../../user/permissions.md) role.
1. Sign in as a user with administrator access.
1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Settings > Metrics and profiling**.
1. Expand the **Usage statistics** section.
......
......@@ -363,11 +363,11 @@ after(:all) do
end
```
## Tag tests that require the Administrator role
## Tag tests that require administrator access
We don't run tests that require the Administrator role against our Production environments.
We don't run tests that require administrator access against our Production environments.
When you add a new test that requires the Administrator role, apply the RSpec metadata `:requires_admin` so that the test will not be included in the test suites executed against Production and other environments on which we don't want to run those tests.
When you add a new test that requires administrator access, apply the RSpec metadata `:requires_admin` so that the test will not be included in the test suites executed against Production and other environments on which we don't want to run those tests.
When running tests locally or configuring a pipeline, the environment variable `QA_CAN_TEST_ADMIN_FEATURES` can be set to `false` to skip tests that have the `:requires_admin` tag.
......
......@@ -26,7 +26,7 @@ project, group, or instance level:
Copy this value, as you need it in a later step.
1. *For project-level or group-level integrations:* In GitLab, go to your project or group.
1. *For instance-level integrations:*
1. Sign in to GitLab as a user with the Administrator access level.
1. Sign in to GitLab as a user with administrator access.
1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Settings > Integrations**.
1. Scroll to **Add an integration**, and select **Datadog**.
......
......@@ -44,7 +44,7 @@ Grant a GitLab user access to the relevant GitLab projects.
1. Grant the user permission to the GitLab projects.
If you're integrating Jenkins with many GitLab projects, consider granting the
user the administrator access level. Otherwise, add the user to each project
user administrator access. Otherwise, add the user to each project
and grant the Developer role.
## Grant Jenkins access to the GitLab API
......
......@@ -10,8 +10,7 @@ You can integrate GitLab and Jira Cloud using the
[GitLab.com for Jira Cloud](https://marketplace.atlassian.com/apps/1221011/gitlab-com-for-jira-cloud)
app in the Atlassian Marketplace.
NOTE:
Only Jira users with the administrator role can install or configure
Only Jira users with administrator access can install or configure
the GitLab.com for Jira Cloud app.
## Install the GitLab.com for Jira Cloud app **(FREE SAAS)**
......@@ -91,10 +90,10 @@ self-managed GitLab instances with Jira Cloud, you can either:
You can configure your Atlassian Cloud instance to allow you to install applications
from outside the Marketplace, which allows you to install the application:
1. Sign in to your Jira instance as a user with an Administrator role.
1. Sign in to your Jira instance as an administrator.
1. Place your Jira instance into
[development mode](https://developer.atlassian.com/cloud/jira/platform/getting-started-with-connect/#step-2--enable-development-mode).
1. Sign in to your GitLab application as an [administrator](../../user/permissions.md).
1. Sign in to your GitLab application as a user with administrator access.
1. Install the GitLab application from your self-managed GitLab instance, as
described in the [Atlassian developer guides](https://developer.atlassian.com/cloud/jira/platform/getting-started-with-connect/#step-3--install-and-test-your-app):
1. In your Jira instance, go to **Apps > Manage Apps** and select **Upload app**:
......
......@@ -367,7 +367,7 @@ The requirements are the same as the previous settings:
- The IdP must pass Group information to GitLab.
- GitLab must know where to look for the groups in the SAML response, as well as
which group(s) grant the user an administrator role.
which groups grant the user administrator access.
```yaml
{ name: 'saml',
......@@ -504,7 +504,7 @@ omniauth:
Keep in mind that every sign in attempt redirects to the SAML server;
you cannot sign in using local credentials. Ensure at least one of the
SAML users has an administrator role.
SAML users has administrator access.
You may also bypass the auto sign-in feature by browsing to
`https://gitlab.example.com/users/sign_in?auto_sign_in=false`.
......
......@@ -26,7 +26,7 @@ For information about email notifications originating from GitLab, read
1. On the left sidebar, select **Overview > Users**.
1. Select **Send email to users**.
![admin users](email1.png)
![administrators](email1.png)
1. Compose an email and choose where to send it (all users or users of a
chosen group or project). The email body only supports plain text messages.
......
......@@ -30,7 +30,7 @@ for deprecated API endpoints. No other new features are provided by this overrid
Prerequisites:
- You must have the Administrator role for your instance.
- You must have administrator access for your instance.
To override the general user and IP rate limits for requests to deprecated API endpoints:
......
......@@ -26,7 +26,7 @@ for the Files API. No other new features are provided by this override.
Prerequisite:
- You must have the Administrator role for your instance.
- You must have administrator access for your instance.
To override the general user and IP rate limits for requests to the Repository files API:
......
......@@ -38,7 +38,7 @@ they do not have access to all projects, groups, or the **Admin Area** menu.
To access potentially dangerous resources, an administrator can activate Admin Mode by:
- Selecting the *Enable Admin Mode* button
- Trying to access any part of the UI that requires an administrator role, specifically those which call `/admin` endpoints.
- Trying to access any part of the UI that requires administrator access, specifically those which call `/admin` endpoints.
The main use case allows administrators to perform their regular tasks as a regular
user, based on their memberships, without having to set up a second account for
......
......@@ -7,7 +7,7 @@ type: reference
# Control access and visibility **(FREE SELF)**
GitLab enables users with the Administrator access level to enforce
GitLab enables users with administrator access to enforce
specific controls on branches, projects, snippets, groups, and more.
To access the visibility and access control options:
......@@ -84,7 +84,7 @@ on the instance. To alter which roles have permission to create projects:
## Restrict project deletion to Administrators **(PREMIUM SELF)**
Anyone with the **Owner** role, either at the project or group level, can
delete a project. To allow only users with the Administrator role to delete projects:
delete a project. To allow only users with administrator access to delete projects:
1. Sign in to GitLab as a user with Administrator access level.
1. On the top bar, select **Menu > Admin**.
......
......@@ -33,10 +33,10 @@ before using this feature.
## Permissions for using Terraform
In GitLab version 13.1, the Maintainer role was required to use a
In GitLab version 13.1, at least the Maintainer role was required to use a
GitLab managed Terraform state backend.
In GitLab versions 13.2 and later:
In GitLab versions 13.2 and later, at least:
- The Maintainer role is required to lock, unlock, and write to the state (using `terraform apply`).
- The Developer role is required to read the state (using `terraform plan -lock=false`).
......
......@@ -603,7 +603,7 @@ You can then tag the manifest list with `mygroup/myapp:1.0.0`.
### Troubleshoot as a GitLab server administrator
Troubleshooting the GitLab Container Registry, most of the times, requires
you to log in to GitLab server with the Administrator role.
you to log in to GitLab server with administrator access.
[Read how to troubleshoot the Container Registry](../../../administration/packages/container_registry.md#troubleshooting).
......
......@@ -181,8 +181,7 @@ Mirroring does not sync any new or updated pull requests from your GitHub projec
## Improve the speed of imports on self-managed instances
NOTE:
An administrator role on the GitLab server is required for this process.
Administrator access on the GitLab server is required for this process.
For large projects it may take a while to import all data. To reduce the time necessary, you can increase the number of
Sidekiq workers that process the following queues:
......
......@@ -50,7 +50,7 @@ information, see the prerequisites and important notes in these sections:
NOTE:
When migrating to GitLab.com, you must create users manually unless [SCIM](../../../user/group/saml_sso/scim_setup.md)
will be used. Creating users with the API is limited to self-managed instances as it requires
the Administrator role.
administrator access.
To migrate all data from self-managed to GitLab.com, you can leverage the [API](../../../api/index.md).
Migrate the assets in this order:
......
......@@ -67,7 +67,7 @@ After you enable custom slash commands in Mattermost, you need configuration
information from GitLab. To get this information:
1. In a different browser tab than your current Mattermost session, sign in to
GitLab as a user with the administrator access level.
GitLab as a user with administrator access.
1. On the top bar, select **Menu > Admin**.
1. In the left menu, select **Settings > Integrations**, then select
**Mattermost slash commands**.
......
......@@ -468,7 +468,7 @@ Merge requests in other projects can still close another project's issues.
Prerequisites:
- You must have the [administrator access level](../../../administration/index.md) for your GitLab instance.
- You must have [administrator access](../../../administration/index.md) to your GitLab instance.
To change the default issue closing pattern, edit the
[`gitlab.rb` or `gitlab.yml` file](../../../administration/issue_closing_pattern.md)
......
......@@ -81,7 +81,7 @@ GitLab Pages website.
You can either use the GitLab [default domain for GitLab Pages websites](getting_started_part_one.md#gitlab-pages-default-domain-names),
`*.gitlab.io`, or your own domain (`example.com`). In that case, you
must have the Administrator role in your domain's registrar (or control panel) to set it up with Pages.
must be an administrator in your domain's registrar (or control panel) to set it up with Pages.
The following diagrams show the workflows you might follow to get started with Pages.
......
......@@ -217,7 +217,7 @@ for details about the pipelines security model.
## Delete a protected branch
Users with at least the Maintainer can manually delete protected
Users with at least the Maintainer role can manually delete protected
branches by using the GitLab web interface:
1. Go to **Repository > Branches**.
......
......@@ -360,7 +360,7 @@ available in project listings. Only project owners and administrators have the
To find an archived project:
1. Sign in to GitLab as the project owner or a user with the Administrator role.
1. Sign in to GitLab as the project owner or a user with administrator access.
1. If you:
- Have the project's URL, open the project's page in your browser.
- Don't have the project's URL:
......
......@@ -58,7 +58,7 @@ User.where(confirmed_at: nil).where('LENGTH(confirmation_token) = 32')
## What does it look like when a user is blocked?
A regular user might receive a message that says "You have to confirm your email address before continuing". This message could includes a 404 or 422 error code, when the user tries to sign in.
A user might receive a message that says "You have to confirm your email address before continuing". This message could includes a 404 or 422 error code, when the user tries to sign in.
NOTE:
We hope to improve the [sign-in experience for an unverified user](https://gitlab.com/gitlab-org/gitlab/-/issues/29279) in a future release.
......
......@@ -2713,7 +2713,7 @@ msgstr ""
msgid "AdminUsers|Admin"
msgstr ""
msgid "AdminUsers|Administrators have access to all groups, projects and users and can manage all features in this installation."
msgid "AdminUsers|Administrator"
msgstr ""
msgid "AdminUsers|Admins"
......@@ -2905,6 +2905,9 @@ msgstr ""
msgid "AdminUsers|The user can't log in."
msgstr ""
msgid "AdminUsers|The user has unlimited access to all groups, projects, users, and features."
msgstr ""
msgid "AdminUsers|The user will be logged out"
msgstr ""
......@@ -3007,7 +3010,7 @@ msgstr ""
msgid "AdminUsers|You can unban their account in the future. Their data remains intact."
msgstr ""
msgid "AdminUsers|You cannot remove your own admin rights."
msgid "AdminUsers|You cannot remove your own administrator access."
msgstr ""
msgid "AdminUsers|You must transfer ownership or delete the groups owned by this user before you can delete their account"
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment