Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(k8s): explain 'external' node type for Kapsule Pool #1377

Merged
merged 1 commit into from
Aug 24, 2022
Merged

docs(k8s): explain 'external' node type for Kapsule Pool #1377

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
30 changes: 18 additions & 12 deletions api/k8s/v1/k8s_sdk.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -789,21 +789,23 @@ type CreateClusterRequestOpenIDConnectConfig struct {
type CreateClusterRequestPoolConfig struct {
// Name: the name of the pool
Name string `json:"name"`
// NodeType: the node type is the type of Scaleway Instance wanted for the pool, nodes with insufficient memory are not eligible (DEV1-S, PLAY2-PICO, STARDUST)
// NodeType: the node type is the type of Scaleway Instance wanted for the pool
//
// The node type is the type of Scaleway Instance wanted for the pool. Nodes with insufficient memory are not eligible (DEV1-S, PLAY2-PICO, STARDUST). 'external' is a special node type used to provision instances from other cloud providers.
NodeType string `json:"node_type"`
// PlacementGroupID: the placement group ID in which all the nodes of the pool will be created
PlacementGroupID *string `json:"placement_group_id"`
// Autoscaling: the enablement of the autoscaling feature for the pool
Autoscaling bool `json:"autoscaling"`
// Size: the size (number of nodes) of the pool
Size uint32 `json:"size"`
// MinSize: the minimun size of the pool
// MinSize: the minimum size of the pool
//
// The minimun size of the pool. Note that this fields will be used only when autoscaling is enabled.
// The minimum size of the pool. Note that this field will be used only when autoscaling is enabled.
MinSize *uint32 `json:"min_size"`
// MaxSize: the maximum size of the pool
//
// The maximum size of the pool. Note that this fields will be used only when autoscaling is enabled.
// The maximum size of the pool. Note that this field will be used only when autoscaling is enabled.
MaxSize *uint32 `json:"max_size"`
// ContainerRuntime: the container runtime for the nodes of the pool
//
Expand Down Expand Up @@ -949,19 +951,21 @@ type Pool struct {
Status PoolStatus `json:"status"`
// Version: the version of the pool
Version string `json:"version"`
// NodeType: the node type is the type of Scaleway Instance wanted for the pool, nodes with insufficient memory are not eligible (DEV1-S, PLAY2-PICO, STARDUST)
// NodeType: the node type is the type of Scaleway Instance wanted for the pool
//
// The node type is the type of Scaleway Instance wanted for the pool. Nodes with insufficient memory are not eligible (DEV1-S, PLAY2-PICO, STARDUST). 'external' is a special node type used to provision instances from other cloud providers.
NodeType string `json:"node_type"`
// Autoscaling: the enablement of the autoscaling feature for the pool
Autoscaling bool `json:"autoscaling"`
// Size: the size (number of nodes) of the pool
Size uint32 `json:"size"`
// MinSize: the minimun size of the pool
// MinSize: the minimum size of the pool
//
// The minimun size of the pool. Note that this fields will be used only when autoscaling is enabled.
// The minimum size of the pool. Note that this field will be used only when autoscaling is enabled.
MinSize uint32 `json:"min_size"`
// MaxSize: the maximum size of the pool
//
// The maximum size of the pool. Note that this fields will be used only when autoscaling is enabled.
// The maximum size of the pool. Note that this field will be used only when autoscaling is enabled.
MaxSize uint32 `json:"max_size"`
// ContainerRuntime: the container runtime for the nodes of the pool
//
Expand Down Expand Up @@ -1719,21 +1723,23 @@ type CreatePoolRequest struct {
ClusterID string `json:"-"`
// Name: the name of the pool
Name string `json:"name"`
// NodeType: the node type is the type of Scaleway Instance wanted for the pool, nodes with insufficient memory are not eligible (DEV1-S, PLAY2-PICO, STARDUST)
// NodeType: the node type is the type of Scaleway Instance wanted for the pool
//
// The node type is the type of Scaleway Instance wanted for the pool. Nodes with insufficient memory are not eligible (DEV1-S, PLAY2-PICO, STARDUST). 'external' is a special node type used to provision instances from other cloud providers.
NodeType string `json:"node_type"`
// PlacementGroupID: the placement group ID in which all the nodes of the pool will be created
PlacementGroupID *string `json:"placement_group_id"`
// Autoscaling: the enablement of the autoscaling feature for the pool
Autoscaling bool `json:"autoscaling"`
// Size: the size (number of nodes) of the pool
Size uint32 `json:"size"`
// MinSize: the minimun size of the pool
// MinSize: the minimum size of the pool
//
// The minimun size of the pool. Note that this fields will be used only when autoscaling is enabled.
// The minimum size of the pool. Note that this field will be used only when autoscaling is enabled.
MinSize *uint32 `json:"min_size"`
// MaxSize: the maximum size of the pool
//
// The maximum size of the pool. Note that this fields will be used only when autoscaling is enabled.
// The maximum size of the pool. Note that this field will be used only when autoscaling is enabled.
MaxSize *uint32 `json:"max_size"`
// ContainerRuntime: the container runtime for the nodes of the pool
//
Expand Down