Skip to content

Commit

Permalink
chore: move base prerequisites to shared location
Browse files Browse the repository at this point in the history
Partials cannot be easily referenced between platform and vcluster
folders. Since base prerequisites are shared between vcluster and
platform, they can be moved the the shared partials folder (docs).
  • Loading branch information
Piotr1215 committed Jan 20, 2025
1 parent 4999f36 commit 24bd54a
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 2 deletions.
10 changes: 10 additions & 0 deletions docs/_partials/base-prerequisites.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
import Mark from "@site/src/components/Mark";

- Administrator access to a Kubernetes cluster: See [Accessing Clusters with kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl) for more information.
Your current kube-context must have administrative privileges, which you can verify with `kubectl auth can-i create clusterrole -A`
:::info
To obtain a kube-context with admin access, ensure you have the necessary credentials and permissions for your Kubernetes cluster. This typically involves using `kubectl config` commands or authenticating through your cloud provider's CLI tools.
:::
- `helm` installed: Helm <Mark color="lightgreen">v3.10</Mark> is required for deploying the platform. Refer to the [Helm Installation Guide](https://Helm.sh/docs/intro/install/) if you need to install it.

- `kubectl` installed: Kubernetes command-line tool for interacting with the cluster. See [Install and Set Up kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl) for installation instructions.
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import ProAdmonition from '../../../_partials/admonitions/pro-admonition.mdx'
import ExperimentalSleepMode from '../../../_partials/config/experimental/sleepMode.mdx'
import SleepModeDeploymentExample from '@site/vcluster/_fragments/sleepmode-deployment-example.mdx'
import SleepModeIngressExample from '@site/vcluster/_fragments/sleepmode-ingress-example.mdx'
import BasePrerequisites from '../../../../platform/_partials/install/base-prerequisites.mdx';
import BasePrerequisites from '@site/docs/_partials/base-prerequisites.mdx';


<ProAdmonition />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import ProAdmonition from '../../../_partials/admonitions/pro-admonition.mdx'
import ExperimentalSleepMode from '../../../_partials/config/experimental/sleepMode.mdx'
import SleepModeDeploymentExample from '@site/vcluster/_fragments/sleepmode-deployment-example.mdx'
import SleepModeIngressExample from '@site/vcluster/_fragments/sleepmode-ingress-example.mdx'
import BasePrerequisites from '../../../../platform/_partials/install/base-prerequisites.mdx';
import BasePrerequisites from '@site/docs/_partials/base-prerequisites.mdx';


<ProAdmonition />
Expand Down

0 comments on commit 24bd54a

Please sign in to comment.