docs: add note to change Longhorn images to reference harbor #2497
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -84,6 +84,10 @@ The following known issues exist in the Longhorn 1.5.X release. | |
| [known issue](https://github.com/longhorn/longhorn/issues/6962) in the Longhorn GitHub repository and a fix is on the | ||
| roadmap. | ||
|
|
||
| - Using Longhorn together in airgap environments with an external registry requires you to update the Longhorn pack | ||
| image references to use the base URL of the Harbor registry. For more information, refer to | ||
| [Longhorn Deployer Stuck in Init State in Airgap Environments](#using-longhorn-with-harbor-registry-in-airgap-environments). | ||
|
There was a problem hiding this comment. 🚫 [vale] reported by reviewdog 🐶 |
||
|
|
||
| </TabItem> | ||
|
|
||
| <TabItem label="1.4.x" value="1.4.x"> | ||
|
|
@@ -136,6 +140,72 @@ when learning how to use Longhorn. | |
| We also recommend you check out the [Examples](https://longhorn.io/docs/1.4.4/references/examples/) section of the | ||
| Longhorn documentation. The examples section contains several use cases of how to configure Longhorn. | ||
|
|
||
| ### Using Longhorn with Harbor Registry in Airgap Environments | ||
|
There was a problem hiding this comment. 🚫 [vale] reported by reviewdog 🐶 |
||
|
|
||
| When you use the Longhorn pack in an airgapped environment, the Harbor Edge-Native Config pack is required for your | ||
|
There was a problem hiding this comment. 🚫 [vale] reported by reviewdog 🐶 |
||
| cluster to function. However, you must change the image references in the Longhorn pack to use the base URL of the local | ||
| Harbor registry. Otherwise, the cluster will fail to deploy, with the `longhorn-driver-deployer` pod stuck in the `Init` | ||
| state. | ||
|
|
||
| 1. Log in to Palette. | ||
|
|
||
| 2. From the left **Main Menu**, select **Profiles**. | ||
|
|
||
| 3. Select the cluster profile you use to deploy the cluster with Longhorn. | ||
|
|
||
| 4. In the pack YAML for the Longhorn pack, replace the base URL of each image referenced in the pack with the Harbor | ||
| registry. | ||
|
|
||
| For example, the following is a snippet of the Longhorn pack's YAML before and after you replace the base URL. | ||
|
|
||
| <Tabs> | ||
|
|
||
| <TabItem label="Before Replacement" value="before"> | ||
|
|
||
| ```yaml | ||
| pack: | ||
| namespace: "longhorn-system" | ||
| namespaceLabels: | ||
| "longhorn-system": | ||
| "pod-security.kubernetes.io/enforce=privileged,pod-security.kubernetes.io/enforce-version=v{{ | ||
| .spectro.system.kubernetes.version | substr 0 4 }}" | ||
| content: | ||
| images: | ||
| - image: gcr.io/spectro-images-public/packs/csi-longhorn/1.5.3/longhorn-engine:v1.5.3 | ||
| - image: gcr.io/spectro-images-public/packs/csi-longhorn/1.5.3/longhorn-manager:v1.5.3 | ||
| - image: gcr.io/spectro-images-public/packs/csi-longhorn/1.5.3/longhorn-ui:v1.5.3 | ||
| - image: gcr.io/spectro-images-public/packs/csi-longhorn/1.5.3/longhorn-instance-manager:v1.5.3 | ||
| - image: gcr.io/spectro-images-public/packs/csi-longhorn/1.5.3/longhorn-share-manager:v1.5.3 | ||
| ``` | ||
|
|
||
| </TabItem> | ||
|
|
||
| <TabItem label="After Replacement" value="after"> | ||
|
|
||
| ```yaml | ||
| pack: | ||
| namespace: "longhorn-system" | ||
| namespaceLabels: | ||
| "longhorn-system": | ||
| "pod-security.kubernetes.io/enforce=privileged,pod-security.kubernetes.io/enforce-version=v{{ | ||
| .spectro.system.kubernetes.version | substr 0 4 }}" | ||
| content: | ||
| images: | ||
| - image: 10.10.137.220:30003/spectro-images-public/packs/csi-longhorn/1.5.3/longhorn-engine:v1.5.3 | ||
| - image: 10.10.137.220:30003/spectro-images-public/packs/csi-longhorn/1.5.3/longhorn-manager:v1.5.3 | ||
| - image: 10.10.137.220:30003/spectro-images-public/packs/csi-longhorn/1.5.3/longhorn-ui:v1.5.3 | ||
| - image: 10.10.137.220:30003/spectro-images-public/packs/csi-longhorn/1.5.3/longhorn-instance-manager:v1.5.3 | ||
| - image: 10.10.137.220:30003/spectro-images-public/packs/csi-longhorn/1.5.3/longhorn-share-manager:v1.5.3 | ||
| ``` | ||
|
|
||
| </TabItem> | ||
|
|
||
| </Tabs> | ||
|
|
||
| Refer to [Harbor Edge-Native Config](./harbor-edge.md#log-in-to-harbor-web-ui) pack documentation to learn how to | ||
|
There was a problem hiding this comment. 🚫 [vale] reported by reviewdog 🐶 |
||
| find the node IP and port of the Harbor registry. If you have given the registry a domain name, you can use the | ||
| domain name instead of the node IP. | ||
|
|
||
| </TabItem> | ||
|
|
||
| <TabItem label="1.3.x" value="1.3.x"> | ||
|
|
@@ -188,6 +258,72 @@ when learning how to use Longhorn. | |
| We also recommend you check out the [Examples](https://longhorn.io/docs/1.4.4/references/examples/) section of the | ||
| Longhorn documentation. The examples section contains several use cases of how to configure Longhorn. | ||
|
|
||
| ### Using Longhorn with Harbor Registry in Airgap Environments | ||
|
There was a problem hiding this comment. 🚫 [vale] reported by reviewdog 🐶 |
||
|
|
||
| When you use the Longhorn pack in an airgapped environment, the Harbor Edge-Native Config pack is required for your | ||
lennessyy marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| cluster to function. However, you must change the image references in the Longhorn pack to use the base URL of the local | ||
| Harbor registry. Otherwise, the cluster will fail to deploy, with the `longhorn-driver-deployer` pod stuck in the `Init` | ||
| state. | ||
|
|
||
| 1. Log in to Palette. | ||
|
|
||
| 2. From the left **Main Menu**, select **Profiles**. | ||
|
|
||
| 3. Select the cluster profile you use to deploy the cluster with Longhorn. | ||
|
|
||
| 4. In the pack YAML for the Longhorn pack, replace the base URL of each image referenced in the pack with the Harbor | ||
| registry. | ||
|
|
||
| For example, the following is a snipped of the Longhorn pack's YAML before and after you replace the base URL: | ||
lennessyy marked this conversation as resolved.
Show resolved
Hide resolved
lennessyy marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| <Tabs> | ||
|
There was a problem hiding this comment. Might be good to use the highlight feature, just to help draw attention to the proper part of the YAMl. I caught myself looking at the label, thinking you were doing magic there 🙈 |
||
|
|
||
| <TabItem label="Before Replacement" value="before"> | ||
|
|
||
| ```yaml | ||
| pack: | ||
| namespace: "longhorn-system" | ||
| namespaceLabels: | ||
| "longhorn-system": | ||
| "pod-security.kubernetes.io/enforce=privileged,pod-security.kubernetes.io/enforce-version=v{{ | ||
| .spectro.system.kubernetes.version | substr 0 4 }}" | ||
| content: | ||
| images: | ||
| - image: gcr.io/spectro-images-public/packs/csi-longhorn/1.5.3/longhorn-engine:v1.5.3 | ||
| - image: gcr.io/spectro-images-public/packs/csi-longhorn/1.5.3/longhorn-manager:v1.5.3 | ||
| - image: gcr.io/spectro-images-public/packs/csi-longhorn/1.5.3/longhorn-ui:v1.5.3 | ||
| - image: gcr.io/spectro-images-public/packs/csi-longhorn/1.5.3/longhorn-instance-manager:v1.5.3 | ||
| - image: gcr.io/spectro-images-public/packs/csi-longhorn/1.5.3/longhorn-share-manager:v1.5.3 | ||
| ``` | ||
|
|
||
| </TabItem> | ||
|
|
||
| <TabItem label="After Replacement" value="after"> | ||
|
|
||
| ```yaml | ||
| pack: | ||
| namespace: "longhorn-system" | ||
| namespaceLabels: | ||
| "longhorn-system": | ||
| "pod-security.kubernetes.io/enforce=privileged,pod-security.kubernetes.io/enforce-version=v{{ | ||
| .spectro.system.kubernetes.version | substr 0 4 }}" | ||
| content: | ||
| images: | ||
| - image: 10.10.137.220:30003/spectro-images-public/packs/csi-longhorn/1.5.3/longhorn-engine:v1.5.3 | ||
| - image: 10.10.137.220:30003/spectro-images-public/packs/csi-longhorn/1.5.3/longhorn-manager:v1.5.3 | ||
| - image: 10.10.137.220:30003/spectro-images-public/packs/csi-longhorn/1.5.3/longhorn-ui:v1.5.3 | ||
| - image: 10.10.137.220:30003/spectro-images-public/packs/csi-longhorn/1.5.3/longhorn-instance-manager:v1.5.3 | ||
| - image: 10.10.137.220:30003/spectro-images-public/packs/csi-longhorn/1.5.3/longhorn-share-manager:v1.5.3 | ||
| ``` | ||
|
|
||
| </TabItem> | ||
|
|
||
| </Tabs> | ||
|
|
||
| Refer to [Harbor Edge-Native Config](./harbor-edge.md#log-in-to-harbor-web-ui) pack documentation to learn how to | ||
lennessyy marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| find the node IP and port of the Harbor registry. If you have given the registry a domain name, you can use the | ||
|
There was a problem hiding this comment. So if I use a domain. Would I prefix with HTTPS/HTTP? |
||
| domain name instead of the node IP. | ||
|
|
||
| </TabItem> | ||
| </Tabs> | ||
|
|
||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Deployer'?