-
Notifications
You must be signed in to change notification settings - Fork 41
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
base: main
Are you sure you want to change the base?
Conversation
❌ Deploy Preview for vcluster-docs-site failed.
|
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[Loft.imperative-headings] Headings should start with an imperative verb. 'Adding' appears to be a present participle (ends with 'ing').
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[Loft.imperative-headings] Headings should start with an imperative verb. 'Deploying' appears to be a present participle (ends with 'ing').
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.
|
||
## Required open ports | ||
|
||
### Connect Kubernetes to the platform |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.
|
||
## 1. Install kube-prometheus-stack | ||
## Install `kube-prometheus-stack` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[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'; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.
|
||
<NetworkPorts /> | ||
|
||
|
||
## Deployment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[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'; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.
### Resource requirements | ||
|
||
<NetworkPorts /> | ||
|
||
|
||
## Deployment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[Loft.headings-ids] Headings must have an associated ID. Add an ID like {#heading-id}.
Content Description
Preview Link
Internal Reference
Closes DOC-462
Closes DOC-451
Closes DOC-505