From 2c9f72de9dc5455e40eb859ce4858a365d048359 Mon Sep 17 00:00:00 2001 From: Lenny Chen <55669665+lennessyy@users.noreply.github.com> Date: Wed, 17 Jul 2024 16:36:58 -0700 Subject: [PATCH 1/2] docs: add known issue (#3415) Co-authored-by: Lenny Chen --- docs/docs-content/release-notes/known-issues.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs-content/release-notes/known-issues.md b/docs/docs-content/release-notes/known-issues.md index 8e5197e119..e38175ff08 100644 --- a/docs/docs-content/release-notes/known-issues.md +++ b/docs/docs-content/release-notes/known-issues.md @@ -16,7 +16,7 @@ The following table lists all known issues that are currently active and affecti | Description | Workaround | Publish Date | Product Component | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- | --------------------- | -| When provisioning an Edge cluster, it's possible that some Operating System (OS) user credentials will be lost once the cluster is active. This is because the cloud-init stages from different sources merge during the deployment process, and sometimes, the same stages without distinct names overwrite each other. | Give each of your cloud-init stages in the OS pack and in the Edge installer **user-data** file a unique name. For more information about cloud-init stages and examples of cloud-init stages with names, refer to [Cloud-init Stages](../clusters/edge/edge-configuration/cloud-init.md). | July 17 2024 | Edge | +| When provisioning an Edge cluster, it's possible that some Operating System (OS) user credentials will be lost once the cluster is active. This is because the cloud-init stages from different events and configurations merge during the deployment process and some stages get overwritten. | Give each of your stages in the OS pack and in the Edge installer **user-data** file a unique name. For more information about cloud-init stages, refer to [Cloud-init Stages](../clusters/edge/edge-configuration/cloud-init.md). | July 17, 2024 | Edge | | When you use a content bundle to provision a new cluster without using the local Harbor registry, it's possible for the images to be pulled from external networks instead of from the content bundle, consuming network bandwidth. If your Edge host has no connection to external networks or if it cannot locate the image on a remote registry, some pods may enter the `ImagePullBackOff` state at first, but eventually the pods will be created using images from the content bundle. | For connected clusters, you can make sure that the remote images are not reachable by the Edge host, which will stop the Palette agent from downloading the image and consuming bandwidth, and eventually the cluster will be created using images from the content bundle. For airgap clusters, the `ImagePullBackOff` error will eventually resolve on its own and there is no action to take. | July 11, 2024 | Edge | | When you add a new VMware vSphere Edge host to an Edge cluster, the IP address may fail to be assigned to the Edge host after a reboot. | Review the [Edge Troubleshooting](../troubleshooting/edge.md) section for workarounds. | July 9, 2024 | Edge | | When you install Palette Edge using an Edge Installer ISO with a RHEL 8 operating system on a Virtual Machine (VM) with insufficient video memory, the QR code in the registration screen does not display correctly. | Increase the video memory of your VM to 8 MB or higher. The steps to do this vary depending on the platform you use to deploy your VM. In vSphere, you can right click on the VM, click **Edit Settings** and adjust the video card memory in the **Video card** tab. | July 9, 2024 | Edge | From 76f18f9b8eeb3c6d83225fe43096fa4229160d1d Mon Sep 17 00:00:00 2001 From: Adelina Simion <43963729+addetz@users.noreply.github.com> Date: Thu, 18 Jul 2024 14:30:22 +0200 Subject: [PATCH 2/2] docs: bump tutorials tag DOC-1303 (#3396) * docs: bump tutorials tag DOC-1303 * docs: add partials to tutorials setup DOC-1303 * docs: add partials to tutorials cleanup DOC-1303 * docs: fix format DOC-1303 --- .prettierignore | 5 +- .../tutorials/_checkout_tutorial_tag.mdx | 10 ++++ .../_download_tutorial_image_docker.mdx | 10 ++++ .../_download_tutorial_image_podman.mdx | 10 ++++ .../_run_tutorial_container_docker.mdx | 10 ++++ .../_run_tutorial_container_podman.mdx | 10 ++++ .../_stop_tutorial_container_docker.mdx | 9 ++++ .../_stop_tutorial_container_podman.mdx | 9 ++++ .../public-cloud/deploy-k8s-cluster.md | 40 +++------------- .../docs-content/getting-started/terraform.md | 40 +++------------- .../cluster-deployment/pde/deploy-app.md | 46 +++---------------- .../public-cloud/deploy-k8s-cluster.md | 40 +++------------- .../update-maintain/update-k8s-cluster.md | 6 +-- .../tutorials/profiles/deploy-pack.md | 22 ++++----- 14 files changed, 109 insertions(+), 158 deletions(-) create mode 100644 _partials/tutorials/_checkout_tutorial_tag.mdx create mode 100644 _partials/tutorials/_download_tutorial_image_docker.mdx create mode 100644 _partials/tutorials/_download_tutorial_image_podman.mdx create mode 100644 _partials/tutorials/_run_tutorial_container_docker.mdx create mode 100644 _partials/tutorials/_run_tutorial_container_podman.mdx create mode 100644 _partials/tutorials/_stop_tutorial_container_docker.mdx create mode 100644 _partials/tutorials/_stop_tutorial_container_podman.mdx diff --git a/.prettierignore b/.prettierignore index c4e6c2e26d..eb3379c58a 100644 --- a/.prettierignore +++ b/.prettierignore @@ -12,4 +12,7 @@ docs/api-content/**/*.json # Troublesome files tsconfig.json src/components/IconMapper/dynamicFontAwesomeImports.js -docs/docs-content/security-bulletins/cve-reports.md \ No newline at end of file +docs/docs-content/security-bulletins/cve-reports.md + +# Ignore partials +_partials/ diff --git a/_partials/tutorials/_checkout_tutorial_tag.mdx b/_partials/tutorials/_checkout_tutorial_tag.mdx new file mode 100644 index 0000000000..56e75876ba --- /dev/null +++ b/_partials/tutorials/_checkout_tutorial_tag.mdx @@ -0,0 +1,10 @@ +--- +partial_category: tutorials +partial_name: checkout-tutorials-tag +--- + +Check out the following git tag. + +```shell +git checkout v1.1.7 +``` \ No newline at end of file diff --git a/_partials/tutorials/_download_tutorial_image_docker.mdx b/_partials/tutorials/_download_tutorial_image_docker.mdx new file mode 100644 index 0000000000..c18832f4e3 --- /dev/null +++ b/_partials/tutorials/_download_tutorial_image_docker.mdx @@ -0,0 +1,10 @@ +--- +partial_category: tutorials +partial_name: download-tutorials-image-docker +--- + +Download the tutorial image to your local machine. + +```bash +docker pull ghcr.io/spectrocloud/tutorials:1.1.7 +``` \ No newline at end of file diff --git a/_partials/tutorials/_download_tutorial_image_podman.mdx b/_partials/tutorials/_download_tutorial_image_podman.mdx new file mode 100644 index 0000000000..3253854732 --- /dev/null +++ b/_partials/tutorials/_download_tutorial_image_podman.mdx @@ -0,0 +1,10 @@ +--- +partial_category: tutorials +partial_name: download-tutorials-image-podman +--- + +Download the tutorial image to your local machine. + +```bash +podman pull ghcr.io/spectrocloud/tutorials:1.1.7 +``` \ No newline at end of file diff --git a/_partials/tutorials/_run_tutorial_container_docker.mdx b/_partials/tutorials/_run_tutorial_container_docker.mdx new file mode 100644 index 0000000000..f4fd61f73c --- /dev/null +++ b/_partials/tutorials/_run_tutorial_container_docker.mdx @@ -0,0 +1,10 @@ +--- +partial_category: tutorials +partial_name: run-tutorials-container-docker +--- + +Next, start the container, and open a bash session into it. + +```shell +docker run --name tutorialContainer --interactive --tty ghcr.io/spectrocloud/tutorials:1.1.7 bash +``` \ No newline at end of file diff --git a/_partials/tutorials/_run_tutorial_container_podman.mdx b/_partials/tutorials/_run_tutorial_container_podman.mdx new file mode 100644 index 0000000000..3f63f1485f --- /dev/null +++ b/_partials/tutorials/_run_tutorial_container_podman.mdx @@ -0,0 +1,10 @@ +--- +partial_category: tutorials +partial_name: run-tutorials-container-podman +--- + +Next, start the container, and open a bash session into it. + +```shell +podman run --name tutorialContainer --interactive --tty ghcr.io/spectrocloud/tutorials:1.1.7 bash +``` \ No newline at end of file diff --git a/_partials/tutorials/_stop_tutorial_container_docker.mdx b/_partials/tutorials/_stop_tutorial_container_docker.mdx new file mode 100644 index 0000000000..df328259c8 --- /dev/null +++ b/_partials/tutorials/_stop_tutorial_container_docker.mdx @@ -0,0 +1,9 @@ +--- +partial_category: tutorials +partial_name: stop-tutorials-container-docker +--- + +```shell +docker stop tutorialContainer && \ +docker rmi --force ghcr.io/spectrocloud/tutorials:1.1.7 +``` \ No newline at end of file diff --git a/_partials/tutorials/_stop_tutorial_container_podman.mdx b/_partials/tutorials/_stop_tutorial_container_podman.mdx new file mode 100644 index 0000000000..12d30606a7 --- /dev/null +++ b/_partials/tutorials/_stop_tutorial_container_podman.mdx @@ -0,0 +1,9 @@ +--- +partial_category: tutorials +partial_name: stop-tutorials-container-podman +--- + +```shell +podman stop tutorialContainer && \ +podman rmi --force ghcr.io/spectrocloud/tutorials:1.1.7 +``` \ No newline at end of file diff --git a/docs/docs-content/clusters/public-cloud/deploy-k8s-cluster.md b/docs/docs-content/clusters/public-cloud/deploy-k8s-cluster.md index 41871802a0..19c51433f2 100644 --- a/docs/docs-content/clusters/public-cloud/deploy-k8s-cluster.md +++ b/docs/docs-content/clusters/public-cloud/deploy-k8s-cluster.md @@ -828,17 +828,9 @@ displaying the version number. docker version ``` -Download the tutorial image to your local machine. + -```bash -docker pull ghcr.io/spectrocloud/tutorials:1.1.3 -``` - -Next, start the container, and open a bash session into it. - -```shell -docker run --name tutorialContainer --interactive --tty ghcr.io/spectrocloud/tutorials:1.1.3 bash -``` + Navigate to the tutorial code. @@ -864,17 +856,9 @@ Use the following command and ensure you receive an output displaying the instal podman info ``` -Download the tutorial image to your local machine. + -```bash -podman pull ghcr.io/spectrocloud/tutorials:1.1.3 -``` - -Next, start the container, and open a bash session into it. - -```shell -podman run --name tutorialContainer --interactive --tty ghcr.io/spectrocloud/tutorials:1.1.3 bash -``` + Navigate to the tutorial code. @@ -898,11 +882,7 @@ Change the directory to the tutorial folder. cd tutorials/ ``` -Check out the following git tag. - -```shell -git checkout v1.1.3 -``` + Change the directory to the tutorial code. @@ -1352,19 +1332,13 @@ the **Enter** key. Next, issue the following command to stop the container. -```shell -docker stop tutorialContainer && \ -docker rmi --force ghcr.io/spectrocloud/tutorials:1.1.3 -``` + -```shell -podman stop tutorialContainer && \ -podman rmi --force ghcr.io/spectrocloud/tutorials:1.1.3 -``` + diff --git a/docs/docs-content/getting-started/terraform.md b/docs/docs-content/getting-started/terraform.md index 380ffd4626..e8d8515519 100644 --- a/docs/docs-content/getting-started/terraform.md +++ b/docs/docs-content/getting-started/terraform.md @@ -75,17 +75,9 @@ displaying the version number. docker version ``` -Download the tutorial image to your local machine. + -```bash -docker pull ghcr.io/spectrocloud/tutorials:1.1.3 -``` - -Next, start the container, and open a bash session into it. - -```shell -docker run --name tutorialContainer --interactive --tty ghcr.io/spectrocloud/tutorials:1.1.3 bash -``` + Navigate to the tutorial code. @@ -111,17 +103,9 @@ Use the following command and ensure you receive an output displaying the instal podman info ``` -Download the tutorial image to your local machine. + -```bash -podman pull ghcr.io/spectrocloud/tutorials:1.1.3 -``` - -Next, start the container, and open a bash session into it. - -```shell -podman run --name tutorialContainer --interactive --tty ghcr.io/spectrocloud/tutorials:1.1.3 bash -``` + Navigate to the tutorial code. @@ -145,11 +129,7 @@ Change the directory to the tutorial folder. cd tutorials/ ``` -Check out the following git tag. - -```shell -git checkout v1.1.3 -``` + Change the directory to the tutorial code. @@ -531,19 +511,13 @@ the **Enter** key. Next, issue the following command to stop the container. -```shell -docker stop tutorialContainer && \ -docker rmi --force ghcr.io/spectrocloud/tutorials:1.1.3 -``` + -```shell -podman stop tutorialContainer && \ -podman rmi --force ghcr.io/spectrocloud/tutorials:1.1.3 -``` + diff --git a/docs/docs-content/tutorials/cluster-deployment/pde/deploy-app.md b/docs/docs-content/tutorials/cluster-deployment/pde/deploy-app.md index f6e8a175a7..e623de069a 100644 --- a/docs/docs-content/tutorials/cluster-deployment/pde/deploy-app.md +++ b/docs/docs-content/tutorials/cluster-deployment/pde/deploy-app.md @@ -389,19 +389,9 @@ displaying the version number. docker version ``` -Download the tutorial image to your local machine.
+ -```bash -docker pull ghcr.io/spectrocloud/tutorials:1.1.3 -``` - -Next, start the container, and open a bash session into it. - -
- -```shell -docker run --name tutorialContainer --interactive --tty ghcr.io/spectrocloud/tutorials:1.1.3 bash -``` + Navigate to the tutorial code. @@ -429,19 +419,9 @@ Use the following command and ensure you receive an output displaying the instal podman info ``` -Download the tutorial image to your local machine.
- -```bash -podman pull ghcr.io/spectrocloud/tutorials:1.1.3 -``` - -Next, start the container, and open a bash session into it. + -
- -```shell -podman run --name tutorialContainer --interactive --tty ghcr.io/spectrocloud/tutorials:1.1.3 bash -``` + Navigate to the tutorial code. @@ -471,13 +451,7 @@ Change directory to the tutorial folder. cd tutorials/ ``` -Check out the following git tag. - -
- -```shell -git checkout v1.0.4 -``` + Change directory to the tutorial code. @@ -1247,19 +1221,13 @@ the **Enter** key. Next, issue the following command to stop the container. -```shell -docker stop tutorialContainer && \ -docker rmi --force ghcr.io/spectrocloud/tutorials:1.1.3 -``` + -```shell -podman stop tutorialContainer && \ -podman rmi --force ghcr.io/spectrocloud/tutorials:1.1.3 -``` + diff --git a/docs/docs-content/tutorials/cluster-deployment/public-cloud/deploy-k8s-cluster.md b/docs/docs-content/tutorials/cluster-deployment/public-cloud/deploy-k8s-cluster.md index b82f05d84d..1fac9cd1d2 100644 --- a/docs/docs-content/tutorials/cluster-deployment/public-cloud/deploy-k8s-cluster.md +++ b/docs/docs-content/tutorials/cluster-deployment/public-cloud/deploy-k8s-cluster.md @@ -828,17 +828,9 @@ displaying the version number. docker version ``` -Download the tutorial image to your local machine. + -```bash -docker pull ghcr.io/spectrocloud/tutorials:1.1.3 -``` - -Next, start the container, and open a bash session into it. - -```shell -docker run --name tutorialContainer --interactive --tty ghcr.io/spectrocloud/tutorials:1.1.3 bash -``` + Navigate to the tutorial code. @@ -864,17 +856,9 @@ Use the following command and ensure you receive an output displaying the instal podman info ``` -Download the tutorial image to your local machine. + -```bash -podman pull ghcr.io/spectrocloud/tutorials:1.1.3 -``` - -Next, start the container, and open a bash session into it. - -```shell -podman run --name tutorialContainer --interactive --tty ghcr.io/spectrocloud/tutorials:1.1.3 bash -``` + Navigate to the tutorial code. @@ -898,11 +882,7 @@ Change the directory to the tutorial folder. cd tutorials/ ``` -Check out the following git tag. - -```shell -git checkout v1.1.3 -``` + Change the directory to the tutorial code. @@ -1352,19 +1332,13 @@ the **Enter** key. Next, issue the following command to stop the container. -```shell -docker stop tutorialContainer && \ -docker rmi --force ghcr.io/spectrocloud/tutorials:1.1.3 -``` + -```shell -podman stop tutorialContainer && \ -podman rmi --force ghcr.io/spectrocloud/tutorials:1.1.3 -``` + diff --git a/docs/docs-content/tutorials/cluster-management/update-maintain/update-k8s-cluster.md b/docs/docs-content/tutorials/cluster-management/update-maintain/update-k8s-cluster.md index 10c26bff5c..c807595c25 100644 --- a/docs/docs-content/tutorials/cluster-management/update-maintain/update-k8s-cluster.md +++ b/docs/docs-content/tutorials/cluster-management/update-maintain/update-k8s-cluster.md @@ -96,11 +96,7 @@ Change the directory to the tutorial folder. cd tutorials/ ``` -Check out the following git tag. - -```shell -git checkout v1.1.3 -``` + Change the directory to the tutorial code. diff --git a/docs/docs-content/tutorials/profiles/deploy-pack.md b/docs/docs-content/tutorials/profiles/deploy-pack.md index 4782781ce2..ceeb14b2be 100644 --- a/docs/docs-content/tutorials/profiles/deploy-pack.md +++ b/docs/docs-content/tutorials/profiles/deploy-pack.md @@ -94,17 +94,17 @@ the currently active containers. docker ps ``` -Use the following command to download the `ghcr.io/spectrocloud/tutorials:1.1.2` image to your local machine. This +Use the following command to download the `ghcr.io/spectrocloud/tutorials:1.1.7` image to your local machine. This Docker image includes the necessary tools. ```bash -docker pull ghcr.io/spectrocloud/tutorials:1.1.2 +docker pull ghcr.io/spectrocloud/tutorials:1.1.7 ``` Next, start the container and open a bash session into it. ```bash -docker run --name tutorialContainer --publish 7000:5000 --interactive --tty ghcr.io/spectrocloud/tutorials:1.1.2 bash +docker run --name tutorialContainer --publish 7000:5000 --interactive --tty ghcr.io/spectrocloud/tutorials:1.1.7 bash ``` @@ -117,17 +117,17 @@ Ensure that Podman is available by issuing a command to list the currently activ podman ps ``` -Use the following command to download the `ghcr.io/spectrocloud/tutorials:1.1.2` image to your local machine. This image +Use the following command to download the `ghcr.io/spectrocloud/tutorials:1.1.7` image to your local machine. This image includes the necessary tools. ```bash -podman pull ghcr.io/spectrocloud/tutorials:1.1.2 +podman pull ghcr.io/spectrocloud/tutorials:1.1.7 ``` Next, start the container and open a bash session into it. ```bash -podman run --name tutorialContainer --publish 7000:5000 --interactive --tty ghcr.io/spectrocloud/tutorials:1.1.2 bash +podman run --name tutorialContainer --publish 7000:5000 --interactive --tty ghcr.io/spectrocloud/tutorials:1.1.7 bash ``` @@ -1290,19 +1290,13 @@ the following commands. -```bash -docker container rm --force tutorialContainer -docker image rm --force ghcr.io/spectrocloud/tutorials:1.1.2 -``` + -```bash -podman container rm --force tutorialContainer -podman image rm --force ghcr.io/spectrocloud/tutorials:1.1.2 -``` +