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.

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

DRAFT: feat(k8s): add acl docs #3460

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
50 changes: 50 additions & 0 deletions containers/kubernetes/how-to/manage-allowed-ips.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
meta:
title: Managing allowed IP addresses for Kubernetes products
description: Learn how to manage allowed IP addresses for your Kubernetes Kapsule and Kosmos clusters. Configure access restrictions with our step-by-step guide.
content:
h1: Managing allowed IP addresses for Kubernetes products
paragraph: Learn how to manage allowed IP addresses for your Kubernetes Kapsule and Kosmos clusters. Configure access restrictions with our step-by-step guide.
tags: kubernetes kapsule kosmos
dates:
validation: 2024-11-05
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
validation: 2024-11-05
validation: 2024-12-16

posted: 2024-11-05
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
posted: 2024-11-05
posted: 2024-12-16

categories:
- containers
---

Restricting IPs on Kubernetes Kapsule or Kosmos clusters enhances security by limiting access to only trusted sources, thereby reducing the risk of unauthorized access and potential attacks.
This control ensures that only specific IP addresses or networks can interact with your clusters, providing an additional layer of protection.
The default entry `0.0.0.0/0` enables any host to establish a connection.
Comment on lines +16 to +18
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Restricting IPs on Kubernetes Kapsule or Kosmos clusters enhances security by limiting access to only trusted sources, thereby reducing the risk of unauthorized access and potential attacks.
This control ensures that only specific IP addresses or networks can interact with your clusters, providing an additional layer of protection.
The default entry `0.0.0.0/0` enables any host to establish a connection.
Restricting IPs on Kubernetes Kapsule or Kosmos clusters enhances security by limiting access to only trusted sources. Since only IP addresses and networks specified by you can interact with your clusters, you reduce the risk of unauthorized access and potential attacks.
The default entry `0.0.0.0/0` enables any host to establish a connection.


<Macro id="requirements" />

- Scaleway account logged into the [Scaleway console](https://console.scaleway.com)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Scaleway account logged into the [Scaleway console](https://console.scaleway.com)
- A Scaleway account logged into the [Scaleway console](https://console.scaleway.com)

- [Owner](/identity-and-access-management/iam/concepts/#owner) status or [IAM permissions](/identity-and-access-management/iam/concepts/#permission) allowing actions in the intended Organization
- [Created](/containers/kubernetes/how-to/create-cluster) a Kubernetes Kapsule or Kosmos cluster

<Message type="note">
Allowed IP configuration is available for public networks only.
</Message>

## How to add an IP address

1. Click **Kubernetes** in the **Containers** section of the [Scaleway console](https://console.scaleway.com). The **Kubernetes Kapsule dashboard** appears.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
1. Click **Kubernetes** in the **Containers** section of the [Scaleway console](https://console.scaleway.com). The **Kubernetes Kapsule dashboard** appears.
1. Click **Kubernetes** in the **Containers** section of the [Scaleway console](https://console.scaleway.com). The **Kubernetes dashboard** appears.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We're specifying Kubernetes Kapsule here, but the requirements say that users can do this either on a Kapsule or Kosmos cluster. We must either remove the Kapsule mention here or state that the settings we show on this page are specifically for Kapsule, no?

2. Select the cluster you wish to configure. The **Cluster information** page opens.
3. Click the **Network** tab to display your cluster's network information. Your access control list appears in the **Allowed IPs for control plane** section.
4. Click **Add allowed IP**. Enter the IP address or IP block in [CIDR notation](/network/ipam/concepts/#cidr-notation) (e.g., `198.51.100.135/32` for a single IP, `198.51.100.0/24` for an IP block) and click **Add IPs**.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
4. Click **Add allowed IP**. Enter the IP address or IP block in [CIDR notation](/network/ipam/concepts/#cidr-notation) (e.g., `198.51.100.135/32` for a single IP, `198.51.100.0/24` for an IP block) and click **Add IPs**.
4. Click **Add allowed IP**. Enter the IP address or IP block in [CIDR notation](/network/ipam/concepts/#cidr-notation) (e.g., `198.51.100.135/32` for a single IP, `198.51.100.0/24` for an IP block), then click **Add IP(s)**.

<Message type="note">
To restore default settings and allow connections from all IPs, add `0.0.0.0/0` to the list.
</Message>

<Message type="important">
For **Kosmos** multi-cloud clusters, allow connections from all Scaleway IP subnets to ensure proper functionality. Access from these IPs cannot be restricted. Refer to our [peering information](https://www.scaleway.com/en/peering/) for details on all Scaleway IP prefixes.
</Message>

## How to delete an IP address

1. Click **Kubernetes** in the **Containers** section of the [Scaleway console](https://console.scaleway.com). The **Kubernetes Kapsule dashboard** appears.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Check if Kapsule mention should be here.

2. Select the cluster you wish to configure. The **Cluster information** page opens.
3. Click the **Network** tab to display your cluster's network information. Your access control list appears in the **Allowed IPs for control plane** section.
4. Locate the IP address in your allowed list.
5. Click <Icon name="delete" /> next to the IP you want to delete. Confirm by typing **DELETE** in the pop-up, then click **Delete allowed IP** to confirm deletion.
6 changes: 5 additions & 1 deletion menu/navigation.json
Original file line number Diff line number Diff line change
Expand Up @@ -1348,6 +1348,10 @@
"label": "Manage a Kosmos cluster",
"slug": "edit-kosmos-cluster"
},
{
"label": "Manage allowed IPs",
"slug": "manage-allowed-ips"
},
{
"label": "Connect to a cluster with kubectl",
"slug": "connect-cluster-kubectl"
Expand Down Expand Up @@ -4885,4 +4889,4 @@
],
"label": "Additional Services"
}
]
]
Loading