feat(containers): add cpu limit to update/create container request messages (#3041)

scaleway-bot · remyleone · web-flow · commit 36399c3abb7c · 2023-04-18T21:04:18.000Z
Co-authored-by: Rémy Léone &lt;rleone@scaleway.com&gt;
diff --git a/cmd/scw/testdata/test-all-usage-container-container-create-usage.golden b/cmd/scw/testdata/test-all-usage-container-container-create-usage.golden
@@ -1,25 +1,26 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Create a new container.
+Create a new container in the specified region.
 
 USAGE:
   scw container container create [arg=value ...]
 
 ARGS:
-  [namespace-id]                                 
-  [name=<generated>]                             
-  [environment-variables.{key}]                  
-  [min-scale]                                    
-  [max-scale]                                    
-  [memory-limit]                                 
+  [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.seconds]                              
   [timeout.nanos]                                
-  [privacy]                                       (unknown_privacy | public | private)
-  [description]                                  
-  [registry-image]                               
-  [max-concurrency]                              
-  [protocol]                                      (unknown_protocol | http1 | h2c)
-  [port]                                         
+  [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").
+  [max-concurrency]                              Number of maximum concurrent executions of the container
+  [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)
diff --git a/cmd/scw/testdata/test-all-usage-container-container-delete-usage.golden b/cmd/scw/testdata/test-all-usage-container-container-delete-usage.golden
@@ -1,12 +1,12 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Delete the container associated with the given id.
+Delete the container associated with the specified ID.
 
 USAGE:
   scw container container delete <container-id ...> [arg=value ...]
 
 ARGS:
-  container-id      
+  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:
diff --git a/cmd/scw/testdata/test-all-usage-container-container-deploy-usage.golden b/cmd/scw/testdata/test-all-usage-container-container-deploy-usage.golden
@@ -1,12 +1,12 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Deploy a container associated with the given id.
+Deploy a container associated with the specified ID.
 
 USAGE:
   scw container container deploy <container-id ...> [arg=value ...]
 
 ARGS:
-  container-id      
+  container-id      UUID of the container to deploy
   [region=fr-par]   Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
 
 FLAGS:
diff --git a/cmd/scw/testdata/test-all-usage-container-container-get-logs-usage.golden b/cmd/scw/testdata/test-all-usage-container-container-get-logs-usage.golden
@@ -1,13 +1,13 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-List your container logs.
+List the logs of the container with the specified ID.
 
 USAGE:
   scw container container get-logs <container-id ...> [arg=value ...]
 
 ARGS:
-  container-id      
-  [order-by]         (timestamp_desc | timestamp_asc)
+  container-id      UUID of the container
+  [order-by]        Order of the logs (timestamp_desc | timestamp_asc)
   [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:
diff --git a/cmd/scw/testdata/test-all-usage-container-container-get-usage.golden b/cmd/scw/testdata/test-all-usage-container-container-get-usage.golden
@@ -1,12 +1,12 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Get the container associated with the given id.
+Get the container associated with the specified ID.
 
 USAGE:
   scw container container get <container-id ...> [arg=value ...]
 
 ARGS:
-  container-id      
+  container-id      UUID of the container to get
   [region=fr-par]   Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
 
 FLAGS:
diff --git a/cmd/scw/testdata/test-all-usage-container-container-list-usage.golden b/cmd/scw/testdata/test-all-usage-container-container-list-usage.golden
@@ -1,16 +1,16 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-List all your containers.
+List all containers for a specified region.
 
 USAGE:
   scw container container list [arg=value ...]
 
 ARGS:
-  [order-by]           (created_at_asc | created_at_desc | name_asc | name_desc)
-  [namespace-id]      
-  [name]              
-  [project-id]        
-  [organization-id]   
+  [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
   [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:
diff --git a/cmd/scw/testdata/test-all-usage-container-container-update-usage.golden b/cmd/scw/testdata/test-all-usage-container-container-update-usage.golden
@@ -1,23 +1,24 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Update the container associated with the given id.
+Update the container associated with the specified ID.
 
 USAGE:
   scw container container update <container-id ...> [arg=value ...]
 
 ARGS:
-  container-id                                   
-  [environment-variables.{key}]                  
-  [min-scale]                                    
-  [max-scale]                                    
-  [memory-limit]                                 
+  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.seconds]                              
   [timeout.nanos]                                
-  [redeploy]                                     
-  [privacy]                                       (unknown_privacy | public | private)
-  [description]                                  
-  [registry-image]                               
-  [max-concurrency]                              
+  [redeploy]                                     Defines whether to redeploy failed containers
+  [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").
+  [max-concurrency]                              Number of maximum concurrent executions of the container
   [protocol]                                      (unknown_protocol | http1 | h2c)
   [port]                                         
   [secret-environment-variables.{index}.key]     
diff --git a/cmd/scw/testdata/test-all-usage-container-cron-create-usage.golden b/cmd/scw/testdata/test-all-usage-container-cron-create-usage.golden
@@ -6,10 +6,10 @@ USAGE:
   scw container cron create [arg=value ...]
 
 ARGS:
-  [container-id]    
-  [schedule]        
-  [args]            
-  [name]            
+  [container-id]    UUID of the container to invoke by the cron
+  [schedule]        UNIX cron shedule
+  [args]            Arguments to pass with the cron
+  [name]            Name of the cron to create
   [region=fr-par]   Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
 
 FLAGS:
diff --git a/cmd/scw/testdata/test-all-usage-container-cron-delete-usage.golden b/cmd/scw/testdata/test-all-usage-container-cron-delete-usage.golden
@@ -1,12 +1,12 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Delete the cron associated with the given id.
+Delete the cron associated with the specified ID.
 
 USAGE:
   scw container cron delete <cron-id ...> [arg=value ...]
 
 ARGS:
-  cron-id           
+  cron-id           UUID of the cron 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:
diff --git a/cmd/scw/testdata/test-all-usage-container-cron-get-usage.golden b/cmd/scw/testdata/test-all-usage-container-cron-get-usage.golden
@@ -1,12 +1,12 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Get the cron associated with the given id.
+Get the cron associated with the specified ID.
 
 USAGE:
   scw container cron get <cron-id ...> [arg=value ...]
 
 ARGS:
-  cron-id           
+  cron-id           UUID of the cron to get
   [region=fr-par]   Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
 
 FLAGS:
diff --git a/cmd/scw/testdata/test-all-usage-container-cron-list-usage.golden b/cmd/scw/testdata/test-all-usage-container-cron-list-usage.golden
@@ -6,8 +6,8 @@ USAGE:
   scw container cron list [arg=value ...]
 
 ARGS:
-  [order-by]         (created_at_asc | created_at_desc)
-  [container-id]    
+  [order-by]        Order of the crons (created_at_asc | created_at_desc)
+  [container-id]    UUID of the container invoked by the cron
   [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:
diff --git a/cmd/scw/testdata/test-all-usage-container-cron-update-usage.golden b/cmd/scw/testdata/test-all-usage-container-cron-update-usage.golden
@@ -1,16 +1,16 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Update the cron associated with the given id.
+Update the cron associated with the specified ID.
 
 USAGE:
   scw container cron update <cron-id ...> [arg=value ...]
 
 ARGS:
-  cron-id           
-  [container-id]    
-  [schedule]        
-  [args]            
-  [name]            
+  cron-id           UUID of the cron to update
+  [container-id]    UUID of the container invoked by the cron
+  [schedule]        UNIX cron schedule
+  [args]            Arguments to pass with the cron
+  [name]            Name of the cron
   [region=fr-par]   Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
 
 FLAGS:
diff --git a/cmd/scw/testdata/test-all-usage-container-domain-create-usage.golden b/cmd/scw/testdata/test-all-usage-container-domain-create-usage.golden
@@ -1,13 +1,13 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Create a domain name binding.
+Create a domain name binding for the container with the specified ID.
 
 USAGE:
   scw container domain create [arg=value ...]
 
 ARGS:
-  [hostname]        
-  [container-id]    
+  [hostname]        Domain to assign
+  [container-id]    UUID of the container to assign the domain to
   [region=fr-par]   Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
 
 FLAGS:
diff --git a/cmd/scw/testdata/test-all-usage-container-domain-delete-usage.golden b/cmd/scw/testdata/test-all-usage-container-domain-delete-usage.golden
@@ -1,12 +1,12 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Delete a domain name binding.
+Delete the domain name binding with the specific ID.
 
 USAGE:
   scw container domain delete <domain-id ...> [arg=value ...]
 
 ARGS:
-  domain-id         
+  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:
diff --git a/cmd/scw/testdata/test-all-usage-container-domain-get-usage.golden b/cmd/scw/testdata/test-all-usage-container-domain-get-usage.golden
@@ -1,12 +1,12 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Get a domain name binding.
+Get a domain name binding for the container with the specified ID.
 
 USAGE:
   scw container domain get <domain-id ...> [arg=value ...]
 
 ARGS:
-  domain-id         
+  domain-id         UUID of the domain to get
   [region=fr-par]   Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
 
 FLAGS:
diff --git a/cmd/scw/testdata/test-all-usage-container-domain-list-usage.golden b/cmd/scw/testdata/test-all-usage-container-domain-list-usage.golden
@@ -1,13 +1,13 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-List all domain name bindings.
+List all domain name bindings in a specified region.
 
 USAGE:
   scw container domain list [arg=value ...]
 
 ARGS:
-  [order-by]         (created_at_asc | created_at_desc | hostname_asc | hostname_desc)
-  [container-id]    
+  [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)
 
 FLAGS:
diff --git a/cmd/scw/testdata/test-all-usage-container-namespace-create-usage.golden b/cmd/scw/testdata/test-all-usage-container-namespace-create-usage.golden
@@ -1,15 +1,15 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Create a new namespace.
+Create a new namespace in a specified region.
 
 USAGE:
   scw container namespace create [arg=value ...]
 
 ARGS:
-  [name=<generated>]                             
-  [environment-variables.{key}]                  
+  [name=<generated>]                             Name of the namespace to create
+  [environment-variables.{key}]                  Environment variables of the namespace to create
   [project-id]                                   Project ID to use. If none is passed the default project ID will be used
-  [description]                                  
+  [description]                                  Description of the namespace to create
   [secret-environment-variables.{index}.key]     
   [secret-environment-variables.{index}.value]   
   [region=fr-par]                                Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
diff --git a/cmd/scw/testdata/test-all-usage-container-namespace-delete-usage.golden b/cmd/scw/testdata/test-all-usage-container-namespace-delete-usage.golden
@@ -1,12 +1,12 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Delete the namespace associated with the given id.
+Delete the namespace associated with the specified ID.
 
 USAGE:
   scw container namespace delete <namespace-id ...> [arg=value ...]
 
 ARGS:
-  namespace-id      
+  namespace-id      UUID of the namespace 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:
diff --git a/cmd/scw/testdata/test-all-usage-container-namespace-get-usage.golden b/cmd/scw/testdata/test-all-usage-container-namespace-get-usage.golden
@@ -1,12 +1,12 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Get the namespace associated with the given id.
+Get the namespace associated with the specified ID.
 
 USAGE:
   scw container namespace get <namespace-id ...> [arg=value ...]
 
 ARGS:
-  namespace-id      
+  namespace-id      UUID of the namespace to get
   [region=fr-par]   Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
 
 FLAGS:
diff --git a/cmd/scw/testdata/test-all-usage-container-namespace-list-usage.golden b/cmd/scw/testdata/test-all-usage-container-namespace-list-usage.golden
@@ -1,15 +1,15 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-List all your namespaces.
+List all namespaces in a specified region.
 
 USAGE:
   scw container namespace list [arg=value ...]
 
 ARGS:
-  [order-by]           (created_at_asc | created_at_desc | name_asc | name_desc)
-  [name]              
-  [project-id]        
-  [organization-id]   
+  [order-by]          Order of the namespaces (created_at_asc | created_at_desc | name_asc | name_desc)
+  [name]              Name of the namespaces
+  [project-id]        UUID of the Project the namespace belongs to
+  [organization-id]   UUID of the Organization the namespace 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)
 
 FLAGS:
diff --git a/cmd/scw/testdata/test-all-usage-container-namespace-update-usage.golden b/cmd/scw/testdata/test-all-usage-container-namespace-update-usage.golden
@@ -1,14 +1,14 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Update the space associated with the given id.
+Update the space associated with the specified ID.
 
 USAGE:
   scw container namespace update <namespace-id ...> [arg=value ...]
 
 ARGS:
-  namespace-id                                   
-  [environment-variables.{key}]                  
-  [description]                                  
+  namespace-id                                   UUID of the namespace to update
+  [environment-variables.{key}]                  Environment variables of the namespace to update
+  [description]                                  Description of the namespace to update
   [secret-environment-variables.{index}.key]     
   [secret-environment-variables.{index}.value]   
   [region=fr-par]                                Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
diff --git a/cmd/scw/testdata/test-all-usage-container-token-create-usage.golden b/cmd/scw/testdata/test-all-usage-container-token-create-usage.golden
diff --git a/cmd/scw/testdata/test-all-usage-container-token-delete-usage.golden b/cmd/scw/testdata/test-all-usage-container-token-delete-usage.golden
diff --git a/cmd/scw/testdata/test-all-usage-container-token-get-usage.golden b/cmd/scw/testdata/test-all-usage-container-token-get-usage.golden
diff --git a/cmd/scw/testdata/test-all-usage-container-token-list-usage.golden b/cmd/scw/testdata/test-all-usage-container-token-list-usage.golden
diff --git a/docs/commands/container.md b/docs/commands/container.md
diff --git a/internal/namespaces/container/v1beta1/container_cli.go b/internal/namespaces/container/v1beta1/container_cli.go
