docs: clarify cluster-proxy installation for non-kind clusters #436
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
|
/assign @qiujian16 |
dhaiducek
reviewed
Nov 5, 2024
| @@ -110,6 +110,18 @@ Then run the following helm command to install the cluster-proxy addon: | |||
| ```shell | |||
| $ helm install -n open-cluster-management-addon --create-namespace \ | |||
| cluster-proxy ocm/cluster-proxy | |||
| ``` | |||
|
|
|||
| **Note:**, if you're using a non-kind cluster, for example, an openshift cluster, you need to set the value of `proxyServer.entrypointAddress` in the managedproxyconfiguration to the address of the proxy server. | |||
There was a problem hiding this comment.
Please re-flow this line to follow the line wrapping in the rest of the document.
| --set "proxyServer.entrypointAddress=<address of the proxy server>" | ||
| ``` | ||
|
|
||
| After the installation, you can check the deployment status of the cluster-proxy addon by running the following command: |
There was a problem hiding this comment.
Please re-flow this line to follow the line wrapping in the rest of the document.
| @@ -110,6 +110,18 @@ Then run the following helm command to install the cluster-proxy addon: | |||
| ```shell | |||
| $ helm install -n open-cluster-management-addon --create-namespace \ | |||
| cluster-proxy ocm/cluster-proxy | |||
| ``` | |||
|
|
|||
| **Note:**, if you're using a non-kind cluster, for example, an openshift cluster, you need to set the value of `proxyServer.entrypointAddress` in the managedproxyconfiguration to the address of the proxy server. | |||
There was a problem hiding this comment.
Capitalize "Kind" and "Openshift". Also has a minor wording suggestion.
Suggested change
| **Note:**, if you're using a non-kind cluster, for example, an openshift cluster, you need to set the value of `proxyServer.entrypointAddress` in the managedproxyconfiguration to the address of the proxy server. | |
| **Note:** If you're using a non-Kind cluster, for example, an Openshift cluster, you need to configure the `ManagedProxyConfiguration` by setting `proxyServer.entrypointAddress` in the `values.yaml` to the address of the proxy server. To do this at install time, you can run the following command: |
xuezhaojun
force-pushed
the
update-cluster-proxy-addon-installation
branch
from
3730eb5
to
e3f67eb
Compare
|
Thanks for the review @dhaiducek, the PR updated, please take another look! |
dhaiducek
reviewed
Nov 5, 2024
|
|
||
| **Note:** If you're using a non-Kind cluster, for example, an Openshift cluster, | ||
| you need to configure the `ManagedProxyConfiguration` by setting `proxyServer.entrypointAddress` | ||
| in the `values.yaml` to the address of the proxy server. |
There was a problem hiding this comment.
Extra space here (my fault 😅 )
Suggested change
| in the `values.yaml` to the address of the proxy server. | |
| in the `values.yaml` to the address of the proxy server. |
Updates the cluster-proxy installation documentation to clarify that non-kind clusters (e.g., OpenShift) require setting the proxyServer.entrypointAddress value. Adds an example helm install command showing how to set this value. Signed-off-by: xuezhaojun <[email protected]>
xuezhaojun
force-pushed
the
update-cluster-proxy-addon-installation
branch
from
e3f67eb
to
0009246
Compare
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: dhaiducek, xuezhaojun The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
openshift-merge-bot
bot
merged commit 0e61c92
into
open-cluster-management-io:main
3 checks passed
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.
Updates the cluster-proxy installation documentation to clarify that non-kind clusters (e.g., OpenShift) require setting the proxyServer.entrypointAddress value. Adds an example helm install command showing how to set this value.