Skip to content

Add AWSO 2.x to 3.x migration guide with manual and automation scripts - #6884

Open
Apoorvkudesia-sumologic wants to merge 52 commits into
mainfrom
AWSOMigration
Open

Add AWSO 2.x to 3.x migration guide with manual and automation scripts#6884
Apoorvkudesia-sumologic wants to merge 52 commits into
mainfrom
AWSOMigration

Conversation

@Apoorvkudesia-sumologic

@Apoorvkudesia-sumologic Apoorvkudesia-sumologic commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

Purpose of this pull request

This pull request adds changes for the AWSO 2.x.x to 3.x.x migration steps with manual and automation script docs.

Select the type of change

  • Minor Changes - Typos, formatting, slight revisions
  • Update Content - Revisions, updating sections
  • New Content - New features, sections, pages, tutorials
  • Site and Tools - .clabot, version updates, maintenance, dependencies, new packages for the site (Docusaurus, Gatsby, React, etc.)

Ticket (if applicable)

@cla-bot cla-bot Bot added the cla-signed Contributor approved, listed in .clabot file label Jul 10, 2026
@amee-sumo

Copy link
Copy Markdown
Collaborator

Review feedback

A few items to address before merge:

  1. Script download path unclear — In the CloudFormation migration doc (line 92), it says "Download the migration script from the sumologic-solution-templates repository" but doesn't provide a direct URL or curl command to download it. Users will need to search the repo. Consider adding a direct link, e.g.:

    curl -O https://raw.githubusercontent.com/SumoLogic/sumologic-solution-templates/main/<path>/MigrateToV300.sh
  2. Placeholder note in manual doc — Line 174 says "Images showing where to find the role ARN in the CloudFormation console and where to update it in Sumo Logic will be added here." This should be resolved before merge — either add the images or remove the note.

  3. Table rendering — In the scripted doc (line 145), --install-apps Yes\|No uses a backslash-pipe that may not render correctly. Consider using Yes/No or `Yes` or `No` instead.

  4. Horizontal rules — The manual doc uses --- separators between steps. These aren't commonly used elsewhere in this repo and add visual weight. Consider removing them for consistency.

— via Claude Code

@amee-sumo

Copy link
Copy Markdown
Collaborator

Review feedback (round 2)

A few more items from the latest revision:

  1. Missing download link for migration script (CloudFormation doc, line 92) — The doc says "Download the migration script from the sumologic-solution-templates repository" but still doesn't provide a direct URL or path. Users can't proceed without searching the repo. Please add a direct link or curl command, e.g.:

    curl -O https://raw.githubusercontent.com/SumoLogic/sumologic-solution-templates/main/<path>/MigrateToV300.sh
  2. Table rendering issue (CloudFormation doc, line 145) — --install-apps Yes\|No renders literally as Yes\|No. The backslash-escaped pipe doesn't work as expected in Markdown tables. Use Yes / No or `Yes` or `No` instead.

  3. Cross-reference link text mismatch (Manual doc, line 13) — The link says "using the migration script" but the linked page title is "Migrate AWS Observability from v2.x to v3.0.0 using CloudFormation". The link text should match the target page title for consistency.

— via Claude Code

@Apoorvkudesia-sumologic Apoorvkudesia-sumologic added the do-not-merge Pull requests that should not be merged label Jul 10, 2026
@amee-sumo

Copy link
Copy Markdown
Collaborator

Review feedback (round 3)

One remaining issue that will confuse users:

Duplicate numbered steps in manual doc (lines 154–166) — The "Find the new IAM role ARN" section has overlapping instructions. Steps 3–4 appear twice with slightly different wording, and the numbered list restarts at 3 after the first screenshot:

1. Go to AWS Console > CloudFormation > Stacks...
2. In the Resources tab, find CreateCommonResources...
3. In the CreateCommonResources stack, go to Resources...search for SumoLogicSourceRole.
4. Note the Physical ID...

[screenshot]

3. In the CreateCommonResources stack, go to Resources...search for SumoLogicSourceRole.  ← duplicate
4. Click the Physical ID link to open the IAM role.  ← duplicate

[screenshot]

5. On the IAM role page, copy the ARN...

This should be a single sequential list (1→2→3→4→5) with screenshots placed between the relevant steps. The old text from before the screenshots were added (lines 154–157) should be removed since lines 159–168 now cover the same steps with proper screenshots.

— via Claude Code

@kimsauce kimsauce changed the title Awso migration Add AWSO 2.x to 3.x migration guide with manual and automation scripts Jul 13, 2026
Apoorvkudesia-sumologic and others added 10 commits July 14, 2026 09:39
Retain the parent "Deploy and Use AWS Observability" category and split its
content into two version subcategories: v3.0.0 (latest) and v2.15.0. Each
contains the full doc set. Add a parent launcher landing page, repoint
intra-version links, and add redirects for the moved 2.15.0 URLs.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Rename the v300/v215 subfolders to the dotted v3.0.0/v2.15.0 form and update
all references: slugs, intra-version links, sidebar IDs, redirect targets,
parent launcher cards, and the migration guides' links into the version docs.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Update cross-repo markdown links (release notes, API docs, FAQ, about,
fedramp, control-tower) that referenced the pre-restructure paths so they
resolve to the v2.15.0 version docs, fixing the production build.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
sachin-sumologic and others added 24 commits August 7, 2026 10:32
Groups the v2.x-to-v3.0.0 migration guides under migration/cloudformation/ and migration/terraform/, each with its own landing page, and replaces the two per-version changelogs with a single consolidated changelog.md. Updates the index page, sidebar, and all cross-references accordingly, and fixes two broken relative links to the old changelog paths.
Removes a stale client-redirect that conflicted with the new consolidated changelog page, repoints legacy redirect targets and blog release-note links to the new path, and fixes three pre-existing broken anchors (before-you-deploy, access-keys, account-settings-preferences) that surfaced once the build could get far enough to check them.

@kimsauce kimsauce left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Re-review of the latest commit (6bdea4c): 1 of 3 issues from the earlier pass is fixed (the v2.15.0 template URL in the update-stack doc — nice fix, now points to the "latest" section instead of hardcoding a version). Two link-target issues remain, flagged inline below.


Generated by Claude Code

<div className="box-wrapper">
<div className="box smallbox card">
<div className="container">
<a href={useBaseUrl('docs/observability/aws/deploy-use-aws-observability/before-you-deploy/')}><img src={useBaseUrl('img/icons/observe.png')} alt="Observe icon" width="40"/><h4>Before You Deploy</h4></a>

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All 8 topic cards on this "v3.0.0 (latest)" landing page link to un-versioned flat paths (before-you-deploy/, deploy-with-aws-cloudformation/, deploy-with-terraform/, migration-strategy-using-terraform/, view-dashboards/, configure-alerts/, update-aws-observability-stack/, resources/ — lines 42, 48, 54, 60, 66, 72, 78, 84), instead of the v3.0.0/-prefixed paths. None of these flat files exist anywhere in the repo anymore on this branch — every one of these docs now lives only under v2.15.0/ or v3.0.0/. So every card on this page is a dead link.

The sibling v2.15.0/index.md added in this same PR gets this right — it prefixes every card link with v2.15.0/. This file should follow the same pattern and prefix each link with v3.0.0/.


Generated by Claude Code

The script automates the entire migration process and pauses at key points for your approval before making any destructive changes.

:::note
This guide is for CloudFormation-based deployments only. If you deployed using Terraform, refer to [Migration Strategy using Terraform](/docs/observability/aws/deploy-use-aws-observability/v3.0.0/migration-strategy-using-terraform/). If you prefer to migrate manually without the script, see [Manually Migrate AWS Observability from v2.x to v3.0.0](/docs/observability/aws/deploy-use-aws-observability/migration/cloudformation/migration-strategy-v2x-to-v300-manual/).

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This note's Terraform cross-link points to the wrong doc: /docs/observability/aws/deploy-use-aws-observability/v3.0.0/migration-strategy-using-terraform/ is the unrelated, pre-existing "Migrate CloudWatch Source to Kinesis Firehose Source using Terraform" page, not a v2.x→v3.0.0 migration guide.

The actual v2.x→v3.0.0 Terraform migration guide added in this PR now lives at /docs/observability/aws/deploy-use-aws-observability/migration/terraform/ (per its slug in migration/terraform.md). This link should point there instead, so Terraform users land on the real migration steps rather than an unrelated source-migration doc.


Generated by Claude Code

sachin-sumologic and others added 5 commits August 24, 2026 11:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla-signed Contributor approved, listed in .clabot file do-not-merge Pull requests that should not be merged

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants