diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2023-08-03 06:09:33 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2023-08-03 06:09:33 +0300 |
commit | f7dd4c23f3a8c61d54f4589c7835e882c889f462 (patch) | |
tree | b40383b3d4d18fd0a79bb94f99cd29bce5e1ad39 /doc | |
parent | b4519ac38b7d2a6dc9f6cead010ab98945ec4fa0 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r-- | doc/administration/audit_event_streaming/graphql_api.md | 66 | ||||
-rw-r--r-- | doc/administration/consul.md | 6 | ||||
-rw-r--r-- | doc/administration/geo/index.md | 1 | ||||
-rw-r--r-- | doc/development/backend/ruby_style_guide.md | 2 | ||||
-rw-r--r-- | doc/update/index.md | 4 |
5 files changed, 73 insertions, 6 deletions
diff --git a/doc/administration/audit_event_streaming/graphql_api.md b/doc/administration/audit_event_streaming/graphql_api.md index f69ccdacdaf..5de78c5693f 100644 --- a/doc/administration/audit_event_streaming/graphql_api.md +++ b/doc/administration/audit_event_streaming/graphql_api.md @@ -170,8 +170,8 @@ by [listing all the custom HTTP headers](#list-streaming-destinations) for the g ```graphql mutation { - externalAuditEventDestinationUpdate(input: { - id:"gid://gitlab/AuditEvents::ExternalAuditEventDestination/1", + externalAuditEventDestinationUpdate(input: { + id:"gid://gitlab/AuditEvents::ExternalAuditEventDestination/1", destinationUrl: "https://www.new-domain.com/webhook", name: "destination-name"} ) { errors @@ -285,7 +285,7 @@ Prerequisites: - You must have the Owner role for the group. -You can remove a list of event type filters using the `auditEventsStreamingDestinationEventsRemove` query type: +You can remove a list of event type filters using the `auditEventsStreamingDestinationEventsRemove` mutation type: ```graphql mutation { @@ -545,6 +545,7 @@ query { value } } + eventTypeFilters } } } @@ -568,7 +569,7 @@ by [listing all the external destinations](#list-streaming-destinations-1) for t ```graphql mutation { - instanceExternalAuditEventDestinationUpdate(input: { + instanceExternalAuditEventDestinationUpdate(input: { id: "gid://gitlab/AuditEvents::InstanceExternalAuditEventDestination/1", destinationUrl: "https://www.new-domain.com/webhook", name: "destination-name"}) { @@ -647,3 +648,60 @@ mutation { ``` The header is deleted if the returned `errors` object is empty. + +### Event type filters + +> Event type filters API [introduced](https://gitlab.com/groups/gitlab-org/-/epics/10868) in GitLab 16.2. + +When this feature is enabled for an instance, you can use an API to permit users to filter streamed audit events per destination. +If the feature is enabled with no filters, the destination receives all audit events. + +A streaming destination that has an event type filter set has a **filtered** (**{filter}**) label. + +#### Use the API to add an event type filter + +Prerequisites: + +- You must have the Administrator access for the instance. + +You can add a list of event type filters using the `auditEventsStreamingDestinationInstanceEventsAdd` mutation: + +```graphql +mutation { + auditEventsStreamingDestinationInstanceEventsAdd(input: { + destinationId: "gid://gitlab/AuditEvents::InstanceExternalAuditEventDestination/1", + eventTypeFilters: ["list of event type filters"]}){ + errors + eventTypeFilters + } +} +``` + +Event type filters are added if: + +- The returned `errors` object is empty. +- The API responds with `200 OK`. + +#### Use the API to remove an event type filter + +Prerequisites: + +- You must have the Administrator access for the instance. + +You can remove a list of event type filters using the `auditEventsStreamingDestinationInstanceEventsRemove` mutation: + +```graphql +mutation { + auditEventsStreamingDestinationInstanceEventsRemove(input: { + destinationId: "gid://gitlab/AuditEvents::InstanceExternalAuditEventDestination/1", + eventTypeFilters: ["list of event type filters"] + }){ + errors + } +} +``` + +Event type filters are removed if: + +- The returned `errors` object is empty. +- The API responds with `200 OK`. diff --git a/doc/administration/consul.md b/doc/administration/consul.md index 5a8946dbcf7..a65b2100237 100644 --- a/doc/administration/consul.md +++ b/doc/administration/consul.md @@ -245,6 +245,12 @@ sudo gitlab-ctl start consul After this, the node should start back up, and the rest of the server agents rejoin. Shortly after that, the client agents should rejoin as well. +If they do not join, you might also need to erase the Consul data on the client: + +```shell +sudo rm -rf /var/opt/gitlab/consul/data +``` + #### Recover a failed node If you have taken advantage of Consul to store other data and want to restore diff --git a/doc/administration/geo/index.md b/doc/administration/geo/index.md index e85543fd69b..0293caaf515 100644 --- a/doc/administration/geo/index.md +++ b/doc/administration/geo/index.md @@ -126,6 +126,7 @@ The following are required to run Geo: - If using different operating system versions between Geo sites, [check OS locale data compatibility](replication/troubleshooting.md#check-os-locale-data-compatibility) across Geo sites to avoid silent corruption of database indexes. +- All sites must define the same [repository storages](../repository_storage_paths.md). Additionally, check the GitLab [minimum requirements](../../install/requirements.md), and use the latest version of GitLab for a better experience. diff --git a/doc/development/backend/ruby_style_guide.md b/doc/development/backend/ruby_style_guide.md index 5e71ed66df6..d6e2f7a48d2 100644 --- a/doc/development/backend/ruby_style_guide.md +++ b/doc/development/backend/ruby_style_guide.md @@ -273,7 +273,7 @@ end class ProjectCreator def self.execute - ActiveRecord::Base.transaction do + ApplicationRecord.transaction do name = SecureRandom.alphanumeric project = Project.create!(name: name) Repository.create!(project: project, name: name) diff --git a/doc/update/index.md b/doc/update/index.md index dd2dd980e91..a030770ac64 100644 --- a/doc/update/index.md +++ b/doc/update/index.md @@ -328,6 +328,7 @@ and [Helm Chart deployments](https://docs.gitlab.com/charts/). They come with ap - Versions containing fix: GitLab 16.1.3 and later. - Geo: A [bug](https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/7841) in the built-in `pg-upgrade` tool prevents upgrading the bundled PostgreSQL database to version 13. This leaves the secondary site in a broken state, and prevents upgrading the Geo installation to GitLab 16.x ([PostgreSQL 12 support has removed in 16.0](deprecations.md#postgresql-12-deprecated) and later releases). This occurs on secondary sites using the bundled PostgreSQL software, running both the secondary main Rails database and tracking database on the same node. There is a manual [workaround](https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/7841#workaround) for those impacted until a fix is backported to 15.11. - Impacted versions: GitLab versions 15.2 - 15.11 + - Versions containing fix: 15.11.12 and later. - Version 16.0 and later are not impacted. Note, 15.11 is a mandatory upgrade stop on the way to 16.0. ### 15.11.0 @@ -337,7 +338,8 @@ and [Helm Chart deployments](https://docs.gitlab.com/charts/). They come with ap - Impacted versions: GitLab versions 15.11.x, 16.0.x, and 16.1.0 - 16.1.2. - Versions containing fix: GitLab 16.1.3 and later. - Geo: A [bug](https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/7841) in the built-in `pg-upgrade` tool prevents upgrading the bundled PostgreSQL database to version 13. This leaves the secondary site in a broken state, and prevents upgrading the Geo installation to GitLab 16.x ([PostgreSQL 12 support has removed in 16.0](deprecations.md#postgresql-12-deprecated) and later releases). This occurs on secondary sites using the bundled PostgreSQL software, running both the secondary main Rails database and tracking database on the same node. There is a manual [workaround](https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/7841#workaround) for those impacted until a fix is backported to 15.11. - - Impacted versions: GitLab versions 15.2 - 15.11 + - Impacted versions: GitLab versions 15.2 - 15.11.11. + - Versions containing fix: 15.11.12 and later. - Version 16.0 and later are not impacted. Note, 15.11 is a mandatory upgrade stop on the way to 16.0. ### 15.11.x |