Google Cloud Platform collector migration guide (1.x.x to 2.0.0)

1 Google Cloud Platform Collector Migration Guide
- 1.1 Preparing for Migration
- 1.2 Migration Steps
  - 1.2.1 Step 1: Update Configuration
  - 1.2.2 Step 2: Test Configuration
- 1.3 Downgrade Considerations

Google Cloud Platform Collector Migration Guide

For users upgrading to version 2.0.0, changes in the configuration files need to be applied to ensure compatibility. This section provides step-by-step instructions for a smooth migration process and guidance on downgrading if needed.

Preparing for Migration

Backup Your Current Configuration: Ensure you have a backup of your existing configuration files before proceeding.
Review the New Configuration Changes: Familiarize yourself with the changes introduced in version 2.0.0, particularly regarding the renaming of custom_service entries and parameter changes.

Migration Steps

Step 1: Update Configuration

Changes in the config.yaml file:

The custom_service entries must now be renamed to either logging, logging_[number], scc_findings, or scc_findings_[number].
The variable tag has been renamed to override_devo_tag.
The variable auto_categorization_method has been renamed to override_auto_categorization_method.
The variables enable_pubsub_undelivered_messages_logging and pubsub_undelivered_messages_request_interval_in_seconds now require an override_ prefix to indicate optional values.

Before (Version <2.0.0) YAML:

custom_service_1:
  subscription_name: "<subscription_id>"
  tag: "<custom_tag>"
  auto_categorization_method: "<auto_categorization_method>"
  enable_pubsub_undelivered_messages_logging: <enable_pubsub_undelivered_messages_logging>
  pubsub_undelivered_messages_request_interval_in_seconds: <pubsub_undelivered_messages_request_interval_in_seconds>

After (Version >=2.0.0) YAML:

logging:
  subscription_name: "<subscription_name_value>"
  override_devo_tag: "<override_devo_tag_value>"
  override_auto_categorization_method: "<override_auto_categorization_method_value>"
  override_enable_pubsub_undelivered_messages_logging: <override_enable_pubsub_undelivered_messages_logging_value>
  override_pubsub_undelivered_messages_request_interval_in_seconds: <override_pubsub_undelivered_messages_request_interval_in_seconds_value>

Before (Version <2.0.0) JSON:

{
  "custom_service_1": {
    "subscription_name": "<subscription_id>",
    "tag": "<custom_tag>",
    "auto_categorization_method": "<auto_categorization_method>",
    "enable_pubsub_undelivered_messages_logging": <enable_pubsub_undelivered_messages_logging>,
    "pubsub_undelivered_messages_request_interval_in_seconds": <pubsub_undelivered_messages_request_interval_in_seconds>
  }
}

After (Version >=2.0.0) JSON:

Step 2: Test Configuration

Verify that the updated configuration files are valid and the services start correctly.
Test the collector to ensure it pulls and delivers data as expected.

Downgrade Considerations

Downgrading from version 2.0.0 to versions below 2.0.0 is supported. To revert:

Rename logging and scc_findings entries back to custom_service_[number].
Change override_devo_tag back to tag.
Change override_auto_categorization_method back to auto_categorization_method.
Remove the override_ prefix from enable_pubsub_undelivered_messages_logging and pubsub_undelivered_messages_request_interval_in_seconds.

Downgrade Configuration (Version <2.0.0) YAML:

Downgrade Configuration (Version <2.0.0) JSON:

Devo latest

Google Cloud Platform collector migration guide (1.x.x to 2.0.0)

Analytics