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

(re)factor: update ports documentation #546

Open
wants to merge 12 commits into
base: main
Choose a base branch
from

Conversation

joaniekube
Copy link
Contributor

@joaniekube joaniekube commented Mar 21, 2025

Content Description

  • Add clarity to open ports docs.
  • Add a networking section and also put content in troubleshooting section.

NOTE: I attempted to add some firewall information to this doc, but I'm not sure if it's correct. While we mention firewall considerations, we don't provide specific details, which is less than ideal for users. I've added some content but commented it out because I'm uncertain about its accuracy. Could you please review both the PR source and the rendered preview? I'm looking for clarity and information for the firewall section as well, as it would be beneficial to make this available to users.

Preview Link

Internal Reference

Closes DOC-462
Closes DOC-451
Closes DOC-505

Copy link

netlify bot commented Mar 21, 2025

Deploy Preview for vcluster-docs-site failed.

Name Link
🔨 Latest commit 4e9d961
🔍 Latest deploy log https://app.netlify.com/sites/vcluster-docs-site/deploys/67e2ee6cf7475f0008377195

@joaniekube joaniekube changed the title (re)factor: Ports recovery branch (re)factor: update ports documentation Mar 21, 2025
@joaniekube joaniekube marked this pull request as ready for review March 24, 2025 10:38
@joaniekube joaniekube requested a review from a team as a code owner March 24, 2025 10:38
@Piotr1215 Piotr1215 requested a review from FabianKramm March 25, 2025 09:21
FabianKramm
FabianKramm previously approved these changes Mar 25, 2025
@Piotr1215
Copy link
Contributor

Piotr1215 commented Mar 25, 2025

Thanks @FabianKramm . @joaniekube please fix the netlify build issues:

11:43:18 AM: > [email protected] build
11:43:18 AM: > docusaurus build
11:43:20 AM: [INFO] [en] Creating an optimized production build...
11:43:21 AM: [ReDoc Compatibility mode]: Converting OpenAPI 2.0 to OpenAPI 3.0
11:43:23 AM: Browserslist: caniuse-lite is outdated. Please run:
11:43:23 AM:   npx update-browserslist-db@latest
11:43:23 AM:   Why you should do it regularly: https://github.com/browserslist/update-db#readme
11:43:23 AM: [info] [webpackbar] Compiling Client
11:43:23 AM: [info] [webpackbar] Compiling Server
11:43:57 AM: [WARNING] Docs markdown link couldn't be resolved: (../../../vcluster/deploy/upgrade/supported_versions.mdx) in "/opt/build/repo/platform/install/advanced/air-gapped.mdx" for version current
[WARNING] Docs markdown link couldn't be resolved: (../../../vcluster/deploy/upgrade/supported_versions.mdx) in "/opt/build/repo/platform/install/advanced/air-gapped.mdx" for version current
[success] [webpackbar] Server: Compiled with some errors in 34.38s
11:44:02 AM: [success] [webpackbar] Client: Compiled with some errors in 39.45s
11:44:02 AM: [ERROR] Client bundle compiled with errors therefore further build is impossible.
11:44:02 AM: Module not found: Error: Can't resolve '../../_partials/install/open-ports.mdx' in '/opt/build/repo/platform/install'
11:44:02 AM: --------------------------
11:44:02 AM: 
11:44:02 AM: Module not found: Error: Can't resolve '../../_partials/install/open-ports.mdx' in '/opt/build/repo/platform/install'
11:44:02 AM: --------------------------
11:44:02 AM: 
11:44:02 AM: Module not found: Error: Can't resolve '../../_partials/install/open-ports.mdx' in '/opt/build/repo/platform/install'

11:44:02 AM: "build.command" failed                                        

Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.

Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.

Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.

Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.

Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.

Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.

Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.

Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.

Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.

Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.

Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.

Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.

Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.

Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[Loft.imperative-headings] Headings should start with an imperative verb. 'Adding' appears to be a present participle (ends with 'ing').

Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[Loft.imperative-headings] Headings should start with an imperative verb. 'Deploying' appears to be a present participle (ends with 'ing').

Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.

Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.

Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.

Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.

Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.

Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.

Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.

Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.

Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.

Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.

Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.

Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.

Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.

Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.


If these ports are blocked by firewall rules, some platform features—such as role-based access control (RBAC) enforcement, cost monitoring, or webhook validation—might fail. Ensure these ports are open to prevent connectivity issues.

## Required open ports
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.


## Required open ports

### Connect Kubernetes to the platform
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.

In private GKE clusters, Kubernetes control plane and worker nodes might reside in separate subnetworks. You might need to explicitly allow traffic on these ports using a firewall rule.
:::

### Connect the platform to Prometheus
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.


## 1. Install kube-prometheus-stack
## Install `kube-prometheus-stack`
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.

@@ -11,10 +11,9 @@ import PartialAdminUpgrade from "../../_partials/install/upgrade.mdx";
import Mark from "@site/src/components/Mark";

import BasePrerequisites from '../../_partials/install/base-prerequisites.mdx';
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.

@@ -22,6 +23,11 @@ in a GitOps fashion as well.

<BasePrerequisites />

### Resource requirements
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.


<NetworkPorts />


## Deployment
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.

@@ -11,6 +11,7 @@ import InstallNextSteps from "../_partials/install/install-next-steps.mdx";
import ListHelmVersions from '../_partials/install/list-helm-versions.mdx';

import BasePrerequisites from '../_partials/install/base-prerequisites.mdx';
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.

@@ -31,6 +32,10 @@ Use one of the following commands to download the vCluster CLI binary from GitHu
After installation, verify the successful installation of the vCluster CLI by running `vcluster version` in your terminal. This command should display the installed version of the vCluster CLI.
:::

### Resource requirements
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.

### Resource requirements

<NetworkPorts />


## Deployment
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants