Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add documentation about replicator tool #1501

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions content/en/user-guide/replicator-tool/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: "Replicator Tool"
date: 2024-09-26T11:03:46-05:00
draft: true

description: >
Internals of LocalStack replicator tool
aliases:
- /localstack/replicator-tool/
- /references/replicator-tool/
tags: ["Pro image"]
---

## Introduction
The new replicator tool enables seamless copying of real AWS resources into LocalStack, allowing you to recreate your cloud environment locally.
By extracting and replicating AWS configurations, services, and data, this tool ensures an accurate reflection of your cloud setup within LocalStack.
Whether for development, testing, or troubleshooting, this tool provides a quick and efficient way to mirror live resources in an emulated environment, enabling you to work locally with the same infrastructure you'd deploy on AWS.

## Usage
To use the replicator tool, follow these steps: (Add steps here)

## Coverage
The tool is capable of replicating the following resources into LocalStack.

{{< localstack_replicator_table >}}
16 changes: 16 additions & 0 deletions data/replication/coverage.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
[
{
"name": "Parameter",
"type": "AWS::SSM::Parameter",
"service": "ssm",
"service_name": "System Session Manager",
"properties_replication": true,
"data_replication": true,
"supported_relations": [
{
"property_name": "KeyId",
"type": "AWS::KMS::Key"
}
]
}
]
41 changes: 41 additions & 0 deletions layouts/partials/replicator_coverage_table.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
<div class="coverage-report">
<table>
<thead>
<tr>
<th class="coverage-report-header-1">Service</th>
<th class="coverage-report-header-2">Resource</th>
<th class="coverage-report-header-1">Properties Replication</th>
<th class="coverage-report-header-2">Data Replication</th>
<th class="coverage-report-header-1">Supported relations</th>
</tr>
</thead>
<tbody>
{{ $data := .Site.Data.replication.coverage }}

{{ range $data }}
<tr>
<!-- Service -->
<td>{{ .service_name }} (<small>{{.service}}</small>)</td>
<!-- Resource -->
<td>{{ .name }} (<small>{{.type}}</small>)</td>
<!-- Properties Replication -->
<td class="coverage-shadow-overlay-green">
{{ if or (eq .properties_replication true) -}}
✔️
{{ end }}
</td>
<!-- Data Replication -->
<td class="coverage-shadow-overlay-green">{{ if (.data_replication) }} ✔️ {{ end }}</td>
<!-- Relationships -->
<td>
{{ $relations := .supported_relations }}
{{ range $relations }}
<b>{{.property_name}}:</b>{{.type}}<br/>
{{end -}}
</td>
</tr>
{{ end -}}
</tbody>
</table>
<br/>
</div>
1 change: 1 addition & 0 deletions layouts/shortcodes/localstack_replicator_table.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{{ partial "replicator_coverage_table" . }}