Release 4.4.a (#3177)

* fix: release patch * docs: PLT-1267 EC Install Validate Flag (#3176) * docs: PEM-5236 Updated Screenshots (#3182) * docs: PEM-5236 * chore: more tenant images updated * chore: more images * chore: more images * chore: more images * chore: fixed all SSO guides * chore: Fix a broken link (#3183) * Optimised images with calibre/image-actions * Optimised images with calibre/image-actions * Apply suggestions from code review Co-authored-by: Adelina Simion <43963729+addetz@users.noreply.github.com> --------- Co-authored-by: Yuliia Horbenko <31223054+yuliiiah@users.noreply.github.com> Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com> Co-authored-by: Adelina Simion <43963729+addetz@users.noreply.github.com> * docs: PCP-3015 (#3190) * docs: PCP-3015 * chore: removed br * docs: palette 4.4.a API docs (#3245) Co-authored-by: Karl Cardenas <karl@spectrocloud.com> * docs: add edge management api 44a (#3234) Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com> Co-authored-by: Karl Cardenas <karl@spectrocloud.com> * Steps for deleting the incorrectly created `kubernetes` LB and public IP (#3252) * chore: Fix markup and alignment in the Troubleshooting section * docs: Document the steps for deleting the incorrectly created LB * docs: Fix a typo * docs: Apply comments from the peer review * chore: Fix a typo that Vale caught * Document the `fullyPrivateAddressing` property and its limitations for Azure (#3258) * docs: Document the property for Azure * docs: Document the limitations for Azure * chore: Fix link format * docs: Small edits to the topic * docs: Implement peer review * docs: edge host grid view (#3286) * docs: document edge host grid view * docs: add png * docs: add webp * docs: add docs for grid view * Update edge-host-view.md * Optimised images with calibre/image-actions * docs: add page to index pages * minor edit * Apply suggestions from code review Co-authored-by: caroldelwing <carolina.delwing@spectrocloud.com> * docs: make format --------- Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com> Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com> Co-authored-by: caroldelwing <carolina.delwing@spectrocloud.com> * docs: update OSS licenses OPS-4804 (#3327) * docs: edge mgmt APIs exposed to connected clusters. (#3235) * docs: document list of apis unavailable to connected clusters * docs: add another endpoint * minor edit * Apply suggestions from code review Co-authored-by: Yuliia Horbenko <31223054+yuliiiah@users.noreply.github.com> --------- Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com> Co-authored-by: Yuliia Horbenko <31223054+yuliiiah@users.noreply.github.com> * docs: PEM-5064 (#3212) * docs: PEM-5064 * draft * docs: test * docs: added draft * chore: fix broken page issue * docs: added warning * Apply suggestions from code review Co-authored-by: caroldelwing <carolina.delwing@spectrocloud.com> * chore: fix prettier * chore: fixed partials --------- Co-authored-by: caroldelwing <carolina.delwing@spectrocloud.com> * docs: change screenshot for Edge filter (#3329) * docs: document edge host grid view * docs: add png * docs: add webp * docs: add docs for grid view * Update edge-host-view.md * Optimised images with calibre/image-actions * docs: add page to index pages * minor edit * Apply suggestions from code review Co-authored-by: caroldelwing <carolina.delwing@spectrocloud.com> * docs: make format * docs: crop screenshot * docs: change to webp * docs: rename image * Optimised images with calibre/image-actions * Optimised images with calibre/image-actions * docs: fix font awesome change --------- Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com> Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com> Co-authored-by: caroldelwing <carolina.delwing@spectrocloud.com> * docs: add parameter about preventing password change in local ui (#3243) * docs: add parameter for diabling pw change * docs: document password change through API * docs: delete dangling sentence * docs: minor edits * Update docs/docs-content/clusters/edge/local-ui/host-management/access-console.md Co-authored-by: Karl Cardenas <29551334+karl-cardenas-coding@users.noreply.github.com> * docs: make format * docs: fix font awesome * docs: cross linking * docs: add cross link * docs: add cloud config * docs: remove unrelated changes * docs: long form commands * docs: address review comments --------- Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com> Co-authored-by: Karl Cardenas <29551334+karl-cardenas-coding@users.noreply.github.com> * docs: Update prereqs for the `fullyPrivateAddressing` parameter (#3339) * docs: Update prereqs for the parameter * chore: Trigger build * docs: document new process for customizing local ui and custom links (#3205) * docs: address breaking change for local ui content * Update docs/docs-content/clusters/edge/local-ui/host-management/custom-link.md * docs: add font awesome * docs: minor edit * docs: remove breanking change from release notes * Apply suggestions from code review Co-authored-by: Yuliia Horbenko <31223054+yuliiiah@users.noreply.github.com> * docs: address review comments --------- Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com> Co-authored-by: Yuliia Horbenko <31223054+yuliiiah@users.noreply.github.com> * docs: DOC-1269 PLT-1298 Release Notes 4.4.a (#3320) * docs: DOC-1269 * docs: more notes * docs: more content * docs: added more content * docs: updated release notes * docs: update release notes * docs: vale feedback * docs: added VerteX section * docs: update edge section * docs: minor updates * docs: apply suggestions from code review Co-authored-by: Lenny Chen <55669665+lennessyy@users.noreply.github.com> * docs: updated release notes * doc: PLT-1298 --------- Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com> Co-authored-by: Lenny Chen <55669665+lennessyy@users.noreply.github.com> * docs: document signed content (#3251) * docs: draft for signed content * docs: fix broken link * docs: add crosslink * docs: add minor clarifications * Update docs/docs-content/clusters/edge/edgeforge-workflow/palette-canvos/signed-content.md * docs: address review comments * docs: add note about signed content --------- Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com> * Document the steps for using custom CA (#3338) * docs: Document the steps for using custom CA * chore: Trigger build * Optimised images with calibre/image-actions * chore: Fix image format * docs: Add a note about HTTPS and TLS to the custom CA topic --------- Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com> * Convert the HTTPS/TLS admonition to a bullet (#3346) * docs: Convert admonitions to bullets in prerequisites * docs: Update wording * Document the step for removing kind images after EC and PCG installation (#3337) * docs: Document the step for removing kind * chore: Trigger build * docs: Add the guidance for PCG deployments * docs: PCP-3244 * docs: fixed date * docs: fixed broken url * docs: PCP-3141 (#3378) * docs: PCP-3141 * docs: added guides * chore: fix release note * docs: updated release notes * docs: vale feedback * docs: added tip about proxy and Palette support * docs: minor updates * Apply suggestions from code review Co-authored-by: Yuliia Horbenko <31223054+yuliiiah@users.noreply.github.com> * chore: fix prettier * chore: completed feedback suggestions --------- Co-authored-by: Yuliia Horbenko <31223054+yuliiiah@users.noreply.github.com> * docs: PEM-5375 (#3397) * docs: PEM-5375 * docs: vale feedback * docs: update release number * Update Palette CLI Binaries URLs (#3437) * docs: update palette cli binaries URL * docs: update spectro cli download URLs * docs: update spectro registry docker image * docs: rearrange Palette CLI rows so that the latest version comes first * docs: update self-hosted upgrade paths * docs: DOC-1312 (#3438) * docs: DOC-1312 * docs: azure update * Apply suggestions from code review Co-authored-by: Adelina Simion <43963729+addetz@users.noreply.github.com> --------- Co-authored-by: Adelina Simion <43963729+addetz@users.noreply.github.com> * docs: added spectro proxy --------- Co-authored-by: Yuliia Horbenko <31223054+yuliiiah@users.noreply.github.com> Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com> Co-authored-by: Adelina Simion <43963729+addetz@users.noreply.github.com> Co-authored-by: Ravikumar Kondepati <ravikum12@gmail.com> Co-authored-by: Lenny Chen <55669665+lennessyy@users.noreply.github.com> Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com> Co-authored-by: caroldelwing <carolina.delwing@spectrocloud.com>
spectrocloud · Jul 20, 2024 · 75cf50f · 75cf50f
1 parent 2e643b7
commit 75cf50f
Show file tree

Hide file tree

Showing 84 changed files with 3,582 additions and 8,162 deletions.
diff --git a/.gitignore b/.gitignore
@@ -73,7 +73,6 @@ _partials/index.ts
 # Ignore statoc/img/packs
 static/img/packs
 
-
 .vale-config/
 vale/styles/spectrocloud/
 vale/styles/spectrocloud-docs-internal/

diff --git a/README.md b/README.md
@@ -26,7 +26,7 @@ To contribute, we recommend having the following software installed locally on y
 
 - Node.js v20 and npm.
 
-- [Vale](https://vale.sh/docs/vale-cli/installation/)
+- [Vale](https://vale.sh/docs/vale-cli/installation/), version 3.6.0 or higher.
 
 ## Local Development (Docker)
 

diff --git a/_partials/feature_flags/_feature_flags_overview.mdx b/_partials/feature_flags/_feature_flags_overview.mdx
@@ -0,0 +1,68 @@
+---
+partial_category: feature-flags
+partial_name: feature-flags-overview
+---
+
+<!-- prettier-ignore -->
+Feature flags allow <PaletteURL text="system administrators" edition={props.edition}  url="/system-management/account-management/#system-administrators" /> to 
+manage what features are available to the system's tenants. They can use this capability to roll out new features to {props.edition} tenants in a controlled manner or choose not to implement a feature for their tenants due to security or compliance reasons.
+
+Features enabled by system administrators are applied to all tenants in the system. Once a feature is enabled, it cannot
+be disabled.
+
+:::warning
+
+We recommend trying out new features in a test environment before enabling them in a production environment. Depending
+on the feature, enabling it may have a significant impact on the system and current workloads.
+
+:::
+
+Review the following section for detailed instructions on enabling and managing feature flags.
+
+## Enable a Feature
+
+Use the following steps to enable a feature flag.
+
+## Prerequisites
+
+- You are a system administrator of the type _Operations Administrator_ or _Root Administrator_.
+
+- You have access to the system console.
+
+## Enablement
+
+<!-- prettier-ignore -->
+1. Log in to the system console. For additional guidance on accessing the system console, check out the
+   <PaletteURL
+     edition={props.edition}
+     text="Access the System Console"
+     url="/system-management/#access-the-system-console"
+   /> guide.
+
+2. From the left **Main Menu**, select **Administration**.
+
+3. Select the **Feature Flags** tab.
+
+4. Locate the feature you want to enable and toggle the switch on the right to enable it. You can also search
+   for a feature by typing the feature name in the search bar.
+
+## Validate
+
+Use the following steps to validate that the feature flag is enabled.
+
+1. Log in as a tenant administrator to one of the tenants in the system.
+
+2. Attempt to access the enabled feature flag. If the feature is enabled, you will be able to use it. If the feature is
+   disabled, you will not be able to access it.
+
+export function PaletteURL({ edition, text, url }) {
+  return (
+    <>
+      {edition.toLowerCase() === "palette" ? (
+        <VersionedLink text={text} url={`/enterprise-version${url}`} />
+      ) : (
+        <VersionedLink text={text} url={`/vertex${url}`} />
+      )}
+    </>
+  );
+}
diff --git a/docs/api-content/api-docs/1-introduction.md b/docs/api-content/api-docs/1-introduction.md
@@ -8,7 +8,7 @@ sidebar_custom_props:
   icon: "graph"
 ---
 
-The API documentation section includes documentation for Palette API and Local Management API.
+The API documentation section includes documentation for Palette API and Edge Management API.
 
 ## Palette API
 
@@ -260,15 +260,15 @@ The API rate limits are as follows:
 | /v1/clusterprofiles/:uid/validate/packs                                                 | 50                     | 5              | 250                |
 | /v1/spectroclusters/:uid/profiles                                                       | 50                     | 5              | 250                |
 
-## Local Management API
+## Edge Management API
 
 An Edge host has its own set of API endpoints. These API endpoints are available on each Edge host instead of on a
-Palette instance. You can use Local Management API endpoints to programmatically perform tasks such as retrieve
+Palette instance. You can use Edge Management API endpoints to programmatically perform tasks such as retrieve
 information about Edge clusters, retrieve the list of available images on your Edge host, and create local clusters
 using embedded cluster definitions.
 
-You can find the Open API Swagger specification for the Local Management API at the following location:
-https://raw.githubusercontent.com/spectrocloud/librarium/version-4-3/docs/api-content/api-docs/edge-v1/emc-api.json
+You can find the Open API Swagger specification for the Edge Management API at the following location:
+https://raw.githubusercontent.com/spectrocloud/librarium/version-4-4/docs/api-content/api-docs/edge-v1/emc-api.json
 
 :::preview
 
@@ -395,3 +395,19 @@ curl --location 'https://10.10.135.182:5080/v1/edge-mgmt/edgehosts/current' \
     }
 }
 ```
+
+### List of Endpoints Unavailable to Connected Edge Hosts
+
+Most Edge Management API endpoints are available for Edge hosts with or without a connection to Palette. However, some
+endpoints are not available to connected Edge hosts and are available to airgapped Edge hosts only. Specifically,
+endpoints that create or update clusters, create or update cluster profile variables, and update cluster settings are
+unavailable, as those operations must be performed from Palette.
+
+The following is a list of endpoints that are only available to Edge hosts that are not connected to Palette:
+
+- `POST https://edge-host-ip:5080/v1/edge-mgmt/cluster`
+- `PATCH https://edge-host-ip:5080/v1/edge-mgmt/cluster`
+- `PUT https://edge-host-ip:5080/v1/edge-mgmt/cluster`
+- `PUT https://edge-host-ip:5080/v1/edge-mgmt/cluster/profiles`
+- `PUT https://edge-host-ip:5080/v1/edge-mgmt/cluster/settings`
+- `POST https://edge-host-ip:5080/v1/edge-mgmt/cluster/profiles/variables/validate`
diff --git a/docs/api-content/api-docs/edge-v1/emc-api.json b/docs/api-content/api-docs/edge-v1/emc-api.json
@@ -11,7 +11,7 @@
   ],
   "swagger": "2.0",
   "info": {
-    "title": "Edge Management APIs",
+    "title": "Local Management APIs",
     "version": "v1"
   },
   "paths": {
@@ -564,6 +564,42 @@
         }
       }
     },
+    "/v1/edge-mgmt/edgehosts/current/actions/content/signing-public-key": {
+      "get": {
+        "description": "Get the base64 encoded key used to verify the signed content.",
+        "tags": [
+          "content"
+        ],
+        "summary": "Get the public key used to verify the signed content.",
+        "operationId": "V1GetContentSigningPublicKey",
+        "responses": {
+          "200": {
+            "description": "(empty)",
+            "schema": {
+              "$ref": "#/definitions/v1ContentSigningKey"
+            }
+          },
+          "404": {
+            "description": "Not found",
+            "schema": {
+              "$ref": "#/definitions/v1Error"
+            }
+          },
+          "500": {
+            "description": "Internal server error",
+            "schema": {
+              "$ref": "#/definitions/v1Error"
+            }
+          },
+          "default": {
+            "description": "generic error response",
+            "schema": {
+              "$ref": "#/definitions/apiError"
+            }
+          }
+        }
+      }
+    },
     "/v1/edge-mgmt/edgehosts/current/actions/reboot": {
       "post": {
         "description": "Reboot edge host",
@@ -656,10 +692,16 @@
         "parameters": [
           {
             "type": "file",
-            "description": "The archive file to be uploaded.",
+            "description": "The clusterconfig file to be uploaded.",
             "name": "uploadFile",
             "in": "formData",
             "required": true
+          },
+          {
+            "type": "file",
+            "description": "The signature for the corresponding cluster config to be uploaded.",
+            "name": "signature",
+            "in": "formData"
           }
         ],
         "responses": {
@@ -696,6 +738,12 @@
             "name": "uploadFile",
             "in": "formData",
             "required": true
+          },
+          {
+            "type": "file",
+            "description": "The signature for the corresponding archive file to be uploaded.",
+            "name": "signature",
+            "in": "formData"
           }
         ],
         "responses": {
@@ -952,6 +1000,30 @@
         }
       }
     },
+    "/v1/edge-mgmt/settings": {
+      "get": {
+        "description": "Get general settings",
+        "tags": [
+          "settings"
+        ],
+        "summary": "Get general settings",
+        "operationId": "v1Settings",
+        "responses": {
+          "200": {
+            "description": "(empty)",
+            "schema": {
+              "$ref": "#/definitions/v1Settings"
+            }
+          },
+          "default": {
+            "description": "generic error response",
+            "schema": {
+              "$ref": "#/definitions/apiError"
+            }
+          }
+        }
+      }
+    },
     "/v1/ping": {
       "get": {
         "description": "Ping Service",
@@ -1679,11 +1751,21 @@
             "$ref": "#/definitions/v1ClusterNodePoolStatus"
           }
         },
+        "ntpServersApplied": {
+          "type": "boolean",
+          "default": false,
+          "x-isnullable": false
+        },
         "services": {
           "type": "array",
           "items": {
             "$ref": "#/definitions/v1Service"
           }
+        },
+        "sshKeysApplied": {
+          "type": "boolean",
+          "default": false,
+          "x-isnullable": false
         }
       }
     },
@@ -1776,6 +1858,21 @@
         "Airgap"
       ]
     },
+    "v1ContentSigningKey": {
+      "type": "object",
+      "properties": {
+        "creationTimestamp": {
+          "description": "CreationTimestamp is the timestamp when the resource was created.",
+          "$ref": "#/definitions/v1Time"
+        },
+        "description": {
+          "type": "string"
+        },
+        "key": {
+          "type": "string"
+        }
+      }
+    },
     "v1DNS": {
       "type": "object",
       "properties": {
@@ -2086,12 +2183,6 @@
           "type": "string",
           "default": ""
         },
-        "isTwoNodeCandidate": {
-          "description": "Enable this flag to support 2-Node HA mode. True indicates this edgehost which act as the recovery node. It is a immutable field can be set only during cluster provisioning.",
-          "type": "boolean",
-          "default": false,
-          "x-omitempty": false
-        },
         "nic": {
           "description": "Edge native nic",
           "$ref": "#/definitions/v1Nic"
@@ -2103,6 +2194,14 @@
         "staticIP": {
           "description": "Deprecated. Edge host static IP",
           "type": "string"
+        },
+        "twoNodeCandidatePriority": {
+          "description": "Set the edgehost candidate priority as primary or secondary, if the edgehost is nominated as two node candidate",
+          "type": "string",
+          "enum": [
+            "primary",
+            "secondary"
+          ]
         }
       }
     },
@@ -2751,6 +2850,9 @@
         "name": {
           "type": "string"
         },
+        "values": {
+          "type": "string"
+        },
         "version": {
           "type": "string"
         }
@@ -2829,6 +2931,9 @@
         "type": {
           "type": "string"
         },
+        "values": {
+          "type": "string"
+        },
         "version": {
           "type": "string"
         }
@@ -2985,6 +3090,22 @@
         }
       }
     },
+    "v1Settings": {
+      "type": "object",
+      "properties": {
+        "hasHarborPack": {
+          "type": "boolean",
+          "default": false
+        },
+        "installationMode": {
+          "type": "string",
+          "enum": [
+            "airgap",
+            "connected"
+          ]
+        }
+      }
+    },
     "v1State": {
       "type": "string",
       "enum": [
@@ -3053,6 +3174,11 @@
       "description": "Current user information",
       "type": "object",
       "properties": {
+        "disablePasswordUpdate": {
+          "description": "Flag to indicate if the user is allowed to update the password",
+          "type": "boolean",
+          "default": false
+        },
         "sshKeys": {
           "description": "Current user's ssh keys",
           "type": "array",