+ :::warning The Linux machine must have network connectivity to your VMware vCenter environment. @@ -85,8 +86,8 @@ To complete this tutorial, you will need the following: - A Palette registration token for pairing Edge hosts with Palette. You will need tenant admin access to Palette to generate a new registration token. For detailed instructions, refer to the - [Create Registration Token](../site-installation/create-registration-token.md) guide. Copy the newly created token to - a clipboard or notepad file to use later in this tutorial. + [Create Registration Token](../../clusters/edge/site-deployment/site-installation/create-registration-token.md) guide. + Copy the newly created token to a clipboard or notepad file to use later in this tutorial. The screenshot below shows a sample registration token in the **Tenant Settings** > **Registration Tokens** section in Palette. @@ -182,8 +183,8 @@ View the newly created file to ensure the arguments are defined per your require cat .arg ``` -Refer to the [Build Edge Artifacts](../../edgeforge-workflow/palette-canvos/palette-canvos.md) guide to learn more about -customizing arguments. +Refer to the [Build Edge Artifacts](../../clusters/edge/edgeforge-workflow/palette-canvos/palette-canvos.md) guide to +learn more about customizing arguments. ## Create User Data @@ -243,6 +244,8 @@ users: passwd: kairos ``` +
+ ## Build Artifacts The CanvOS utility uses [Earthly](https://earthly.dev/) to build the target artifacts. Issue the following command to @@ -258,7 +261,7 @@ will fail silently. You can exclude image versions you do not need from the build process by commenting out the lines in the `build-provider-images` parameter in the file **Earthfile** in the **CanvOS** repository. This speeds up build process and reduces the amount of space required for the build process. For an example of excluding a version from build, refer -to [Build Edge Artifacts guide](../../edgeforge-workflow/palette-canvos/palette-canvos.md). +to [Build Edge Artifacts guide](../../clusters/edge/edgeforge-workflow/palette-canvos/palette-canvos.md). ::: @@ -363,8 +366,8 @@ docker push ttl.sh/ubuntu:k3s-1.27.5-v4.1.2-demo As a reminder, [ttl.sh](https://ttl.sh/) is a short-lived image registry. If you do not use these provider images in your cluster profile within 24 hours of pushing to _ttl.sh_, they will expire and must be re-pushed. If you want to use a different image registry, refer to the Advanced workflow in the -[Build Edge Artifacts](../../edgeforge-workflow/palette-canvos/palette-canvos.md) guide to learn how to use another -registry. +[Build Edge Artifacts](../../clusters/edge/edgeforge-workflow/palette-canvos/palette-canvos.md) guide to learn how to +use another registry. ::: @@ -479,7 +482,7 @@ is an explanation of the options and sub-command used below: - The `--env-file` option reads the **.packerenv** file. - The `--volume ` option mounts a local directory to our official tutorials container, - `ghcr.io/spectrocloud/tutorials:1.1.6`. + `ghcr.io/spectrocloud/tutorials:1.1.5`. - The `sh -c "source /edge/vmware/clone_vm_template/setenv.sh "` shell sub-command defines the GOVC environment variables, the number of VMs, a prefix string for the VM name, and the VM template name. Most of the GOVC environment @@ -492,7 +495,7 @@ is an explanation of the options and sub-command used below: - The `-force` flag destroys any existing template. - The `--var-file` option reads the **vsphere.hcl** file from the container. This file contains the VM template name, VM configuration, and ISO file name to use. The VM configuration conforms to the - [minimum device requirements](../../architecture.md#minimum-device-requirements). + [minimum device requirements](../../clusters/edge/hardware-requirements.md). The **vsphere.hcl** file content is shown below for your reference. This tutorial does not require you to modify these configurations. @@ -523,7 +526,7 @@ is an explanation of the options and sub-command used below: Should you need to change the VM template name or VM settings defined in the **vsphere.hcl** file, or review the Packer script, you must open a bash session into the container using the - `docker run -it --env-file .packerenv --volume "${ISOFILEPATH}:/edge/vmware/packer/build" ghcr.io/spectrocloud/tutorials:1.1.6 bash` + `docker run -it --env-file .packerenv --volume "${ISOFILEPATH}:/edge/vmware/packer/build" ghcr.io/spectrocloud/tutorials:1.1.5 bash` command, and change to the **edge/vmware/packer/** directory to make the modifications. After you finish the modifications, issue the `packer build -force --var-file=vsphere.hcl build.pkr.hcl` command to trigger the Packer build process. @@ -539,8 +542,8 @@ docker run --interactive --tty --rm \ --env-file .packerenv \ --env-file .goenv \ --volume "${ISOFILEPATH}:/edge/vmware/packer/build" \ - ghcr.io/spectrocloud/tutorials:1.1.6 \ - sh -c "source /edge/vmware/clone_vm_template/setenv.sh && bash /edge/vmware/clone_vm_template/delete-packer-cache.sh && cd /edge/vmware/packer/ && packer init build.pkr.hcl && packer build -force --var-file=vsphere.hcl build.pkr.hcl" + ghcr.io/spectrocloud/tutorials:1.1.5 \ + sh -c "source /edge/vmware/clone_vm_template/setenv.sh && cd /edge/vmware/packer/ && packer init build.pkr.hcl && packer build -force --var-file=vsphere.hcl build.pkr.hcl" ``` Depending on your machine and network, the build process can take 7-10 minutes to finish. @@ -570,7 +573,7 @@ GOVC requires the same VMware vCenter details as the environment variables you d The next step is to use the following `docker run` command to clone the VM template and provision three VMs. Here is an explanation of the options and sub-command used below: -- The `--env-file` option reads the **.goenv** file in our official `ghcr.io/spectrocloud/tutorials:1.1.6` tutorials +- The `--env-file` option reads the **.goenv** file in our official `ghcr.io/spectrocloud/tutorials:1.1.5` tutorials container. - The `sh -c "cd edge/vmware/clone_vm_template/ && ./deploy-edge-host.sh"` shell sub-command changes to the container's @@ -612,7 +615,7 @@ export GOVC_FOLDER="${vcenter_folder}" Suppose you have changed the VM template name in the previous step or need to change the number of VMs to provision. In that case, you must modify the **setenv.sh** script. To do so, you can reuse the container bash session from the previous step if it is still active, or you can open another bash session into the container using the -`docker run -it --env-file .goenv ghcr.io/spectrocloud/tutorials:1.1.6 bash` command. If you use an existing container +`docker run -it --env-file .goenv ghcr.io/spectrocloud/tutorials:1.1.5 bash` command. If you use an existing container bash session, create the **.goenv** file described above and source it in your container environment. Next, change to the **edge/vmware/clone_vm_template/** directory to modify the **setenv.sh** script, and issue the `./deploy-edge-host.sh` command to deploy the VMs. @@ -624,7 +627,7 @@ Issue the following command to clone the VM template and provision three VMs. ```bash docker run -it --rm \ --env-file .goenv \ - ghcr.io/spectrocloud/tutorials:1.1.6 \ + ghcr.io/spectrocloud/tutorials:1.1.5 \ sh -c "cd edge/vmware/clone_vm_template/ && ./deploy-edge-host.sh" ``` @@ -664,7 +667,7 @@ select **Clusters**. Click on the **Edge Hosts** tab and verify the three VMs yo If the three Edge hosts are not displayed in the **Edge hosts** tab, the automatic registration failed. If this happens, you can manually register hosts by clicking the **Add Edge Hosts** button and pasting the Edge host ID. Repeat this host registration process for each of the three VMs. If you need help, the detailed instructions are available in the -[Register Edge Host](../../site-deployment/site-installation/edge-host-registration.md) guide. +[Register Edge Host](../../clusters/edge/site-deployment/site-installation/edge-host-registration.md) guide. ## Deploy a Cluster @@ -703,8 +706,7 @@ section. ### Profile Layers -In the **Profile Layers** section, add the following [BYOS Edge OS](../../../../integrations/byoos.md) pack to the OS -layer. +In the **Profile Layers** section, add the following [BYOS Edge OS](../../integrations/byoos.md) pack to the OS layer. | **Pack Type** | **Registry** | **Pack Name** | **Pack Version** | | ------------- | ------------ | ------------- | ---------------- | @@ -757,7 +759,8 @@ Click on the **Next layer** button to add the following Kubernetes layer to your Select the K3s version 1.27.x. 1.27.X because earlier in this tutorial, you pushed a provider image compatible with K3s v1.27.5 to the _ttl.sh_ image registry. The `system.uri` attribute of the BYOOS pack will reference the Kubernetes -version you select using the `{{ .spectro.system.kubernetes.version }}` [macro](../../../cluster-management/macros.md). +version you select using the `{{ .spectro.system.kubernetes.version }}` +[macro](../../clusters/cluster-management/macros.md). Click on the **Next layer** button, and add the following network layer. This example uses the Calico Container Network Interface (CNI). However, you can choose a different CNI pack that fits your needs, such as Flannel, Cilium, or Custom @@ -882,13 +885,13 @@ and the set of worker nodes is the worker pool. Provide the following details for the control plane pool. -| **Field** | **Value for the control-plane-pool** | -| ------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------- | -| Node pool name | control-plane-pool | -| Allow worker capability | Checked | -| Additional Labels (Optional) | None | -| [Taints](../../../cluster-management/taints.md#taints) | Off | -| Pool Configuration > Edge Hosts | Choose one of the registered Edge hosts.
Palette will automatically display the Network Interface Card (NIC) Name for the selected host. | +| **Field** | **Value for the control-plane-pool** | +| ------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------- | +| Node pool name | control-plane-pool | +| Allow worker capability | Checked | +| Additional Labels (Optional) | None | +| [Taints](../../clusters/cluster-management/taints.md#taints) | Off | +| Pool Configuration > Edge Hosts | Choose one of the registered Edge hosts.
Palette will automatically display the Nic Name for the selected host. | The screenshot below shows an Edge host added to the control plane pool. @@ -979,7 +982,7 @@ following command to delete the Edge hosts. ```bash docker run --interactive --tty --rm --env-file .goenv \ - ghcr.io/spectrocloud/tutorials:1.1.6 \ + ghcr.io/spectrocloud/tutorials:1.1.5 \ sh -c "cd edge/vmware/clone_vm_template/ && ./delete-edge-host.sh" ``` @@ -1025,7 +1028,7 @@ template, right-click on it and choose **Delete** option from the **drop-down Me Switch to the **Storage** view in your vSphere client. To delete the **palette-edge-installer.iso** file from the **packer_cache/** directory in the VMware vCenter datastore, right-click on it and choose **Delete** option from the -**drop-down Menu**. +**drop-down Menu**.
## Wrap-Up @@ -1048,12 +1051,12 @@ In addition, you can use Palette to manage the entire lifecycle of Edge clusters To learn more about Edge, check out the resources below. -- [Build Edge Artifacts](../../edgeforge-workflow/palette-canvos/palette-canvos.md) +- [Build Edge Artifacts](../../clusters/edge/edgeforge-workflow/palette-canvos/palette-canvos.md) -- [Build Content Bundle](../../edgeforge-workflow/palette-canvos/build-content-bundle.md) +- [Build Content Bundle](../../clusters/edge/edgeforge-workflow/palette-canvos/build-content-bundle.md) -- [Model Edge Native Cluster Profile](../../site-deployment/model-profile.md) +- [Model Edge Native Cluster Profile](../../clusters/edge/site-deployment/model-profile.md) -- [Installation](../../site-deployment/stage.md) +- [Prepare Edge Hosts for Installation](../../clusters/edge/site-deployment/stage.md) -- [Perform Site Install](../../site-deployment/site-installation/site-installation.md) +- [Perform Site Install](../../clusters/edge/site-deployment/site-installation/site-installation.md) diff --git a/docs/docs-content/tutorials/getting-started/_category_.json b/docs/docs-content/tutorials/getting-started/_category_.json new file mode 100644 index 0000000000..597b920dff --- /dev/null +++ b/docs/docs-content/tutorials/getting-started/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Getting Started", + "position": 10 +} diff --git a/docs/docs-content/tutorials/getting-started/aws/_category_.json b/docs/docs-content/tutorials/getting-started/aws/_category_.json new file mode 100644 index 0000000000..de48752528 --- /dev/null +++ b/docs/docs-content/tutorials/getting-started/aws/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "AWS", + "position": 0 +} diff --git a/docs/docs-content/tutorials/getting-started/azure/_category_.json b/docs/docs-content/tutorials/getting-started/azure/_category_.json new file mode 100644 index 0000000000..f8d22745cf --- /dev/null +++ b/docs/docs-content/tutorials/getting-started/azure/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Azure", + "position": 20 +} diff --git a/docs/docs-content/tutorials/getting-started/gcp/_category_.json b/docs/docs-content/tutorials/getting-started/gcp/_category_.json new file mode 100644 index 0000000000..e08eb7176b --- /dev/null +++ b/docs/docs-content/tutorials/getting-started/gcp/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "GCP", + "position": 30 +} diff --git a/docs/docs-content/tutorials/getting-started/vmware/_category_.json b/docs/docs-content/tutorials/getting-started/vmware/_category_.json new file mode 100644 index 0000000000..0b76feede0 --- /dev/null +++ b/docs/docs-content/tutorials/getting-started/vmware/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "VMware", + "position": 40 +} diff --git a/docs/docs-content/tutorials/profiles/_category_.json b/docs/docs-content/tutorials/profiles/_category_.json new file mode 100644 index 0000000000..200fce79e1 --- /dev/null +++ b/docs/docs-content/tutorials/profiles/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Profiles and Packs", + "position": 20 +} diff --git a/docs/docs-content/tutorials/profiles/app-profiles/_category_.json b/docs/docs-content/tutorials/profiles/app-profiles/_category_.json new file mode 100644 index 0000000000..5d54640165 --- /dev/null +++ b/docs/docs-content/tutorials/profiles/app-profiles/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "App Profiles", + "position": 10 +} diff --git a/docs/docs-content/tutorials/profiles/cluster-profiles/_category_.json b/docs/docs-content/tutorials/profiles/cluster-profiles/_category_.json new file mode 100644 index 0000000000..db28af90c5 --- /dev/null +++ b/docs/docs-content/tutorials/profiles/cluster-profiles/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Cluster Profiles", + "position": 0 +} diff --git a/docs/docs-content/registries-and-packs/deploy-pack.md b/docs/docs-content/tutorials/profiles/deploy-pack.md similarity index 97% rename from docs/docs-content/registries-and-packs/deploy-pack.md rename to docs/docs-content/tutorials/profiles/deploy-pack.md index fa12197cec..4782781ce2 100644 --- a/docs/docs-content/registries-and-packs/deploy-pack.md +++ b/docs/docs-content/tutorials/profiles/deploy-pack.md @@ -4,12 +4,9 @@ title: "Deploy a Custom Pack" description: "Learn how to deploy applications to a Kubernetes cluster using Palette's custom packs, hosted in either the Spectro registry or an OCI registry." -icon: "" -hide_table_of_contents: false -toc_min_heading_level: 2 -toc_max_heading_level: 2 -sidebar_position: 40 +sidebar_position: 0 tags: ["packs", "tutorial"] +category: ["tutorial"] --- Custom add-on packs allow you to deploy Kubernetes applications in clusters and reuse them in multiple deployments. This @@ -148,9 +145,9 @@ Do not exit the container until the tutorial is complete. Otherwise, you may los ## Build a Pack Building a custom pack involves defining specific files. As outlined in the -[Adding Add-on Packs](adding-add-on-packs.md) guide, there are two ways to define a custom pack: using manifest files or -Helm charts. The file structure differs for manifest-based packs and Helm chart-based packs. Below is the reference file -structure for each. +[Adding Add-on Packs](../../registries-and-packs/adding-add-on-packs.md) guide, there are two ways to define a custom +pack: using manifest files or Helm charts. The file structure differs for manifest-based packs and Helm chart-based +packs. Below is the reference file structure for each.
+ 
+
+
+### Ready to Start Learning?
+
+Explore more through the following tutorials.
+
+
+
{cards.map((card, index) => (
@@ -25,20 +33,19 @@ export default function SimpleCardGrid({ cards = [] }: SimpleCardProps) {
buttonText={card.buttonText}
relativeURL={card.relativeURL}
key={`simpleCard-${index}`}
+ hideNumber={hideNumber}
/>
))}
);
}
-function SimpleCard({ title, index, description, buttonText, relativeURL }: SimpleCard) {
+function SimpleCard({ title, index, description, buttonText, relativeURL, hideNumber }: SimpleCard) {
+ console.log(hideNumber);
return (
-
-
+ {index}
- {title}
- {description}
+
+ );
+ }
+ return (
+ {index}
+ {title}
+
+
+ );
+}
diff --git a/src/css/custom.scss b/src/css/custom.scss
index 8d199c6281..2628b5a228 100644
--- a/src/css/custom.scss
+++ b/src/css/custom.scss
@@ -11,6 +11,7 @@
@import "./dark-mode.scss";
@import "./reset.scss";
@import "./table.scss";
+@import "./sidebars.scss";
html {
// mendable widget inline style affects fonts
@@ -37,6 +38,7 @@ html {
--ifm-alert-shadow: unset;
--openapi-demo-font-size-code: 10px;
--openapi-demo-font-size-input: 10px;
+ --custom-sidebar-item-color: #aeb1be;
}
.markdown h1:first-child {
@@ -220,6 +222,12 @@ p img.markdown-image {
}
}
+// Allow hiding directories in docs-content
+
+.hidden-category {
+ display: none !important;
+}
+
// Reduce the spacing between lines in code blocks
.theme-code-block code {
diff --git a/src/css/dark-mode.scss b/src/css/dark-mode.scss
index b5ce18b829..3753484aef 100644
--- a/src/css/dark-mode.scss
+++ b/src/css/dark-mode.scss
@@ -44,6 +44,7 @@ html[data-theme="dark"] {
--custom-release-notes-selected-background: #2b323c;
--custom-release-notes-option-font-color: white;
--custom-release-notes-menu-padding: #2b323c;
+ --custom-sidebar-icon-color: #aeb1be;
.theme-last-updated {
color: var(--ifm-font-color-base);
diff --git a/src/css/light-mode.scss b/src/css/light-mode.scss
index ec16dad856..a850ca8cb5 100644
--- a/src/css/light-mode.scss
+++ b/src/css/light-mode.scss
@@ -52,6 +52,10 @@ html[data-theme="light"] {
}
}
+ .category > .menu__list-item-collapsible:hover {
+ background: none;
+ }
+
.menu__list-item-collapsible:hover {
background: #f7f9ff;
}
diff --git a/src/css/sidebars.scss b/src/css/sidebars.scss
new file mode 100644
index 0000000000..f293a96879
--- /dev/null
+++ b/src/css/sidebars.scss
@@ -0,0 +1,33 @@
+.privacy-settings {
+ display: flex;
+ align-items: center;
+ border-top: 1px solid var(--custom-sidebar-item-color);
+ border-radius: 0px;
+ margin-right: 16px;
+ margin-top: 4px;
+ margin-left: 12px;
+ padding-top: 16px;
+ padding-left: 0;
+}
+
+.category > .menu__list-item-collapsible {
+ color: var(--custom-sidebar-item-color);
+ font-size: 14px;
+ border-bottom: 1px solid var(--custom-sidebar-item-color);
+ border-radius: 0px;
+ margin-right: 16px;
+ margin-left: 12px;
+}
+
+.category > .menu__list-item-collapsible > .menu__link {
+ color: var(--custom-sidebar-item-color);
+ padding: 12px 0;
+}
+
+.category > .menu__list-item-collapsible > .menu__link.menu__link--active {
+ color: var(--ifm-menu-color-active);
+}
+
+.category .menu__list {
+ padding-left: 0px;
+}
diff --git a/static/assets/docs/images/tutorials/tutorials_landing-page-intro.webp b/static/assets/docs/images/tutorials/tutorials_landing-page-intro.webp
new file mode 100644
index 0000000000..28964aa711
Binary files /dev/null and b/static/assets/docs/images/tutorials/tutorials_landing-page-intro.webp differ
{title}
+