feat: add structs for vcluster configuration defaults & validation

docs/docusaurus.config.js

@@ -1,5 +1,7 @@
 __webpack_public_path__ = "/docs/";
 
+const resolveGlob = require('resolve-glob');
+
 module.exports = {
   title: "vcluster docs | Virtual Clusters for Kubernetes",
   tagline: "Virtual Clusters for Kubernetes",
@@ -77,11 +79,15 @@ module.exports = {
           editUrl: "https://github.com/loft-sh/vcluster/edit/main/docs/",
         },
         theme: {
-          customCss: require.resolve("./src/css/custom.css"),
+          // customCss: require.resolve("./src/css/custom.css"),
+          customCss: resolveGlob.sync(['./src/css/**/*.scss'])
         },
       },
     ],
   ],
+  plugins: [
+    'docusaurus-plugin-sass',
+  ],
   scripts: [
     {
       src: "https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js",

docs/package.json

@@ -13,9 +13,12 @@
     "@docusaurus/preset-classic": "^2.4.1",
     "classnames": "^2.2.6",
     "docusaurus-gtm-plugin": "^0.0.2",
+    "docusaurus-plugin-sass": "^0.2.5",
     "mdx-link-checker": "^0.1.1",
     "react": "^16.8.4",
-    "react-dom": "^16.8.4"
+    "react-dom": "^16.8.4",
+    "resolve-glob": "^1.0.0",
+    "sass": "^1.71.1"
   },
   "browserslist": {
     "production": [

docs/pages/configuration/_partials/access.mdx

@@ -0,0 +1,17 @@
+
+import PartialAccessreference from "./access_reference.mdx"
+
+
+<details className="config-field" data-expandable="true" open>
+<summary>
+
+## `access` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type"></span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#access}
+
+
+
+</summary>
+
+<PartialAccessreference />
+
+
+</details>

docs/pages/configuration/_partials/access/audit.mdx

@@ -0,0 +1,17 @@
+
+import PartialAuditreference from "./audit_reference.mdx"
+
+
+<details className="config-field" data-expandable="true" open>
+<summary>
+
+### `audit` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type"></span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#access-audit}
+
+
+
+</summary>
+
+<PartialAuditreference />
+
+
+</details>

docs/pages/configuration/_partials/access/audit/enabled.mdx

@@ -0,0 +1,13 @@
+
+<details className="config-field" data-expandable="false" open>
+<summary>
+
+#### `enabled` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type">boolean</span> <span className="config-field-default">false</span> <span className="config-field-enum"></span> {#access-audit-enabled}
+
+
+
+</summary>
+
+
+
+</details>

docs/pages/configuration/_partials/access/audit/level.mdx

@@ -0,0 +1,13 @@
+
+<details className="config-field" data-expandable="false" open>
+<summary>
+
+#### `level` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type">integer</span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#access-audit-level}
+
+TODO validate log levels
+
+</summary>
+
+
+
+</details>

docs/pages/configuration/_partials/access/audit/policy.mdx

@@ -0,0 +1,17 @@
+
+import PartialPolicyreference from "./policy_reference.mdx"
+
+
+<details className="config-field" data-expandable="true" open>
+<summary>
+
+#### `policy` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type"></span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#access-audit-policy}
+
+
+
+</summary>
+
+<PartialPolicyreference />
+
+
+</details>

docs/pages/configuration/_partials/access/audit/policy/rules.mdx

@@ -0,0 +1,17 @@
+
+import PartialRulesreference from "./rules_reference.mdx"
+
+
+<details className="config-field" data-expandable="true" open>
+<summary>
+
+##### `rules` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type">object[]</span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#access-audit-policy-rules}
+
+
+
+</summary>
+
+<PartialRulesreference />
+
+
+</details>

docs/pages/configuration/_partials/access/audit/policy/rules/apiGroups.mdx

@@ -0,0 +1,14 @@
+
+<details className="config-field" data-expandable="false" open>
+<summary>
+
+###### `apiGroups` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type">string[]</span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#access-audit-policy-rules-apiGroups}
+
+APIGroups is the name of the APIGroup that contains the resources.  If multiple API groups are specified, any action requested against one of
+the enumerated resources in any API group will be allowed. "" represents the core API group and "*" represents all API groups.
+
+</summary>
+
+
+
+</details>

docs/pages/configuration/_partials/access/audit/policy/rules/nonResourceURLs.mdx

@@ -0,0 +1,15 @@
+
+<details className="config-field" data-expandable="false" open>
+<summary>
+
+###### `nonResourceURLs` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type">string[]</span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#access-audit-policy-rules-nonResourceURLs}
+
+NonResourceURLs is a set of partial urls that a user should have access to.  *s are allowed, but only as the full, final step in the path
+Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding.
+Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"),  but not both.
+
+</summary>
+
+
+
+</details>

docs/pages/configuration/_partials/access/audit/policy/rules/resourceNames.mdx

@@ -0,0 +1,13 @@
+
+<details className="config-field" data-expandable="false" open>
+<summary>
+
+###### `resourceNames` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type">string[]</span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#access-audit-policy-rules-resourceNames}
+
+ResourceNames is an optional white list of names that the rule applies to.  An empty set means that everything is allowed.
+
+</summary>
+
+
+
+</details>

docs/pages/configuration/_partials/access/audit/policy/rules/resources.mdx

@@ -0,0 +1,13 @@
+
+<details className="config-field" data-expandable="false" open>
+<summary>
+
+###### `resources` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type">string[]</span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#access-audit-policy-rules-resources}
+
+Resources is a list of resources this rule applies to. '*' represents all resources.
+
+</summary>
+
+
+
+</details>

docs/pages/configuration/_partials/access/audit/policy/rules/verbs.mdx

@@ -0,0 +1,13 @@
+
+<details className="config-field" data-expandable="false" open>
+<summary>
+
+###### `verbs` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type">string[]</span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#access-audit-policy-rules-verbs}
+
+Verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '*' represents all verbs.
+
+</summary>
+
+
+
+</details>

docs/pages/configuration/_partials/access/audit/policy/rules_reference.mdx

@@ -0,0 +1,20 @@
+
+import PartialVerbs from "./rules/verbs.mdx"
+import PartialApigroups from "./rules/apiGroups.mdx"
+import PartialResources from "./rules/resources.mdx"
+import PartialResourcenames from "./rules/resourceNames.mdx"
+import PartialNonresourceurls from "./rules/nonResourceURLs.mdx"
+
+<PartialVerbs />
+
+
+<PartialApigroups />
+
+
+<PartialResources />
+
+
+<PartialResourcenames />
+
+
+<PartialNonresourceurls />

docs/pages/configuration/_partials/access/audit/policy_reference.mdx

@@ -0,0 +1,17 @@
+
+import PartialRulesreference from "./policy/rules_reference.mdx"
+
+
+<details className="config-field" data-expandable="true">
+<summary>
+
+##### `rules` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type">object[]</span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#access-audit-policy-rules}
+
+
+
+</summary>
+
+<PartialRulesreference />
+
+
+</details>

docs/pages/configuration/_partials/access/audit_reference.mdx

@@ -0,0 +1,25 @@
+
+import PartialEnabled from "./audit/enabled.mdx"
+import PartialLevel from "./audit/level.mdx"
+import PartialPolicyreference from "./audit/policy_reference.mdx"
+
+<PartialEnabled />
+
+
+<PartialLevel />
+
+
+
+<details className="config-field" data-expandable="true">
+<summary>
+
+#### `policy` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type"></span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#access-audit-policy}
+
+
+
+</summary>
+
+<PartialPolicyreference />
+
+
+</details>

docs/pages/configuration/_partials/access_reference.mdx

@@ -0,0 +1,17 @@
+
+import PartialAuditreference from "./access/audit_reference.mdx"
+
+
+<details className="config-field" data-expandable="true">
+<summary>
+
+### `audit` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type"></span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#access-audit}
+
+
+
+</summary>
+
+<PartialAuditreference />
+
+
+</details>

docs/pages/configuration/_partials/controlPlane.mdx

@@ -0,0 +1,17 @@
+
+import PartialControlplanereference from "./controlPlane_reference.mdx"
+
+
+<details className="config-field" data-expandable="true" open>
+<summary>
+
+## `controlPlane` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type"></span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#controlPlane}
+
+
+
+</summary>
+
+<PartialControlplanereference />
+
+
+</details>

docs/pages/configuration/_partials/controlPlane/advanced.mdx

@@ -0,0 +1,17 @@
+
+import PartialAdvancedreference from "./advanced_reference.mdx"
+
+
+<details className="config-field" data-expandable="true" open>
+<summary>
+
+### `advanced` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type"></span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#controlPlane-advanced}
+
+
+
+</summary>
+
+<PartialAdvancedreference />
+
+
+</details>

docs/pages/configuration/_partials/controlPlane/advanced/defaultImageRegistry.mdx

@@ -0,0 +1,13 @@
+
+<details className="config-field" data-expandable="false" open>
+<summary>
+
+#### `defaultImageRegistry` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type">string</span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#controlPlane-advanced-defaultImageRegistry}
+
+
+
+</summary>
+
+
+
+</details>

docs/pages/configuration/_partials/controlPlane/advanced/headless.mdx

@@ -0,0 +1,13 @@
+
+<details className="config-field" data-expandable="false" open>
+<summary>
+
+#### `headless` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type">boolean</span> <span className="config-field-default">false</span> <span className="config-field-enum"></span> {#controlPlane-advanced-headless}
+
+
+
+</summary>
+
+
+
+</details>

docs/pages/configuration/_partials/controlPlane/advanced/metadata.mdx

@@ -0,0 +1,17 @@
+
+import PartialMetadatareference from "./metadata_reference.mdx"
+
+
+<details className="config-field" data-expandable="true" open>
+<summary>
+
+#### `metadata` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type"></span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#controlPlane-advanced-metadata}
+
+
+
+</summary>
+
+<PartialMetadatareference />
+
+
+</details>

docs/pages/configuration/_partials/controlPlane/advanced/metadata/allResources.mdx

@@ -0,0 +1,17 @@
+
+import PartialAllresourcesreference from "./allResources_reference.mdx"
+
+
+<details className="config-field" data-expandable="true" open>
+<summary>
+
+##### `allResources` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type"></span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#controlPlane-advanced-metadata-allResources}
+
+
+
+</summary>
+
+<PartialAllresourcesreference />
+
+
+</details>