diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/administration/gitaly/praefect.md | 16 | ||||
-rw-r--r-- | doc/administration/packages/dependency_proxy.md | 2 | ||||
-rw-r--r-- | doc/api/merge_request_context_commits.md | 97 | ||||
-rw-r--r-- | doc/development/shell_scripting_guide/index.md | 2 | ||||
-rw-r--r-- | doc/update/README.md | 13 | ||||
-rw-r--r-- | doc/user/clusters/applications.md | 13 | ||||
-rw-r--r-- | doc/user/packages/dependency_proxy/index.md | 4 |
7 files changed, 123 insertions, 24 deletions
diff --git a/doc/administration/gitaly/praefect.md b/doc/administration/gitaly/praefect.md index 73a020b87d0..650e797324a 100644 --- a/doc/administration/gitaly/praefect.md +++ b/doc/administration/gitaly/praefect.md @@ -166,16 +166,19 @@ praefect['auth_token'] = 'PRAEFECT_EXTERNAL_TOKEN' praefect['virtual_storages'] = { 'praefect' => { 'gitaly-1' => { - 'address' => 'tcp://gitaly-1.internal:8075', + # Replace GITALY_URL_OR_IP below with the real address to connect to. + 'address' => 'tcp://GITALY_URL_OR_IP:8075', 'token' => 'PRAEFECT_INTERNAL_TOKEN', 'primary' => true }, 'gitaly-2' => { - 'address' => 'tcp://gitaly-2.internal:8075', + # Replace GITALY_URL_OR_IP below with the real address to connect to. + 'address' => 'tcp://GITALY_URL_OR_IP:8075', 'token' => 'PRAEFECT_INTERNAL_TOKEN' }, 'gitaly-3' => { - 'address' => 'tcp://gitaly-3.internal:8075', + # Replace GITALY_URL_OR_IP below with the real address to connect to. + 'address' => 'tcp://GITALY_URL_OR_IP:8075', 'token' => 'PRAEFECT_INTERNAL_TOKEN' } } @@ -265,6 +268,8 @@ gitaly['auth_token'] = 'PRAEFECT_INTERNAL_TOKEN' gitaly['listen_addr'] = "0.0.0.0:8075" git_data_dirs({ + # Update this to the name of this Gitaly server which will be later + # exposed in the UI under "Admin area > Gitaly" "gitaly-1" => { "path" => "/var/opt/gitlab/git-data" } @@ -301,13 +306,14 @@ is present, there should be two storages available to GitLab: ```ruby # /etc/gitlab/gitlab.rb on gitlab server +# Replace PRAEFECT_URL_OR_IP below with real address Praefect can be accessed at. # Replace PRAEFECT_EXTERNAL_TOKEN below with real secret. git_data_dirs({ "default" => { "path" => "/var/opt/gitlab/git-data" }, "praefect" => { - "gitaly_address" => "tcp://praefect.internal:2305", + "gitaly_address" => "tcp://PRAEFECT_URL_OR_IP:2305", "gitaly_token" => 'PRAEFECT_EXTERNAL_TOKEN' } }) @@ -324,7 +330,7 @@ on the Praefect node. Save your changes and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). -Run `gitlab-rake gitlab:gitaly:check` to confirm that GitLab can reach Praefect. +Run `sudo gitlab-rake gitlab:gitaly:check` to confirm that GitLab can reach Praefect. ### Testing Praefect diff --git a/doc/administration/packages/dependency_proxy.md b/doc/administration/packages/dependency_proxy.md index 519ec02bd33..4cbb22668d9 100644 --- a/doc/administration/packages/dependency_proxy.md +++ b/doc/administration/packages/dependency_proxy.md @@ -1,4 +1,4 @@ -# GitLab Dependency Proxy administration **(PREMIUM ONLY)** +# GitLab Dependency Proxy administration **(ULTIMATE ONLY)** > [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/7934) in [GitLab Premium](https://about.gitlab.com/pricing/) 11.11. diff --git a/doc/api/merge_request_context_commits.md b/doc/api/merge_request_context_commits.md new file mode 100644 index 00000000000..4b8edf657e4 --- /dev/null +++ b/doc/api/merge_request_context_commits.md @@ -0,0 +1,97 @@ +# Merge request context commits API + +## List MR context commits + +Get a list of merge request context commits. + +``` +GET /projects/:id/merge_requests/:merge_request_iid/context_commits +``` + +Parameters: + +- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user +- `merge_request_iid` (required) - The internal ID of the merge request + +```json +[ + { + "id": "4a24d82dbca5c11c61556f3b35ca472b7463187e", + "short_id": "4a24d82d", + "created_at": "2017-04-11T10:08:59.000Z", + "parent_ids": null, + "title": "Update README.md to include `Usage in testing and development`", + "message": "Update README.md to include `Usage in testing and development`", + "author_name": "Luke \"Jared\" Bennett", + "author_email": "lbennett@gitlab.com", + "authored_date": "2017-04-11T10:08:59.000Z", + "committer_name": "Luke \"Jared\" Bennett", + "committer_email": "lbennett@gitlab.com", + "committed_date": "2017-04-11T10:08:59.000Z", + "author": null, + "author_gravatar_url": "https://www.gravatar.com/avatar/2acf1fb99417a2b3971def5a294abbeb?s=80&d=identicon", + "commit_url": "http://127.0.0.1:3000/gitlab-org/gitlab-test/commit/4a24d82dbca5c11c61556f3b35ca472b7463187e", + "commit_path": "/gitlab-org/gitlab-test/commit/4a24d82dbca5c11c61556f3b35ca472b7463187e", + "description_html": "", + "title_html": "Update README.md to include `Usage in testing and development`", + "signature_html": null, + "pipeline_status_path": null + } +] +``` + +## Create MR context commits + +Create a list of merge request context commits. + +``` +POST /projects/:id/merge_requests/:merge_request_iid/context_commits +``` + +Parameters: + +- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user +- `merge_request_iid` (required) - The internal ID of the merge request + +``` +POST /projects/:id/merge_requests/ +``` + +| Attribute | Type | Required | Description | +| --------- | ---- | -------- | ----------- | +| `commits` | string array | yes | The context commits' sha | + +```json +[ + { + "id": "6d394385cf567f80a8fd85055db1ab4c5295806f", + "message": "Added contributing guide\n\nSigned-off-by: Dmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com>\n", + "parent_ids": [ + "1a0b36b3cdad1d2ee32457c102a8c0b7056fa863" + ], + "authored_date": "2014-02-27T10:05:10.000+02:00", + "author_name": "Dmitriy Zaporozhets", + "author_email": "dmitriy.zaporozhets@gmail.com", + "committed_date": "2014-02-27T10:05:10.000+02:00", + "committer_name": "Dmitriy Zaporozhets", + "committer_email": "dmitriy.zaporozhets@gmail.com" + } +] +``` + +## Delete MR context commits + +Delete a list of merge request context commits. + +``` +DELETE /projects/:id/merge_requests/:merge_request_iid/context_commits +``` + +Parameters: + +- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user +- `merge_request_iid` (required) - The internal ID of the merge request + +| Attribute | Type | Required | Description | +| --------- | ---- | -------- | ----------- | +| `commits` | string array | yes | The context commits' sha | diff --git a/doc/development/shell_scripting_guide/index.md b/doc/development/shell_scripting_guide/index.md index e0895a088ab..a501e3def10 100644 --- a/doc/development/shell_scripting_guide/index.md +++ b/doc/development/shell_scripting_guide/index.md @@ -99,7 +99,7 @@ NOTE: **Note:** This is a work in progress. It is an [ongoing effort](https://gitlab.com/gitlab-org/gitlab-foss/issues/64016) to evaluate different tools for the -automated testing of shell scripts (like [BATS](https://github.com/sstephenson/bats)). +automated testing of shell scripts (like [BATS](https://github.com/bats-core/bats-core)). ## Code Review diff --git a/doc/update/README.md b/doc/update/README.md index 510a8fb31fb..255abc7b523 100644 --- a/doc/update/README.md +++ b/doc/update/README.md @@ -131,7 +131,7 @@ sudo -u git -H bundle exec rails runner -e production 'puts Sidekiq::Queue.new(" Major versions are reserved for backwards incompatible changes. We recommend that you first upgrade to the latest available minor version within your major version. Please follow the [Upgrade Recommendations](../policy/maintenance.md#upgrade-recommendations) -to identify the ideal upgrade path. +to identify a supported upgrade path. Before upgrading to a new major version, you should ensure that any background migration jobs from previous releases have been completed. To see the current size @@ -183,11 +183,18 @@ users first upgrade to the latest 11.11 patch release. Once upgraded to 11.11.x, users can upgrade to 12.0.x. Failure to do so may result in database migrations not being applied, which could lead to application errors. -Example 1: you are currently using GitLab 11.11.3, which is the latest patch +It is also required that you upgrade to 12.0.x before moving to a later version +of 12.x. + +Example 1: you are currently using GitLab 11.11.8, which is the latest patch release for 11.11.x. You can upgrade as usual to 12.0.x. Example 2: you are currently using a version of GitLab 10.x. To upgrade, first -upgrade to 11.11.3. Once upgraded to 11.11.3 you can safely upgrade to 12.0.x. +upgrade to the last 10.x release (10.8.7) then the last 11.x release (11.11.8). +Once upgraded to 11.11.8 you can safely upgrade to 12.0.x. + +See our [documentation on upgrade paths](../policy/maintenance.md#upgrade-recommendations) +for more information. ## Miscellaneous diff --git a/doc/user/clusters/applications.md b/doc/user/clusters/applications.md index fba74590fac..c502cd607d7 100644 --- a/doc/user/clusters/applications.md +++ b/doc/user/clusters/applications.md @@ -435,18 +435,7 @@ and you will have access to more advanced querying capabilities. Log data is automatically deleted after 15 days using [Curator](https://www.elastic.co/guide/en/elasticsearch/client/curator/5.5/about.html). -This is a preliminary release of Elastic Stack as a GitLab-managed application. By default, -the ability to install it is disabled. - -To allow installation of Elastic Stack as a GitLab-managed application, ask a GitLab -administrator to run following command within a Rails console: - -```ruby -Feature.enable(:enable_cluster_application_elastic_stack) -``` - -Once the feature flag is set, to enable log shipping, install Elastic Stack into the cluster with the -**Install** button. +To enable log shipping, install Elastic Stack into the cluster with the **Install** button. NOTE: **Note:** The [`stable/elastic-stack`](https://github.com/helm/charts/tree/master/stable/elastic-stack) diff --git a/doc/user/packages/dependency_proxy/index.md b/doc/user/packages/dependency_proxy/index.md index 05934212a12..1cebd734a99 100644 --- a/doc/user/packages/dependency_proxy/index.md +++ b/doc/user/packages/dependency_proxy/index.md @@ -1,6 +1,6 @@ -# Dependency Proxy **(PREMIUM ONLY)** +# Dependency Proxy **(ULTIMATE ONLY)** -> [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/7934) in [GitLab Premium](https://about.gitlab.com/pricing/) 11.11. +> [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/7934) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 11.11. NOTE: **Note:** This is the user guide. In order to use the dependency proxy, an administrator |