summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorShinya Maeda <shinya@gitlab.com>2018-07-06 14:38:24 +0900
committerShinya Maeda <shinya@gitlab.com>2018-07-06 14:38:24 +0900
commit25bd5413200c9cd9368c753e2752f07735604547 (patch)
treec4cc75a53face6a6d0da8adca9a3994d3cc688b5 /doc
parentb025e89e08888f3b393108f984a25c209526491b (diff)
parent969b7c565c6fe5cdfc54830d1da35f254ddaf530 (diff)
downloadgitlab-ce-25bd5413200c9cd9368c753e2752f07735604547.tar.gz
Merge branch 'master' into build-chunks-on-object-storage
Diffstat (limited to 'doc')
-rw-r--r--doc/administration/uploads.md3
-rw-r--r--doc/api/jobs.md68
-rw-r--r--doc/api/projects.md33
-rw-r--r--doc/api/todos.md1
-rw-r--r--doc/ci/examples/container_scanning.md4
-rw-r--r--doc/development/api_graphql_styleguide.md88
-rw-r--r--doc/integration/google.md4
-rw-r--r--doc/integration/shibboleth.md27
-rw-r--r--doc/workflow/todos.md1
9 files changed, 183 insertions, 46 deletions
diff --git a/doc/administration/uploads.md b/doc/administration/uploads.md
index 6688181c5a8..85eca403253 100644
--- a/doc/administration/uploads.md
+++ b/doc/administration/uploads.md
@@ -52,6 +52,7 @@ _The uploads are stored by default in
>**Notes:**
- [Introduced][ee-3867] in [GitLab Enterprise Edition Premium][eep] 10.5.
+- Since version 11.1, we support direct_upload to S3.
If you don't want to use the local disk where GitLab is installed to store the
uploads, you can use an object storage provider like AWS S3 instead.
@@ -65,7 +66,7 @@ For source installations the following settings are nested under `uploads:` and
|---------|-------------|---------|
| `enabled` | Enable/disable object storage | `false` |
| `remote_directory` | The bucket name where Uploads will be stored| |
-| `direct_upload` | Set to true to enable direct upload of Uploads without the need of local shared storage. Option may be removed once we decide to support only single storage for all files. This is beta option as it uses inefficient way of uploading data (via Unicorn). The accelerated uploads gonna be implemented in future releases | `false` |
+| `direct_upload` | Set to true to enable direct upload of Uploads without the need of local shared storage. Option may be removed once we decide to support only single storage for all files. | `false` |
| `background_upload` | Set to false to disable automatic upload. Option may be removed once upload is direct to S3 | `true` |
| `proxy_download` | Set to true to enable proxying all files served. Option allows to reduce egress traffic as this allows clients to download directly from remote storage instead of proxying all data | `false` |
| `connection` | Various connection options described below | |
diff --git a/doc/api/jobs.md b/doc/api/jobs.md
index 0fbfc7cf0fd..cfa5e9a3e95 100644
--- a/doc/api/jobs.md
+++ b/doc/api/jobs.md
@@ -32,15 +32,12 @@ Example of response
"title": "Test the CI integration."
},
"coverage": null,
- "created_at": "2015-12-24T15:51:21.802Z",
- "artifacts_file": {
- "filename": "artifacts.zip",
- "size": 1000
- },
- "finished_at": "2015-12-24T17:54:27.895Z",
- "artifacts_expire_at": "2016-01-23T17:54:27.895Z"
- "id": 7,
- "name": "teaspoon",
+ "created_at": "2015-12-24T15:51:21.727Z",
+ "artifacts_file": null,
+ "finished_at": "2015-12-24T17:54:24.921Z",
+ "artifacts_expire_at": "2016-01-23T17:54:24.921Z",
+ "id": 6,
+ "name": "rspec:other",
"pipeline": {
"id": 6,
"ref": "master",
@@ -50,7 +47,7 @@ Example of response
"ref": "master",
"runner": null,
"stage": "test",
- "started_at": "2015-12-24T17:54:27.722Z",
+ "started_at": "2015-12-24T17:54:24.729Z",
"status": "failed",
"tag": false,
"user": {
@@ -79,12 +76,15 @@ Example of response
"title": "Test the CI integration."
},
"coverage": null,
- "created_at": "2015-12-24T15:51:21.727Z",
- "artifacts_file": null,
- "finished_at": "2015-12-24T17:54:24.921Z",
- "artifacts_expire_at": "2016-01-23T17:54:24.921Z",
- "id": 6,
- "name": "rspec:other",
+ "created_at": "2015-12-24T15:51:21.802Z",
+ "artifacts_file": {
+ "filename": "artifacts.zip",
+ "size": 1000
+ },
+ "finished_at": "2015-12-24T17:54:27.895Z",
+ "artifacts_expire_at": "2016-01-23T17:54:27.895Z"
+ "id": 7,
+ "name": "teaspoon",
"pipeline": {
"id": 6,
"ref": "master",
@@ -94,7 +94,7 @@ Example of response
"ref": "master",
"runner": null,
"stage": "test",
- "started_at": "2015-12-24T17:54:24.729Z",
+ "started_at": "2015-12-24T17:54:27.722Z",
"status": "failed",
"tag": false,
"user": {
@@ -148,15 +148,12 @@ Example of response
"title": "Test the CI integration."
},
"coverage": null,
- "created_at": "2015-12-24T15:51:21.802Z",
- "artifacts_file": {
- "filename": "artifacts.zip",
- "size": 1000
- },
- "finished_at": "2015-12-24T17:54:27.895Z",
- "artifacts_expire_at": "2016-01-23T17:54:27.895Z"
- "id": 7,
- "name": "teaspoon",
+ "created_at": "2015-12-24T15:51:21.727Z",
+ "artifacts_file": null,
+ "finished_at": "2015-12-24T17:54:24.921Z",
+ "artifacts_expire_at": "2016-01-23T17:54:24.921Z"
+ "id": 6,
+ "name": "rspec:other",
"pipeline": {
"id": 6,
"ref": "master",
@@ -166,7 +163,7 @@ Example of response
"ref": "master",
"runner": null,
"stage": "test",
- "started_at": "2015-12-24T17:54:27.722Z",
+ "started_at": "2015-12-24T17:54:24.729Z",
"status": "failed",
"tag": false,
"user": {
@@ -195,12 +192,15 @@ Example of response
"title": "Test the CI integration."
},
"coverage": null,
- "created_at": "2015-12-24T15:51:21.727Z",
- "artifacts_file": null,
- "finished_at": "2015-12-24T17:54:24.921Z",
- "artifacts_expire_at": "2016-01-23T17:54:24.921Z"
- "id": 6,
- "name": "rspec:other",
+ "created_at": "2015-12-24T15:51:21.802Z",
+ "artifacts_file": {
+ "filename": "artifacts.zip",
+ "size": 1000
+ },
+ "finished_at": "2015-12-24T17:54:27.895Z",
+ "artifacts_expire_at": "2016-01-23T17:54:27.895Z"
+ "id": 7,
+ "name": "teaspoon",
"pipeline": {
"id": 6,
"ref": "master",
@@ -210,7 +210,7 @@ Example of response
"ref": "master",
"runner": null,
"stage": "test",
- "started_at": "2015-12-24T17:54:24.729Z",
+ "started_at": "2015-12-24T17:54:27.722Z",
"status": "failed",
"tag": false,
"user": {
diff --git a/doc/api/projects.md b/doc/api/projects.md
index b4599fdc97e..1e06f6d01f3 100644
--- a/doc/api/projects.md
+++ b/doc/api/projects.md
@@ -511,6 +511,39 @@ GET /projects/:id
}
```
+If the project is a fork, and you provide a valid token to authenticate, the
+`forked_from_project` field will appear in the response.
+
+```json
+{
+ "id":3,
+
+ ...
+
+ "forked_from_project":{
+ "id":13083,
+ "description":"GitLab Community Edition",
+ "name":"GitLab Community Edition",
+ "name_with_namespace":"GitLab.org / GitLab Community Edition",
+ "path":"gitlab-ce",
+ "path_with_namespace":"gitlab-org/gitlab-ce",
+ "created_at":"2013-09-26T06:02:36.000Z",
+ "default_branch":"master",
+ "tag_list":[],
+ "ssh_url_to_repo":"git@gitlab.com:gitlab-org/gitlab-ce.git",
+ "http_url_to_repo":"https://gitlab.com/gitlab-org/gitlab-ce.git",
+ "web_url":"https://gitlab.com/gitlab-org/gitlab-ce",
+ "avatar_url":"https://assets.gitlab-static.net/uploads/-/system/project/avatar/13083/logo-extra-whitespace.png",
+ "star_count":3812,
+ "forks_count":3561,
+ "last_activity_at":"2018-01-02T11:40:26.570Z"
+ }
+
+ ...
+
+}
+```
+
## Get project users
Get the users list of a project.
diff --git a/doc/api/todos.md b/doc/api/todos.md
index 27e623007cc..0843e4eedc6 100644
--- a/doc/api/todos.md
+++ b/doc/api/todos.md
@@ -18,6 +18,7 @@ Parameters:
| `action` | string | no | The action to be filtered. Can be `assigned`, `mentioned`, `build_failed`, `marked`, `approval_required`, `unmergeable` or `directly_addressed`. |
| `author_id` | integer | no | The ID of an author |
| `project_id` | integer | no | The ID of a project |
+| `group_id` | integer | no | The ID of a group |
| `state` | string | no | The state of the todo. Can be either `pending` or `done` |
| `type` | string | no | The type of a todo. Can be either `Issue` or `MergeRequest` |
diff --git a/doc/ci/examples/container_scanning.md b/doc/ci/examples/container_scanning.md
index af87c83a4e5..0f79f7d1b17 100644
--- a/doc/ci/examples/container_scanning.md
+++ b/doc/ci/examples/container_scanning.md
@@ -57,9 +57,9 @@ so, the CI/CD job must be named `container_scanning` and the artifact path must
[Learn more on container scanning results shown in merge requests](https://docs.gitlab.com/ee/user/project/merge_requests/container_scanning.html).
CAUTION: **Caution:**
-Container Scanning was previously using `sast:container` for job name and
+Before GitLab 11.0, Container Scanning was previously using `sast:container` for job name and
`gl-sast-container-report.json` for the artifact name. While these old names
-are still maintained they have been deprecated with GitLab 11.0 and may be removed
+are still maintained, they have been deprecated with GitLab 11.0 and may be removed
in next major release, GitLab 12.0. You are advised to update your current `.gitlab-ci.yml`
configuration to reflect that change.
diff --git a/doc/development/api_graphql_styleguide.md b/doc/development/api_graphql_styleguide.md
index 33f078b0a63..b4a2349844b 100644
--- a/doc/development/api_graphql_styleguide.md
+++ b/doc/development/api_graphql_styleguide.md
@@ -54,6 +54,94 @@ a new presenter specifically for GraphQL.
The presenter is initialized using the object resolved by a field, and
the context.
+### Connection Types
+
+GraphQL uses [cursor based
+pagination](https://graphql.org/learn/pagination/#pagination-and-edges)
+to expose collections of items. This provides the clients with a lot
+of flexibility while also allowing the backend to use different
+pagination models.
+
+To expose a collection of resources we can use a connection type. This wraps the array with default pagination fields. For example a query for project-pipelines could look like this:
+
+```
+query($project_path: ID!) {
+ project(fullPath: $project_path) {
+ pipelines(first: 2) {
+ pageInfo {
+ hasNextPage
+ hasPreviousPage
+ }
+ edges {
+ cursor
+ node {
+ id
+ status
+ }
+ }
+ }
+ }
+}
+```
+
+This would return the first 2 pipelines of a project and related
+pagination info., ordered by descending ID. The returned data would
+look like this:
+
+```json
+{
+ "data": {
+ "project": {
+ "pipelines": {
+ "pageInfo": {
+ "hasNextPage": true,
+ "hasPreviousPage": false
+ },
+ "edges": [
+ {
+ "cursor": "Nzc=",
+ "node": {
+ "id": "77",
+ "status": "FAILED"
+ }
+ },
+ {
+ "cursor": "Njc=",
+ "node": {
+ "id": "67",
+ "status": "FAILED"
+ }
+ }
+ ]
+ }
+ }
+ }
+}
+```
+
+To get the next page, the cursor of the last known element could be
+passed:
+
+```
+query($project_path: ID!) {
+ project(fullPath: $project_path) {
+ pipelines(first: 2, after: "Njc=") {
+ pageInfo {
+ hasNextPage
+ hasPreviousPage
+ }
+ edges {
+ cursor
+ node {
+ id
+ status
+ }
+ }
+ }
+ }
+}
+```
+
### Exposing permissions for a type
To expose permissions the current user has on a resource, you can call
diff --git a/doc/integration/google.md b/doc/integration/google.md
index 8906f91b6b4..73e2f5826ff 100644
--- a/doc/integration/google.md
+++ b/doc/integration/google.md
@@ -30,7 +30,7 @@ In Google's side:
```
https://gitlab.example.com/users/auth/google_oauth2/callback
- https://gitlab.exampl.com/-/google_api/auth/callback
+ https://gitlab.example.com/-/google_api/auth/callback
```
1. You should now be able to see a Client ID and Client secret. Note them down
@@ -77,7 +77,7 @@ On your GitLab server:
For installations from source:
- ```
+ ```yaml
- { name: 'google_oauth2', app_id: 'YOUR_APP_ID',
app_secret: 'YOUR_APP_SECRET',
args: { access_type: 'offline', approval_prompt: '' } }
diff --git a/doc/integration/shibboleth.md b/doc/integration/shibboleth.md
index 0e43b4a39a4..41fa63ae6f2 100644
--- a/doc/integration/shibboleth.md
+++ b/doc/integration/shibboleth.md
@@ -43,7 +43,19 @@ exclude shibboleth URLs from rewriting, add "RewriteCond %{REQUEST_URI} !/Shibbo
RequestHeader set X_FORWARDED_PROTO 'https'
```
-1. Edit /etc/gitlab/gitlab.rb configuration file, your shibboleth attributes should be in form of "HTTP_ATTRIBUTE" and you should adjust them to your need and environment. Add any other configuration you need.
+1. Edit /etc/gitlab/gitlab.rb configuration file to enable OmniAuth and add
+Shibboleth as an OmniAuth provider. User attributes will be sent from the
+Apache reverse proxy to GitLab as headers with the names from the Shibboleth
+attribute mapping. Therefore the values of the `args` hash
+should be in the form of `"HTTP_ATTRIBUTE"`. The keys in the hash are arguments
+to the [OmniAuth::Strategies::Shibboleth class](https://github.com/toyokazu/omniauth-shibboleth/blob/master/lib/omniauth/strategies/shibboleth.rb)
+and are documented by the [omniauth-shibboleth gem](https://github.com/toyokazu/omniauth-shibboleth)
+(take care to note the version of the gem packaged with GitLab). If some of
+your users appear to be authenticated by Shibboleth and Apache, but GitLab
+rejects their account with a URI that contains "e-mail is invalid" then your
+Shibboleth Identity Provider or Attribute Authority may be asserting multiple
+e-mail addresses. In this instance, you might consider setting the
+`multi_values` argument to `first`.
File should look like this:
```
@@ -58,14 +70,15 @@ gitlab_rails['omniauth_block_auto_created_users'] = false
gitlab_rails['omniauth_enabled'] = true
gitlab_rails['omniauth_providers'] = [
{
- "name" => 'shibboleth',
- "args" => {
- "shib_session_id_field" => "HTTP_SHIB_SESSION_ID",
+ "name" => "'shibboleth"',
+ "label" => "Text for Login Button",
+ "args" => {
+ "shib_session_id_field" => "HTTP_SHIB_SESSION_ID",
"shib_application_id_field" => "HTTP_SHIB_APPLICATION_ID",
- "uid_field" => 'HTTP_EPPN',
- "name_field" => 'HTTP_CN',
+ "uid_field" => 'HTTP_EPPN',
+ "name_field" => 'HTTP_CN',
"info_fields" => { "email" => 'HTTP_MAIL'}
- }
+ }
}
]
diff --git a/doc/workflow/todos.md b/doc/workflow/todos.md
index 760cd87d4cc..dda82352c67 100644
--- a/doc/workflow/todos.md
+++ b/doc/workflow/todos.md
@@ -109,6 +109,7 @@ There are four kinds of filters you can use on your Todos dashboard.
| Filter | Description |
| ------- | ----------- |
| Project | Filter by project |
+| Group | Filter by group |
| Author | Filter by the author that triggered the Todo |
| Type | Filter by issue or merge request |
| Action | Filter by the action that triggered the Todo |