Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: document trusted boot #2612

Merged
merged 139 commits into from
Jun 6, 2024
Merged
Show file tree
Hide file tree
Changes from 124 commits
Commits
Show all changes
139 commits
Select commit Hold shift + click to select a range
33ee951
feat: release 4.3
karl-cardenas-coding Jan 29, 2024
1160097
docs: add instructions for first boot tui (#2141)
lennessyy Feb 9, 2024
a4b4142
Update Nutanix Docs to capture changes in the cluster creation workfl…
yuliiiah Feb 16, 2024
83a3cb6
docs: add cluster update behavior (#2134)
lennessyy Feb 26, 2024
bb343cb
Merge branch 'master' into release-4-3
karl-cardenas-coding Feb 26, 2024
9ba1b8c
docs: PEM-4571 multi-account (#2296)
karl-cardenas-coding Feb 28, 2024
62e1c7e
docs: PEM-4571 Password Blocklist (#2304)
karl-cardenas-coding Feb 28, 2024
bb5c34a
Merge branch 'master' into release-4-3
karl-cardenas-coding Feb 29, 2024
8697d23
Merge branch 'master' into release-4-3
karl-cardenas-coding Mar 1, 2024
19dcea4
docs: PCP-2510 Konvoy (#2319)
karl-cardenas-coding Mar 4, 2024
07b7f01
chore: document EMC API endpoints (#2340)
karl-cardenas-coding Mar 6, 2024
e90d0d4
docs: document namespace-based image swap diabling (#2352)
lennessyy Mar 6, 2024
f3ff5ec
docs: PCP-2494 custom MAAS Endpoint (#2363)
karl-cardenas-coding Mar 6, 2024
204310a
Merge branch 'master' into release-4-3
karl-cardenas-coding Mar 6, 2024
e6e0fd3
Merge branch 'master' into release-4-3
karl-cardenas-coding Mar 6, 2024
f6f0114
docs: PCP-2607 (#2369)
karl-cardenas-coding Mar 6, 2024
7abed62
docs: document edge management console (#2186)
lennessyy Mar 7, 2024
e0134e1
docs: 4.3 API Docs (#2376)
prathabk Mar 7, 2024
027d6d4
Update the TechPreview component to also accept custom text (#2377) (…
yuliiiah Mar 7, 2024
43fff14
Merge branch 'master' into release-4-3
karl-cardenas-coding Mar 7, 2024
f5462ef
docs: PLT-1080 FIPS Validate Command (#2384)
karl-cardenas-coding Mar 8, 2024
e69ce23
docs: add the command to bring up TUI before cluster deployment (#2387)
lennessyy Mar 8, 2024
239b96d
Cluster Profile Variables (#2343)
yuliiiah Mar 8, 2024
9f1118a
docs: DOC-1100 validator updates (#2388)
karl-cardenas-coding Mar 11, 2024
1566ce2
docs: replace EMC with local ui (#2392)
lennessyy Mar 12, 2024
9e13fc3
Change EMC to local UI and fix all links (#2406)
yuliiiah Mar 13, 2024
975aa80
Update cluster creation guides + Refactor Azure AKS (#2405)
yuliiiah Mar 14, 2024
d0582a6
docs: address PE-4011 and PE-3874 (#2398)
lennessyy Mar 14, 2024
61d0973
docs: add section for custom image registry options (#2386)
lennessyy Mar 14, 2024
407bbdf
docs: add rook ceph documentation (#2412)
lennessyy Mar 15, 2024
dc4a1f3
docs: rebase from master
karl-cardenas-coding Mar 18, 2024
e404008
docs: Update the PXK and PXK-E packs docs (#2423)
yuliiiah Mar 19, 2024
7641de5
docs: DOC-1090 PCP-2590 PE-3943 4.3 Release Notes (#2342)
karl-cardenas-coding Mar 19, 2024
fdc9300
docs: change edge harbor hardware requirements (#2413)
lennessyy Mar 20, 2024
ae31f05
docs: PLT-1100 added docs for Palette EC install (#2428)
karl-cardenas-coding Mar 20, 2024
dc80e93
docs: fix find/replace issue
Mar 20, 2024
949f231
Merge branch 'release-4-3' of https://github.com/spectrocloud/librari…
Mar 20, 2024
3ac233e
Merge branch 'master' into release-4-3
karl-cardenas-coding Mar 21, 2024
fc299c7
docs: merge master and DOC-1117
karl-cardenas-coding Mar 21, 2024
e5fcd37
Merge branch 'master' into release-4-3
karl-cardenas-coding Mar 22, 2024
69b5e67
Merge branch 'master' into release-4-3
karl-cardenas-coding Mar 23, 2024
0f00f58
Merge branch 'master' into release-4-3
karl-cardenas-coding Mar 26, 2024
e0ef28b
docs: updated release notes
karl-cardenas-coding Mar 26, 2024
7d0ab71
Update download URLs (#2481)
yuliiiah Mar 26, 2024
dd66c09
docs: document how to generate FIPS-compliant Edge artifacts (#2462)
lennessyy Mar 26, 2024
c05ef72
docs: update open source licenses list (#2485)
caroldelwing Mar 26, 2024
0fe189a
docs: add update cluster section (#2482)
caroldelwing Mar 27, 2024
643a466
docs: DOC-1127 (#2486)
karl-cardenas-coding Mar 27, 2024
4fef91f
chore: rebase from master
karl-cardenas-coding Mar 28, 2024
2ee6843
chore: rebased with master
karl-cardenas-coding Mar 28, 2024
3311d43
docs: add note to change Longhorn images to reference harbor (#2497)
lennessyy Mar 29, 2024
32f7da5
chore: update release notes date
karl-cardenas-coding Apr 3, 2024
a2a14a2
Merge branch 'master' into release-4-3
karl-cardenas-coding Apr 3, 2024
550e685
generate keys
Apr 4, 2024
4f2583c
add more content about keys
Apr 8, 2024
33d95cc
docs: add information about keys
Apr 11, 2024
fea36fb
Apply suggestions from code review
lennessyy Apr 11, 2024
0458801
add key table
Apr 11, 2024
c00e702
Update key-management.md
antongisli Apr 16, 2024
2cb7128
enroll keys file start
Apr 23, 2024
c778eab
Merge branch 'master' into trusted-boot
Apr 23, 2024
6e61ce0
fix merge conflicts
Apr 23, 2024
87d3dc4
Merge branch 'master' into trusted-boot
lennessyy Apr 24, 2024
2291218
add instructions for exporting keys
Apr 26, 2024
7aba72c
create skeleton documents
Apr 26, 2024
7b8de90
docs: add install document
May 1, 2024
2086bf7
add installation instructions
May 2, 2024
475f23a
docs: add additional pages to trusted boot
May 3, 2024
37c00e8
remove redundant redirect
May 3, 2024
a14e1bf
make further updates to trusted boot
May 6, 2024
5c2465f
change to webp
May 7, 2024
5b1cbf0
update image format
May 7, 2024
3c53e1b
add boot diagram
May 7, 2024
a9a8911
add resources to index page
May 7, 2024
f8919a6
add image
May 8, 2024
f95792e
add image
May 8, 2024
efd606c
fix redirects
May 8, 2024
6b28df0
arrange pages in order
May 8, 2024
8ca17ce
fix broken links
May 8, 2024
a00b34f
add instructions for corporate CA
May 9, 2024
f21c1b8
update folder structure
May 9, 2024
67c3715
add two new topics
May 14, 2024
16f85d4
partial update efi limit
May 15, 2024
067d3d7
add instructions on how to add content
May 17, 2024
a91690a
add new image
May 21, 2024
e517aad
docs: update image format
May 21, 2024
eee589d
Merge branch 'release-4-4' into trusted-boot
May 21, 2024
b5bf96b
docs: add EFI check documentation
May 22, 2024
4e0fd4c
docs: add warning for trusted boot
May 22, 2024
67323ab
docs: address vale
May 22, 2024
3e148cb
Optimised images with calibre/image-actions
vault-token-factory-spectrocloud[bot] May 22, 2024
69c3ad0
Optimised images with calibre/image-actions
vault-token-factory-spectrocloud[bot] May 22, 2024
f597020
chore: updated netlify.sh
karl-cardenas-coding May 22, 2024
950d830
docs: incorporate feedback
May 22, 2024
baff292
Merge branch 'trusted-boot' of https://github.com/spectrocloud/librar…
May 22, 2024
968a08a
Apply suggestions from code review
lennessyy May 24, 2024
83541f1
docs: address comments
May 24, 2024
81d2cdb
docs: edit for clarify
May 24, 2024
728ade3
copy edit
May 24, 2024
6c6dd5f
Merge branch 'release-4-4' into trusted-boot
lennessyy May 28, 2024
f81db83
docs: address comments
May 28, 2024
7067b09
docs: update images
May 28, 2024
6b0c554
update image
May 28, 2024
32636a1
Optimised images with calibre/image-actions
vault-token-factory-spectrocloud[bot] May 28, 2024
3e3574e
docs: fix image ref
May 28, 2024
ec577be
Merge branch 'trusted-boot' of https://github.com/spectrocloud/librar…
May 28, 2024
7aec894
Optimised images with calibre/image-actions
vault-token-factory-spectrocloud[bot] May 28, 2024
51f25fb
Optimised images with calibre/image-actions
vault-token-factory-spectrocloud[bot] May 28, 2024
d3b850a
update image
May 28, 2024
2c5b1e2
update image
May 28, 2024
4f2c455
Merge branch 'trusted-boot' of https://github.com/spectrocloud/librar…
May 28, 2024
3c3bdf8
Optimised images with calibre/image-actions
vault-token-factory-spectrocloud[bot] May 28, 2024
3054034
docs: add limitation
May 29, 2024
5af29ce
PE-4465 add warning about manual key enrollment
May 29, 2024
22d6f53
docs: adjust page ordering
May 30, 2024
abbf8d1
docs: incorporate feedback
Jun 4, 2024
355fbe9
docs: address review comments
Jun 4, 2024
b199ddc
docs: address review comments
Jun 4, 2024
0f59ad6
docs: minor edits
Jun 4, 2024
70ad619
docs: minior edits
Jun 5, 2024
65607ff
Apply suggestions from code review
lennessyy Jun 5, 2024
d5fc0eb
docs: prettier format
Jun 5, 2024
d4cef04
Merge branch 'release-4-4' into trusted-boot
lennessyy Jun 5, 2024
7b5d81f
docs: copy edits
Jun 5, 2024
cc7719f
docs: add crosslink
Jun 5, 2024
2d44d1f
docs: vale comments
Jun 5, 2024
65f5088
docs: fix typo
Jun 5, 2024
1ef395b
Optimised images with calibre/image-actions
vault-token-factory-spectrocloud[bot] Jun 5, 2024
449fbe4
Optimised images with calibre/image-actions
vault-token-factory-spectrocloud[bot] Jun 5, 2024
5404b32
Optimised images with calibre/image-actions
vault-token-factory-spectrocloud[bot] Jun 5, 2024
82d9784
docs: add links to parent pages
Jun 5, 2024
8ca2e3d
docs: merge changes
Jun 5, 2024
9041278
docs: add preview flag to trusted boot
Jun 5, 2024
d2fd21d
Apply suggestions from code review
lennessyy Jun 5, 2024
5c4e1e6
docs: address feedback
Jun 5, 2024
e90a344
Merge branch 'trusted-boot' of https://github.com/spectrocloud/librar…
Jun 5, 2024
1790bc2
prettier formatting
Jun 5, 2024
f6f2208
docs: add limitation and git link
Jun 5, 2024
5977b8f
docs: resolve conflicts
Jun 6, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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`. |
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
Loading