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

docs(srv): add troubleshooting on testing private resources MTA-5424 #4211

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
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
12 changes: 12 additions & 0 deletions menu/navigation.json
Original file line number Diff line number Diff line change
Expand Up @@ -3781,6 +3781,10 @@
{
"label": "My function fails after too many retries",
"slug": "too-many-retries"
},
{
"label": "Tests fail on private functions",
"slug": "tests-fail-on-private-function"
}
],
"label": "Troubleshooting",
Expand Down Expand Up @@ -3838,6 +3842,10 @@
"label": "Secure a container",
"slug": "secure-a-container"
},
{
"label": "Test a container",
"slug": "test-a-container"
},
{
"label": "Monitor container logs and metrics",
"slug": "monitor-container"
Expand Down Expand Up @@ -3939,6 +3947,10 @@
{
"label": "My container stopped working after a redeploy",
"slug": "container-stopped-after-redeploy"
},
{
"label": "Tests fail on private containers",
"slug": "tests-fail-on-ùprivate-container"
}
],
"label": "Troubleshooting",
Expand Down
44 changes: 44 additions & 0 deletions serverless/containers/how-to/test-a-container.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
meta:
title: How to test a container
description: Instructions for testing your Serverless Containers on Scaleway.
content:
h1: How to test a container
paragraph: Instructions for testing your Serverless Containers on Scaleway.
tags: container serverless test-container
dates:
validation: 2025-01-14
posted: 2025-01-15
categories:
- serverless
---

This page shows you how to execute Serverless Containers from the [Scaleway console](https://console.scaleway.com). The **Test** feature of a container allows you to run your code using a selection of methods to make sure it behaves as expected.

<Macro id="requirements" />

- A Scaleway account logged into the [console](https://console.scaleway.com)
- [Owner](/identity-and-access-management/iam/concepts/#owner) status or [IAM permissions](/identity-and-access-management/iam/concepts/#permission) allowing you to perform actions in the intended Organization
- [Created a container](/serverless/containers/how-to/deploy-container/)

1. Click **Containers** in the **Serverless** section of the side menu. The containers page displays.

2. Click the relevant containers namespace. A list of your containers displays.

3. Click the name of the container you want to test.

4. Open the **Test** tab.

5. Select the **method** you want to use from the drop-down menu.

6. Enter the **path** to your container. Leave the default `/` value if the host of your container is not located in a specific folder.

7. Click **+ Advanced options** to add any required HTTP header or parameter to your container.

8. Click **Run**.

The **Output** section displays the response from your container and the status code.

<Message type="note">
If you encounter a message error while testing your container, refer to the [dedicated troubleshooting](/serverless/containers/troubleshooting/tests-fail-on-private-container/) for more information.
</Message>
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
meta:
title: Tests fail on private Serverless Containers
description: I get error messages when testing private Serverless Containers using the Scaleway Console
content:
h1: Tests fail on private Serverless Containers
paragraph: I get error messages when testing private Serverless Containers using the Scaleway Console
tags: serverless containers private troubleshooting issue error test authentication token unable
dates:
validation: 2025-01-14
posted: 2025-01-14
categories:
- serverless
---

## Problem

I get error messages when testing private Serverless Containers using the Scaleway Console.

### Cause

[Private](/serverless/containers/concepts/#privacy-policy) containers require a `X-Auth-Token` HTTP header when being run or tested.

### Possible solutions

Make sure that you have [created an authentication token](/serverless/containers/how-to/create-auth-token-from-console/) from the Scaleway console, and passed it as a HTTP header while [testing your container](/serverless/containers/how-to/test-a-container).
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Make sure that you have [created an authentication token](/serverless/containers/how-to/create-auth-token-from-console/) from the Scaleway console, and passed it as a HTTP header while [testing your container](/serverless/containers/how-to/test-a-container).
Make sure that you have [created an authentication token](/serverless/containers/how-to/create-auth-token-from-console/) from the Scaleway console, and passed it as an HTTP header while [testing your container](/serverless/containers/how-to/test-a-container).

4 changes: 4 additions & 0 deletions serverless/functions/how-to/test-a-function.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,3 +38,7 @@ This page shows you how to execute Serverless Functions from the [Scaleway conso
8. Click **Run**.

The **Output** section displays the response from your function and the status code.

<Message type="note">
If you encounter a message error while testing your function, refer to the [dedicated troubleshooting](/serverless/functions/troubleshooting/tests-fail-on-private-function/) for more information.
</Message>
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
meta:
title: Tests fail on private Serverless Functions
description: I get error messages when testing private Serverless Functions using the Scaleway Console
content:
h1: Tests fail on private Serverless Functions
paragraph: I get error messages when testing private Serverless Functions using the Scaleway Console
tags: serverless functions private troubleshooting issue error test authentication token unable
dates:
validation: 2025-01-14
posted: 2025-01-14
categories:
- serverless
---

## Problem

I get error messages when testing private Serverless Functions using the Scaleway Console.

### Cause

[Private](/serverless/functions/concepts/#privacy-policy) functions require a `X-Auth-Token` HTTP header when being run or tested.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
[Private](/serverless/functions/concepts/#privacy-policy) functions require a `X-Auth-Token` HTTP header when being run or tested.
[Private](/serverless/functions/concepts/#privacy-policy) functions require an `X-Auth-Token` HTTP header when being run or tested.


### Possible solutions

Make sure that you have [created an authentication token](/serverless/functions/how-to/create-auth-token-from-console/) from the Scaleway console, and passed it as a HTTP header while [testing your function](/serverless/functions/how-to/test-a-function).
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Make sure that you have [created an authentication token](/serverless/functions/how-to/create-auth-token-from-console/) from the Scaleway console, and passed it as a HTTP header while [testing your function](/serverless/functions/how-to/test-a-function).
Make sure that you have [created an authentication token](/serverless/functions/how-to/create-auth-token-from-console/) from the Scaleway console, and passed it as an HTTP header while [testing your function](/serverless/functions/how-to/test-a-function).

Loading