docs(containers): document VPC integration fields (#1018)

Author: scaleway-bot

scaleway-async/scaleway_async/container/v1beta1/api.py

@@ -279,7 +279,7 @@ async def create_namespace(
         """
         Create a new namespace.
         Create a new namespace in a specified region.
-        :param activate_vpc_integration:
+        :param activate_vpc_integration: When activated, containers in the namespace can be connected to a Private Network.
         :param region: Region to target. If none is passed will use default region from the config.
         :param name: Name of the namespace to create.
         :param environment_variables: Environment variables of the namespace to create.
@@ -645,7 +645,9 @@ async def create_container(
         - memory_usage_threshold: Scale depending on the memory usage of a container instance.
         :param health_check: Health check configuration of the container.
         :param tags: Tags of the Serverless Container.
-        :param private_network_id:
+        :param private_network_id: When connected to a Private Network, the container can access other Scaleway resources in this Private Network.
+
+        Note: this feature is currently in beta and requires a namespace with VPC integration activated, using the `activate_vpc_integration` flag.
         :param command: Command executed when the container starts. This overrides the default command defined in the container image. This is usually the main executable, or entry point script to run.
         :param args: Arguments passed to the command specified in the "command" field. These override the default arguments from the container image, and behave like command-line parameters.
         :return: :class:`Container <Container>`
@@ -746,9 +748,9 @@ async def update_container(
         :param description: Description of the container.
         :param registry_image: Name of the registry image (e.g. "rg.fr-par.scw.cloud/something/image:tag").
         :param max_concurrency: Number of maximum concurrent executions of the container.
-        :param protocol:
-        :param port:
-        :param secret_environment_variables:
+        :param protocol: Protocol the container uses.
+        :param port: Port the container listens on.
+        :param secret_environment_variables: Secret environment variables of the container.
         :param http_option: Possible values:
          - redirected: Responds to HTTP request with a 301 redirect to ask the clients to use HTTPS.
          - enabled: Serve both HTTP and HTTPS traffic.
@@ -760,7 +762,9 @@ async def update_container(
         - memory_usage_threshold: Scale depending on the memory usage of a container instance.
         :param health_check: Health check configuration of the container.
         :param tags: Tags of the Serverless Container.
-        :param private_network_id:
+        :param private_network_id: When connected to a Private Network, the container can access other Scaleway resources in this Private Network.
+
+        Note: this feature is currently in beta and requires a namespace with VPC integration activated, using the `activate_vpc_integration` flag.
         :param command: Command executed when the container starts. This overrides the default command defined in the container image. This is usually the main executable, or entry point script to run.
         :param args: Arguments passed to the command specified in the "command" field. These override the default arguments from the container image, and behave like command-line parameters.
         :return: :class:`Container <Container>`

scaleway-async/scaleway_async/container/v1beta1/types.py

@@ -522,6 +522,9 @@ class Container:
     """
 
     private_network_id: Optional[str]
+    """
+    When connected to a Private Network, the container can access other Scaleway resources in this Private Network.
+    """
 
 
 @dataclass
@@ -668,6 +671,10 @@ class Namespace:
     """
 
     vpc_integration_activated: Optional[bool]
+    """
+    When activated, containers in the namespace can be connected to a Private Network.
+Note that activating the VPC integration can only be done when creating a new namespace.
+    """
 
 
 @dataclass
@@ -876,6 +883,11 @@ class CreateContainerRequest:
     """
 
     private_network_id: Optional[str]
+    """
+    When connected to a Private Network, the container can access other Scaleway resources in this Private Network.
+
+Note: this feature is currently in beta and requires a namespace with VPC integration activated, using the `activate_vpc_integration` flag.
+    """
 
     command: Optional[List[str]]
     """
@@ -937,6 +949,9 @@ class CreateDomainRequest:
 @dataclass
 class CreateNamespaceRequest:
     activate_vpc_integration: bool
+    """
+    When activated, containers in the namespace can be connected to a Private Network.
+    """
 
     region: Optional[ScwRegion]
     """
@@ -1533,10 +1548,19 @@ class UpdateContainerRequest:
     """
 
     protocol: Optional[ContainerProtocol]
+    """
+    Protocol the container uses.
+    """
 
     port: Optional[int]
+    """
+    Port the container listens on.
+    """
 
     secret_environment_variables: Optional[List[Secret]]
+    """
+    Secret environment variables of the container.
+    """
 
     http_option: Optional[ContainerHttpOption]
     """
@@ -1574,6 +1598,11 @@ class UpdateContainerRequest:
     """
 
     private_network_id: Optional[str]
+    """
+    When connected to a Private Network, the container can access other Scaleway resources in this Private Network.
+
+Note: this feature is currently in beta and requires a namespace with VPC integration activated, using the `activate_vpc_integration` flag.
+    """
 
     command: Optional[List[str]]
     """

scaleway/scaleway/container/v1beta1/api.py

@@ -277,7 +277,7 @@ def create_namespace(
         """
         Create a new namespace.
         Create a new namespace in a specified region.
-        :param activate_vpc_integration:
+        :param activate_vpc_integration: When activated, containers in the namespace can be connected to a Private Network.
         :param region: Region to target. If none is passed will use default region from the config.
         :param name: Name of the namespace to create.
         :param environment_variables: Environment variables of the namespace to create.
@@ -641,7 +641,9 @@ def create_container(
         - memory_usage_threshold: Scale depending on the memory usage of a container instance.
         :param health_check: Health check configuration of the container.
         :param tags: Tags of the Serverless Container.
-        :param private_network_id:
+        :param private_network_id: When connected to a Private Network, the container can access other Scaleway resources in this Private Network.
+
+        Note: this feature is currently in beta and requires a namespace with VPC integration activated, using the `activate_vpc_integration` flag.
         :param command: Command executed when the container starts. This overrides the default command defined in the container image. This is usually the main executable, or entry point script to run.
         :param args: Arguments passed to the command specified in the "command" field. These override the default arguments from the container image, and behave like command-line parameters.
         :return: :class:`Container <Container>`
@@ -742,9 +744,9 @@ def update_container(
         :param description: Description of the container.
         :param registry_image: Name of the registry image (e.g. "rg.fr-par.scw.cloud/something/image:tag").
         :param max_concurrency: Number of maximum concurrent executions of the container.
-        :param protocol:
-        :param port:
-        :param secret_environment_variables:
+        :param protocol: Protocol the container uses.
+        :param port: Port the container listens on.
+        :param secret_environment_variables: Secret environment variables of the container.
         :param http_option: Possible values:
          - redirected: Responds to HTTP request with a 301 redirect to ask the clients to use HTTPS.
          - enabled: Serve both HTTP and HTTPS traffic.
@@ -756,7 +758,9 @@ def update_container(
         - memory_usage_threshold: Scale depending on the memory usage of a container instance.
         :param health_check: Health check configuration of the container.
         :param tags: Tags of the Serverless Container.
-        :param private_network_id:
+        :param private_network_id: When connected to a Private Network, the container can access other Scaleway resources in this Private Network.
+
+        Note: this feature is currently in beta and requires a namespace with VPC integration activated, using the `activate_vpc_integration` flag.
         :param command: Command executed when the container starts. This overrides the default command defined in the container image. This is usually the main executable, or entry point script to run.
         :param args: Arguments passed to the command specified in the "command" field. These override the default arguments from the container image, and behave like command-line parameters.
         :return: :class:`Container <Container>`

scaleway/scaleway/container/v1beta1/types.py

@@ -522,6 +522,9 @@ class Container:
     """
 
     private_network_id: Optional[str]
+    """
+    When connected to a Private Network, the container can access other Scaleway resources in this Private Network.
+    """
 
 
 @dataclass
@@ -668,6 +671,10 @@ class Namespace:
     """
 
     vpc_integration_activated: Optional[bool]
+    """
+    When activated, containers in the namespace can be connected to a Private Network.
+Note that activating the VPC integration can only be done when creating a new namespace.
+    """
 
 
 @dataclass
@@ -876,6 +883,11 @@ class CreateContainerRequest:
     """
 
     private_network_id: Optional[str]
+    """
+    When connected to a Private Network, the container can access other Scaleway resources in this Private Network.
+
+Note: this feature is currently in beta and requires a namespace with VPC integration activated, using the `activate_vpc_integration` flag.
+    """
 
     command: Optional[List[str]]
     """
@@ -937,6 +949,9 @@ class CreateDomainRequest:
 @dataclass
 class CreateNamespaceRequest:
     activate_vpc_integration: bool
+    """
+    When activated, containers in the namespace can be connected to a Private Network.
+    """
 
     region: Optional[ScwRegion]
     """
@@ -1533,10 +1548,19 @@ class UpdateContainerRequest:
     """
 
     protocol: Optional[ContainerProtocol]
+    """
+    Protocol the container uses.
+    """
 
     port: Optional[int]
+    """
+    Port the container listens on.
+    """
 
     secret_environment_variables: Optional[List[Secret]]
+    """
+    Secret environment variables of the container.
+    """
 
     http_option: Optional[ContainerHttpOption]
     """
@@ -1574,6 +1598,11 @@ class UpdateContainerRequest:
     """
 
     private_network_id: Optional[str]
+    """
+    When connected to a Private Network, the container can access other Scaleway resources in this Private Network.
+
+Note: this feature is currently in beta and requires a namespace with VPC integration activated, using the `activate_vpc_integration` flag.
+    """
 
     command: Optional[List[str]]
     """