Skip to content

Commit e38d5cf

Browse files
committed
Finished updating FAQ
1 parent 1daf267 commit e38d5cf

File tree

2 files changed

+43
-41
lines changed

2 files changed

+43
-41
lines changed

src/content/docs/aws/getting-started/faq.md renamed to src/content/docs/aws/getting-started/faq.mdx

Lines changed: 42 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ sidebar:
66
order: 5
77
---
88

9+
import { Tabs, TabItem } from '@astrojs/starlight/components';
10+
911
## LocalStack Core FAQs
1012

1113
### How do I resolve SSL issues due to revoked local certificate for `localhost.localstack.cloud`?
@@ -17,7 +19,7 @@ To resolve the issue follow the steps:
1719
The exact path may differ depending on your operating system and how you’ve started LocalStack.
1820
Please refer to our [documentation](https://docs.localstack.cloud/references/filesystem/#localstack-volume) for specific instructions.
1921

20-
**Workarounds for older (<v3.7.0) LocalStack versions:**
22+
**Workarounds for older (&lt;v3.7.0) LocalStack versions:**
2123

2224
1. **Disable Certificate Download**: To prevent downloading a revoked certificate, set the environment variable `SKIP_SSL_CERT_DOWNLOAD=1`.
2325
This will cause LocalStack to use a self-signed SSL certificate.
@@ -34,15 +36,15 @@ To resolve the issue follow the steps:
3436
If the LocalStack CLI version is heavily outdated, it might lead to issues with container startup and debug commands.
3537
If you are using an older version of LocalStack, you can update it by running the following command:
3638

37-
{{< command >}}
38-
$ pip install --upgrade localstack localstack-ext
39-
{{< / command >}}
39+
```bash
40+
pip install --upgrade localstack localstack-ext
41+
```
4042

4143
If you are running a newer version of LocalStack, you can check the version by running the following command:
4244

43-
{{< command >}}
45+
```bash
4446
$ localstack update localstack-cli
45-
{{< / command >}}
47+
```
4648

4749
### Is using `localhost.localstack.cloud:4566` to set as the endpoint for AWS services recommended?
4850

@@ -105,19 +107,22 @@ To prevent this, you can temporarily set the `MSYS_NO_PATHCONV` environment vari
105107
Another workaround is to double the first slash in your command to prevent the POSIX-to-Windows path conversion.
106108

107109
This will lead to issues with Git Bash
108-
{{< command >}}
110+
111+
```bash
109112
$ aws ssm get-parameter --name "/test/parameter/new"
110-
{{< / command >}}
113+
```
111114

112115
Option 1: Set the environment variable
113-
{{< command >}}
116+
117+
```bash
114118
$ MSYS_NO_PATHCONV=1 aws ssm put-parameter --name "/test/parameter/new" --type String --value "test"
115-
{{< / command >}}
119+
```
116120

117121
Option 2: Double the first slash
118-
{{< command >}}
122+
123+
```bash
119124
$ aws ssm put-parameter --name "//test/parameter/new" --type String --value "test"
120-
{{< / command >}}
125+
```
121126

122127
For additional known issues related to Git Bash, you can refer to the following link: [Git Bash Known Issues](https://github.com/git-for-windows/build-extra/blob/main/ReleaseNotes.md#known-issues)
123128

@@ -177,7 +182,7 @@ sudo sysctl -w net.ipv4.ip_forward=1
177182
Using LocalStack inside a Docker network with multiple other containers can lead to connectivity issues from/to those containers.
178183
For example, a container which attempts to deploy a stack and interact with the services directly, from within the same Docker network.
179184

180-
Refer to our [network troubleshooting guide]({{< ref "references/network-troubleshooting" >}}) covering several scenarios.
185+
Refer to our [network troubleshooting guide](/aws/capabilities/networking/) covering several scenarios.
181186

182187
### How to resolve the pull rate limit issue for LocalStack's Docker image?
183188

@@ -203,29 +208,32 @@ You can add in the volume `~/.docker/config.json:/config.json` where the `config
203208
If you have an active AWS account, you can use the public AWS ECR image.
204209
You can use the following command to pull the image:
205210

206-
{{< tabpane >}}
207-
{{< tab header="Community" lang="shell" >}}
211+
<Tabs>
212+
<TabItem label="Community">
213+
```shell
208214
docker pull public.ecr.aws/localstack/localstack:latest
209-
{{< /tab >}}
210-
{{< tab header="Pro" lang="powershell" >}}
215+
```
216+
</TabItem>
217+
<TabItem label="Pro">
218+
```shell
211219
docker pull public.ecr.aws/localstack/localstack-pro:latest
212-
{{< /tab >}}
213-
{{< /tabpane >}}
220+
```
221+
</TabItem>
222+
</Tabs>
214223

215224
### How to increase IO performance for LocalStack's Docker image under Windows?
216225

217-
{{< callout "note">}}
226+
:::note
218227
Some options that are not part of the standard configuration may have unintended consequences for AWS services that operate within LocalStack.
219228
For example, these options may interfere with the functionality of AppSync function executor, RDS MySQL persistence and SageMaker.
220229
We advise you to exercise caution.
221-
{{< /callout >}}
230+
:::
222231

223232
You can change the LocalStack `volume` folder to use the WSL Linux file system instead of the Windows host folder.
224233
To do so, you need to change the [`docker-compose.yml`](https://github.com/localstack/localstack/blob/master/docker-compose-pro.yml) file and add the following lines:
225234

226-
{{< tabpane text=true >}}
227-
{{< tab header="WSL Linux File System" >}}
228-
{{% markdown %}}
235+
<Tabs>
236+
<TabItem label="WSL Linux File System">
229237

230238
```yaml
231239
volumes:
@@ -236,23 +244,17 @@ To do so, you need to change the [`docker-compose.yml`](https://github.com/local
236244
---
237245
238246
As an alternative, you can set the volume as `- "~/volume:/var/lib/localstack"` then start Docker using command `wsl docker compose -f docker-compose.yml up`.
239-
240-
{{% /markdown %}}
241-
{{< /tab >}}
242-
{{< tab header="Docker Volumes" >}}
243-
{{% markdown %}}
244-
247+
</TabItem>
248+
<TabItem label="Docker Volumes">
245249
```yaml
246250
volumes:
247251
- "/var/run/docker.sock:/var/run/docker.sock"
248252
- "localstack_data:/var/lib/localstack" # mount Docker volume
249253
volumes:
250254
localstack_data:
251255
```
252-
253-
{{% /markdown %}}
254-
{{< /tab >}}
255-
{{< /tabpane >}}
256+
</TabItem>
257+
</Tabs>
256258

257259
For more details visit [Docker WSL documentation](https://docs.docker.com/desktop/wsl), [Docker WSL best practices](https://docs.docker.com/desktop/wsl/best-practices) and [Docker Volumes documentation](https://docs.docker.com/storage/volumes/).
258260

@@ -272,11 +274,11 @@ Pushing and pulling a Cloud Pod from our Web Application is facilitated by using
272274

273275
The easiest way to check if LocalStack Pro or Enterprise is activated is to check the health endpoint of LocalStack for a list of the running services:
274276

275-
{{< command >}}
277+
```bash
276278
$ curl localhost:4566/_localstack/health | jq
277-
{{< / command >}}
279+
```
278280

279-
If a Pro-only [service]({{< ref "aws" >}}) -- like [XRay]({{< ref "xray" >}}) -- is running, LocalStack Pro or Enterprise has started successfully.
281+
If a Pro-only service -- like [XRay](/aws/services/x-ray) -- is running, LocalStack Pro or Enterprise has started successfully.
280282
If your Auth Token is invalid, you will see an error message like this in the logs of LocalStack:
281283

282284
```bash
@@ -292,7 +294,7 @@ If the Auth Token still does not work, please [contact us](https://localstack.cl
292294
A CI Auth Token allows you to use LocalStack in your CI environment.
293295
Every activation with a CI Auth Token consumes one CI credit.
294296
This means that with every build triggered through the LocalStack container you will consume one credit.
295-
To understand the CI pricing across our product tiers, follow up with our [LocalStack in CI]({{<ref "user-guide/ci">}}) documentation.
297+
To understand the CI pricing across our product tiers, follow up with our [LocalStack in CI](/aws/integrations/continuous-integration/) documentation.
296298

297299
### What should I do if I cannot connect to LocalStack API?
298300

@@ -319,9 +321,9 @@ socket.gaierror: [Errno -3] Temporary failure in name resolution
319321

320322
Confirm this by using a tool like `dig`:
321323

322-
{{< command >}}
324+
```bash
323325
$ dig api.localstack.cloud
324-
{{< / command >}}
326+
```
325327

326328
If the result has some other status than `status: NOERROR,` your machine cannot resolve this domain.
327329

src/content/docs/aws/getting-started/quickstart.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Start the LocalStack Pro container with your `LOCALSTACK_AUTH_TOKEN` pre-configu
5353
<Code code={`localstack auth set-token <your-auth-token>\nlocalstack start`} lang="shell" />
5454
</TabItem>
5555
<TabItem label="Windows">
56-
<Code code={`localstack auth set-token <your-auth-token>\nlocalstack start`} lang="powershell" />
56+
<Code code={`localstack auth set-token <your-auth-token>\nlocalstack start`} lang="shell" />
5757
</TabItem>
5858
</Tabs>
5959

0 commit comments

Comments
 (0)