Skip to content

Commit 95ea134

Browse files
committed
fix description for release; add cloudpod section in README
1 parent 0468fab commit 95ea134

File tree

3 files changed

+29
-5
lines changed

3 files changed

+29
-5
lines changed

.github/workflows/cloudpod_release.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,15 +39,15 @@ jobs:
3939
run: ls -R
4040
- name: Prepare Release Notes
4141
run: |
42-
echo "This release includes the Cloud Pod of the sample created with LocalStack Version `${{ inputs.release-tag || 'latest'}}`." > Release.txt
43-
echo "Please use the `release-pod-{database}.zip` you need for your configuration." >> Release.txt
42+
echo "This release includes the Cloud Pod of the sample created with LocalStack Version \`${{ inputs.release-tag || 'latest'}}\`." > Release.txt
43+
echo "Please use the \`release-pod-{database}.zip\` you need for your configuration." >> Release.txt
4444
echo "### MariaDB" >> Release.txt
45-
echo "By default LocalStack uses the engine `mariadb`, so you need `release-pod-mariadb.zip`." >> Release.txt
45+
echo "By default LocalStack uses the engine \`mariadb\`, so you need \`release-pod-mariadb.zip\`." >> Release.txt
4646
echo "You can click the Launchpad to inject the pod into your running LocalStack instance:" >> Release.txt
4747
echo "[![LocalStack Pods Launchpad](https://localstack.cloud/gh/launch-pod-badge.svg)](https://app.localstack.cloud/launchpad?url=https://github.com/$GITHUB_REPOSITORY/releases/download/${{ inputs.release-tag || 'latest'}}/release-pod-mariadb.zip)" >> Release.txt
4848
echo "### MySQL" >> Release.txt
49-
echo "If you start LocalStack with `RDS_MYSQL_DOCKER=1`, please use the `mysql` pod `release-pod-mysql.zip`" >> Release.txt
50-
echo "You can click the Launchpad to inject the `mysql` version of the pod into your running LocalStack instance:" >> Release.txt
49+
echo "If you start LocalStack with \`RDS_MYSQL_DOCKER=1\`, please use the \`mysql\` pod \`release-pod-mysql.zip\`" >> Release.txt
50+
echo "You can click the Launchpad to inject the \`mysql\` version of the pod into your running LocalStack instance:" >> Release.txt
5151
echo "[![LocalStack Pods Launchpad](https://localstack.cloud/gh/launch-pod-badge.svg)](https://app.localstack.cloud/launchpad?url=https://github.com/$GITHUB_REPOSITORY/releases/download/${{ inputs.release-tag || 'latest'}}/release-pod-mysql.zip)" >> Release.txt
5252
- name: Create Release
5353
id: create_release

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -196,3 +196,27 @@ The implementation can be found in `lib/resource-initializer.ts`.
196196
## Learn More
197197

198198
More details about the original sample can be found in the AWS blog post — [Use AWS CDK to initialize Amazon RDS instances](https://aws.amazon.com/blogs/infrastructure-and-automation/use-aws-cdk-to-initialize-amazon-rds-instances/).
199+
200+
## Cloud Pods
201+
202+
[Cloud Pods](https://docs.localstack.cloud/user-guide/tools/cloud-pods/) are a mechanism that allows you to take a snapshot of the state in your current LocalStack instance, persist it to a storage backend, and easily share it with your team members.
203+
204+
You can convert your current AWS infrastructure state to a Cloud Pod using the `localstack` CLI.
205+
Check out our [Getting Started guide](https://docs.localstack.cloud/user-guide/tools/cloud-pods/getting-started/) and [LocalStack Cloud Pods CLI reference](https://docs.localstack.cloud/user-guide/tools/cloud-pods/pods-cli/) to learn more about Cloud Pods and how to use them.
206+
207+
To inject a Cloud Pod you can use [Cloud Pods Launchpad](https://docs.localstack.cloud/user-guide/tools/cloud-pods/launchpad/) wich quickly injects Cloud Pods into your running LocalStack container.
208+
209+
> **NOTE**: The Cloud Pod linked here, was created with the `latest` LocalStack version, make sure you also run `latest` when injecting.
210+
Further, LocalStack needs to be started with the flag `RDS_MYSQL_DOCKER=1`. For different flavors check the available [releases](https://github.com/localstack/amazon-rds-init-cdk/releases).
211+
212+
Click here [![LocalStack Pods Launchpad](https://localstack.cloud/gh/launch-pod-badge.svg)](https://app.localstack.cloud/launchpad?url=https://github.com/localstack/amazon-rds-init-cdk/releases/download/latest/release-pod-mysql.zip) to launch the Cloud Pods Launchpad and inject the Cloud Pod for this application by clicking the `Inject` button.
213+
214+
![Cloud Pod injection with the Cloud Pod Launchpad](images/screenshot_launchpad.png)
215+
216+
Alternatively, you can inject the pod by using the `localstack` CLI.
217+
First, you need to download the pod you want to inject from the [releases](https://github.com/localstack/amazon-rds-init-cdk/releases).
218+
Then run:
219+
220+
```sh
221+
localstack pod load file://$(pwd)/release-pod-mysql.zip
222+
```

images/screenshot_launchpad.png

111 KB
Loading

0 commit comments

Comments
 (0)