Skip to content

Commit

Permalink
docs: document trusted boot (#2612)
Browse files Browse the repository at this point in the history
* feat: release 4.3

* docs: add instructions for first boot tui (#2141)

* add instructions for first boot tui

* change page position

* remove QR code registration

* add cross reference

* add first boot condition

* Optimised images with calibre/image-actions

* Apply suggestions from code review

Co-authored-by: Yuliia Horbenko <31223054+yuliiiah@users.noreply.github.com>

* Update docs/docs-content/clusters/edge/site-deployment/site-installation/edge-host-registration.md

* make format

* add additional detail

* docs: add changes to tui

* add installer reference

---------

Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Yuliia Horbenko <31223054+yuliiiah@users.noreply.github.com>

* Update Nutanix Docs to capture changes in the cluster creation workflows (#2226)

* chore: Fix alignment in all Nutanix topics

* chore: Fix command template

* docs: Interim progress for the new Nutanix cluster creation UI

* docs: Finish describing fields for node pool configuration

* Apply suggestions from code review

Co-authored-by: caroldelwing <carolina.delwing@spectrocloud.com>
Co-authored-by: Karl Cardenas <karl@spectrocloud.com>

* chore: Fix formatting

* docs: Change the optional field description

---------

Co-authored-by: caroldelwing <carolina.delwing@spectrocloud.com>
Co-authored-by: Karl Cardenas <karl@spectrocloud.com>

* docs: add cluster update behavior (#2134)

* docs: airgap refactor DOC-1044 DOC-1043 DOC-973

* docs: updated diagram

* chore: more content

* docs: added more steps

* chore: save

* chore: save

* chore: merged master

* docs: more step

* save

* docs: updated airgap VMware step

* docs: DOC-1044 metalLB limitation

* docs: DOC-1043 Grafana issue

* docs: language cleanup

* docs: ready for ent refactpr

* docs: added OVAs

* docs: prep for palette airgap

* docs: save

* docs: final touches

* docs: vale feedback

* Optimised images with calibre/image-actions

* Apply suggestions from code review

Co-authored-by: Yuliia Horbenko <31223054+yuliiiah@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Yuliia Horbenko <31223054+yuliiiah@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Yuliia Horbenko <31223054+yuliiiah@users.noreply.github.com>

* docs: feedback - manual

* Apply suggestions from code review

Co-authored-by: Yuliia Horbenko <31223054+yuliiiah@users.noreply.github.com>

* docs: ready for merge

* chore: prettier fix

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Yuliia Horbenko <31223054+yuliiiah@users.noreply.github.com>

* docs: add cluster update behavior

* chore: added missing refactor page (#2137)

* chore: added missing refactor page

* chore: vale feedback

* add repage behavior

* fix linking issue

* address vale comments

* Apply suggestions from code review

Co-authored-by: caroldelwing <carolina.delwing@spectrocloud.com>
Co-authored-by: Karl Cardenas <karl@spectrocloud.com>

* incorporate feedback

* docs: change minimum disk size for Edge (#2132)

* change minimum disk size

* Update docs/docs-content/clusters/edge/architecture.md

---------

Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com>

* change li elements

* run prettier

* fix orphan

---------

Co-authored-by: Karl Cardenas <karl@spectrocloud.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Yuliia Horbenko <31223054+yuliiiah@users.noreply.github.com>
Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com>
Co-authored-by: caroldelwing <carolina.delwing@spectrocloud.com>

* docs: PEM-4571 multi-account (#2296)

* docs: PEM-4571 multi-account

* docs: ready for review

* docs: fixed broken link

* Optimised images with calibre/image-actions

* docs: updated passwork reset link limitation

* docs: updated header

* Apply suggestions from code review

Co-authored-by: Lenny Chen <55669665+lennessyy@users.noreply.github.com>

* docs: PM feedback

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Lenny Chen <55669665+lennessyy@users.noreply.github.com>

* docs: PEM-4571 Password Blocklist (#2304)

* docs: PEM-4571 multi-account

* docs: ready for review

* docs: fixed broken link

* Optimised images with calibre/image-actions

* docs: updated passwork reset link limitation

* docs: updated header

* docs: PEM-4299

* chore: pwd lenght

* docs: updated content

* docs: apply suggestions from code review

Co-authored-by: Lenny Chen <55669665+lennessyy@users.noreply.github.com>

* docs: added blocklist content to Palette

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Lenny Chen <55669665+lennessyy@users.noreply.github.com>

* docs: PCP-2510 Konvoy (#2319)

* docs: PCP-2510

* docs: added folders

* docs: added more content

* docs: konvoy build steps

* docs: minor adjustment

* docs: added packs page

* docs: merged release-4-3

* docs: ready for review

* Apply suggestions from code review

Co-authored-by: Adelina Simion <43963729+addetz@users.noreply.github.com>

* Optimised images with calibre/image-actions

* docs: feedback

---------

Co-authored-by: Adelina Simion <43963729+addetz@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* chore: document EMC API endpoints (#2340)

* chore: edge API WIP

* modify emc api

* modify base URL

* clean up script to generate edge API

* update emc swagger file

* Update docs/api-content/api-docs/1-introduction.md

Co-authored-by: Karl Cardenas <karl@spectrocloud.com>

* Update docs/api-content/api-docs/1-introduction.md

* docs: removed TP from H2 heading

* chore: adding tech previw callout

---------

Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com>
Co-authored-by: Lenny Chen <55669665+lennessyy@users.noreply.github.com>

* docs: document namespace-based image swap diabling (#2352)

* docs: add imageswap disabling documentation

* slight edits

* Vale comments

* nginx

* typo

* mode content out of tab

* Update docs/docs-content/integrations/harbor-edge.md

* address review comments

* fix typo

* add example

* Update docs/docs-content/integrations/harbor-edge.md

Co-authored-by: Karl Cardenas <karl@spectrocloud.com>

---------

Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com>
Co-authored-by: Karl Cardenas <karl@spectrocloud.com>

* docs: PCP-2494 custom MAAS Endpoint (#2363)

* docs: PCP-2494 content

* docs: vale feedback

* docs: vale feedback

* Apply suggestions from code review

Co-authored-by: Adelina Simion <43963729+addetz@users.noreply.github.com>

* docs: PCP-2494

---------

Co-authored-by: Adelina Simion <43963729+addetz@users.noreply.github.com>

* docs: PCP-2607 (#2369)

* docs: document edge management console (#2186)

* add instructions for first boot tui

* change page position

* remove QR code registration

* add cross reference

* add first boot condition

* add emc login functionality

* add draft on customizing ui

* add steps on creating local cluster

* modify build artifacts step

* docs: write about provider images

* add steps for building iso

* edit provider image

* docs: add upload content

* fix bad quotes

* fix broken link

* minor fixes

* add credential providing instructions

* fix tab item issue

* add instructions for exporting cluster definition

* add arg files instructions

* fix repeated word

* Optimised images with calibre/image-actions

* add info note on provider images page

* modify wording about user data

* add proxy configuration steps

* add new changes

* repeated word

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <karl@spectrocloud.com>

* small changes

* work on feedback

* Optimised images with calibre/image-actions

* Address feedback

* fix broken links

* fix broken links

* address comments

* address feedback

* address more comments

* address review comments

* add QR code registration back

* add note about proxy setting after reset

* add note about local registry

* Optimised images with calibre/image-actions

* docs: add note about duplicate profile layers

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <karl@spectrocloud.com>

* Update docs/docs-content/clusters/edge/edge-configuration/installer-reference.md

* fix tui acronym use

* docs: fix prereq

* update diagram

* Optimised images with calibre/image-actions

---------

Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Karl Cardenas <karl@spectrocloud.com>

* docs: 4.3 API Docs (#2376)

* 4.3 API Docs

* chore: fix prettier

---------

Co-authored-by: Karl Cardenas <karl@spectrocloud.com>

* Update the TechPreview component to also accept custom text (#2377) (#2379)

* chore: Update the TechPreview component to also accept custom text

* chore: Fix the linter warning and clean up CSS a bit

* docs:  PLT-1080 FIPS Validate Command (#2384)

* save

* docs: PLT-1080

* docs: add more content

* docs: updates

* docs: vale feedback

* Apply suggestions from code review

Co-authored-by: Adelina Simion <43963729+addetz@users.noreply.github.com>

* docs: feedback

---------

Co-authored-by: Adelina Simion <43963729+addetz@users.noreply.github.com>

* docs: add the command to bring up TUI before cluster deployment (#2387)

* docs: add tui day 2 instructions

* minor edits

* Update docs/docs-content/clusters/edge/site-deployment/initial-setup.md

Co-authored-by: caroldelwing <carolina.delwing@spectrocloud.com>

---------

Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com>
Co-authored-by: caroldelwing <carolina.delwing@spectrocloud.com>

* Cluster Profile Variables (#2343)

* docs: Prelim profile variables topic placement + fix alignment in the Profiles section

* docs: Profile variables draft

* docs: Implement Vale review

* Optimised images with calibre/image-actions

* docs: Implement SME review and edit the text a bit

* docs: Define profile variables in the glossary

* docs: Implement peer review

* Optimised images with calibre/image-actions

* docs: Update the structure

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* docs: DOC-1100 validator updates (#2388)

* docs: validator updates

* docs: update describe section

* docs: added example

* docs: added more context to the upgrade command

* docs: aDOC-1100 apply suggestions from code review

Co-authored-by: Yuliia Horbenko <31223054+yuliiiah@users.noreply.github.com>

* docs: prettier fix

---------

Co-authored-by: Yuliia Horbenko <31223054+yuliiiah@users.noreply.github.com>

* docs: replace EMC with local ui (#2392)

* replace EMC with local UI

* change filename to local-ui.md

* fix broken anchors

* fix broken link

* make local ui common noun

* common noun local ui

* fix typos

* change edge host API name

---------

Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com>

* Change EMC to local UI and fix all links (#2406)

* chore: Fix link formatting

* chore: Change EMC to local UI and fix all links

* Update cluster creation guides + Refactor Azure AKS (#2405)

* docs: Update the AWS EKS guide

* docs: Update the AWS IaaS guide

* docs: Update the Azure IaaS guide

* docs: Start updating the Azure AKS guide

* docs: Update the GCP IaaS guide

* docs: Update the GCP GKE guide

* docs: Update the TKE guide

* docs: Remove a note from the TKE guide

* docs: Continue  updating the Azure AKS guide

* docs: Continue  updating the Azure AKS guide

* docs: Finish updating the Azure AKS guide

* docs: Update the MAAS guide

* docs: Update the Nutanix guide

* chore: Fix a broken anchor

* chore: Implement the Vale feedback

* chore: Fix more broken anchors

* chore: Fix even more broken anchors

* docs: Implement peer review

* docs: address PE-4011 and PE-3874 (#2398)

* docs: address PE-4011

* docs: add PE-3874

* address review comments

---------

Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com>

* docs: add section for custom image registry options (#2386)

* docs: add content for custom image registries

* fix broken link

* docs: add prerequisites

* add corrections

* add redirects

* Apply suggestions from code review

Co-authored-by: Yuliia Horbenko <31223054+yuliiiah@users.noreply.github.com>

* address review comments

* docs: add instructions for using palette edge cli

* fix broken links

* add clarification

* docs: add clarifications

* Optimised images with calibre/image-actions

---------

Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com>
Co-authored-by: Yuliia Horbenko <31223054+yuliiiah@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* docs: add rook ceph documentation (#2412)

* docs: add rook ceph documentation

* docs: small edit

* Apply suggestions from code review

Co-authored-by: Yuliia Horbenko <31223054+yuliiiah@users.noreply.github.com>

* prettier

---------

Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com>
Co-authored-by: Yuliia Horbenko <31223054+yuliiiah@users.noreply.github.com>

* docs: Update the PXK and PXK-E packs docs (#2423)

* docs: Update the PXK and PXK-E packs docs

* docs: Implement Vale feedback

* chore: Fix gitleaks

* docs: Update the K3s and RKE2 packs docs

* docs: DOC-1090 PCP-2590 PE-3943  4.3 Release Notes (#2342)

* docs: DOC-1090

* save

* docs: PCP-2590

* chore: branch switch

* docs: save

* docs: more content

* chore: save

* chore: added css property

* chore: added TechnicalPreviewReleaseNoteBadge component

* docs: ready to implement

* chore: updated README

* docs: new content

* docs: more content

* chore: added packs

* docs: added reference page

* docs: fixed vertex label

* docs: fixed broken link

* docs: update

* docs: updated packs

* chore: updated release notes

* docs: added new links

* docs: updated release notes with PCG update

* chore: vale feedback

* chore: fix jest

* modify private external registry bullet

* docs: Apply suggestions from code review

Co-authored-by: Lenny Chen <55669665+lennessyy@users.noreply.github.com>

* docs: feedback

---------

Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com>
Co-authored-by: Lenny Chen <55669665+lennessyy@users.noreply.github.com>

* docs: change edge harbor hardware requirements (#2413)

* docs: change edge harbor hardware requirements

* fix unfinished sentence

* clarify single node

* add fixes

---------

Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com>

* docs: PLT-1100 added docs for Palette EC install (#2428)

* docs: PLT-1100 added docs for Palette EC install

* docs: add VerteX steps

* chore: fixed gitleaks

* chore: gitleaks

* chore: revert eager load removal

* Apply suggestions from code review

Co-authored-by: Yuliia Horbenko <31223054+yuliiiah@users.noreply.github.com>

* chore: prettier fix

---------

Co-authored-by: Yuliia Horbenko <31223054+yuliiiah@users.noreply.github.com>

* docs: fix find/replace issue

* docs: merge master and DOC-1117

* docs: updated release notes

* Update download URLs (#2481)

* docs: Update download URLs

* docs: Edit a missed version reference

* docs: document how to generate FIPS-compliant Edge artifacts (#2462)

* docs: WIP fips images

* docs: fips first draft

* docs: fips-canvos

* docs: add fips instructions

* docs: fix tabs issue

* docs: copyedits

* fix vale issues

* docs: minor edits

* fix vale

* fix step numbering

* Apply suggestions from code review

Co-authored-by: Yuliia Horbenko <31223054+yuliiiah@users.noreply.github.com>

* make format

* clarify pxk-e

* punctuation

---------

Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com>
Co-authored-by: Yuliia Horbenko <31223054+yuliiiah@users.noreply.github.com>

* docs: update open source licenses list (#2485)

* docs: add update cluster section (#2482)

* docs: add update cluster section

* docs: apply suggestions from review

* Apply suggestions from code review

Co-authored-by: Yuliia Horbenko <31223054+yuliiiah@users.noreply.github.com>

* docs: add suggestions from pr review

---------

Co-authored-by: Yuliia Horbenko <31223054+yuliiiah@users.noreply.github.com>

* docs: DOC-1127 (#2486)

* docs: DOC-1127

* Apply suggestions from code review

Co-authored-by: Adelina Simion <43963729+addetz@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Adelina Simion <43963729+addetz@users.noreply.github.com>

* chore: fix format issue

---------

Co-authored-by: Adelina Simion <43963729+addetz@users.noreply.github.com>

* docs: add note to change Longhorn images to reference harbor (#2497)

* docs: add requirement to change longhorn image base URL

* Update docs/docs-content/integrations/longhorn.md

* Update docs/docs-content/integrations/longhorn.md

* move procedure to usage

* fix syntax issue

---------

Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com>

* chore: update release notes date

* generate keys

* add more content about keys

* docs: add information about keys

* Apply suggestions from code review

Co-authored-by: Ettore Di Giacinto <mudler@users.noreply.github.com>

* add key table

* Update key-management.md

* enroll keys file start

* add instructions for exporting keys

* create skeleton documents

* docs: add install document

* add installation instructions

* docs: add additional pages to trusted boot

* remove redundant redirect

* make further updates to trusted boot

* change to webp

* update image format

* add boot diagram

* add resources to index page

* add image

* add image

* fix redirects

* arrange pages in order

* fix broken links

* add instructions for corporate CA

* update folder structure

* add two new topics

* partial update efi limit

* add instructions on how to add content

* add new image

* docs: update image format

* docs: add EFI check documentation

* docs: add warning for trusted boot

* docs: address vale

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* chore: updated netlify.sh

* docs: incorporate feedback

* Apply suggestions from code review

Co-authored-by: antongisli <anton@spectrocloud.com>

* docs: address comments

* docs: edit for clarify

* copy edit

* docs: address comments

* docs: update images

* update image

* Optimised images with calibre/image-actions

* docs: fix image ref

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* update image

* update image

* Optimised images with calibre/image-actions

* docs: add limitation

* PE-4465 add warning about manual key enrollment

* docs: adjust page ordering

* docs: incorporate feedback

* docs: address review comments

* docs: address review comments

* docs: minor edits

* docs: minior edits

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <karl@spectrocloud.com>

* docs: prettier format

* docs: copy edits

* docs: add crosslink

* docs: vale comments

* docs: fix typo

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* docs: add links to parent pages

* docs: add preview flag to trusted boot

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <karl@spectrocloud.com>

* docs: address feedback

* prettier formatting

* docs: add limitation and git link

---------

Co-authored-by: Karl Cardenas <karl@spectrocloud.com>
Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Yuliia Horbenko <31223054+yuliiiah@users.noreply.github.com>
Co-authored-by: caroldelwing <carolina.delwing@spectrocloud.com>
Co-authored-by: Adelina Simion <43963729+addetz@users.noreply.github.com>
Co-authored-by: Prathab Kali <prathab@spectrocloud.com>
Co-authored-by: Ettore Di Giacinto <mudler@users.noreply.github.com>
Co-authored-by: antongisli <anton@spectrocloud.com>
Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
  • Loading branch information
11 people authored Jun 6, 2024
1 parent 19754ce commit 29fa874
Show file tree
Hide file tree
Showing 28 changed files with 1,835 additions and 21 deletions.
2 changes: 1 addition & 1 deletion _partials/index.ts
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
// This file is generated. DO NOT EDIT!
export * as partialexample10148 from '@site/_partials/_partial_example.mdx';
export * as partialexample4372 from '@site/_partials/_partial_example.mdx';
4 changes: 4 additions & 0 deletions docs/docs-content/clusters/edge/edge.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,4 +75,8 @@ specific challenges with additional software.

- [Site Deployment](site-deployment/site-deployment.md)

- [Trusted Boot](trusted-boot/trusted-boot.md)

- [Networking](networking/networking.md)

- [Third-Party Integration](third-party-integrations/third-party-integrations.md)
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,22 @@ tags: ["edge"]
During the EdgeForge process, you provide an **.arg** document that contains a list of parameters to configure the build
of both the provider images and the Edge Installer ISO. This page lists the parameters available in the **.arg** file.

| **Argument** | **Description** | **Allowed Values** |
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------- |
| `ARCH` | Architecture of the image. | `amd64`, `arm64`. |
| `CUSTOM_TAG` | A custom tag for the provider images. This custom tag will be appended to the `IMAGE_REGISTRY` and `IMAGE_REPO` parameters to form the full image tag. | Lowercase alphanumeric string without spaces. |
| `FIPS_ENABLED` | Whether to generate FIPS compliant binaries. | `true`, `false.` |
| `HTTP_PROXY` | URL of the HTTP Proxy server. | URL string. |
| `HTTPS_PROXY` | URL of the HTTPS Proxy server. | URL string. |
| `IMAGE_REGISTRY` | The image registry to use for tagging the generated provider images. | Your image registry hostname, without `http` or `https` <br /> Example: docker.io/spectrocloud. |
| `IMAGE_REPO` | The image repository to use for tagging the generated provider images. | Your image repository name. |
| `ISO_NAME` | Name of the Installer ISO file. | Lowercase alphanumeric string without spaces. The characters `-` and `_` are allowed. |
| `K8S_DISTRIBUTION` | Kubernetes distribution. | ` k3s`, `rke2`, `kubeadm`, `kubeadm-fips`. |
| `NO_PROXY` | URLS that should be excluded from the proxy. | Comma-separated URL string. |
| `OS_DISTRIBUTION` | OS distribution. | `ubuntu`, `opensuse-leap`, `rhel`. |
| `OS_VERSION` | OS version. This applies to Ubuntu only. | `20`, `22`. |
| `PROXY_CERT_PATH` | Absolute path of the SSL Proxy certificate in the PEM format. | Absolute path string. |
| `UPDATE_KERNEL` | Determines whether to upgrade the Kernel version to the latest from the upstream OS provider. | `true`, `false`. |
| **Argument** | **Description** | **Allowed Values** |
| ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
| `ARCH` | Architecture of the image. Required. | `amd64`, `arm64`. |
| `AUTO_ENROLL_SECUREBOOT_KEYS` | Determines whether to auto enroll keys used for Trusted Boot. | `true`, `false`. Default is `false`. |
| `CUSTOM_TAG` | A custom tag for the provider images. This custom tag will be appended to the `IMAGE_REGISTRY` and `IMAGE_REPO` parameters to form the full image tag. | Lowercase alphanumeric string without spaces. |
| `FIPS_ENABLED` | Whether to generate FIPS compliant binaries. | `true`, `false.` Default is `false` |
| `HTTP_PROXY` | URL of the HTTP Proxy server. | URL string. |
| `HTTPS_PROXY` | URL of the HTTPS Proxy server. | URL string. |
| `IMAGE_REGISTRY` | The image registry to use for tagging the generated provider images. Required. | Your image registry hostname, without `http` or `https` <br /> Example: docker.io/spectrocloud. |
| `IMAGE_REPO` | The image repository to use for tagging the generated provider images. Required. | Your image repository name. |
| `INCLUDE_MS_SECUREBOOT_KEYS` | Whether to include Microsoft's secure boot keys in the set of keys to enroll in your device for secure boot. Almost every machine requires these keys. | `true`, `false`. Default is `true`. |
| `ISO_NAME` | Name of the Installer ISO file. Required. | Lowercase alphanumeric string without spaces. The characters `-` and `_` are allowed. |
| `IS_UKI` | Determines whether to build a Unified Kernel Image (UKI) to enabled Trusted Boot. Refer to [Trusted Boot](../../trusted-boot/trusted-boot.md) for more information. | `true`, `false`. Default is `false`. |
| `K8S_DISTRIBUTION` | Kubernetes distribution. | ` k3s`, `rke2`, `kubeadm`, `kubeadm-fips`. |
| `NO_PROXY` | URLS that should be excluded from the proxy. | Comma-separated URL string. |
| `OS_DISTRIBUTION` | OS distribution. | `ubuntu`, `opensuse-leap`, `rhel`. |
| `OS_VERSION` | OS version. This applies to Ubuntu only. | `20`, `22`. |
| `PROXY_CERT_PATH` | Absolute path of the SSL Proxy certificate in the PEM format. | Absolute path string. |
| `UPDATE_KERNEL` | Determines whether to upgrade the Kernel version to the latest from the upstream OS provider. | `true`, `false`. |
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,8 @@ process.

- 4 CPU
- 8 GB memory
- 50 GB storage
- 150 GB storage. If you plan on using a content bundle, the actual storage will depend on the size of the content
bundle you will use to build the Edge installer ISO image.

## Instructions

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ artifacts at the same time.

- 4 CPU
- 8 GB memory
- 50 GB storage
- 150 GB storage

- [Git](https://git-scm.com/downloads). You can ensure git installation by issuing the `git --version` command.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,8 @@ This page guides you through the process of building FIPS-compliant Edge Install

- 4 CPU
- 8 GB memory
- 50 GB storage
- 150 GB storage. If you plan on using a content bundle, the actual storage will depend on the size of the content
bundle you will use to build the Edge installer ISO image.

- Depending on the Operating System (OS) you want to use on your Edge host, you will need the following subscription
credentials:
Expand Down
10 changes: 10 additions & 0 deletions docs/docs-content/clusters/edge/hardware-requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,16 @@ All Edge hosts must meet the following minimum hardware requirements.

ARM64 support is only verified for the Nvidia Jetson Orin device family.

## Trusted Boot

To use Trusted Boot, your Edge host must meet the following additional requirements:

- Edge host must have a Trusted Plat Module (TPM) 2.0 or later.
- Edge host must support Unified Extensible Firmware Interface (UEFI) boot options.
- Edge host must be capable of booting Extensible Firmware Interface (EFI) files of size 850 MB or greater. Refer to
[Check Hardware EFI Boot Limit](/docs/docs-content/clusters/edge/trusted-boot/edgeforge/check-efi-limit.md) for a
rough estimate of your EFI boot limit. For a more precise determination, contact sales@spectrocloud.com.

## Virtual Machine Operator (VMO)

To operate VMO on edge clusters, the CPUs of the constituent Edge hosts must have the following virtualization
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"position": 30
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
sidebar_label: "Deployment and Management"
title: "Deployment and Day 2 Operations for Trusted Boot"
description:
"Learn about how to install Palette Edge with Trusted Boot and how to upgrade a cluster in Day-2 operations."
hide_table_of_contents: false
sidebar_position: 20
tags: ["edge"]
---

Once you have built the Edge Installer ISO and have pushed the provider image to an available registry, you can proceed
to installation and Day-2 operations such as upgrading a cluster thereafter. Both the installation process and the
upgrade process for Palette Edge with Trusted Boot are similar to those without Trusted Boot.

This section discusses how to install Palette Edge with Trusted Boot and how to upgrade a cluster.

## Resources

- [Installation](./install.md)
- [Upgrade a Cluster](./upgrade-cluster.md)
Loading

0 comments on commit 29fa874

Please sign in to comment.