diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/administration/gitaly/troubleshooting.md | 4 | ||||
-rw-r--r-- | doc/integration/azure.md | 28 | ||||
-rw-r--r-- | doc/user/product_analytics/index.md | 38 |
3 files changed, 39 insertions, 31 deletions
diff --git a/doc/administration/gitaly/troubleshooting.md b/doc/administration/gitaly/troubleshooting.md index dbbd348556c..ef1f4e06595 100644 --- a/doc/administration/gitaly/troubleshooting.md +++ b/doc/administration/gitaly/troubleshooting.md @@ -400,6 +400,10 @@ To resolve this, remove the `noexec` option from the file system mount. An alter 1. Add `gitaly['runtime_dir'] = '<PATH_WITH_EXEC_PERM>'` to `/etc/gitlab/gitlab.rb` and specify a location without `noexec` set. 1. Run `sudo gitlab-ctl reconfigure`. +### Commit signing fails with `invalid argument: signing key is encrypted` or `invalid data: tag byte does not have MSB set.` + +Because Gitaly commit signing is headless and not associated with a specific user, the GPG signing key must be created without a passphrase, or the passphrase must be removed before export. + ## Troubleshoot Praefect (Gitaly Cluster) The following sections provide possible solutions to Gitaly Cluster errors. diff --git a/doc/integration/azure.md b/doc/integration/azure.md index 0d8c830c016..8d993dfbb63 100644 --- a/doc/integration/azure.md +++ b/doc/integration/azure.md @@ -29,9 +29,13 @@ You must set the `uid_field`, which differs across the providers: | [`omniauth_openid_connect`](https://github.com/omniauth/omniauth_openid_connect/) | `sub` | Specify `uid_field` to use another field | To migrate from `omniauth-azure-oauth2` to `omniauth_openid_connect` you -must change the configuration: +must change the configuration. -- **For Omnibus installations** +::Tabs + +:::TabTitle Linux package (Omnibus) + +Remove some of the existing configuration and add new configuration as shown. ```diff gitlab_rails['omniauth_providers'] = [ @@ -60,7 +64,9 @@ gitlab_rails['omniauth_providers'] = [ ] ``` -- **For installations from source** +:::TabTitle Self-compiled (source) + +Remove some of the existing configuration and add new configuration as shown. ```diff - { name: 'azure_oauth2', @@ -88,10 +94,16 @@ gitlab_rails['omniauth_providers'] = [ } ``` +::EndTabs + To migrate for example from `omniauth-azure-activedirectory-v2` to `omniauth_openid_connect` you -must change the configuration: +must change the configuration. -- **For Omnibus installations** +::Tabs + +:::TabTitle Linux package (Omnibus) + +Remove some of the existing configuration and add new configuration as shown. ```diff gitlab_rails['omniauth_providers'] = [ @@ -120,7 +132,9 @@ gitlab_rails['omniauth_providers'] = [ ] ``` -- **For installations from source** +:::TabTitle Self-compiled (source) + +Remove some of the existing configuration and add new configuration as shown. ```diff - { name: 'azure_activedirectory_v2', @@ -148,6 +162,8 @@ gitlab_rails['omniauth_providers'] = [ } ``` +::EndTabs + For more information on other customizations, see [`gitlab_username_claim`](index.md#authentication-sources). ## Register an Azure application diff --git a/doc/user/product_analytics/index.md b/doc/user/product_analytics/index.md index b5f936e7848..1c6a241d5f4 100644 --- a/doc/user/product_analytics/index.md +++ b/doc/user/product_analytics/index.md @@ -23,9 +23,9 @@ For more information, see the [group direction page](https://about.gitlab.com/di Product analytics uses several tools: -- [**Jitsu**](https://jitsu.com/docs) - A web and app event collection platform that provides a consistent API to collect user data and pass it through to ClickHouse. +- [**Snowplow**](https://docs.snowplow.io/docs) - A developer-first engine for collecting behavioral data, and passing it through to ClickHouse. - [**ClickHouse**](https://clickhouse.com/docs) - A database suited to store, query, and retrieve analytical data. -- [**Cube.js**](https://cube.dev/docs/) - An analytical graphing library that provides an API to run queries against the data stored in Clickhouse. +- [**Cube**](https://cube.dev/docs/) - An analytical graphing library that provides an API to run queries against the data stored in Clickhouse. The following diagram illustrates the product analytics flow: @@ -34,19 +34,21 @@ The following diagram illustrates the product analytics flow: title: Product Analytics flow --- flowchart TB - subgraph Adding data - A([SDK]) --Send user data--> B[Analytics Proxy] - B --Transform data and pass it through--> C[Snowplow] - C --Pass the data to the associated database--> D([Clickhouse]) + subgraph Event collection + A([SDK]) --Send user data--> B[Snowplow Collector] + B --Pass data through--> C[Snowplow Enricher] end - subgraph Showing dashboards - E([Dashboards]) --Generated from the YAML definition--> F[Dashboard] + subgraph Data warehouse + C --Transform and enrich data--> D([Clickhouse]) + end + subgraph Data visualization with dashboards + E([Dashboards]) --Generated from the YAML definition--> F[Panels/Visualizations] F --Request data--> G[Product Analytics API] - G --Run Cube queries with pre-aggregations--> H[Cube.js] + G --Run Cube queries with pre-aggregations--> H[Cube] H --Get data from database--> D D --Return results--> H - H --> G - G --Transform data to be rendered--> F + H --Transform data to be rendered--> G + G --Return data--> F end ``` @@ -73,20 +75,6 @@ Prerequisite: 1. On the left sidebar, select **Settings > General**. 1. Expand the **Analytics** tab and find the **Product analytics** section. 1. Select **Enable product analytics** and enter the configuration values. - The following table shows the required configuration parameters and example values: - - | Name | Value | - |--------------------------------|------------------------------------------------------------| - | Configurator connection string | `https://test:test@configurator.gitlab.com` | - | Jitsu host | `https://jitsu.gitlab.com` | - | Jitsu project ID | `g0maofw84gx5sjxgse2k` | - | Jitsu administrator email | `jitsu.admin@gitlab.com` | - | Jitsu administrator password | `<your_password>` | - | Collector host | `https://collector.gitlab.com` | - | ClickHouse URL | `https://<username>:<password>@clickhouse.gitlab.com:8123` | - | Cube API URL | `https://cube.gitlab.com` | - | Cube API key | `25718201b3e9...ae6bbdc62dbb` | - 1. Select **Save changes**. ## Product analytics dashboards |