summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2020-07-23 03:09:42 +0000
committerGitLab Bot <gitlab-bot@gitlab.com>2020-07-23 03:09:42 +0000
commitf8454d351eb238ae9898fb7bd67013fe8e93d0db (patch)
tree988278bb45940e7b9c3253e652f54597fce33f2c /doc
parent46c2316f9226d9701437bd535880651e59bebdc6 (diff)
downloadgitlab-ce-f8454d351eb238ae9898fb7bd67013fe8e93d0db.tar.gz
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r--doc/api/graphql/audit_report.md116
-rw-r--r--doc/api/graphql/img/user_query_example_v13_2.pngbin0 -> 324114 bytes
-rw-r--r--doc/api/services.md4
-rw-r--r--doc/development/documentation/index.md4
-rw-r--r--doc/user/packages/container_registry/index.md8
5 files changed, 124 insertions, 8 deletions
diff --git a/doc/api/graphql/audit_report.md b/doc/api/graphql/audit_report.md
new file mode 100644
index 00000000000..8b8ea913c03
--- /dev/null
+++ b/doc/api/graphql/audit_report.md
@@ -0,0 +1,116 @@
+# Set up an Audit Report with GraphQL
+
+This page describes how you can use the GraphiQL explorer to set up an audit report
+for a specific subset of users.
+
+You can run the same query directly via a HTTP endpoint, using `cURL`. For more information, see our
+guidance on getting started from the [command line](getting_started.md#command-line).
+
+The [example users query](#set-up-the-graphiql-explorer) looks for a subset of users in
+a GitLab instance either by username or
+[global ID](../../development/api_graphql_styleguide.md#exposing-global-ids). The query
+includes:
+
+- [`pageInfo`](#pageinfo)
+- [`nodes`](#nodes)
+
+## pageInfo
+
+This contains the data needed to implement pagination. GitLab uses cursor-based
+[pagination](getting_started.md#pagination). For more information, see
+[Pagination](https://graphql.org/learn/pagination/) in the GraphQL documentation.
+
+## nodes
+
+In a GraphQL query, `nodes` is used to represent a collection of [`nodes` on a graph](https://en.wikipedia.org/wiki/Vertex_(graph_theory)).
+In this case, the collection of nodes is a collection of `User` objects. For each one,
+we output:
+
+- Their user's `id`.
+- The `membership` fragment, which represents a Project or Group membership belonging
+ to that user. Outputting a fragment is denoted with the `...memberships` notation.
+
+The GitLab GraphQL API is extensive and a large amount of data for a wide variety of entities can be output.
+See the official [reference documentation](reference/index.md) for the most up-to-date information.
+
+## Set up the GraphiQL explorer
+
+This procedure presents a substantive example that you can copy and paste into GraphiQL
+explorer. GraphiQL explorer is available for:
+
+- GitLab.com users at [https://gitlab.com/-/graphql-explorer](https://gitlab.com/-/graphql-explorer).
+- Self-managed users at `https://gitlab.example.com/-/graphql-explorer`.
+
+1. Copy the following code excerpt:
+
+ ```graphql
+ {
+ users(usernames: ["user1", "user2", "user3"]) {
+ pageInfo {
+ endCursor
+ startCursor
+ hasNextPage
+ }
+ nodes {
+ id
+ ...memberships
+ }
+ }
+ }
+
+ fragment membership on MemberInterface {
+ createdAt
+ updatedAt
+ accessLevel {
+ integerValue
+ stringValue
+ }
+ createdBy {
+ id
+ }
+ }
+
+ fragment memberships on User {
+ groupMemberships {
+ nodes {
+ ...membership
+ group {
+ id
+ name
+ }
+ }
+ }
+
+ projectMemberships {
+ nodes {
+ ...membership
+ project {
+ id
+ name
+ }
+ }
+ }
+ }
+ ```
+
+1. Open the [GraphiQL explorer tool](https://gitlab.com/-/graphql-explorer).
+1. Paste the `query` listed above into the left window of your GraphiQL explorer tool.
+1. Click Play to get the result shown here:
+
+![GraphiQL explorer search for boards](img/user_query_example_v13_2.png)
+
+NOTE: **Note:**
+[The GraphQL API returns a GlobalID, rather than a standard ID.](getting_started.md#queries-and-mutations) It also expects a GlobalID as an input rather than
+a single integer.
+
+This GraphQL query returns the groups and projects that the user has been *explicitly* made a member of.
+Since the GraphiQL explorer uses the session token to authorize access to resources,
+the output is limited to the projects and groups accessible to the currently signed-in user.
+
+If you've signed in as an instance administrator, you would have access to all records, regardless of ownership.
+
+For more information on:
+
+- GraphQL specific entities, such as Fragments and Interfaces, see the official
+ [GraphQL documentation](https://graphql.org/learn/).
+- Individual attributes, see the [GraphQL API Resources](reference/index.md).
diff --git a/doc/api/graphql/img/user_query_example_v13_2.png b/doc/api/graphql/img/user_query_example_v13_2.png
new file mode 100644
index 00000000000..8935bb7fa3c
--- /dev/null
+++ b/doc/api/graphql/img/user_query_example_v13_2.png
Binary files differ
diff --git a/doc/api/services.md b/doc/api/services.md
index 4052fd22641..e5819a82e9e 100644
--- a/doc/api/services.md
+++ b/doc/api/services.md
@@ -229,8 +229,8 @@ Parameters:
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `token` | string | true | Buildkite project GitLab token |
-| `project_url` | string | true | `https://buildkite.com/example/project` |
-| `enable_ssl_verification` | boolean | false | Enable SSL verification |
+| `project_url` | string | true | Pipeline URL. For example, `https://buildkite.com/example/pipeline` |
+| `enable_ssl_verification` | boolean | false | DEPRECATED: This parameter has no effect since SSL verification will always be enabled |
| `push_events` | boolean | false | Enable notifications for push events |
### Delete Buildkite service
diff --git a/doc/development/documentation/index.md b/doc/development/documentation/index.md
index 2ea26985fcf..71d8a8fc7f9 100644
--- a/doc/development/documentation/index.md
+++ b/doc/development/documentation/index.md
@@ -445,8 +445,8 @@ In case the review app URL returns 404, follow these steps to debug:
If you want to know the in-depth details, here's what's really happening:
1. You manually run the `review-docs-deploy` job in a merge request.
-1. The job runs the [`scripts/trigger-build-docs`](https://gitlab.com/gitlab-org/gitlab/blob/master/scripts/trigger-build-docs)
- script with the `deploy` flag, which in turn:
+1. The job runs the [`scripts/trigger-build`](https://gitlab.com/gitlab-org/gitlab/blob/master/scripts/trigger-build)
+ script with the `docs deploy` flag, which in turn:
1. Takes your branch name and applies the following:
- The `docs-preview-` prefix is added.
- The product slug is used to know the project the review app originated
diff --git a/doc/user/packages/container_registry/index.md b/doc/user/packages/container_registry/index.md
index 80009aa8b04..6f865604a08 100644
--- a/doc/user/packages/container_registry/index.md
+++ b/doc/user/packages/container_registry/index.md
@@ -505,14 +505,14 @@ To delete the underlying layers and images that aren't associated with any tags,
### Enable the cleanup policy
-The cleanup policy is enabled for all projects by default.
+Cleanup policies can be run on all projects, with these exceptions:
-- For GitLab.com, the project must have been created before February, 2020.
+- For GitLab.com, the project must have been created after 2020-02-22.
Support for projects created earlier
[is planned](https://gitlab.com/gitlab-org/gitlab/-/issues/196124).
- For self-managed GitLab instances, the project must have been created
- before GitLab 12.7. However, an administrator can enable the cleanup policy
- for all projects (even those created before 12.7) in
+ in GitLab 12.8 or later. However, an administrator can enable the cleanup policy
+ for all projects (even those created before 12.8) in
[GitLab application settings](../../../api/settings.md#change-application-settings)
by setting `container_expiration_policies_enable_historic_entries` to true.