Skip to content

Added delete api for instance GCP config for audit events

Hitesh Raghuvanshi requested to merge 423040-destroy-instance-gcp into master

What does this MR do and why?

This MR adds a new mutation to the GraphQL API that allows users to delete instance level Google Cloud Logging configurations. The mutation will delete the configuration and create an audit event. If there is an error during deletion, the mutation will return an error message. The mutation is available to only instance admins of instances with Ultimate license.

This is quite similar to group level api for deletion of gcp configs as mentioned in

Creation API is being added in !130663 (merged).

Query plan

Select query

  "audit_events_instance_google_cloud_logging_configurations"."id" = 6

Deletion query

  "audit_events_instance_google_cloud_logging_configurations"."id" = 6

How to set up and validate locally

  1. For this you need to have admin access of a GitLab instance with an Ultimate license.
  2. Create an entry for the instance level GCP config by running following command in rails console
AuditEvents::Instance::GoogleCloudLoggingConfiguration.create!(google_project_id_name: "project-name", client_email: "", log_id_name: "some_log_name", name: "First destination", private_key: "random_private_key")
  1. Visit graphql explorer https://gitlab.localdev:3000/-/graphql-explorer.
  2. Run following query to list down the destination and note the graphql id for the same
query instanceGoogleCloudLoggingConfigurations {
  instanceGoogleCloudLoggingConfigurations {
    nodes {
  1. Then run the delete mutation in the explorer using the graphql id of the destination obtained in step 4.
mutation instanceGoogleCloudLoggingConfigurationDestroy {
  instanceGoogleCloudLoggingConfigurationDestroy(input: { id: "gid://gitlab/AuditEvents::Instance::GoogleCloudLoggingConfiguration/9" }) {
  1. Run the query in step 4 to verify the config got deleted. Also check for the audit event generated in https://gitlab.localdev:3000/admin/audit_logs, it should look something like following image image

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Related to #423040 (closed)

Edited by Hitesh Raghuvanshi

Merge request reports