Skip to content

Commit 58ce335

Browse files
authored
docs(containers): document VPC integration fields (scaleway#2589)
1 parent 2c91f5b commit 58ce335

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

api/container/v1beta1/container_sdk.go

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -996,6 +996,7 @@ type Container struct {
996996
// Tags: list of tags applied to the Serverless Container.
997997
Tags []string `json:"tags"`
998998

999+
// PrivateNetworkID: when connected to a Private Network, the container can access other Scaleway resources in this Private Network.
9991000
PrivateNetworkID *string `json:"private_network_id"`
10001001

10011002
// 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.
@@ -1097,7 +1098,8 @@ type Namespace struct {
10971098
// UpdatedAt: last update date of the namespace.
10981099
UpdatedAt *time.Time `json:"updated_at"`
10991100

1100-
// Deprecated
1101+
// Deprecated: VpcIntegrationActivated: when activated, containers in the namespace can be connected to a Private Network.
1102+
// Note that activating the VPC integration can only be done when creating a new namespace.
11011103
VpcIntegrationActivated *bool `json:"vpc_integration_activated,omitempty"`
11021104
}
11031105

@@ -1253,6 +1255,9 @@ type CreateContainerRequest struct {
12531255
// Tags: tags of the Serverless Container.
12541256
Tags []string `json:"tags"`
12551257

1258+
// PrivateNetworkID: when connected to a Private Network, the container can access other Scaleway resources in this Private Network.
1259+
//
1260+
// Note: this feature is currently in beta and requires a namespace with VPC integration activated, using the `activate_vpc_integration` flag.
12561261
PrivateNetworkID *string `json:"private_network_id,omitempty"`
12571262

12581263
// 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.
@@ -1315,6 +1320,7 @@ type CreateNamespaceRequest struct {
13151320
// Tags: tags of the Serverless Container Namespace.
13161321
Tags []string `json:"tags"`
13171322

1323+
// ActivateVpcIntegration: when activated, containers in the namespace can be connected to a Private Network.
13181324
ActivateVpcIntegration bool `json:"activate_vpc_integration"`
13191325
}
13201326

@@ -1831,11 +1837,14 @@ type UpdateContainerRequest struct {
18311837
// Deprecated: MaxConcurrency: number of maximum concurrent executions of the container.
18321838
MaxConcurrency *uint32 `json:"max_concurrency,omitempty"`
18331839

1834-
// Protocol: default value: unknown_protocol
1840+
// Protocol: protocol the container uses.
1841+
// Default value: unknown_protocol
18351842
Protocol ContainerProtocol `json:"protocol"`
18361843

1844+
// Port: port the container listens on.
18371845
Port *uint32 `json:"port,omitempty"`
18381846

1847+
// SecretEnvironmentVariables: secret environment variables of the container.
18391848
SecretEnvironmentVariables []*Secret `json:"secret_environment_variables"`
18401849

18411850
// HTTPOption: possible values:
@@ -1863,6 +1872,9 @@ type UpdateContainerRequest struct {
18631872
// Tags: tags of the Serverless Container.
18641873
Tags *[]string `json:"tags,omitempty"`
18651874

1875+
// PrivateNetworkID: when connected to a Private Network, the container can access other Scaleway resources in this Private Network.
1876+
//
1877+
// Note: this feature is currently in beta and requires a namespace with VPC integration activated, using the `activate_vpc_integration` flag.
18661878
PrivateNetworkID *string `json:"private_network_id,omitempty"`
18671879

18681880
// 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.

0 commit comments

Comments
 (0)