summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2020-01-14 00:08:14 +0000
committerGitLab Bot <gitlab-bot@gitlab.com>2020-01-14 00:08:14 +0000
commit427c549b6396885fb60a687326b6cd62878e4ca3 (patch)
tree145713e2f6fdaf7499b0cb44010503e16b6248b9 /doc
parent74a89b1221eaf780374bd1d4c5b2ee4a0f488908 (diff)
downloadgitlab-ce-427c549b6396885fb60a687326b6cd62878e4ca3.tar.gz
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r--doc/api/keys.md62
-rw-r--r--doc/development/feature_flags/process.md4
-rw-r--r--doc/user/clusters/applications.md34
-rw-r--r--doc/user/project/clusters/kubernetes_pod_logs.md38
4 files changed, 132 insertions, 6 deletions
diff --git a/doc/api/keys.md b/doc/api/keys.md
index 5dedb630a27..30b0cda6c8b 100644
--- a/doc/api/keys.md
+++ b/doc/api/keys.md
@@ -128,3 +128,65 @@ Example response:
}
}
```
+
+Deploy Keys are bound to the creating user, so if you query with a deploy key
+fingerprint you get additional information about the projects using that key:
+
+```sh
+curl --header "PRIVATE-TOKEN: <your_access_token>" 'https://gitlab.example.com/api/v4/keys?fingerprint=SHA256%3AnUhzNyftwADy8AH3wFY31tAKs7HufskYTte2aXo%2FlCg
+```
+
+Example response:
+
+```json
+{
+ "id": 1,
+ "title": "Sample key 1",
+ "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt1016k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=",
+ "created_at": "2019-11-14T15:11:13.222Z",
+ "user": {
+ "id": 1,
+ "name": "Administrator",
+ "username": "root",
+ "state": "active",
+ "avatar_url": "https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
+ "web_url": "http://0.0.0.0:3000/root",
+ "created_at": "2019-11-14T15:09:34.831Z",
+ "bio": null,
+ "location": null,
+ "public_email": "",
+ "skype": "",
+ "linkedin": "",
+ "twitter": "",
+ "website_url": "",
+ "organization": null,
+ "last_sign_in_at": "2019-11-16T22:41:26.663Z",
+ "confirmed_at": "2019-11-14T15:09:34.575Z",
+ "last_activity_on": "2019-11-20",
+ "email": "admin@example.com",
+ "theme_id": 1,
+ "color_scheme_id": 1,
+ "projects_limit": 100000,
+ "current_sign_in_at": "2019-11-19T14:42:18.078Z",
+ "identities": [
+ ],
+ "can_create_group": true,
+ "can_create_project": true,
+ "two_factor_enabled": false,
+ "external": false,
+ "private_profile": false,
+ "shared_runners_minutes_limit": null,
+ "extra_shared_runners_minutes_limit": null
+ },
+ "deploy_keys_projects": [
+ {
+ "id": 1,
+ "deploy_key_id": 1,
+ "project_id": 1,
+ "created_at": "2020-01-09T07:32:52.453Z",
+ "updated_at": "2020-01-09T07:32:52.453Z",
+ "can_push": false
+ }
+ ]
+}
+```
diff --git a/doc/development/feature_flags/process.md b/doc/development/feature_flags/process.md
index c64b14a05a4..4b44c8dadca 100644
--- a/doc/development/feature_flags/process.md
+++ b/doc/development/feature_flags/process.md
@@ -15,7 +15,9 @@ should be leveraged:
- Feature flags should remain in the codebase for as short period as possible
to reduce the need for feature flag accounting.
- The person operating with feature flags is responsible for clearly communicating
- the status of a feature behind the feature flag with responsible stakeholders.
+ the status of a feature behind the feature flag with responsible stakeholders. The
+ issue description should be updated with the feature flag name and whether it is
+ defaulted on or off as soon it is evident that a feature flag is needed.
- Merge requests that make changes hidden behind a feature flag, or remove an
existing feature flag because a feature is deemed stable must have the
~"feature flag" label assigned.
diff --git a/doc/user/clusters/applications.md b/doc/user/clusters/applications.md
index 1bb608c38ab..f2be9b2f3ac 100644
--- a/doc/user/clusters/applications.md
+++ b/doc/user/clusters/applications.md
@@ -41,6 +41,7 @@ The following applications can be installed:
- [JupyterHub](#jupyterhub)
- [Knative](#knative)
- [Crossplane](#crossplane)
+- [Elastic Stack](#elastic-stack)
With the exception of Knative, the applications will be installed in a dedicated
namespace called `gitlab-managed-apps`.
@@ -431,6 +432,38 @@ administrator to run following command within a Rails console:
Feature.enable(:enable_cluster_application_crossplane)
```
+### Elastic Stack
+
+> Introduced in GitLab 12.7 for project- and group-level clusters.
+
+[Elastic Stack](https://www.elastic.co/products/elastic-stack) is a complete end-to-end
+log analysis solution which helps in deep searching, analyzing and visualizing the logs
+generated from different machines.
+
+GitLab is able to gather logs from pods in your cluster automatically.
+Filebeat will run as a DaemonSet on each node in your cluster, and it will ship container logs to Elasticsearch for querying.
+GitLab will then connect to Elasticsearch for logs instead of the Kubernetes API,
+and you will have access to more advanced querying capabilities.
+
+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.
+
+NOTE: **Note:**
+The [`stable/elastic-stack`](https://github.com/helm/charts/tree/master/stable/elastic-stack)
+chart is used to install this application with a
+[`values.yaml`](https://gitlab.com/gitlab-org/gitlab/blob/master/vendor/elastic_stack/values.yaml)
+file.
+
## Install using GitLab CI (alpha)
> [Introduced](https://gitlab.com/gitlab-org/gitlab/merge_requests/20822) in GitLab 12.6.
@@ -639,6 +672,7 @@ The applications below can be uninstalled.
| Knative | 12.1+ | The associated IP will be deleted and cannot be restored. |
| Prometheus | 11.11+ | All data will be deleted and cannot be restored. |
| Crossplane | 12.5+ | All data will be deleted and cannot be restored. |
+| Elastic Stack | 12.7+ | All data will be deleted and cannot be restored. |
| Sentry | 12.6+ | The PostgreSQL persistent volume will remain and should be manually removed for complete uninstall. |
To uninstall an application:
diff --git a/doc/user/project/clusters/kubernetes_pod_logs.md b/doc/user/project/clusters/kubernetes_pod_logs.md
index 797ddf784cc..7cd5d99ef67 100644
--- a/doc/user/project/clusters/kubernetes_pod_logs.md
+++ b/doc/user/project/clusters/kubernetes_pod_logs.md
@@ -41,9 +41,37 @@ Logs can be displayed by clicking on a specific pod from [Deploy Boards](../depl
1. On the **Environments** page, you should see the status of the environment's pods with [Deploy Boards](../deploy_boards.md).
1. When mousing over the list of pods, a tooltip will appear with the exact pod name and status.
![Deploy Boards pod list](img/pod_logs_deploy_board.png)
-1. Click on the desired pod to bring up the logs view, which will contain the last 500 lines for that pod.
- You may switch between the following in this view:
- - Pods.
- - [From GitLab 12.4](https://gitlab.com/gitlab-org/gitlab/issues/5769), environments.
+1. Click on the desired pod to bring up the logs view.
- Support for pods with multiple containers is coming [in a future release](https://gitlab.com/gitlab-org/gitlab/issues/6502).
+### Logs view
+
+The logs view will contain the last 500 lines for a pod, and has control to filter via:
+
+- Pods.
+- [From GitLab 12.4](https://gitlab.com/gitlab-org/gitlab/issues/5769), environments.
+- [From GitLab 12.7](https://gitlab.com/gitlab-org/gitlab/merge_requests/21656), [full text search](#full-text-search).
+
+Support for pods with multiple containers is coming [in a future release](https://gitlab.com/gitlab-org/gitlab/issues/13404).
+
+Support for historical data is coming [in a future release](https://gitlab.com/gitlab-org/gitlab/issues/196191).
+
+### Full text search
+
+> [Introduced](https://gitlab.com/gitlab-org/gitlab/merge_requests/21656) in GitLab 12.7.
+
+When you enable [Elastic Stack](../../clusters/applications.md#elastic-stack) on your cluster,
+you can search the content of your logs via a search bar.
+
+The search is passed on to Elasticsearch using the [simple_query_string](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html)
+Elasticsearch function, which supports the following operators:
+
+```
++ signifies AND operation
+| signifies OR operation
+- negates a single token
+" wraps a number of tokens to signify a phrase for searching
+* at the end of a term signifies a prefix query
+( and ) signify precedence
+~N after a word signifies edit distance (fuzziness)
+~N after a phrase signifies slop amount
+```