DOC-800 Edge how-to using content bundle #1400

sudkul87 · 2023-07-06T09:46:08Z

Describe the Change

This PR adds a How-to for creating Edge artifacts using a content bundle.

Review Changes

💻 Preview URLs

Build Edge Artifacts using a Content Bundle - New
Build Edge Artifacts - Updated
Deploy Edge Cluster - Updated

🎫 Jira Ticket - DOC-800

…to docs-edge-tutorial

github-actions · 2023-07-21T16:16:51Z

Images automagically compressed by Calibre's image-actions ✨

Compression reduced images by 30.3%, saving 472.29 KB.

Filename	Before	After	Improvement	Visual comparison
`assets/docs/images/clusters_edge_edge-forge-workflow_build-images_build-artifacts_url.png`	1.52 MB	1.06 MB	-30.3%	View diff

406 images did not require optimisation.

karl-cardenas-coding

Feedback below. There are ways we can reduce the text and leverage the fact that a guide is a prereq.

content/docs/04-clusters/03-edge/04-edgeforge-workflow/12-build-artifacts.md

karl-cardenas-coding · 2023-07-24T22:47:19Z

content/docs/04-clusters/03-edge/04-edgeforge-workflow/12-build-artifacts.md

+  palette-edge-installer.iso.sha256
+  ```
+
+# Validate


For the Validate section you are in the same spot as you were in the Edge artifacts guide. You can use the same language you used there but you can explain that in order to test, the user must deploy an Edge cluster.

content/docs/04-clusters/03-edge/04-edgeforge-workflow/12-build-artifacts.md

karl-cardenas-coding · 2023-07-24T22:49:59Z

content/docs/04-clusters/03-edge/09-site-deployment/06-deploy-cluster.md

@@ -41,7 +41,7 @@ For learning purposes, you will set up Virtual Machines (VMs) as Edge hosts and
 To complete this tutorial, you will need the following:
 <br/>

-* Access to a VMware vCenter environment where you will provision VMs as Edge hosts. You will need the server URL, login credentials, and names of the data center, data store, resource pool, folder, cluster, and DHCP-enabled network.
+* Access to a VMware vCenter environment where you will provision VMs as Edge hosts. You will need the server URL, login credentials, and names of the data center, data store, resource pool, folder, cluster, and DHCP-enabled network. The VMs you will prepare as Edge hosts using the Edge installer ISO image must be DHCP-enabled. 


This latest addition, how do I, as a user ensure this is true? Can we link to a VMware guide? You may have to break this out into its own bullet.

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

github-actions · 2023-07-26T20:50:32Z

content/docs/04-clusters/03-edge/04-edgeforge-workflow/03.5-palette-canvos.md

 <br />

  ```bash
  export CUSTOM_TAG=palette-learn
  ```
  <br />

-7. Issue the command below to create the **.arg** file with the custom tag. It uses the default values for the remaining variables. You can refer to the existing **.arg.template** file to learn more about the available customizable variables.  
+7. Issue the command below to create the **.arg** file containing the custom tag. The remaining arguments in the **.arg** file will use the default values. For example, `ubuntu` is the default operating system, `demo` is the default tag, and [ttl.sh](https://ttl.sh/) is the default image registry. Refer to the existing **.arg.template** file in the current directory or the [README](https://github.com/spectrocloud/CanvOS#readme) to learn more about the available customizable arguments.  


🚫 [vale] _{reported by reviewdog 🐶}
[Vale.Terms] Use 'readme' instead of 'README'.

github-actions · 2023-07-26T20:50:32Z

content/docs/04-clusters/03-edge/04-edgeforge-workflow/03.5-palette-canvos.md

+  |OS|Public Repo|BYOS Edge OS|`1.0.0`|
+
+
+16. Replace the the cluster profile's BYOOS pack manifest with the following custom manifest so that the cluster profile can pull the provider image from the ttl.sh image registry.  


🚫 [vale] _{reported by reviewdog 🐶}
[Vale.Repetition] 'the' is repeated!

github-actions · 2023-07-26T20:50:33Z

content/docs/04-clusters/03-edge/04-edgeforge-workflow/03.5-palette-canvos.md

+  |OS|Public Repo|BYOS Edge OS|`1.0.0`|
+
+
+21. Replace the the cluster profile's BYOOS pack manifest with the following custom manifest so that the cluster profile can pull the provider image from the ttl.sh image registry.  


🚫 [vale] _{reported by reviewdog 🐶}
[Vale.Repetition] 'the' is repeated!

github-actions · 2023-07-26T20:53:06Z

Images automagically compressed by Calibre's image-actions ✨

Compression reduced images by 40.9%, saving 736.64 KB.

Filename	Before	After	Improvement	Visual comparison
`assets/docs/images/clusters_edge_edge-forge-workflow_build-images_build-artifacts_overarching.png`	299.50 KB	194.44 KB	-35.1%	View diff
`assets/docs/images/clusters_edge_edge-forge-workflow_build-images_build-project_id.png`	1.47 MB	869.73 KB	-42.1%	View diff

406 images did not require optimisation.

…to edge-how-to-content-bundle

github-actions · 2023-07-26T21:38:22Z

content/docs/04-clusters/03-edge/09-site-deployment/06-deploy-cluster.md

+* Access to a VMware vCenter environment where you will provision VMs as Edge hosts. You will need the server URL, login credentials, and names of the data center, data store, resource pool, folder, cluster, and DHCP-enabled network. 
+
+
+* The VMs you will prepare as Edge hosts image must be attached to a DHCP-enabled network. To ensure DHCP is enabled on the network, review the network settings on your ESXi Host.


🚫 [vale] _{reported by reviewdog 🐶}
[Vale.Spelling] Did you really mean 'ESXi'?

content/docs/04-clusters/03-edge/09-site-deployment/06-deploy-cluster.md

…cluster.md

content/docs/04-clusters/03-edge/09-site-deployment/06-deploy-cluster.md

…cluster.md

github-actions · 2023-07-26T21:41:27Z

content/docs/04-clusters/03-edge/09-site-deployment/06-deploy-cluster.md

+* Access to a VMware vCenter environment where you will provision VMs as Edge hosts. You will need the server URL, login credentials, and names of the data center, data store, resource pool, folder, cluster, and DHCP-enabled network. 
+
+
+* The VMs you will prepare as Edge hosts must be attached to a DHCP-enabled network. To ensure DHCP is enabled on the network, review the network settings on your ESXi Host.


🚫 [vale] _{reported by reviewdog 🐶}
[Vale.Spelling] Did you really mean 'ESXi'?

content/docs/04-clusters/03-edge/04-edgeforge-workflow/12-build-artifacts.md

karl-cardenas-coding

@sudkul87 looks great, just some minor suggestions. PR approved 👍🏻

content/docs/04-clusters/03-edge/04-edgeforge-workflow/12-build-artifacts.md

karl-cardenas-coding · 2023-07-31T00:11:33Z

content/docs/04-clusters/03-edge/04-edgeforge-workflow/12-build-artifacts.md

+2. Open a terminal session and navigate to the folder where you have downloaded the palette-edge binary.
+
+
+
+3. Set the executable permissions for the palette-edge binary by issuing the following command.


We can combine these two.

content/docs/04-clusters/03-edge/04-edgeforge-workflow/12-build-artifacts.md

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

github-actions · 2023-07-31T05:02:30Z

content/docs/04-clusters/03-edge/04-edgeforge-workflow/12-build-artifacts.md

+
+<InfoBox>
+
+We recommend you check out the end-to-end tutorial [Deploy an Edge Cluster on VMware](/clusters/edge/site-deployment/deploy-cluster) for a detailed walkthrough on deploying an Edge environment using VMware to simulate bare metal hosts. You can use your VMware environment to validate the Edge artifacts and that you have all the required dependencies included in your content bundle. 


🚫 [vale] _{reported by reviewdog 🐶}
[Vale.Spelling] Did you really mean 'walkthrough'?

github-actions · 2023-07-31T07:05:43Z

content/docs/04-clusters/03-edge/04-edgeforge-workflow/12-build-artifacts.md

+<br />
+
+
+As the next step, we recommend you check out the end-to-end tutorial, [Deploy an Edge Cluster on VMware](/clusters/edge/site-deployment/deploy-cluster). The tutorial provides a detailed walkthrough on deploying an Edge cluster in a VMware environment. 


🚫 [vale] _{reported by reviewdog 🐶}
[Vale.Spelling] Did you really mean 'walkthrough'?

3pings and others added 30 commits April 29, 2023 15:23

added draft for Edge Forge how to quickstart

3b9499a

spelling fixes

c670b02

fixed minor typos

e6ab624

Updated for edge-native virtualbox

c706f12

Updated Getting Start with Edge

d9985f5

Updated for git tags

6b0e0b5

Updated spelling

81d30cd

fixed formatting

a9cc2d8

renamed files and organized layout

c5913a7

updated image references and location names

e513795

docs: initialize new files for how-to and tutorial

dd31611

Merge branch 'master' of https://github.com/spectrocloud/librarium in…

9725de1

…to docs-edge-tutorial

docs: partial how-to file

13edf98

Merge branch 'master' of https://github.com/spectrocloud/librarium in…

283883e

…to docs-edge-tutorial

docs: how-to first draft ready

10e71ed

docs: add finishing touches to the how-to guide

f3ec3f4

docs: change code block highlight color

7fd9a4c

docs: add opensuse support

2935f4b

docs: add ubuntu 20.04

f6b8e01

docs: clarify ubuntu and opensuse requirements

1729b10

docs: address initial feedback

8798a7b

docs: reduce words

93d8097

docs: ask env vars in one place instead of two

4a70248

docs: update how-to and tutorial

0bc1ae6

docs: tutorial wip

00f5e85

docs: pull master

343eb8b

Merge branch 'master' of https://github.com/spectrocloud/librarium in…

f74c14a

…to docs-edge-tutorial

docs: copy the how-to

8bf979d

Merge branch 'master' of https://github.com/spectrocloud/librarium in…

88dd802

…to docs-edge-tutorial

docs: add more steps

8e61184

Optimised images with calibre/image-actions

4d74c56

karl-cardenas-coding requested changes Jul 24, 2023

View reviewed changes

sudkul87 and others added 2 commits July 25, 2023 17:51

Apply suggestions from code review

d02f832

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

docs: apply suggestions from the feedback meeting

8eb728c

github-actions bot reviewed Jul 26, 2023

View reviewed changes

Optimised images with calibre/image-actions

e3f3636

sudkul87 added 2 commits July 27, 2023 03:06

docs: add dhcp

226727e

Merge branch 'master' of https://github.com/spectrocloud/librarium in…

46baab9

…to edge-how-to-content-bundle

github-actions bot reviewed Jul 26, 2023

View reviewed changes

sudkul87 commented Jul 26, 2023

View reviewed changes

content/docs/04-clusters/03-edge/09-site-deployment/06-deploy-cluster.md Outdated Show resolved Hide resolved

Update content/docs/04-clusters/03-edge/09-site-deployment/06-deploy-…

07ba000

…cluster.md

sudkul87 commented Jul 26, 2023

View reviewed changes

content/docs/04-clusters/03-edge/09-site-deployment/06-deploy-cluster.md Outdated Show resolved Hide resolved

Update content/docs/04-clusters/03-edge/09-site-deployment/06-deploy-…

42195c5

…cluster.md

github-actions bot reviewed Jul 26, 2023

View reviewed changes

sudkul87 commented Jul 27, 2023

View reviewed changes

content/docs/04-clusters/03-edge/04-edgeforge-workflow/12-build-artifacts.md Outdated Show resolved Hide resolved

sudkul87 commented Jul 27, 2023

View reviewed changes

content/docs/04-clusters/03-edge/04-edgeforge-workflow/12-build-artifacts.md Outdated Show resolved Hide resolved

sudkul87 commented Jul 27, 2023

View reviewed changes

content/docs/04-clusters/03-edge/04-edgeforge-workflow/12-build-artifacts.md Outdated Show resolved Hide resolved

Apply suggestions from morning self review

d3568c2

sudkul87 commented Jul 27, 2023

View reviewed changes

content/docs/04-clusters/03-edge/04-edgeforge-workflow/12-build-artifacts.md Outdated Show resolved Hide resolved

sudkul87 commented Jul 27, 2023

View reviewed changes

content/docs/04-clusters/03-edge/04-edgeforge-workflow/12-build-artifacts.md Outdated Show resolved Hide resolved

add summary

8fc3ef5

karl-cardenas-coding approved these changes Jul 31, 2023

View reviewed changes

Apply suggestions from code review

9f23db8

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

github-actions bot reviewed Jul 31, 2023

View reviewed changes

docs: apply suggestions

b90404a

github-actions bot reviewed Jul 31, 2023

View reviewed changes

sudkul87 merged commit 65d8995 into master Jul 31, 2023
11 checks passed

sudkul87 deleted the edge-how-to-content-bundle branch July 31, 2023 07:50

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOC-800 Edge how-to using content bundle #1400

DOC-800 Edge how-to using content bundle #1400

sudkul87 commented Jul 6, 2023 •

edited

Loading

github-actions bot commented Jul 21, 2023

karl-cardenas-coding left a comment

karl-cardenas-coding Jul 24, 2023

karl-cardenas-coding Jul 24, 2023

github-actions bot Jul 26, 2023

github-actions bot Jul 26, 2023

github-actions bot Jul 26, 2023

github-actions bot commented Jul 26, 2023

github-actions bot Jul 26, 2023

github-actions bot Jul 26, 2023

karl-cardenas-coding left a comment

karl-cardenas-coding Jul 31, 2023

github-actions bot Jul 31, 2023

github-actions bot Jul 31, 2023

		\|OS\|Public Repo\|BYOS Edge OS\|`1.0.0`\|


		16. Replace the the cluster profile's BYOOS pack manifest with the following custom manifest so that the cluster profile can pull the provider image from the ttl.sh image registry.

		\|OS\|Public Repo\|BYOS Edge OS\|`1.0.0`\|


		21. Replace the the cluster profile's BYOOS pack manifest with the following custom manifest so that the cluster profile can pull the provider image from the ttl.sh image registry.

		* Access to a VMware vCenter environment where you will provision VMs as Edge hosts. You will need the server URL, login credentials, and names of the data center, data store, resource pool, folder, cluster, and DHCP-enabled network.


		* The VMs you will prepare as Edge hosts image must be attached to a DHCP-enabled network. To ensure DHCP is enabled on the network, review the network settings on your ESXi Host.

		2. Open a terminal session and navigate to the folder where you have downloaded the palette-edge binary.



		3. Set the executable permissions for the palette-edge binary by issuing the following command.


		<InfoBox>

		We recommend you check out the end-to-end tutorial [Deploy an Edge Cluster on VMware](/clusters/edge/site-deployment/deploy-cluster) for a detailed walkthrough on deploying an Edge environment using VMware to simulate bare metal hosts. You can use your VMware environment to validate the Edge artifacts and that you have all the required dependencies included in your content bundle.

		<br />


		As the next step, we recommend you check out the end-to-end tutorial, [Deploy an Edge Cluster on VMware](/clusters/edge/site-deployment/deploy-cluster). The tutorial provides a detailed walkthrough on deploying an Edge cluster in a VMware environment.

DOC-800 Edge how-to using content bundle #1400

DOC-800 Edge how-to using content bundle #1400

Conversation

sudkul87 commented Jul 6, 2023 • edited Loading

Describe the Change

Review Changes

github-actions bot commented Jul 21, 2023

karl-cardenas-coding left a comment

Choose a reason for hiding this comment

karl-cardenas-coding Jul 24, 2023

Choose a reason for hiding this comment

karl-cardenas-coding Jul 24, 2023

Choose a reason for hiding this comment

github-actions bot Jul 26, 2023

Choose a reason for hiding this comment

github-actions bot Jul 26, 2023

Choose a reason for hiding this comment

github-actions bot Jul 26, 2023

Choose a reason for hiding this comment

github-actions bot commented Jul 26, 2023

github-actions bot Jul 26, 2023

Choose a reason for hiding this comment

github-actions bot Jul 26, 2023

Choose a reason for hiding this comment

karl-cardenas-coding left a comment

Choose a reason for hiding this comment

karl-cardenas-coding Jul 31, 2023

Choose a reason for hiding this comment

github-actions bot Jul 31, 2023

Choose a reason for hiding this comment

github-actions bot Jul 31, 2023

Choose a reason for hiding this comment

sudkul87 commented Jul 6, 2023 •

edited

Loading