fix: 4-5-5 patch release updates (#4485)

* docs: add edge cli checksum, add 2.0.0 byos pack steps * docs: update compatibility matrix and spectro-registry image * docs: update edge managament api for 4.5.5 (#4486) Co-authored-by: Lenny Chen <[email protected]> * docs: update compatibility matrix * docs: fix vertex upgrade path --------- Co-authored-by: Lenny Chen <[email protected]> Co-authored-by: Lenny Chen <[email protected]>
spectrocloud · Oct 28, 2024 · 001876c · 001876c
1 parent d1c5d81
commit 001876c
Show file tree

Hide file tree

Showing 7 changed files with 133 additions and 15 deletions.
diff --git a/docs/api-content/api-docs/edge-v1/emc-api.json b/docs/api-content/api-docs/edge-v1/emc-api.json
@@ -49,12 +49,13 @@
         }
       },
       "patch": {
-        "description": "Updates a cluster with the provided cluster configuration",
+        "description": "DEPRECATED - This endpoint is deprecated and will be removed in future versions. Use /v1/edge-mgmt/cluster/{clusterName} instead",
         "tags": [
           "edge-mgmt"
         ],
-        "summary": "Updates a cluster with the provided cluster configuration",
-        "operationId": "v1UpdateCluster",
+        "summary": "DEPRECATED - This endpoint is deprecated and will be removed in future versions. Use /v1/edge-mgmt/cluster/{clusterName} instead",
+        "operationId": "v1PatchCluster",
+        "deprecated": true,
         "parameters": [
           {
             "name": "body",
@@ -400,6 +401,86 @@
         }
       }
     },
+    "/v1/edge-mgmt/cluster/{clusterName}": {
+      "put": {
+        "description": "Updates a cluster with the provided cluster configuration",
+        "tags": [
+          "edge-mgmt"
+        ],
+        "summary": "Updates a cluster with the provided cluster configuration",
+        "operationId": "v1UpdateClusterConfig",
+        "parameters": [
+          {
+            "type": "string",
+            "description": "Name of the cluster to be updated",
+            "name": "clusterName",
+            "in": "path",
+            "required": true
+          },
+          {
+            "name": "body",
+            "in": "body",
+            "required": true,
+            "schema": {
+              "$ref": "#/definitions/v1ClusterConfiguration"
+            }
+          }
+        ],
+        "responses": {
+          "202": {
+            "description": "(empty)",
+            "schema": {
+              "$ref": "#/definitions/v1AcceptedResponseWithMessage"
+            }
+          },
+          "500": {
+            "description": "Internal server error",
+            "schema": {
+              "$ref": "#/definitions/v1Error"
+            }
+          }
+        }
+      },
+      "patch": {
+        "description": "Patch a cluster with the provided cluster configuration",
+        "tags": [
+          "edge-mgmt"
+        ],
+        "summary": "Patch a cluster with the provided cluster configuration",
+        "operationId": "v1PatchClusterConfig",
+        "parameters": [
+          {
+            "type": "string",
+            "description": "Name of the cluster to be patched",
+            "name": "clusterName",
+            "in": "path",
+            "required": true
+          },
+          {
+            "name": "body",
+            "in": "body",
+            "required": true,
+            "schema": {
+              "$ref": "#/definitions/v1ClusterPatch"
+            }
+          }
+        ],
+        "responses": {
+          "202": {
+            "description": "(empty)",
+            "schema": {
+              "$ref": "#/definitions/v1AcceptedResponseWithMessage"
+            }
+          },
+          "500": {
+            "description": "Internal server error",
+            "schema": {
+              "$ref": "#/definitions/v1Error"
+            }
+          }
+        }
+      }
+    },
     "/v1/edge-mgmt/clusters/archive/embedded/details": {
       "get": {
         "description": "parses the cluster-config archive.",
@@ -2048,6 +2129,17 @@
         }
       }
     },
+    "v1ClusterPatch": {
+      "type": "object",
+      "properties": {
+        "clusterConfigPatches": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/v1HttpPatch"
+          }
+        }
+      }
+    },
     "v1ClusterProfileConfiguration": {
       "description": "v1ClusterProfileConfiguration is the configuration required to update a cluster's profiles.",
       "type": "object",
@@ -3063,6 +3155,32 @@
         }
       }
     },
+    "v1HttpPatch": {
+      "type": "object",
+      "required": [
+        "op",
+        "path"
+      ],
+      "properties": {
+        "op": {
+          "description": "The operation to be performed",
+          "type": "string",
+          "enum": [
+            "add",
+            "remove",
+            "replace"
+          ]
+        },
+        "path": {
+          "description": "A path to the pointer on which operation will be done",
+          "type": "string"
+        },
+        "value": {
+          "description": "The value to be used within the operations.",
+          "type": "object"
+        }
+      }
+    },
     "v1InternalServerError": {
       "description": "Internal Server Error"
     },

diff --git a/docs/docs-content/component.md b/docs/docs-content/component.md
@@ -16,6 +16,8 @@ This page lists the version details of various Palette components and their resp
 
 | Palette Release | Recommended CLI Version |
 | --------------- | ----------------------- |
+| Release 4.5.5   | v4.5.0                  |
+| Release 4.5.4   | v4.5.0                  |
 | Release 4.5.3   | v4.5.0                  |
 | Release 4.4.18  | v4.4.8                  |
 | Release 4.4.14  | v4.4.6                  |
@@ -33,6 +35,8 @@ This page lists the version details of various Palette components and their resp
 
 | Palette Release | CLI Version |
 | --------------- | ----------- |
+| Release 4.5.5   | v4.5.5      |
+| Release 4.5.4   | v4.5.3      |
 | Release 4.5.3   | v4.5.3      |
 | Release 4.4.18  | v4.4.12     |
 | Release 4.4.14  | v4.4.8      |

diff --git a/docs/docs-content/deployment-modes/agent-mode/install-agent-host.md b/docs/docs-content/deployment-modes/agent-mode/install-agent-host.md
@@ -222,17 +222,12 @@ Palette. You will then create a cluster profile and use the registered host to d
 
 14. Select **Edge Native** as the **Cloud Type** and click **Next**.
 
-<!-- 15. The **Profile Layers** section specifies the packs that compose the profile. Add the **BYOS Edge OS** pack version
-    **2.0.0** to the OS layer. -->
-
 15. The **Profile Layers** section specifies the packs that compose the profile. Add the **BYOS Edge OS** pack version
-    **1.0.0** to the OS layer.
-
-<!-- 16. Click **Values** under **Pack Details**, then click on **Presets** on the right-hand side. Select **Agent Mode**. -->
+    **2.0.0** to the OS layer.
 
-    <!-- ![View of the cluster profile creation page with the BYOS pack.](/deployment-modes_agent-mode_byos-pack.webp) -->
+16. Click **Values** under **Pack Details**, then click on **Presets** on the right-hand side. Select **Agent Mode**.
 
-16. Click **Values** under **Pack Details**, and set `system.uri` to `NA`.
+    ![View of the cluster profile creation page with the BYOS pack.](/deployment-modes_agent-mode_byos-pack.webp)
 
 17. Click **Next Layer** to continue.
 

diff --git a/docs/docs-content/enterprise-version/upgrade/upgrade.md b/docs/docs-content/enterprise-version/upgrade/upgrade.md
@@ -35,6 +35,7 @@ minor version available.
 
 | **Source Version** | **Target Version** |    **Support**     |
 | :----------------: | :----------------: | :----------------: |
+|       4.5.3        |       4.5.5        | :white_check_mark: |
 |       4.5.3        |       4.5.4        | :white_check_mark: |
 |       4.4.20       |       4.5.3        | :white_check_mark: |
 |       4.4.6        |       4.5.3        | :white_check_mark: |

diff --git a/docs/docs-content/registries-and-packs/advanced-configuration.md b/docs/docs-content/registries-and-packs/advanced-configuration.md
@@ -73,7 +73,7 @@ docker run -d \
     -e REGISTRY_LOG_LEVEL=debug \
     -e REGISTRY_AUTH=htpasswd \
     -e REGISTRY_AUTH_HTPASSWD_REALM="My Enterprise Realm" \
-    gcr.io/spectro-images-public/release/spectro-registry:4.4.0
+    us-docker.pkg.dev/palette-images/palette/spectro-registry:4.5.0
 ```
 
 Alternatively, you can start the container by mounting a directory with a new configuration file and pointing the server
@@ -85,7 +85,7 @@ docker run -d \
     -p 443:5000 \
     --name spectro-registry \
     --volume $(pwd)/myconfig.yml:/etc/myconfig.yml \
-    gcr.io/spectro-images-public/release/spectro-registry:4.4.0 \
+    us-docker.pkg.dev/palette-images/palette/spectro-registry:4.5.0 \
     serve /etc/spectropaxconfig/myconfig.yml
 ```
 

diff --git a/docs/docs-content/spectro-downloads.md b/docs/docs-content/spectro-downloads.md
@@ -31,5 +31,5 @@ the [Palette CLI](./automation/palette-cli/palette-cli.md) document for installa
 
 | Version | Operating System                                                                      | Checksum (SHA256)                                                  |
 | ------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
-| 4.5.5   | [Linux-amd64](https://software.spectrocloud.com/stylus/v4.5.5/cli/linux/palette-edge) | ``                                                                 |
+| 4.5.5   | [Linux-amd64](https://software.spectrocloud.com/stylus/v4.5.5/cli/linux/palette-edge) | `f93382a7ab92e9621f47d857252c2673b33de79735cf729fcb4b2fb24719d537` |
 | 4.5.3   | [Linux-amd64](https://software.spectrocloud.com/stylus/v4.5.3/cli/linux/palette-edge) | `9008f77d11b0129c35d2c9da6bb29a09ca6bc63ffa27d828996d30ac4c853c28` |
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "spectro-cloud-docs",
-  "version": "4.5.4",
+  "version": "4.5.5",
   "private": true,
   "scripts": {
     "docusaurus": "docusaurus",