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

chore(gen): documentation review MTA-5103 #3782

Merged
merged 8 commits into from
Oct 8, 2024
Merged
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
21 changes: 11 additions & 10 deletions console/account/how-to/recover-a-lost-password.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: Recover a lost password for your Scaleway account.
tags: account password recovery login
dates:
validation: 2024-03-27
validation: 2024-10-01
posted: 2021-06-11
categories:
- console
Expand All @@ -19,29 +19,30 @@ If you forget or lose the password to your [Scaleway account](https://console.sc

- A [Scaleway](https://www.scaleway.com/en/) account

## Passwordless authentication using a Magic Link
## Log in without a password using a magic link

The [Magic Link](/console/account/how-to/log-in-to-the-console/) allows you to access your account without a password, using multifactor authentication.
The [magic link](/console/account/how-to/log-in-to-the-console/) allows you to access your account without a password, using multifactor authentication.

Click **Send a Magic Link** on the Login page of the Scaleway console.
Click **Send magic link** on the Login page of the Scaleway console.

A secret link is sent to your email. You can access your account by clicking on the link.

## Password reset using email validation
## Reset your password using email validation

If you forget or lose your password, you can request to reset it.

1. Go to the [lost password](https://console.scaleway.com/forgot-password/) page of the console:
1. From the [Scaleway console login page](https://account.scaleway.com/), Click **Log in with password**.
1. Click **Forgot your password?**, or access the [lost password](https://console.scaleway.com/forgot-password/) page.
2. Enter your email address and click **Reset password**. A password reset link is sent to your email address.
3. Click the link in the email address to reset your password.
4. Enter your new password and click **Reset password** to set the new password for your account. You are redirected to the Login page.
5. Log in to the console with your email address and your new password.

## Password recovery in case of lost email account
## Recover your password if you lost access to your email account

If you lose access to your email account, it will not be possible to reset the password directly from the Scaleway console.
If you lose access to your email account, you will not be able to reset the password directly from the Scaleway console.

In case you can no longer access your email account, you must send us a request to update your contact information with the following pieces of identification:
If you cannot access your email account, you must send us a request to update your contact information with the following pieces of identification:

* Email address
* Postal address
Expand All @@ -53,7 +54,7 @@ In case you can no longer access your email account, you must send us a request
* Copy of your last Scaleway invoice or the amount charged if you do not have a copy
* A card or bank statement showing your Scaleway invoice debit

Once you have gathered all the required documents, the request has to be sent by email to: [[email protected]](mailto:[email protected]).
Once you have gathered all the required documents, send the request by email to: [[email protected]](mailto:[email protected]).

We will update the email address on receipt of the application, subject to validation.

Expand Down
8 changes: 4 additions & 4 deletions console/account/troubleshooting/cannot-erase-account.mdx
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
---
meta:
title: I cannot erase my account and personal data
title: I cannot close my account and erase personal data
description: Resolve issues encountered when deleting Scaleway accounts.
content:
h1: I cannot erase my account and personal data
paragraph: Resolve issues encountered when deleting Scaleway accounts.
tags: account close delete deactivate close-account
dates:
validation: 2024-03-28
validation: 2024-10-01
posted: 2024-03-28
categories:
- console
---

## My request to erase my account and personal data has failed
## My request to close my account and erase personal data has failed

### Problem
When you click the **Send request** button, an error message appears. This message says that you still have active resources.
Expand All @@ -32,4 +32,4 @@ I received an email explaining that my request to erase my account and personal
You may have unpaid consumption, preventing us from proceeding with your request.

### Solution
You can check your consumption from your [Billing space](https://console.scaleway.com/billing). All invoices must be marked as paid, and your current consumption must be zero. Once these criteria are met, you can send another request to delete your account and personal data.
You can check your consumption from your [Billing space](https://console.scaleway.com/billing). All invoices must be marked as paid, and your current consumption must be zero. Once these criteria are met, you can send another request to delete your account and erase personal data.
12 changes: 6 additions & 6 deletions faq/serverless-functions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ content:
h1: Serverless Functions
hero: assets/faas.webp
dates:
validation: 2024-03-25
validation: 2024-10-03
category: serverless
---

Expand All @@ -16,21 +16,21 @@ category: serverless

Serverless Functions is billed on a pay-as-you-go basis. Three components are taken into account:

* **Monthly Request number:** each time your function is invoked we increase a counter.
* **Monthly request number:** each time your function is invoked we increase a counter.

* **Resource consumption:** this component is obtained by multiplying the memory tiers chosen by the duration of each function invocation.

* **Resources provision:** in order to mitigate cold start, users can choose to keep some function Instances warm (by filing the min scale value). We then charge for the provisioned resources similarly to the Resources consumption component.
* **Resources provision:** in order to mitigate cold start, users can choose to keep some function instances warm (by filing the minimum scale value). We then charge for the provisioned resources similarly to the Resources consumption component.

The scheme below illustrates our billing model:

<Lightbox src={["scaleway-Billing-FaaS-1-DEF.webp", "scaleway-Billing-FaaS-2-DEF.webp"]} size={"medium"} alt={["Functions Billing", "Functions Billing"]} />

### Pricing

* **Monthly requests:** **€0.15 per million requests** and we offer **1M free requests** per account per month.
* **Monthly requests:** **€0.15 per million requests**, and we offer **1M free requests** per account per month.

* **Resources consumption:** **€1.20 per 100 000 GB-s** and we provide **400 000 GB-s free tiers** per account and per month.
* **Resources consumption:** **€1.20 per 100 000 GB-s**, and we provide **400 000 GB-s free tiers** per account and per month.

| Memory provisioned | Cost per second |
|---------------------|-----------------|
Expand Down Expand Up @@ -157,7 +157,7 @@ Serverless Functions use cases are wide so [several ways to deploy functions](/s

## How can I test my functions locally?

Local development is useful for debugging, profiling, testing etc... so we provide libraries to do this: [local testing doc](/serverless/functions/reference-content/local-testing/).
Scaleway provides libraries to run your functions locally, for debugging, profiling, and testing purposes. Refer to the [dedicated documentation](/serverless/functions/reference-content/local-testing/) for more information.

## Where can I find some advanced code examples for functions?

Expand Down
11 changes: 5 additions & 6 deletions faq/serverless-jobs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ content:
h1: Serverless Jobs
hero: assets/serverless-jobs.webp
dates:
validation: 2024-03-25
validation: 2024-10-03
category: serverless
---

Expand Down Expand Up @@ -84,19 +84,18 @@ Serverless Jobs are integrated with [Cockpit](/observability/cockpit/quickstart/

## Can I cancel or modify a Serverless Job after it has started?

An ongoing Serverless Job can be interrupted during its execution from the **Job runs** section of a job's **Overview** tab.
An ongoing Serverless Job can be interrupted during its execution from the **Job runs** section of a job's **Overview** tab. Refer to the [dedicated docmentation](/serverless/jobs/how-to/stop-job/) for more information.

## How can I automate the deployment and management of Scaleway Serverless Jobs?

Scaleway Serverless Jobs is part of the Scaleway ecosystem, it can therefore be driven using the [Scaleway CLI](/developer-tools/scaleway-cli/quickstart/), the [Scaleway API](https://www.scaleway.com/en/developers/api/), and other [developer tools](https://www.scaleway.com/en/developers/). Our serverless ecosystem offers a lot of possibilities with event-driven architectures, and integrations with more products of the Scaleway ecosystem are under active development.

## Do Serverless Jobs offer parallelization?
## Can I run multiple Serverless Jobs at the same time?

Not yet. Scaleway Serverless Jobs will soon offer parallelization via a `parallelism` parameter for each job. This will automatically launch a given number of replicas of the Job container in parallel.
When starting a job, you can use contextual options to define the number of jobs to execute at the same time. Refer to the [dedicated documentation](/serverless/jobs/how-to/run-job/#how-to-run-a-job-with-contextual-options) for more information.

## How can I configure access to a Private Network?

Scaleway Serverless Jobs does not currently support Scaleway VPC or Private Networks, though this feature is under development.

To add network restrictions on your resource, consult the [list of prefixes used at Scaleway](https://www.scaleway.com/en/peering/). Serverless resources do not have dedicated or predictable IP addresses.

To add network restrictions on your resource, consult the [list of prefixes used at Scaleway](https://www.scaleway.com/en/peering/). Serverless resources do not have dedicated or predictable IP addresses.
2 changes: 1 addition & 1 deletion faq/serverless-sql-databases.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ category: serverless

You are billed both for the compute resources provisioned and the storage used. You can see the cost estimate in the Database creation wizard.

- **Compute**: You are billed based on compute resources (vCPU and RAM) provisioned to handle your workload. Provisioned resources evolve according to the [autoscaling](/serverless/sql-databases/reference-content/serverless-sql-databases-overview/#autoscaling) parameter and stay between the minimum and maximum thresholds defined for your database. For each vCPU provisioned, 4 GB of RAM will be allocated.
- **Compute**: You are billed based on compute resources (vCPU and RAM) provisioned to handle your workload. Provisioned resources evolve according to the [autoscaling](/serverless/sql-databases/reference-content/serverless-sql-databases-overview/#autoscaling) parameter, and stay between the minimum and maximum thresholds defined for your database. For each vCPU provisioned, 4 GB of RAM will be allocated.
SamyOubouaziz marked this conversation as resolved.
Show resolved Hide resolved

- **Storage**: You are billed for the storage consumed by your database. Storage price is based on the size of your database (in GB) and includes 7 days of automated backups at no additional costs. Storage is always billed even if your database is in an active state or idle state.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: Add a custom domain to Scaleway Serverless Containers.
tags: custom-domain container serverless cname record
dates:
validation: 2024-03-27
validation: 2024-10-01
posted: 2022-02-21
categories:
- serverless
Expand All @@ -23,10 +23,10 @@ Each container comes with an automatically generated domain, on which it is avai
- A running [Serverless Container](/serverless/containers/how-to/deploy-a-container-from-scaleway-container-registry/)
- Registered a domain name with the provider of your choice and have access to the domain name's DNS zone file

If you are using **Cloudflare DNS**, see the note below regarding proxying.

1. On your domain provider's platform (for example, [Scaleway's domains](/network/domains-and-dns/how-to/manage-dns-records/)), add a CNAME record pointing to your container default URL in the domain's DNS zone file.



<Message type="note">
- All domains are supported.
- When using a root domain:
Expand Down Expand Up @@ -81,15 +81,15 @@ HTTP-01 challenge failure (and by extension, a custom domain in `error` status)
| DNS record is not available yet. | This can be the case if the custom domain is created immediately after the CNAME is configured on your DNS provider side. | As a rule of thumb, wait a few minutes after creating the CNAME on your DNS provider, or at least wait until the DNS record is available on main resolvers (`1.1.1.1`, `8.8.8.8`). |
| DNS cache is stale (still pointing to an old endpoint). | If the custom domain was pointing to another endpoint before adding the CNAME record to the Serverless Container, and if the TTL is greater than the maximum time of the check (3 min), it can sometimes happen that the custom domain still resolves to the old endpoint, thus making the challenge fail. | Wait until DNS entry is available and use a smaller TTL. |
| Negative DNS cache is stale | If the initial check fails (DNS record is not available yet), and the negative TTL configured on your DNS provider side is high, the negative TTL will prevent subsequent checks from querying the nameserver again, until it expires. Depending on the negative TTL configured, this can take more or less time. | Either reduce the negative TTL in your DNS provider configuration, or just wait until you are sure DNS record is available. If you already tried to add the custom domain and faced this issue, you likely have to wait for the negative TTL to expire before making another attempt (so the cache can also expire on our side). |
| Route `/.well-known/acme-challenge` is not handled correctly. | To perform the HTTP-01 challenge, a call will be made on `<your_custom_domain>/.well-known/acme-challenge/<token>`. If you are using a proxying/caching tool (like Cloudflare) between the custom domain and the Serverless Container endpoint, a cached version of that route can be served, making the check fails. | Don't configure caching rules for routes starting with `/.well-known/acme-challenge`. See an example below with Cloudflare. |
| Route `/.well-known/acme-challenge` is not handled correctly. | To perform the HTTP-01 challenge, a call will be made on `<your_custom_domain>/.well-known/acme-challenge/<token>`. If you are using a proxying/caching tool (like Cloudflare) between the custom domain and the Serverless Container endpoint, a cached version of that route can be served, making the check fails. | Do not configure caching rules for routes starting with `/.well-known/acme-challenge`. Refer to the example below with Cloudflare. |

Example of configuration on Cloudflare to disable caching with "Cache rules":

<Lightbox src="cloudflare-bypass-cache-well-known-acme-challenge.webp" size="medium" alt="Bypass cache for /.well-known/acme-challenge routes" />

## Migrating an active domain

Read this section if you are trying to migrate a domain that is already serving a live website/API/web application -- but not yet hosted on a Serverless Container -- and you are trying to migrate.
Read this section if you are trying to migrate a domain that is already serving a live website/API/web application, but not yet hosted on a Serverless Container.

To clarify, let's take a concrete example:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ content:
h1: Containers concurrency
paragraph: Learn about concurrency settings for Scaleway Serverless Containers.
dates:
validation: 2024-03-26
validation: 2024-10-03
posted: 2024-03-26
tags: serverless containers concurrency concurrent execution scaling parallelism parallel instances
categories:
Expand All @@ -20,8 +20,6 @@ Concurrency determines the number of incoming requests a single instance of a co

A higher number of instances processing requests at the same time implies a greater usage of memory and [vCPU](/serverless/containers/concepts/#vcpu), and consequently a higher cost.



## Maximum concurrent requests per instance

When [deploying a container](/serverless/containers/how-to/deploy-a-container-from-scaleway-container-registry/), Scaleway Serverless Containers allows you to edit the **Maximum concurrent requests per instance** parameter.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ content:
h1: Methods to deploy Serverless Containers
paragraph: Step-by-step guide to deploying a container on Scaleway.
dates:
validation: 2024-03-27
validation: 2024-10-03
posted: 2023-03-10
---

Expand Down Expand Up @@ -58,7 +58,7 @@ Installation instructions and documentation are available in the [Scaleway CLI r

## Scaleway SDKs

The Scaleway SDKs allow you to manage your resources directly from your favorite languages.
The Scaleway Software Development Kits (SDK) allow you to manage your resources directly from your favorite languages.

The available SDKs are:

Expand Down
4 changes: 2 additions & 2 deletions serverless/functions/reference-content/local-testing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: Learn how to test your Serverless Functions locally before deployment on Scaleway.
tags: functions serverless local testing
dates:
validation: 2024-03-27
validation: 2024-10-03
posted: 2023-03-06
categories:
- serverless
Expand Down Expand Up @@ -51,5 +51,5 @@ with different libraries available to your local development environment.
Performance during local testing can differ from the deployed Serverless Functions environment, and will involve [limitations](/serverless/functions/reference-content/functions-limitations/) around resource usage and quotas.

<Message type="note">
CPU/Memory settings do not apply when testing functions locally.
CPU/memory settings do not apply when testing functions locally.
</Message>
4 changes: 2 additions & 2 deletions serverless/jobs/reference-content/jobs-limitations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: Learn the limitations of Scaleway Serverless Jobs.
tags: Jobs limitations serverless
dates:
validation: 2024-03-28
validation: 2024-10-03
posted: 2021-03-28
categories:
- serverless
Expand All @@ -25,7 +25,7 @@ This section contains usage limits that apply when using Serverless Jobs.
| Max ephemeral storage | 10 GB | Job run |
| CPU max | 6 VCPU | Job run |
| Memory max | 16 GB | Job run |
| timeout | 24h | Job run |
| Timeout | 24h | Job run |

## Default values for CPU and memory limits

Expand Down
2 changes: 1 addition & 1 deletion serverless/jobs/troubleshooting/common-errors.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: Troubleshoot common errors in Scaleway Serverless Jobs.
tags: serverless jobs troubleshooting issue error message
dates:
validation: 2024-03-28
validation: 2024-10-03
posted: 2024-03-28
categories:
- serveless
Expand Down
4 changes: 1 addition & 3 deletions storage/object/how-to/access-objects-via-https.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ content:
paragraph: Securely access objects in Object Storage over HTTPS.
tags: object storage object-storage download https
dates:
validation: 2024-03-12
validation: 2024-10-04
posted: 2023-09-05
categories:
- storage
Expand Down Expand Up @@ -35,5 +35,3 @@ If an object is public, you can retreive the link to access it from the [Scalewa
<Message type="note">
To make the link to an object permanent, [change its visibility](/storage/object/how-to/manage-object-visibility/) to **public**. The link will work as long as the object is public.
</Message>