Skip to content
Draft
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
Original file line number Diff line number Diff line change
@@ -1,48 +1,45 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Create a new container in the specified region.

When creating a container, the `created` status is no longer used. The deployment process is started
and the status is set to `pending` accordingly.
Name must be unique inside the given namespace.

USAGE:
scw container container create [arg=value ...]

ARGS:
[namespace-id] UUID of the namespace the container belongs to
[name] Name of the container
[environment-variables.{key}] Environment variables of the container
[min-scale] Minimum number of instances to scale the container to
[max-scale] Maximum number of instances to scale the container to
[memory-limit] Memory limit of the container in MB
[cpu-limit] CPU limit of the container in mvCPU
[timeout] Processing time limit for the container
[privacy] Privacy setting of the container (unknown_privacy | public | private)
[description] Description of the container
[registry-image] Name of the registry image (e.g. "rg.fr-par.scw.cloud/something/image:tag").
[protocol] Protocol the container uses (unknown_protocol | http1 | h2c)
[port] Port the container listens on
[secret-environment-variables.{index}.key]
[secret-environment-variables.{index}.value]
[http-option=enabled] Configure how HTTP and HTTPS requests are handled (unknown_http_option | enabled | redirected)
[sandbox] Execution environment of the container (unknown_sandbox | v1 | v2)
[local-storage-limit] Local storage limit of the container (in MB)
[scaling-option.concurrent-requests-threshold]
[scaling-option.cpu-usage-threshold]
[scaling-option.memory-usage-threshold]
[health-check.http.path] Path to use for the HTTP health check.
[health-check.failure-threshold] Number of consecutive health check failures before considering the container unhealthy.
[health-check.interval] Period between health checks.
[tags.{index}] Tags of the Serverless Container
namespace-id Unique ID of the namespace the container belongs to.
name Container name.
[environment-variables.{key}] Environment variables of the container.
[secret-environment-variables.{key}] Secret environment variables of the container.
[min-scale] Minimum number of instances to scale the container to.
[max-scale] Maximum number of instances to scale the container to.
[memory-limit-bytes] Memory limit of the container in bytes.
[mvcpu-limit] CPU limit of the container in mvCPU.
[timeout] Processing time limit for the container.
[privacy=public] Privacy policy of the container. (unknown_privacy | public | private)
[description] Container description.
image Image reference (e.g. "rg.fr-par.scw.cloud/my-registry-namespace/image:tag").
[protocol=http1] Protocol the container uses. (unknown_protocol | http1 | h2c)
[port=8080] Port the container listens on.
[https-connections-only=false] If true, it will allow only HTTPS connections to access your container to prevent it from being triggered by insecure connections (HTTP).
[sandbox=v2] Execution environment of the container. (unknown_sandbox | v1 | v2)
[local-storage-limit-bytes] Local storage limit of the container (in bytes).
[scaling-option.concurrent-requests-threshold] Scale depending on the number of concurrent requests being processed per container instance. The threshold value is the number of concurrent requests above which the container will be scaled up.
[scaling-option.cpu-usage-threshold] Scale depending on the CPU usage of a container instance. The threshold value is the percentage of CPU usage above which the container will be scaled up.
[scaling-option.memory-usage-threshold] Scale depending on the memory usage of a container instance. The threshold value is the percentage of memory usage above which the container will be scaled up.
[liveness-probe.failure-threshold] Number of consecutive failures before considering the container as unhealthy
[liveness-probe.interval] Time interval between checks.
[liveness-probe.timeout] Duration before the check times out.
[liveness-probe.http.path] HTTP path to perform the check on.
[startup-probe.failure-threshold] Number of consecutive failures before considering the container as unhealthy
[startup-probe.interval] Time interval between checks.
[startup-probe.timeout] Duration before the check times out.
[startup-probe.http.path] HTTP path to perform the check on.
[tags.{index}] Tags of the Serverless Container.
[private-network-id] ID of the Private Network the container is connected to.
[command.{index}] Container command
[args.{index}] Container arguments
[deploy=true] Deploy container after creation
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)

DEPRECATED ARGS:
[max-concurrency] Number of maximum concurrent executions of the container

FLAGS:
-h, --help help for create
--list-sub-commands List all subcommands
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Delete the container associated with the specified ID.
It also deletes in cascade any resource linked to the container (crons, tokens, etc.).

This action **cannot** be undone.

USAGE:
scw container container delete <container-id ...> [arg=value ...]

ARGS:
container-id UUID of the container to delete
container-id UUID of the container to delete.
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)

FLAGS:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
Get the container associated with the specified ID.

USAGE:
scw container container get <container-id ...> [arg=value ...]
scw container container get [arg=value ...]

ARGS:
container-id UUID of the container to get
container-id
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)

FLAGS:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,16 +1,18 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
List all containers for a specified region.
By default, the containers listed are ordered by creation date in ascending order. This can be modified via the `order_by` field.

Additional parameters can be set in the query to filter, such as `organization_id`, `project_id`, and `name`.

USAGE:
scw container container list [arg=value ...]

ARGS:
[order-by] Order of the containers (created_at_asc | created_at_desc | name_asc | name_desc)
[namespace-id] UUID of the namespace the container belongs to
[name] Name of the container
[project-id] UUID of the Project the container belongs to
[organization-id] UUID of the Organization the container belongs to
[order-by] (created_at_asc | created_at_desc | name_asc | name_desc)
[project-id]
[namespace-id]
[name]
[organization-id]
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw | all)

FLAGS:
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Performs a rollout of the container by creating new instances with the latest image version and terminating the old instances.
When using mutable registry image references (e.g. `my-registry-namespace/image:tag`), this endpoint can be used to force the container to use
the most recent image version available in the registry.

USAGE:
scw container container redeploy <container-id ...> [arg=value ...]

ARGS:
container-id ID of the container to redeploy.
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)

FLAGS:
-h, --help help for redeploy
--list-sub-commands List all subcommands
-w, --wait wait until the container is ready

GLOBAL FLAGS:
-c, --config string The path to the config file
-D, --debug Enable debug mode
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
-p, --profile string The config profile to use
Original file line number Diff line number Diff line change
@@ -1,48 +1,44 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Update the container associated with the specified ID.

When updating a container, the container is automatically redeployed to apply the changes.

Warning: The `redeploy` field has been deprecated. An update now always redeploys the container.
Only fields present in the request are updated; others are left untouched.

USAGE:
scw container container update <container-id ...> [arg=value ...]

ARGS:
container-id UUID of the container to update
[environment-variables.{key}] Environment variables of the container
[min-scale] Minimum number of instances to scale the container to
[max-scale] Maximum number of instances to scale the container to
[memory-limit] Memory limit of the container in MB
[cpu-limit] CPU limit of the container in mvCPU
[timeout] Processing time limit for the container
[privacy] Privacy settings of the container (unknown_privacy | public | private)
[description] Description of the container
[registry-image] Name of the registry image (e.g. "rg.fr-par.scw.cloud/something/image:tag").
[protocol] Protocol the container uses (unknown_protocol | http1 | h2c)
[port] Port the container listens on
[secret-environment-variables.{index}.key]
[secret-environment-variables.{index}.value]
[http-option] Configure how HTTP and HTTPS requests are handled (unknown_http_option | enabled | redirected)
[sandbox] Execution environment of the container (unknown_sandbox | v1 | v2)
[local-storage-limit] Local storage limit of the container (in MB)
[scaling-option.concurrent-requests-threshold]
[scaling-option.cpu-usage-threshold]
[scaling-option.memory-usage-threshold]
[health-check.http.path] Path to use for the HTTP health check.
[health-check.failure-threshold] Number of consecutive health check failures before considering the container unhealthy.
[health-check.interval] Period between health checks.
[tags.{index}] Tags of the Serverless Container
container-id UUID of the container to update.
[environment-variables.{key}] Environment variables of the container.
[secret-environment-variables.{key}] Secret environment variables of the container.
[min-scale] Minimum number of instances to scale the container to.
[max-scale] Maximum number of instances to scale the container to.
[memory-limit-bytes] Memory limit of the container in bytes.
[mvcpu-limit] CPU limit of the container in mvCPU.
[timeout] Processing time limit for the container.
[privacy] Privacy policy of the container. (unknown_privacy | public | private)
[description] Container description.
[image] Image reference (e.g. "rg.fr-par.scw.cloud/my-registry-namespace/image:tag").
[protocol] Protocol the container uses. (unknown_protocol | http1 | h2c)
[port] Port the container listens on.
[https-connection-only] If true, it will allow only HTTPS connections to access your container to prevent it from being triggered by insecure connections (HTTP).
[sandbox] Execution environment of the container. (unknown_sandbox | v1 | v2)
[local-storage-limit-bytes] Local storage limit of the container (in bytes).
[scaling-option.concurrent-requests-threshold] Scale depending on the number of concurrent requests being processed per container instance. The threshold value is the number of concurrent requests above which the container will be scaled up.
[scaling-option.cpu-usage-threshold] Scale depending on the CPU usage of a container instance. The threshold value is the percentage of CPU usage above which the container will be scaled up.
[scaling-option.memory-usage-threshold] Scale depending on the memory usage of a container instance. The threshold value is the percentage of memory usage above which the container will be scaled up.
[liveness-probe.failure-threshold] Number of consecutive failures before considering the container as unhealthy
[liveness-probe.interval] Time interval between checks.
[liveness-probe.timeout] Duration before the check times out.
[liveness-probe.http.path] HTTP path to perform the check on.
[startup-probe.failure-threshold]
[startup-probe.interval]
[startup-probe.timeout]
[startup-probe.http.path]
[tags.{index}] Tags of the Serverless Container.
[private-network-id] ID of the Private Network the container is connected to.
[command.{index}] Container command
[args.{index}] Container arguments
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)

DEPRECATED ARGS:
[redeploy] Defines whether to redeploy failed containers
[max-concurrency] Number of maximum concurrent executions of the container

FLAGS:
-h, --help help for update
--list-sub-commands List all subcommands
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ USAGE:
scw container container <command>

AVAILABLE COMMANDS:
create Create a new container
delete Delete a container
deploy Deploy a container
get Get a container
list List all your containers
update Update an existing container
create Create a new container in a namespace.
delete Delete the container associated with the specified ID.
get Get the container associated with the specified ID.
list List all containers the caller can access (read permission).
redeploy Redeploy a container
update Update the container associated with the specified ID.

FLAGS:
-h, --help help for container
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Create a custom domain for the container with the specified ID.
Create a new custom domain for the container with the specified ID.

USAGE:
scw container domain create [arg=value ...]

ARGS:
[hostname] Domain to assign
[container-id] UUID of the container to assign the domain to
container-id Unique ID of the container the domain will be assigned to.
hostname Domain assigned to the container.
[tags.{index}] A list of arbitrary tags associated with the domain.
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)

FLAGS:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Delete the custom domain with the specific ID.
Delete the custom domain associated with the specified ID.

USAGE:
scw container domain delete <domain-id ...> [arg=value ...]

ARGS:
domain-id UUID of the domain to delete
domain-id UUID of the domain to delete.
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)

FLAGS:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Get a custom domain for the container with the specified ID.
Get the custom domain associated with the specified ID.

USAGE:
scw container domain get <domain-id ...> [arg=value ...]
scw container domain get [arg=value ...]

ARGS:
domain-id UUID of the domain to get
domain-id
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)

FLAGS:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,19 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
List all custom domains in a specified region.
By default, the custom domains listed are ordered by creation date in ascending order. This can be modified via the `order_by` field.

Additional parameters can be set in the query to filter the output, such as `organization_id`, `project_id`, `namespace_id`, or `container_id`.

USAGE:
scw container domain list [arg=value ...]

ARGS:
[order-by] Order of the domains (created_at_asc | created_at_desc | hostname_asc | hostname_desc)
[container-id] UUID of the container the domain belongs to
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw | all)
[order-by] (created_at_asc | created_at_desc | hostname_asc | hostname_desc)
[project-id]
[namespace-id]
[container-id]
[organization-id]
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw | all)

FLAGS:
-h, --help help for list
Expand Down
Loading
Loading