diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2021-04-20 03:09:27 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2021-04-20 03:09:27 +0300 |
commit | 93f35ae25c1604450616ea352fd45d50552c0860 (patch) | |
tree | 9dc80506387430d943906c3151fc3d46a5786d35 /doc | |
parent | c9bef85d79791d41292d2f0727eb362034ebba1e (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r-- | doc/api/graphql/reference/index.md | 8 | ||||
-rw-r--r-- | doc/api/projects.md | 2 | ||||
-rw-r--r-- | doc/ci/services/gitlab.md | 50 | ||||
-rw-r--r-- | doc/push_rules/push_rules.md | 22 | ||||
-rw-r--r-- | doc/user/packages/container_registry/index.md | 8 |
5 files changed, 62 insertions, 28 deletions
diff --git a/doc/api/graphql/reference/index.md b/doc/api/graphql/reference/index.md index a2547b9a691..e353346b0b1 100644 --- a/doc/api/graphql/reference/index.md +++ b/doc/api/graphql/reference/index.md @@ -2117,6 +2117,7 @@ Represents a DAST Site Profile. | `profileName` | [`String`](#string) | The name of the site profile. | | `referencedInSecurityPolicies` | [`[String!]`](#string) | List of security policy names that are referencing given project. | | `requestHeaders` | [`String`](#string) | Comma-separated list of request header names and values to be added to every request made by DAST. Will always return `null` if `security_dast_site_profiles_additional_fields` feature flag is disabled. | +| `targetType` | [`DastTargetTypeEnum`](#dasttargettypeenum) | The type of target to be scanned. Will always return `null` if `security_dast_site_profiles_api_option` feature flag is disabled. | | `targetUrl` | [`String`](#string) | The URL of the target to be scanned. | | `userPermissions` | [`DastSiteProfilePermissions!`](#dastsiteprofilepermissions) | Permissions for the current user on the resource. | | `validationStatus` | [`DastSiteProfileValidationStatusEnum`](#dastsiteprofilevalidationstatusenum) | The current validation status of the site profile. | @@ -7871,6 +7872,13 @@ Status of a container repository. | `HEADER` | Header validation. | | `TEXT_FILE` | Text file validation. | +### `DastTargetTypeEnum` + +| Value | Description | +| ----- | ----------- | +| `API` | API target. | +| `WEBSITE` | Website target. | + ### `DataVisualizationColorEnum` Color of the data visualization palette. diff --git a/doc/api/projects.md b/doc/api/projects.md index a6d7e538509..50c1356dfd8 100644 --- a/doc/api/projects.md +++ b/doc/api/projects.md @@ -1125,7 +1125,7 @@ POST /projects | `build_timeout` | integer | **{dotted-circle}** No | The maximum amount of time, in seconds, that a job can run. | | `builds_access_level` | string | **{dotted-circle}** No | One of `disabled`, `private`, or `enabled`. | | `ci_config_path` | string | **{dotted-circle}** No | The path to CI configuration file. | -| `container_expiration_policy_attributes` | hash | **{dotted-circle}** No | Update the image cleanup policy for this project. Accepts: `cadence` (string), `keep_n` (integer), `older_than` (string), `name_regex` (string), `name_regex_delete` (string), `name_regex_keep` (string), `enabled` (boolean). | +| `container_expiration_policy_attributes` | hash | **{dotted-circle}** No | Update the image cleanup policy for this project. Accepts: `cadence` (string), `keep_n` (integer), `older_than` (string), `name_regex` (string), `name_regex_delete` (string), `name_regex_keep` (string), `enabled` (boolean). Valid values for `cadence` are: `1d` (every day), `7d` (every week), `14d` (every two weeks), `1month` (every month), or `3month` (every quarter). | | `container_registry_enabled` | boolean | **{dotted-circle}** No | Enable container registry for this project. | | `default_branch` | string | **{dotted-circle}** No | The [default branch](../user/project/repository/branches/default.md) name. | | `description` | string | **{dotted-circle}** No | Short project description. | diff --git a/doc/ci/services/gitlab.md b/doc/ci/services/gitlab.md index d9962d9d1f2..8a582cc87eb 100644 --- a/doc/ci/services/gitlab.md +++ b/doc/ci/services/gitlab.md @@ -5,40 +5,36 @@ info: To determine the technical writer assigned to the Stage/Group associated w type: reference --- -# Using GitLab +# Use GitLab as a microservice -As many applications depend on accessing JSON apis you eventually need them in order for your tests to run. -In this example we are providing GitLab as a Microservice to be accessible for API clients. -Below you are guided how to do this with the Docker executors of GitLab Runner. +Many applications need to access JSON APIs, so application tests might need access +to APIs too. The following example shows how to use GitLab as a microservice to give +tests access to the GitLab API. -## Use GitLab with the Docker executor +1. Configure a [runner](../runners/README.md) with the Docker or Kubernetes executor. +1. In your `.gitlab-ci.yml` add: -If you're using [GitLab Runner](../runners/README.md) with the Docker/Kubernetes executor, -you basically have everything set up already. + ```yaml + services: + - name: gitlab/gitlab-ce:latest + alias: gitlab -First, in your `.gitlab-ci.yml` add: + variables: + GITLAB_HTTPS: "false" # ensure that plain http works + GITLAB_ROOT_PASSWORD: "password" # to access the api with user root:password + ``` -```yaml -services: - - name: gitlab/gitlab-ce:latest - alias: gitlab +1. To set values for the `GITLAB_HTTPS` and `GITLAB_ROOT_PASSWORD`, + [assign them to a variable in the user interface](../variables/README.md#project-cicd-variables). + Then assign that variable to the corresponding variable in your + `.gitlab-ci.yml` file. + +Then, commands in `script:` sections in your `.gitlab-ci.yml` file can access the API at `http://gitlab/api/v4`. -variables: - GITLAB_HTTPS: "false" # ensure that plain http will work - GITLAB_ROOT_PASSWORD: "password" # in order to access the api with user root:password -``` - -To set values for the `GITLAB_HTTPS`, `GITLAB_ROOT_PASSWORD`, -[assign them to a variable in the user interface](../variables/README.md#project-cicd-variables), -then assign that variable to the corresponding variable in your -`.gitlab-ci.yml` file. - -From your ci `script:` the API will then be availible at `http://gitlab/api/v4` - -If you're wondering why we used `gitlab` for the `Host`, read more at +For more information about why `gitlab` is used for the `Host`, see [How services are linked to the job](../docker/using_docker_images.md#extended-docker-configuration-options). You can also use any other Docker image available on [Docker Hub](https://hub.docker.com/u/gitlab). -The `gitlab` image can accept some environment variables. For more details, -see the [omnibus documentation](../../install/README.md). +The `gitlab` image can accept environment variables. For more details, +see the [Omnibus documentation](../../install/README.md). diff --git a/doc/push_rules/push_rules.md b/doc/push_rules/push_rules.md index 9be76416ba7..2117a961957 100644 --- a/doc/push_rules/push_rules.md +++ b/doc/push_rules/push_rules.md @@ -103,6 +103,28 @@ The following options are available: NOTE: GitLab uses [RE2 syntax](https://github.com/google/re2/wiki/Syntax) for regular expressions in push rules, and you can test them at the [regex101 regex tester](https://regex101.com/). +### Caveat to "Reject unsigned commits" push rule **(PREMIUM)** + +This push rule ignores commits that are authenticated and created by GitLab +(either through the UI or API). When the **Reject unsigned commits** push rule is +enabled, unsigned commits may still show up in the commit history if a commit was +created **within** GitLab itself. As expected, commits created outside GitLab and +pushed to the repository are rejected. For more information about how GitLab +plans to fix this issue, read [issue #19185](https://gitlab.com/gitlab-org/gitlab/-/issues/19185). + +#### "Reject unsigned commits" push rule disables Web IDE + +In 13.10, if a project has the "Reject unsigned commits" push rule, the user will not be allowed to +commit through GitLab Web IDE. + +To allow committing through the Web IDE on a project with this push rule, a GitLab administrator will +need to disable the feature flag `reject_unsigned_commits_by_gitlab`. This can be done through a +[rails console](../administration/operations/rails_console.md) and running: + +```ruby +Feature.disable(:reject_unsigned_commits_by_gitlab) +``` + ## Prevent pushing secrets to the repository > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/385) in GitLab 8.12. diff --git a/doc/user/packages/container_registry/index.md b/doc/user/packages/container_registry/index.md index 102defacffa..bc96d3c937c 100644 --- a/doc/user/packages/container_registry/index.md +++ b/doc/user/packages/container_registry/index.md @@ -636,6 +636,14 @@ Examples: curl --request PUT --header 'Content-Type: application/json;charset=UTF-8' --header "PRIVATE-TOKEN: <your_access_token>" --data-binary '{"container_expiration_policy_attributes":{"cadence":"1month","enabled":true,"keep_n":1,"older_than":"14d","name_regex":"","name_regex_delete":".*","name_regex_keep":".*-master"}}' "https://gitlab.example.com/api/v4/projects/2" ``` +Valid values for `cadence` when using the API are: + +- `1d` (every day) +- `7d` (every week) +- `14d` (every two weeks) +- `1month` (every month) +- `3month` (every quarter) + See the API documentation for further details: [Edit project](../../../api/projects.md#edit-project). ### Use with external container registries |