Skip to content

Commit 8f242fe

Browse files
thomas-tacquetbene2k1ofranc
authored
chore(serverless-containers): concept categories test (#5638)
* chore(serverless-containers): concept categories test * Apply suggestions from code review Co-authored-by: Benedikt Rollik <[email protected]> * complete some definition * Update pages/serverless-containers/concepts.mdx --------- Co-authored-by: Benedikt Rollik <[email protected]> Co-authored-by: Océane <[email protected]>
1 parent cbdab05 commit 8f242fe

File tree

3 files changed

+102
-79
lines changed

3 files changed

+102
-79
lines changed

pages/serverless-containers/concepts.mdx

Lines changed: 96 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,6 @@ dates:
77
---
88
import ServerlessConcepts from '@macros/serverless/serverless-concepts.mdx'
99

10-
11-
## Arguments
12-
13-
See [Commands and arguments](#commands-and-arguments) below.
14-
1510
## Autoscaling
1611

1712
Autoscaling refers to the ability of Serverless Containers to automatically adjust the number of instances without manual intervention.
@@ -24,6 +19,22 @@ Autoscaling parameters are [min-scale](/serverless-containers/concepts/#min-scal
2419

2520
Refer to the [dedicated documentation](/serverless-containers/reference-content/containers-autoscaling/) for more information on autoscaling.
2621

22+
### Min scale
23+
24+
Customizing the minimum scale for Serverless can help ensure that an instance remains pre-allocated and ready to handle requests, reducing delays associated with [cold starts](#cold-start). However, this setting also impacts the costs of your Serverless Container.
25+
26+
For **CPU** and **RAM** based autoscaling, the `min-scale` value must be at least `1`.
27+
28+
### Max scale
29+
30+
This parameter sets the maximum number of container instances.
31+
32+
You should adjust it based on your container's traffic spikes, keeping in mind that you may wish to limit the maximum scale to manage costs effectively while provisioning enough containers to handle spikes.
33+
34+
### Scale to zero
35+
36+
When provisioned with a [minimum scale](#min-scale) of `0`, Serverless Containers scale down to zero active instances as long as they are not triggered. While idling, they do not consume any resources, which allows to reduce the cost of your infrastructure.
37+
2738
## Cold start
2839

2940
Cold start is the time a Container takes to handle a request when it is called for the first time.
@@ -54,6 +65,10 @@ args: ["$(MESSAGE)"]
5465
5566
Refer to the [official Kubernetes documentation](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/) for more information on commands and arguments behavior.
5667
68+
### Arguments
69+
70+
See [Commands and arguments](#commands-and-arguments).
71+
5772
## Concurrency
5873
5974
Concurrency defines the number of simultaneous requests a single instance of your container can handle at the same time. Once the number of incoming requests exceeds this value, your container scales according to your parameters.
@@ -62,34 +77,28 @@ Refer to the [dedicated documentation](/serverless-containers/reference-content/
6277
6378
## Container
6479
65-
A container is a package of software that includes all dependencies: code, runtime, configuration, and system libraries so that it can run on any host system. Scaleway provides custom Docker images that are entirely handled for you in the cloud.
80+
A container is a package of software that includes all dependencies: code, runtime, configuration, and system libraries so that it can run on any host system.
6681
6782
## Container image
6883
6984
A container image is a file that includes all the requirements and instructions of a complete and executable version of an application.
7085
7186
## Container Registry
7287
73-
Container Registry is the place where your images are stored before being deployed. We recommend using Scaleway Container Registry for optimal integration. See the [migration guide](/serverless-containers/api-cli/migrate-external-image-to-scaleway-registry/) for full details.
74-
75-
## CRON trigger
76-
77-
A CRON trigger is a mechanism used to automatically invoke a Serverless Container at a specific time on a recurring schedule.
78-
79-
It works similarly to a traditional Linux [cron job](https://en.wikipedia.org/wiki/Cron), using the `* * * * *` format, and uses the **UTC** time zone. Refer to our [cron schedules reference](/serverless-containers/reference-content/cron-schedules/) for more information.
80-
81-
## Custom domain
82-
83-
By default, a generated endpoint is assigned to your Serverless resource. Custom domains allow you to use your own domain - see our [custom domain documentation](/serverless-containers/how-to/add-a-custom-domain-to-a-container) for full details.
88+
Container Registry is the place where your images are stored before being deployed. We recommend using Scaleway Container Registry for optimal integration and performances. See the [migration guide](/serverless-containers/api-cli/migrate-external-image-to-scaleway-registry/) for full details.
8489
8590
## Deployment
8691
87-
Some parameter changes require a new deployment of the container to take effect. The deployment happens without causing downtime, as traffic is switched to the newest version.
92+
Some parameter changes require a new deployment of the container to take effect. The deployment happens without causing downtime, as traffic is switched to the newest version once it is ready.
8893
8994
## Endpoint
9095
9196
An endpoint is the URL generated to access your resource. It can be customized with [custom domains](#custom-domain).
9297
98+
### Custom domain
99+
100+
By default, a generated endpoint is assigned to your Serverless resource. Custom domains allow you to use your own domain - see our [custom domain documentation](/serverless-containers/how-to/add-a-custom-domain-to-a-container) for full details.
101+
93102
## Environment variables
94103
95104
Environment variables are key/value pairs injected into your container. They are useful to share information such as configurations with your container. Environment variables defined at the container level override the ones defined at the namespace level if they have the same name.
@@ -98,18 +107,10 @@ Some names are reserved. [See details about reserved names](/serverless-containe
98107
99108
## Ephemeral storage
100109
101-
In addition to vCPU and RAM, Serverless Containers also provide a storage volume for the duration of the task. This storage space allows you to hold the data retrieved by the job, and disappears once the execution is complete.
110+
In addition to vCPU and RAM, Serverless Containers also provide a storage volume for the duration of the task. This storage space allows you to hold data during the life of the Servlerless Container instance and disappears once the execution is complete.
102111
103112
The maximum size of the ephemeral storage is tied to the allocated memory.
104113
105-
## GB-s
106-
107-
Unit used to measure the resource consumption of a container. It reflects the amount of memory consumed over time.
108-
109-
## gRPC
110-
111-
gRPC is supported on Serverless Containers, as long as you have enabled http2 (`h2c`) protocol.
112-
113114
## Health check
114115
115116
To determine the status of a container, the default health check automatically checks if basic requirements are met, to define the status as `ready`. You can customize the following elements to better fit your use case:
@@ -126,49 +127,28 @@ You can define custom health check rules via the [Scaleway console](/serverless-
126127

127128
A Serverless Container instance handles incoming requests based on factors like the request volume, min scale, and max scale parameters.
128129

129-
## JWT Token
130-
131-
JWT (JSON Web Token) is an access token you can create from the console or API to enable an application to access your private container. [Find out how to secure a container](/serverless-containers/how-to/secure-a-container/#restrict-access-to-your-containers).
132-
133130
## Load balancing
134131

135132
The Serverless infrastructure manages incoming request traffic. In scenarios like sudden traffic spikes or load testing, resources are automatically scaled based on the max scale parameter to handle the load.
136133

137-
## Logging
134+
## Monitoring
138135

139-
Serverless Containers offers a built-in logging system based on Cockpit to track the activity of your resources. Refer to [monitoring Serverless Containers](/serverless-containers/how-to/monitor-container/) for more information.
136+
Monitoring is the process of continuously collecting and analyzing data about your Serverless applications and infrastructure to ensure they are healthy, performing well, and available.
140137

141-
## Max scale
138+
### Logging
142139

143-
This parameter sets the maximum number of container instances. You should adjust it based on your container's traffic spikes, keeping in mind that you may wish to limit the maximum scale to manage costs effectively.
140+
Serverless Containers offers a built-in logging system based on Cockpit to track the activity of your resources. Refer to [monitoring Serverless Containers](/serverless-containers/how-to/monitor-container/) for more information.
144141

145-
## Metrics
142+
### Metrics
146143

147144
Performance metrics for your Serverless resources are natively available. Refer to [monitoring Serverless Containers](/serverless-containers/how-to/monitor-container/) for more information.
148145

149-
## Min scale
150-
151-
Customizing the minimum scale for Serverless can help ensure that an instance remains pre-allocated and ready to handle requests, reducing delays associated with cold starts. However, this setting also impacts the costs of your Serverless Container.
152-
153-
## mvCPU
154-
155-
A [vCPU](#vcpu) (Virtual Central Processing Unit) is equivalent to 1000 mvCPU.
156-
157146
## Namespace
158147

159-
A namespace is a project that allows you to [group your containers](/serverless-containers/how-to/create-manage-delete-containers-namespace/).
148+
A namespace is a folder with some settings that allows you to [group your containers](/serverless-containers/how-to/create-manage-delete-containers-namespace/).
160149

161150
Containers in the same namespace can share environment variables, secrets, and access tokens, defined at the namespace level.
162151

163-
## NATS trigger
164-
165-
A NATS trigger is a mechanism that connects a container to a [NATS](/nats/concepts/#nats) subject and invokes the container automatically whenever a message is published to the subject.
166-
167-
For each message that is sent to a NATS subject, the NATS trigger reads the message and invokes the associated container with the message as the input parameter.
168-
The container can then process the message and perform any required actions, such as updating a database or sending a notification.
169-
170-
Refer to the [dedicated documenation](/serverless-containers/how-to/add-trigger-to-a-container/) for more information on how to add triggers to a Serverless Container.
171-
172152
## Port
173153

174154
The port of a containerized application refers to the network port that the application inside the container listens on for incoming requests.
@@ -179,6 +159,10 @@ Refer to the [dedicated documentation](/serverless-containers/reference-content/
179159

180160
A container's privacy policy defines whether a container may be invoked anonymously (**public**) or only via an authentication mechanism provided by the [Scaleway API](https://www.scaleway.com/en/developers/api/serverless-containers/#authentication) (**private**).
181161

162+
### JWT Token
163+
164+
JWT (JSON Web Token) is an access token you can create to enable an application to access your `private` container. [Find out how to restrict access to a container](/serverless-containers/how-to/secure-a-container/#restrict-access-to-your-containers).
165+
182166
## Private Networks
183167

184168
Scaleway Serverless Containers support Private Networks.
@@ -187,23 +171,14 @@ Private Networks let you connect Scaleway resources across multiple AZs within t
187171

188172
**D**ynamic **H**ost **C**onfiguration **P**rotocol (DHCP) is built into each Private Network, making it easy to manage the private IP addresses of your resources on the network.
189173

190-
Read our dedicated documentation on [creating a Private Network](/vpc/how-to/create-private-network/).
174+
Read our dedicated documentation on [use Private Networks](/serverless-containers/how-to/use-private-networks/).
191175

192176
<Message type="note">
193177
Previously, Private Networks at Scaleway were zoned. Only resources from within one defined AZ could be attached to each network. Now, all Private Networks are regional, and resources from any AZ within that network's region can be attached. "Old" zoned Private Networks have all been automatically migrated to become regional.
194178

195179
While DHCP is built into all new Private Networks, it may not be automatically activated for older Private Networks. Check our [migration](/vpc/reference-content/vpc-migration/) documentation for more information.
196180
</Message>
197181

198-
## Queue trigger
199-
200-
A queue trigger is a mechanism that connects a container to a queue created with [Scaleway Queues](/queues/concepts/#scaleway-queues), and invokes the container automatically whenever a message is added to the queue.
201-
202-
For each message that is sent to a queue, the trigger reads the message and invokes the associated container with the message as the input parameter.
203-
The container can then process the message, and perform any required actions, such as updating a database or sending a notification.
204-
205-
Refer to the [dedicated documenation](/serverless-containers/how-to/add-trigger-to-a-container/) for more information on how to add triggers to a Serverless Container.
206-
207182
## Registry endpoint
208183

209184
The registry endpoint parameter is the resource linked to the container image used in your Serverless Container.
@@ -234,14 +209,12 @@ A sandbox is an isolation area for your container. Serverless Containers offer t
234209

235210
Refer to the [dedicated documentation](/serverless-containers/reference-content/containers-sandbox/) for more information on sandbox environments.
236211

237-
## Scale to zero
238-
239-
When provisioned with a [minimum scale](#min-scale) of `0`, Serverless Containers scale down to zero active instances as long as they are not triggered. While idling, they do not consume any resources, which allows to reduce the cost of your infrastructure.
240-
241212
## Secrets
242213

243214
Secrets are an extra-secure type of environment variable. They are environment variables that are injected into your container and stored securely, but not displayed in the console after initial validation. Secrets defined at the container level override the ones defined at the namespace level if they have the same name.
244215

216+
Secrets on Serverless Containers are not linked with Secret Manager product yet.
217+
245218
## Serverless
246219

247220
Serverless allows you to deploy your Functions (FaaS) and Containerized Applications (CaaS) in a managed infrastructure. Scaleway ensures the deployment, availability, and scalability of all your projects.
@@ -269,18 +242,41 @@ A Serverless Container can have the following statuses:
269242
* **Pending**: your resource is under deployment.
270243
* **Error**: something went wrong during the deployment process. [Check our troubleshooting documentation](/serverless-containers/troubleshooting/cannot-deploy-image) to solve the issue.
271244

272-
## Terraform/OpenTofu
245+
## Triggers
273246

274-
Terraform/OpenTofu is a tool for managing infrastructure using code. [Read the Terraform/OpenTofu documentation for Serverless Containers](https://registry.terraform.io/providers/scaleway/scaleway/latest/docs/resources/container).
247+
For Serverless Containers, a trigger is a setting that can start events that automatically interacts your service.
275248

276-
## vCPU
249+
A trigger could be an incoming scheduled HTTP request or a message being published to a queue. When the event occurs, the trigger invokes your service to run its code.
277250

278-
vCPU is the abbreviation for **v**irtual **C**entralized **P**rocessing **U**nit. A vCPU represents a portion or share of the underlying physical CPU assigned to a particular container.
279-
The performance of a vCPU is determined by the percentage of time spent on the physical processor's core. It is possible to allocate different resource allowances on specific vCPUs for specific containers or virtual machines.
251+
### CRON trigger
280252

281-
## vCPU-s
253+
A CRON trigger is a mechanism used to automatically invoke a Serverless Container at a specific time on a recurring schedule.
254+
255+
It works similarly to a traditional Linux [cron job](https://en.wikipedia.org/wiki/Cron), using the `* * * * *` format, and uses the **UTC** time zone. Refer to our [cron schedules reference](/serverless-containers/reference-content/cron-schedules/) for more information.
256+
257+
It allows Serverless Containers to execute scheduled tasks, like managing other resources, generating backups and waking up the Container at specific times.
282258

283-
Unit used to measure the resource consumption of a container. It reflects the amount of vCPU used over time.
259+
### Queue trigger
260+
261+
A queue trigger is a mechanism that connects a container to a queue created with [Scaleway Queues](/queues/concepts/#scaleway-queues), and invokes the container automatically whenever a message is added to the queue.
262+
263+
For each message that is sent to a queue, the trigger reads the message and invokes the associated container with the message as the input parameter.
264+
The container can then process the message, and perform any required actions, such as updating a database or sending a notification.
265+
266+
Refer to the [dedicated documenation](/serverless-containers/how-to/add-trigger-to-a-container/) for more information on how to add triggers to a Serverless Container.
267+
268+
### NATS trigger
269+
270+
A NATS trigger is a mechanism that connects a container to a [NATS](/nats/concepts/#nats) subject and invokes the container automatically whenever a message is published to the subject.
271+
272+
For each message that is sent to a NATS subject, the NATS trigger reads the message and invokes the associated container with the message as the input parameter.
273+
The container can then process the message and perform any required actions, such as updating a database or sending a notification.
274+
275+
Refer to the [dedicated documentation](/serverless-containers/how-to/add-trigger-to-a-container/) for more information on how to add triggers to a Serverless Container.
276+
277+
## Terraform/OpenTofu
278+
279+
Terraform/OpenTofu is a tool for managing infrastructure using code. [Read the Terraform/OpenTofu documentation for Serverless Containers](https://registry.terraform.io/providers/scaleway/scaleway/latest/docs/resources/container).
284280

285281
## Protocol
286282

@@ -289,3 +285,28 @@ Serverless Containers supports **http1** (default) and **http2** (`h2c`). Use HT
289285
<Message type="note">
290286
HTTP/1.0 is not supported. Refer to the [dedicated troubleshooting page](/serverless-containers/troubleshooting/http1-errors/) for more information.
291287
</Message>
288+
289+
### gRPC
290+
291+
gRPC is supported on Serverless Containers, as long as you have enabled http2 (`h2c`) protocol.
292+
293+
## Units
294+
295+
Units are standardized measures of the computational resources, such as processing power and memory, allocated to run your service. The quantity of units you assign determines your application's performance capacity and directly influences its cost.
296+
297+
### vCPU
298+
299+
vCPU is the abbreviation for **v**irtual **C**entralized **P**rocessing **U**nit. A vCPU represents a portion or share of the underlying physical CPU assigned to a particular container.
300+
The performance of a vCPU is determined by the percentage of time spent on the physical processor's core. It is possible to allocate different resource allowances on specific vCPUs for specific containers or virtual machines.
301+
302+
### mvCPU
303+
304+
A [vCPU](#vcpu) (Virtual Central Processing Unit) is equivalent to 1000 mvCPU.
305+
306+
### vCPU-s
307+
308+
Unit used to measure the resource consumption of a container. It reflects the amount of vCPU used over time in seconds.
309+
310+
### GB-s
311+
312+
Unit used to measure the RAM consumption of a container. It reflects the amount of memory consumed over time in seconds.

0 commit comments

Comments
 (0)