docs: document application proxy #3471
Conversation
lennessyy
added
backport-version-4-0
❌ Deploy Preview for docs-spectrocloud failed. Why did it fail? →
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
|
||
| If you are provisioning the PCG using the Palette CLI, you can configure the proxy settings during the PCG | ||
| installation through the Palette CLI's interactive prompts. If you are using Helm to provision a PCG or have an | ||
| existing PCG that is not yet configured to use proxy, refer to to |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Repetition] 'to' is repeated!
| `your-namespace` with the namespace where the pod resides. | ||
|
|
||
| ``` | ||
| kubectl get pod pod-name -o jsonpath='{.spec.containers[*].env}' --namespace your-namespace | jq . |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[spectrocloud-docs-internal.longform] Avoid using the short form of commands. Replace the short form flag in 'name -o' with the corresponding long form flag.
✅ Deploy Preview for docs-spectrocloud ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
|
||
| If you are provisioning the PCG using the Palette CLI, you can configure the proxy settings during the PCG | ||
| installation through the Palette CLI's interactive prompts. If you are using Helm to provision a PCG or have an | ||
| existing PCG that is not yet configured to use proxy, refer to to |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Repetition] 'to' is repeated!
| `your-namespace` with the namespace where the pod resides. | ||
|
|
||
| ``` | ||
| kubectl get pod pod-name -o jsonpath='{.spec.containers[*].env}' --namespace your-namespace | jq . |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[spectrocloud-docs-internal.longform] Avoid using the short form of commands. Replace the short form flag in 'name -o' with the corresponding long form flag.
lennessyy
removed
backport-version-4-0
There was a problem hiding this comment.
Great writeup @lennessyy . Some suggestions and comments below.
| [Enable and Manage Proxy Configurations for PCG](../pcg/manage-pcg/configure-proxy.md) to learn how to install Reach | ||
| on a PCG cluster and use it to configure proxy settings. | ||
|
|
||
| 2. Once you have configured proxy settings through Reach for your PCG, you can proceed to create your cluster using a |
There was a problem hiding this comment.
SaaS customers will have to register a new cloud account in Palette and specify the PCG. They cannot alter existing cloud accounts. I think it would help if we link to the three public cloud accounts registration guides to help the user.
|
|
||
| <TabItem value="Palette SaaS Non-Edge"> | ||
|
|
||
| 1. If you are using Palette SaaS, you must deploy a Private Cloud Gateway (PCG) and configure it to use a proxy server |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'cloud' instead of 'Cloud'.
|
|
||
| 1. If you are using Palette SaaS, you must deploy a Private Cloud Gateway (PCG) and configure it to use a proxy server | ||
| before you can configure cluster applications to use the proxy server. For more information about PCGs, refer to | ||
| [Private Cloud Gateway](../pcg/pcg.md). You must configure proxy settings for the PCG, and then clusters created by |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'cloud' instead of 'Cloud'.
* docs: initial commit * docs: progress * docs: progress * docs: incomplete * docs: draft proxy settings * docs: finish draft of cluster proxy settings * docs: copy edits * docs: add prerequisite sections * docs: add prerequisites * docs: fix syntax issue * docs: fix syntax issue * docs: syntax issue * docs: fix broken links * docs: minor edit * docs: adjust list order * docs: address vale * docs: use group ID * docs: change code highlight * docs: address review feedback * docs: minor edit * docs: fix typo * docs: change link --------- Co-authored-by: Lenny Chen <[email protected]> Co-authored-by: Karl Cardenas <[email protected]> (cherry picked from commit 6b429f2)
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation and see the Github Action logs for details |
* docs: initial commit * docs: progress * docs: progress * docs: incomplete * docs: draft proxy settings * docs: finish draft of cluster proxy settings * docs: copy edits * docs: add prerequisite sections * docs: add prerequisites * docs: fix syntax issue * docs: fix syntax issue * docs: syntax issue * docs: fix broken links * docs: minor edit * docs: adjust list order * docs: address vale * docs: use group ID * docs: change code highlight * docs: address review feedback * docs: minor edit * docs: fix typo * docs: change link --------- Co-authored-by: Lenny Chen <[email protected]> Co-authored-by: Karl Cardenas <[email protected]> (cherry picked from commit 6b429f2) Co-authored-by: Lenny Chen <[email protected]>
|
🎉 This PR is included in version 4.4.12 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
Describe the Change
This PR documents how to configure applications to use proxy settings in a cluster.
Changed Pages
💻 Configure Applications to Use Proxy Server
Jira Tickets
🎫 Jira Ticket
Backports
Can this PR be backported?