-
Notifications
You must be signed in to change notification settings - Fork 260
feat(k8s): add documentation about new security group management #5190
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.
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
Merged
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
8430c86
feat(k8s): security group management
bene2k1 98ba92a
docs(k8s): security group management
bene2k1 8bca6d1
Apply suggestions from code review
bene2k1 ef8e435
Apply suggestions from code review
bene2k1 700b8aa
Apply suggestions from code review
bene2k1 28035ad
feat(k8s): update content
bene2k1 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
59 changes: 59 additions & 0 deletions
59
pages/kubernetes/reference-content/security-group-management.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| --- | ||
| meta: | ||
| title: Scaleway Kubernetes Kapsule and Kosmos security group management | ||
| description: This page explains how to Scaleway Kubernetes Kapsule and Kosmos manage security groups | ||
| content: | ||
| h1: Scaleway Kubernetes Kapsule and Kosmos security group management | ||
| paragraph: This page explains how to Scaleway Kubernetes Kapsule and Kosmos manage security groups | ||
bene2k1 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| tags: kubernetes kapsule kosmos security group | ||
| dates: | ||
| validation: 2025-06-26 | ||
| posted: 2025-06-06 | ||
| categories: | ||
| - kubernetes | ||
| --- | ||
|
|
||
| Scaleway Kubernetes Kapsule and Kosmos provide managed Kubernetes services that simplify the deployment and management of containerized applications. | ||
| As part of the security configuration for these services, Scaleway allows users to manage security groups for Kapsule pools to control network traffic to and from cluster nodes. | ||
| This document outlines the process for managing security groups when creating and configuring pools in Scaleway Kubernetes Kapsule. | ||
|
|
||
| <Message type="note"> | ||
| Previously, Scaleway created a separate security group for each zone where a cluster had at least one pool. This approach has been replaced with the option to use either a user-specified security group or the shared default security group. | ||
| </Message> | ||
|
|
||
| ## Security group management for Kapsule pools | ||
|
|
||
| When creating a pool using the CLI or API, you can specify a security group ID to associate an existing security group with the pool. This allows for customized network traffic rules tailored to your specific requirements. | ||
bene2k1 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| Run the following syntax to create a new pool using the CLI: | ||
| ``` | ||
| scw k8s pool create cluster-id=11111111-1111-1111-1111-111111111111 name=bar node-type=DEV1-XL size=2 security-group-id11111111-1111-1111-1111-111111111111 | ||
bene2k1 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| ``` | ||
| <Message type="note"> | ||
| Replace `11111111-1111-1111-1111-111111111111` with the UUID of your cluster and security group. | ||
| </Message> | ||
|
|
||
| For more information how to create a pool using the API, refer to the [Kubernetes API documentation](https://www.scaleway.com/en/developers/api/kubernetes/#path-pools-create-a-new-pool-in-a-cluster). | ||
|
|
||
bene2k1 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| If no security group ID is provided during pool creation, Scaleway assigns a default preconfigured security group named **Kapsule default security group**. | ||
bene2k1 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| This default security group is shared across all Kapsule pools within the same availability zone. | ||
bene2k1 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
bene2k1 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ### Verify security group configuration | ||
|
|
||
| After creating the pool, verify that the correct security group is applied by checking the pool details in the Scaleway console or using the CLI: | ||
bene2k1 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ```bash | ||
| scw k8s pool get <pool-id> | ||
| ``` | ||
|
|
||
| Ensure that the security group rules align with your application's networking needs and cluster communication requirements. | ||
bene2k1 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
|
|
||
| ## Modify security group rules (Optional): | ||
bene2k1 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| To update the rules of an existing security group, navigate to the Instances section in the Scaleway console. | ||
| Select the security group (either the custom one or the Kapsule default security group) and [modify the inbound/outbound rules](/instances/how-to/use-security-groups/#how-to-edit-a-security-group) as needed. | ||
bene2k1 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| <Message type="important"> | ||
| Changes to the Kapsule default security group will affect all pools in the same zone that use this default group. | ||
bene2k1 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| </Message> | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.