Update the support-bundle-image setting #624
Open
Conversation
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
3 tasks
|
w13915984028
force-pushed
the
doc6277
branch
2 times, most recently
from
d24e370
to
a5f7a99
Compare
Signed-off-by: Jian Wang <jian.wang@suse.com>
w13915984028
changed the title
w13915984028
commented
Aug 16, 2024
|
|
||
| - If you have set a customized image but want to follow the default image, then use the `kubectl` command to clear the `value` field. | ||
|
|
||
| - The UI menu **Use the default value** is not the best option to clear this setting. It copies the current `default` to `value`, the `default` will be updated when upgrading but the `value` field will not. |
There was a problem hiding this comment.
It is a bit surprised to observe the side affect of Use the default value in this context. UI? copies the default field to Value field.
Alternatively, if user clicks Use the default value and does not further change the configuration, when saving, UI deletes the value field; thus it really always sticks to default.
In different Harvester releases, Harvester may change the default.
WDYT? thanks.
| @@ -414,7 +414,9 @@ Specify an IP range in the IPv4 CIDR format. The number of IPs must be four time | |||
|
|
|||
| **Definition**: Support bundle image, with various versions available in [rancher/support-bundle-kit](https://hub.docker.com/r/rancher/support-bundle-kit/tags). | |||
|
|
|||
| **Default value**: | |||
| **Default value**: The default value is the `support-bundle-kit` image which is packed into the Harvester ISO. It varies between different Harvester releases. | |||
There was a problem hiding this comment.
Suggested change
| **Default value**: The default value is the `support-bundle-kit` image which is packed into the Harvester ISO. It varies between different Harvester releases. | |
| **Default value**: `support-bundle-kit` image that is packed into the Harvester ISO and is specific to each Harvester release. |
| **Default value**: | ||
| **Default value**: The default value is the `support-bundle-kit` image which is packed into the Harvester ISO. It varies between different Harvester releases. | ||
|
|
||
| **Example**: After one Harvester cluster is installed, you observe that the `default` image tag is `v0.0.25`. |
There was a problem hiding this comment.
Suggested change
| **Example**: After one Harvester cluster is installed, you observe that the `default` image tag is `v0.0.25`. | |
| **Example**: | |
| In this example, the default image tag of the cluster is `v0.0.25`. |
| @@ -424,6 +426,99 @@ Specify an IP range in the IPv4 CIDR format. The number of IPs must be four time | |||
| } | |||
| ``` | |||
|
|
|||
| From CLI, the `support-bundle-image` setting object is like: | |||
There was a problem hiding this comment.
Suggested change
| From CLI, the `support-bundle-image` setting object is like: | |
| The CLI shows the following `support-bundle-image` setting object: |
| status: {} | ||
| ``` | ||
|
|
||
| And you want to use the newer image tag `v0.0.36`, after setting from Harvester UI it is like: |
There was a problem hiding this comment.
Suggested change
| And you want to use the newer image tag `v0.0.36`, after setting from Harvester UI it is like: | |
| After some time, a newer image tag (`v0.0.36`) is specified in the `value` field using the Harvester UI. |
| value: '{"repository":"rancher/support-bundle-kit","tag":"v0.0.36","imagePullPolicy":"IfNotPresent"}' // your setting value | ||
| ``` | ||
|
|
||
| Later this cluster is upgraded, it is further like: |
There was a problem hiding this comment.
Suggested change
| Later this cluster is upgraded, it is further like: | |
| Eventually, this cluster is upgraded and the object changes again. |
|
|
||
| :::note | ||
|
|
||
| - Harvester always sets the `default` field to the image tag which is packed into Harvester ISO. When the cluster is upgraded, the `default` field is also updated automatically. As long as the `value` field is not set or empty, Harvester sticks to the `default` field. It makes sure the image is on the cluster and is up-to-date. |
There was a problem hiding this comment.
Suggested change
| - Harvester always sets the `default` field to the image tag which is packed into Harvester ISO. When the cluster is upgraded, the `default` field is also updated automatically. As long as the `value` field is not set or empty, Harvester sticks to the `default` field. It makes sure the image is on the cluster and is up-to-date. | |
| - The value of `tag` in the `default` field is always based on the image that is packed into the Harvester ISO. This field is automatically updated whenever the cluster is upgraded. | |
| - The `default` field is used when the `value` field is not set or is left empty. Harvester checks if the default image is stored in the cluster and is up-to-date. |
|
|
||
| - Harvester always sets the `default` field to the image tag which is packed into Harvester ISO. When the cluster is upgraded, the `default` field is also updated automatically. As long as the `value` field is not set or empty, Harvester sticks to the `default` field. It makes sure the image is on the cluster and is up-to-date. | ||
|
|
||
| - In general you do not need to set this setting. If you plan to set a specific image, be aware that it will take precedence of the `default` and is not updated automatically. |
There was a problem hiding this comment.
Suggested change
| - In general you do not need to set this setting. If you plan to set a specific image, be aware that it will take precedence of the `default` and is not updated automatically. | |
| - Configuring this setting is not required. If you decide to specify a different image tag in the `value` field, remember that this tag may become outdated when the cluster is upgraded. |
|
|
||
| - In general you do not need to set this setting. If you plan to set a specific image, be aware that it will take precedence of the `default` and is not updated automatically. | ||
|
|
||
| - If you have set a customized image but want to follow the default image, then use the `kubectl` command to clear the `value` field. |
There was a problem hiding this comment.
Suggested change
| - If you have set a customized image but want to follow the default image, then use the `kubectl` command to clear the `value` field. | |
| - Use the command `$ kubectl edit settings.harvesterhci.io support-bundle-image` to clear the `value` field. |
|
|
||
| - If you have set a customized image but want to follow the default image, then use the `kubectl` command to clear the `value` field. | ||
|
|
||
| - The UI menu **Use the default value** is not the best option to clear this setting. It copies the current `default` to `value`, the `default` will be updated when upgrading but the `value` field will not. |
There was a problem hiding this comment.
Suggested change
| - The UI menu **Use the default value** is not the best option to clear this setting. It copies the current `default` to `value`, the `default` will be updated when upgrading but the `value` field will not. | |
| - The **Use the default value** button on the Harvester UI only copies the contents of the `default` field to the `value` field. You may use this to replace an outdated image tag, but the copied tag will eventually become outdated as well (when the cluster is upgraded and the `default` field is updated). |
|
|
||
| - The UI menu **Use the default value** is not the best option to clear this setting. It copies the current `default` to `value`, the `default` will be updated when upgrading but the `value` field will not. | ||
|
|
||
| - If your cluster is in an air-gapped environment and the set `support-bundle-image` is not the default one, you need to prepare this image on your local [containerd registry](#containerd-registry). The operation [Generate a Support Bundle](../troubleshooting/harvester.md#generate-a-support-bundle) will fail if the set image is not available. |
There was a problem hiding this comment.
Suggested change
| - If your cluster is in an air-gapped environment and the set `support-bundle-image` is not the default one, you need to prepare this image on your local [containerd registry](#containerd-registry). The operation [Generate a Support Bundle](../troubleshooting/harvester.md#generate-a-support-bundle) will fail if the set image is not available. | |
| - If your cluster is in an air-gapped environment and you specified a non-default image tag in the `value` field, ensure that the image is available in the local [containerd registry](#containerd-registry). Harvester is unable to [generate a support bundle](../troubleshooting/harvester.md#generate-a-support-bundle) if the image is not available. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Add more details about support-bundle-image setting and suggest user not to set it in general.
Issue: harvester/harvester#6277