docs(containers): document VPC integration fields (scaleway#4781)

Co-authored-by: Leïla Marabese <[email protected]>

Author: scaleway-bot

cmd/scw/testdata/test-all-usage-container-container-create-usage.golden

@@ -31,7 +31,7 @@ ARGS:
   [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
-  [private-network-id]                             
+  [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

cmd/scw/testdata/test-all-usage-container-container-update-usage.golden

@@ -17,8 +17,8 @@ ARGS:
   [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]                                        (unknown_protocol | http1 | h2c)
-  [port]                                           
+  [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)
@@ -31,7 +31,7 @@ ARGS:
   [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
-  [private-network-id]                             
+  [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)

cmd/scw/testdata/test-all-usage-container-namespace-create-usage.golden

@@ -13,7 +13,7 @@ ARGS:
   [secret-environment-variables.{index}.key]     
   [secret-environment-variables.{index}.value]   
   [tags.{index}]                                 Tags of the Serverless Container Namespace
-  [activate-vpc-integration]                     
+  [activate-vpc-integration]                     Activate VPC integration for the namespace.
   [region=fr-par]                                Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
 
 FLAGS:

docs/commands/container.md

@@ -86,7 +86,7 @@ scw container container create [arg=value ...]
 | 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 |
-| private-network-id |  |  |
+| private-network-id |  | ID of the Private Network the container is connected to. |
 | command.{index} |  | Container command |
 | args.{index} |  | Container arguments |
 | deploy | Default: `true` | Deploy container after creation |
@@ -205,8 +205,8 @@ scw container container update <container-id ...> [arg=value ...]
 | description |  | Description of the container |
 | registry-image |  | Name of the registry image (e.g. "rg.fr-par.scw.cloud/something/image:tag"). |
 | ~~max-concurrency~~ | Deprecated | Number of maximum concurrent executions of the container |
-| protocol | One of: `unknown_protocol`, `http1`, `h2c` |  |
-| port |  |  |
+| protocol | One of: `unknown_protocol`, `http1`, `h2c` | Protocol the container uses |
+| port |  | Port the container listens on |
 | secret-environment-variables.{index}.key |  |  |
 | secret-environment-variables.{index}.value |  |  |
 | http-option | One of: `unknown_http_option`, `enabled`, `redirected` | Configure how HTTP and HTTPS requests are handled |
@@ -219,7 +219,7 @@ scw container container update <container-id ...> [arg=value ...]
 | 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 |
-| private-network-id |  |  |
+| private-network-id |  | ID of the Private Network the container is connected to. |
 | command.{index} |  | Container command |
 | args.{index} |  | Container arguments |
 | region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config |
@@ -483,7 +483,7 @@ scw container namespace create [arg=value ...]
 | secret-environment-variables.{index}.key |  |  |
 | secret-environment-variables.{index}.value |  |  |
 | tags.{index} |  | Tags of the Serverless Container Namespace |
-| activate-vpc-integration |  |  |
+| activate-vpc-integration |  | Activate VPC integration for the namespace. |
 | region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config |
 
 

internal/namespaces/container/v1beta1/container_cli.go

@@ -279,6 +279,7 @@ func containerNamespaceCreate() *core.Command {
 			},
 			{
 				Name:       "activate-vpc-integration",
+				Short:      `Activate VPC integration for the namespace.`,
 				Required:   false,
 				Deprecated: false,
 				Positional: false,
@@ -723,6 +724,7 @@ func containerContainerCreate() *core.Command {
 			},
 			{
 				Name:       "private-network-id",
+				Short:      `ID of the Private Network the container is connected to.`,
 				Required:   false,
 				Deprecated: false,
 				Positional: false,
@@ -859,6 +861,7 @@ func containerContainerUpdate() *core.Command {
 			},
 			{
 				Name:       "protocol",
+				Short:      `Protocol the container uses`,
 				Required:   false,
 				Deprecated: false,
 				Positional: false,
@@ -870,6 +873,7 @@ func containerContainerUpdate() *core.Command {
 			},
 			{
 				Name:       "port",
+				Short:      `Port the container listens on`,
 				Required:   false,
 				Deprecated: false,
 				Positional: false,
@@ -965,6 +969,7 @@ func containerContainerUpdate() *core.Command {
 			},
 			{
 				Name:       "private-network-id",
+				Short:      `ID of the Private Network the container is connected to.`,
 				Required:   false,
 				Deprecated: false,
 				Positional: false,