diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2019-10-02 09:06:28 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2019-10-02 09:06:28 +0300 |
commit | 404bb44ef7dfc2b0d4da6b946b8b96007aca4b56 (patch) | |
tree | dbc4049f82cb048b471e853c6015ac303981cef9 /doc | |
parent | d14219486e0f3b6e642eaeff0862dea169e5d260 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r-- | doc/api/access_requests.md | 48 | ||||
-rw-r--r-- | doc/development/README.md | 1 | ||||
-rw-r--r-- | doc/development/auto_devops.md | 42 | ||||
-rw-r--r-- | doc/topics/autodevops/index.md | 18 |
4 files changed, 72 insertions, 37 deletions
diff --git a/doc/api/access_requests.md b/doc/api/access_requests.md index 973c3968d90..584a4ecb89c 100644 --- a/doc/api/access_requests.md +++ b/doc/api/access_requests.md @@ -6,7 +6,7 @@ The access levels are defined in the `Gitlab::Access` module. Currently, these levels are recognized: -``` +```plaintext 10 => Guest access 20 => Reporter access 30 => Developer access @@ -18,14 +18,16 @@ Gets a list of access requests viewable by the authenticated user. -``` +```plaintext GET /groups/:id/access_requests GET /projects/:id/access_requests ``` -| Attribute | Type | Required | Description | -| --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | +| Attribute | Type | Required | Description | +| --------- | -------------- | -------- | ----------- | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | + +Example request: ```bash curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/:id/access_requests @@ -59,14 +61,16 @@ Example response: Requests access for the authenticated user to a group or project. -``` +```plaintext POST /groups/:id/access_requests POST /projects/:id/access_requests ``` -| Attribute | Type | Required | Description | -| --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | +| Attribute | Type | Required | Description | +| --------- | -------------- | -------- | ----------- | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | + +Example request: ```bash curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/:id/access_requests @@ -90,16 +94,18 @@ Example response: Approves an access request for the given user. -``` +```plaintext PUT /groups/:id/access_requests/:user_id/approve PUT /projects/:id/access_requests/:user_id/approve ``` -| Attribute | Type | Required | Description | -| --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | -| `user_id` | integer | yes | The user ID of the access requester | -| `access_level` | integer | no | A valid access level (defaults: `30`, developer access level) | +| Attribute | Type | Required | Description | +| -------------- | -------------- | -------- | ----------- | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | +| `user_id` | integer | yes | The user ID of the access requester | +| `access_level` | integer | no | A valid access level (defaults: `30`, developer access level) | + +Example request: ```bash curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/:id/access_requests/:user_id/approve?access_level=20 @@ -123,15 +129,17 @@ Example response: Denies an access request for the given user. -``` +```plaintext DELETE /groups/:id/access_requests/:user_id DELETE /projects/:id/access_requests/:user_id ``` -| Attribute | Type | Required | Description | -| --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | -| `user_id` | integer | yes | The user ID of the access requester | +| Attribute | Type | Required | Description | +| --------- | -------------- | -------- | ----------- | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | +| `user_id` | integer | yes | The user ID of the access requester | + +Example request: ```bash curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/:id/access_requests/:user_id diff --git a/doc/development/README.md b/doc/development/README.md index bdc92236716..6480d40303b 100644 --- a/doc/development/README.md +++ b/doc/development/README.md @@ -68,6 +68,7 @@ description: 'Learn how to contribute to GitLab.' - [Git LFS](lfs.md) - [Developing against interacting components or features](interacting_components.md) - [File uploads](uploads.md) +- [Auto DevOps development guide](auto_devops.md) ## Performance guides diff --git a/doc/development/auto_devops.md b/doc/development/auto_devops.md new file mode 100644 index 00000000000..f88bcc9cfb8 --- /dev/null +++ b/doc/development/auto_devops.md @@ -0,0 +1,42 @@ +# Auto DevOps development guide + +This document provides a development guide for contributors to +[Auto DevOps](../topics/autodevops/index.md) + +## Development + +Auto DevOps builds on top of GitLab CI to create an automatic pipeline +based on your project contents. When Auto DevOps is enabled for a +project, the user does not need to explicitly include any pipeline configuration +through a [`.gitlab-ci.yml` file](../ci/yaml/README.md). + +In the absence of a `.gitlab-ci.yml` file, the [Auto DevOps CI +template](https://gitlab.com/gitlab-org/gitlab/blob/master/lib/gitlab/ci/templates/Auto-DevOps.gitlab-ci.yml) +is used implicitly to configure the pipeline for the project. This +template is a top-level template that includes other sub-templates, +which then defines jobs. + +Some jobs use images that are built from external projects: + +- [Auto Build](../topics/autodevops/index.md#auto-build) uses + [configuration](https://gitlab.com/gitlab-org/gitlab/blob/master/lib/gitlab/ci/templates/Jobs/Build.gitlab-ci.yml) + in which the `build` job uses an image that is built using the + [`auto-build-image`](https://gitlab.com/gitlab-org/cluster-integration/auto-build-image) + project. +- [Auto Deploy](../topics/autodevops/index.md#auto-deploy) uses + [configuration](https://gitlab.com/gitlab-org/gitlab/blob/master/lib/gitlab/ci/templates/Jobs/Deploy.gitlab-ci.yml) + in which the jobs defined in this template use an image that is built using the + [`auto-deploy-image`](https://gitlab.com/gitlab-org/cluster-integration/auto-deploy-image) + project. By default, the Helm chart defined in + [`auto-deploy-app`](https://gitlab.com/gitlab-org/charts/auto-deploy-app) + is used to deploy. + +There are extra variables that get passed to the CI jobs when Auto +DevOps is enabled that are not present in a normal CI job. These can be +found in +[`ProjectAutoDevops`](https://gitlab.com/gitlab-org/gitlab/blob/bf69484afa94e091c3e1383945f60dbe4e8681af/app/models/project_auto_devops.rb). + +## Development environment + +Configuring [GDK for Auto +DevOps](https://gitlab.com/gitlab-org/gitlab-development-kit/blob/master/doc/howto/auto_devops.md). diff --git a/doc/topics/autodevops/index.md b/doc/topics/autodevops/index.md index 662cc838bdb..802effcb7a2 100644 --- a/doc/topics/autodevops/index.md +++ b/doc/topics/autodevops/index.md @@ -1183,22 +1183,6 @@ As of GitLab 10.0, the supported buildpacks are: The following restrictions apply. -### Private project support - -CAUTION: **Caution:** Private project support in Auto DevOps is experimental. - -When a project has been marked as private, GitLab's [Container -Registry][container-registry] requires authentication when downloading -containers. Auto DevOps will automatically provide the required authentication -information to Kubernetes, allowing temporary access to the registry. -Authentication credentials will be valid while the pipeline is running, allowing -for a successful initial deployment. - -After the pipeline completes, Kubernetes will no longer be able to access the -Container Registry. **Restarting a pod, scaling a service, or other actions which -require on-going access to the registry may fail**. On-going secure access is -planned for a subsequent release. - ### Private registry support There is no documented way of using private container registry with Auto DevOps. @@ -1274,4 +1258,4 @@ curl --data "value=true" --header "PRIVATE-TOKEN: personal_access_token" https:/ ## Development guides -Configuring [GDK for Auto DevOps](https://gitlab.com/gitlab-org/gitlab-development-kit/blob/master/doc/howto/auto_devops.md). +[Development guide for Auto DevOps](../../development/auto_devops.md) |