diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-03-10 09:08:10 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-03-10 09:08:10 +0000 |
commit | 82fa8a3d1e8466ef36b58604d20fcc145ea12118 (patch) | |
tree | c5c0286537405c2fa7719ecce3ed0d73d947c555 /doc/user | |
parent | 232655bf32cd474d54de357b65ef43d77271117c (diff) | |
download | gitlab-ce-82fa8a3d1e8466ef36b58604d20fcc145ea12118.tar.gz |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/user')
-rw-r--r-- | doc/user/admin_area/settings/sign_up_restrictions.md | 4 | ||||
-rw-r--r-- | doc/user/application_security/dast/index.md | 25 | ||||
-rw-r--r-- | doc/user/project/integrations/prometheus.md | 37 | ||||
-rw-r--r-- | doc/user/project/integrations/prometheus_units.md | 110 |
4 files changed, 163 insertions, 13 deletions
diff --git a/doc/user/admin_area/settings/sign_up_restrictions.md b/doc/user/admin_area/settings/sign_up_restrictions.md index 6dbdf24d477..590907e5bef 100644 --- a/doc/user/admin_area/settings/sign_up_restrictions.md +++ b/doc/user/admin_area/settings/sign_up_restrictions.md @@ -39,9 +39,9 @@ email domains to prevent malicious users from creating accounts. You can send confirmation emails during sign-up and require that users confirm their email address. If this setting is selected: -- For GitLab 12.1 and earlier, the user is unable to sign in until they confirm their +- For GitLab 12.7 and earlier, the user is unable to sign in until they confirm their email address. -- For GitLab 12.2 and later, the user [has 30 days to confirm their email address](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/31245). +- For GitLab 12.8 and later, the user [has 30 days to confirm their email address](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/31245). After 30 days, they will be unable to log in and access GitLab features. ![Email confirmation](img/email_confirmation_v12_7.png) diff --git a/doc/user/application_security/dast/index.md b/doc/user/application_security/dast/index.md index 7ef16ef88f0..7bc7822ae30 100644 --- a/doc/user/application_security/dast/index.md +++ b/doc/user/application_security/dast/index.md @@ -356,6 +356,31 @@ dast: The DAST job does not require the project's repository to be present when running, so by default [`GIT_STRATEGY`](../../../ci/yaml/README.md#git-strategy) is set to `none`. +## Running DAST in an offline air-gapped installation + +DAST can be executed on an offline air-gapped GitLab Ultimate installation using the following process: + +1. Host the DAST image `registry.gitlab.com/gitlab-org/security-products/dast:latest` in your local + Docker container registry. +1. Add the following configuration to your `.gitlab-ci.yml` file. You must replace `image` to refer + to the DAST Docker image hosted on your local Docker container registry: + + ```yaml + include: + - template: DAST.gitlab-ci.yml + + dast: + image: registry.example.com/namespace/dast:latest + script: + - export DAST_WEBSITE=${DAST_WEBSITE:-$(cat environment_url.txt)} + - /analyze -t $DAST_WEBSITE --auto-update-addons false -z"-silent" + ``` + +The option `--auto-update-addons false` instructs ZAP not to update add-ons. + +The option `-z` passes the quoted `-silent` parameter to ZAP. The `-silent` parameter ensures ZAP +does not make any unsolicited requests including checking for updates. + ## Reports The DAST job can emit various reports. diff --git a/doc/user/project/integrations/prometheus.md b/doc/user/project/integrations/prometheus.md index 9c98ef1f2f8..ae643127018 100644 --- a/doc/user/project/integrations/prometheus.md +++ b/doc/user/project/integrations/prometheus.md @@ -203,14 +203,17 @@ For example: panel_groups: - group: 'Group Title' panels: - - type: area-chart - title: "Chart Title" - y_label: "Y-Axis" - metrics: - - id: metric_of_ages - query_range: 'http_requests_total' - label: "Instance: {{instance}}, method: {{method}}" - unit: "count" + - type: area-chart + title: "Chart Title" + y_label: "Y-Axis" + y_axis: + format: number + precision: 0 + metrics: + - id: my_metric_id + query_range: 'http_requests_total' + label: "Instance: {{instance}}, method: {{method}}" + unit: "count" ``` The above sample dashboard would display a single area chart. Each file should @@ -276,9 +279,18 @@ The following tables outline the details of expected properties. | `type` | enum | no, defaults to `area-chart` | Specifies the chart type to use, can be: `area-chart`, `line-chart` or `anomaly-chart`. | | `title` | string | yes | Heading for the panel. | | `y_label` | string | no, but highly encouraged | Y-Axis label for the panel. | +| `y_axis` | string | no | Y-Axis configuration for the panel. | | `weight` | number | no, defaults to order in file | Order to appear within the grouping. Lower number means higher priority, which will be higher on the page. Numbers do not need to be consecutive. | | `metrics` | array | yes | The metrics which should be displayed in the panel. Any number of metrics can be displayed when `type` is `area-chart` or `line-chart`, whereas only 3 can be displayed when `type` is `anomaly-chart`. | +**Axis (`panels[].y_axis`) properties:** + +| Property | Type | Required | Description | +| ----------- | ------ | ------------------------- | -------------------------------------------------------------------- | +| `name` | string | no, but highly encouraged | Y-Axis label for the panel, it will replace `y_label` if set. | +| `format` | string | no, defaults to `number` | Unit format used. See the [full list of units](prometheus_units.md). | +| `precision` | number | no, defaults to `2` | Number of decimals to display in the number. | + **Metrics (`metrics`) properties:** | Property | Type | Required | Description | @@ -297,7 +309,7 @@ When a static label is used and a query returns multiple time series, then all t ```yaml metrics: - - id: metric_of_ages + - id: my_metric_id query_range: 'http_requests_total' label: "Time Series" unit: "count" @@ -311,7 +323,7 @@ For labels to be more explicit, using variables that reflect time series labels ```yaml metrics: - - id: metric_of_ages + - id: my_metric_id query_range: 'http_requests_total' label: "Instance: {{instance}}, method: {{method}}" unit: "count" @@ -325,7 +337,7 @@ There is also a shorthand value for dynamic dashboard labels that make use of on ```yaml metrics: - - id: metric_of_ages + - id: my_metric_id query_range: 'http_requests_total' label: "Method" unit: "count" @@ -351,6 +363,9 @@ panel_groups: - type: area-chart # or line-chart title: 'Area Chart Title' y_label: "Y-Axis" + y_axis: + format: number + precision: 0 metrics: - id: area_http_requests_total query_range: 'http_requests_total' diff --git a/doc/user/project/integrations/prometheus_units.md b/doc/user/project/integrations/prometheus_units.md new file mode 100644 index 00000000000..9df9f52ceb1 --- /dev/null +++ b/doc/user/project/integrations/prometheus_units.md @@ -0,0 +1,110 @@ +# Unit formats reference + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/201999) in GitLab 12.9. + +You can select units to format your charts by adding `format` to your +[axis configuration](prometheus.md#dashboard-yaml-properties). + +## Numbers + +For generic data, numbers are formatted according to the current locale. + +Formats: `number` + +**Examples:** + +| Data | Displayed | +| --------- | --------- | +| `10` | 1 | +| `1000` | 1,000 | +| `1000000` | 1,000,000 | + +## Percentage + +For percentage data, format numbers in the chart with a `%` symbol. + +Formats supported: `percent`, `percentHundred` + +**Examples:** + +| Format | Data | Displayed | +| ---------------- | ----- | --------- | +| `percent` | `0.5` | 50% | +| `percent` | `1` | 100% | +| `percent` | `2` | 200% | +| `percentHundred` | `50` | 50% | +| `percentHundred` | `100` | 100% | +| `percentHundred` | `200` | 200% | + +## Duration + +For time durations, format numbers in the chart with a time unit symbol. + +Formats supported: `milliseconds`, `seconds` + +**Examples:** + +| Format | Data | Displayed | +| -------------- | ------ | --------- | +| `milliseconds` | `10` | 10ms | +| `milliseconds` | `500` | 100ms | +| `milliseconds` | `1000` | 1000ms | +| `seconds` | `10` | 10s | +| `seconds` | `500` | 500s | +| `seconds` | `1000` | 1000s | + +## Digital (Metric) + +Converts a number of bytes using metric prefixes. It scales to +use the unit that's the best fit. + +Formats supported: + +- `decimalBytes` +- `kilobytes` +- `megabytes` +- `gigabytes` +- `terabytes` +- `petabytes` + +**Examples:** + +| Format | Data | Displayed | +| -------------- | --------- | --------- | +| `decimalBytes` | `1` | 1B | +| `decimalBytes` | `1000` | 1kB | +| `decimalBytes` | `1000000` | 1MB | +| `kilobytes` | `1` | 1kB | +| `kilobytes` | `1000` | 1MB | +| `kilobytes` | `1000000` | 1GB | +| `megabytes` | `1` | 1MB | +| `megabytes` | `1000` | 1GB | +| `megabytes` | `1000000` | 1TB | + +## Digital (IEC) + +Converts a number of bytes using binary prefixes. It scales to +use the unit that's the best fit. + +Formats supported: + +- `bytes` +- `kibibytes` +- `mebibytes` +- `gibibytes` +- `tebibytes` +- `pebibytes` + +**Examples:** + +| Format | Data | Displayed | +| ----------- | ------------- | --------- | +| `bytes` | `1` | 1B | +| `bytes` | `1024` | 1KiB | +| `bytes` | `1024 * 1024` | 1MiB | +| `kibibytes` | `1` | 1KiB | +| `kibibytes` | `1024` | 1MiB | +| `kibibytes` | `1024 * 1024` | 1GiB | +| `mebibytes` | `1` | 1MiB | +| `mebibytes` | `1024` | 1GiB | +| `mebibytes` | `1024 * 1024` | 1TiB | |