Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Yuliia Horbenko <[email protected]>
  • Loading branch information
karl-cardenas-coding and yuliiiah authored Jul 16, 2024
1 parent 90adb70 commit 3034f7b
Show file tree
Hide file tree
Showing 6 changed files with 23 additions and 23 deletions.
32 changes: 16 additions & 16 deletions docs/docs-content/clusters/pcg/manage-pcg/configure-proxy.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,30 +10,30 @@ tags: ["pcg", "proxy"]
---

You can add and manage proxy configurations for a Private Cloud Gateway (PCG) deployed into an existing Kubernetes
cluster. By default, a PCG deployed onto an existing Kubernetes cluster does not have a proxy configuration. If your
cluster. By default, a PCG deployed to an existing Kubernetes cluster does not have a proxy configuration. If your
infrastructure environment requires a proxy configuration, use the instructions in this guide to add and manage proxy
configurations for a PCG deployed in a Kubernetes cluster and to ensure workload clusters deployed through Palette
inherit the proxy configuration from the PCG cluster.

:::info

Your workload clusters deployed through Palette will inherit proxy configuration from the PCG cluster. The PCG is not
used as a network proxy for deployed workload clusters. The PCG also does not provide internet connectivity for the
workload clusters. Individual workload clusters must have their proxy configurations to access the internet.
Workload clusters deployed through Palette will inherit proxy configuration from the PCG cluster. The PCG is not
used as a network proxy for deployed workload clusters and does not provide internet connectivity for the
workload clusters. Individual workload clusters must have their own proxy configurations to access the internet.

:::

Use the following steps to add and manage proxy configurations for a PCG.

## Prerequisites

- A PCG is deployed into an active Kubernetes cluster, which is active and healthy. Refer to
- A PCG is deployed into an active and healthy Kubernetes cluster. Refer to
[Deploy a PCG to an Existing Kubernetes Cluster](../deploy-pcg-k8s.md) for additional guidance.

:::warning

If you deployed a [PCG through the Palette CLI](../pcg.md#supported-environments), refer to the respective platform
install guide for instructions on how to configure proxy settings during the installation process through the CLI.
installation guide for instructions on how to configure proxy settings during the installation process through the CLI.

:::

Expand All @@ -43,16 +43,16 @@ Use the following steps to add and manage proxy configurations for a PCG.
- Admin access to the Kubernetes cluster where the PCG is deployed. The Reach Helm Chart will create a namespace,
service accounts, and roles in the cluster.

- The extract utilities `zip` and `tar` are installed on the machine you are using to deploy the Helm chart.
- The extract utilities `zip` and `tar` are installed in the system you are using to deploy the Helm chart.

- Tenant administrator access.
- Palette tenant administrator access.

- Proxy configuration details, such as the proxy URL, port, and authentication credentials.

- The deployed PCG must have network connectivity to the proxy server.

- The Kubernetes cluster where the PCG is deployed must have the proxy configuration. This includes any Certificate
Authority (CA) certificates are required to authenticate the proxy server. This step varies depending on the platform
Authority (CA) certificates that are required to authenticate with the proxy server. This step varies depending on the platform
where the Kubernetes cluster is deployed. Some platforms, such as managed Kubernetes services, may require additional
steps. Below is a list of helpful links to set up proxy configurations for some common Kubernetes platforms:

Expand Down Expand Up @@ -80,13 +80,13 @@ Use the following steps to add and manage proxy configurations for a PCG.

1. Open a terminal session and navigate to the folder where you downloaded the Reach Helm Chart zip file.

2. Unzip the downloaded artifact you received from the support team.
2. Unzip the zip file you received from the support team.

```shell
unzip release-*.zip -d palette
```

3. Navigate to the release folder inside the unzipped folder.
3. Navigate to the release folder.

```shell
cd palette/charts/release-*/
Expand All @@ -106,15 +106,15 @@ Use the following steps to add and manage proxy configurations for a PCG.
cd extras/reach-system/ && tar -xvzf reach-system-*.tgz
```

6. Use a text editor and open the **values.yaml** file that is inside the **reach-system** directory. Fill out the
6. Open the **reach-system/values.yaml** file in a text editor. Fill out the
following YAML fields with the proxy configuration details:

- `reachSystem.enabled`: Set this field to `true` to enable the Reach service.
- `reachSystem.proxySettings.http_proxy`: The HTTP proxy URL, including the port number.
- `reachSystem.proxySettings.https_proxy`: The HTTPS proxy URL, including the port number.
- `reachSystem.proxySettings.no_proxy`: A comma-separated list of URLs that should bypass the proxy.
- `reachSystem.proxySettings.ca_crt_path`: The path to the CA certificate file used to authenticate the proxy server.
Make sure the CA is in PEM format. If you do not have a CA certificate, leave this field empty.
Make sure the CA certificate is in the PEM format. If you do not have a CA certificate, leave this field empty.

<br />

Expand Down Expand Up @@ -175,21 +175,21 @@ the PCG.

1. Open a terminal session.

2. Issue the following command against the Kubernetes cluster where the PCG is deployed. Verify the pods are active and
2. Issue the following command against the Kubernetes cluster where the PCG is deployed. Verify that the pods are active and
healthy.

```shell
kubectl get pods --namespace reach-system
```

The output should display the Reach service pods in a healthy state.
The output should display the Reach service pods in the **Running** status.

```shell hideClipboard
NAME READY STATUS RESTARTS AGE
reach-controller-manager-995c74db5-frb5j 2/2 Running 0 2m
```

3. After you configure your cloud account to use the PCG. You can verify that deployed clusters inherit the proxy
3. After configuring your cloud account to use the PCG, you can verify that the deployed workload clusters inherit the proxy
configuration from the PCG. To verify the proxy configuration is inherited by the workload clusters, deploy a
workload cluster through Palette. SSH into a node in the workload cluster and issue the following command to verify
the proxy configuration is inherited.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs-content/clusters/public-cloud/azure/aks.md
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ explains how you can create an Azure AKS cluster managed by Palette.
| **Storage Container** | Optionally, if you are using a custom storage container, use the **drop-down Menu** to select it. For information about use cases for custom storage, review [Azure Storage](../azure/architecture.md#azure-storage). |
| **SSH Key** | The public SSH key for connecting to the nodes. SSH key pairs must be pre-configured in your Azure environment. The key you select is inserted into the provisioned VMs. For more information, review Microsoft's [Supported SSH key formats](https://learn.microsoft.com/en-us/azure/virtual-machines/linux/mac-create-ssh-keys#supported-ssh-key-formats). |
| **Enable Private Cluster** | Whether the control plane or API server should have internal IP addresses. Refer to the [Create a private AKS cluster](https://learn.microsoft.com/en-us/azure/aks/private-clusters?tabs=azure-portal) guide for more information. |
| **Static Placement** | By default, Palette uses dynamic placement. This creates a new VNet for clusters with two subnets in different Availability Zones (AZs). Palette places resources in these clusters, manages the resources, and deletes them when the corresponding cluster is deleted.<br /><br />If you want to place resources into a pre-existing VNet, enable the **Static Placement** option and fill out the input values listed in the [Static Placement](#static-placement-settings) table below. <br /> <br /> Select **Static Placement** for clusters that you want to use your network proxy configurations. To learn more about proxy configurations, check out [Proxy Configuration](./architecture.md#proxy-configuration). |
| **Static Placement** | By default, Palette uses dynamic placement. This creates a new VNet for clusters with two subnets in different Availability Zones (AZs). Palette places resources in these clusters, manages the resources, and deletes them when the corresponding cluster is deleted.<br /><br />If you want to place resources into a pre-existing VNet, enable the **Static Placement** option and fill out the input values listed in the [Static Placement](#static-placement-settings) table below. <br /> <br /> Select **Static Placement** for clusters where you want to use your network proxy configurations. To learn more about proxy configurations, check out [Proxy Configuration](./architecture.md#proxy-configuration). |

#### Static Placement Settings

Expand Down
4 changes: 2 additions & 2 deletions docs/docs-content/clusters/public-cloud/azure/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,12 +170,12 @@ you use any of the following tags.

You can enable your Azure clusters to use a proxy server for outbound traffic. To use your proxy server with Azure
clusters, you must deploy a Private Cloud Gateway (PCG) in your Azure environment. The PCG must be configured with the
proxy server details. Once the PCG is deployed and configured with the proxy server details, newly deployed Azure
proxy server details. Once the PCG is deployed and configured with the proxy server details, the newly deployed Azure
clusters will inherit the proxy configurations from the PCG.

:::tip

We recommend you review the [gRPC and Proxies](../../../architecture/grps-proxy.md) to be aware of network proxies
We recommend you review the [gRPC and Proxies](../../../architecture/grps-proxy.md) to be aware of network proxies that
Palette supports. Palette uses gRPC to communicate with clusters, and depending on the proxy server you use, you may
need to configure the proxy server to support gRPC.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Use the following steps to add an Azure or Azure Government account in Palette o

:::info

If you want to provide network proxy configurations to your Kubernetes clusters deployed through Palette, you must use a
If you want to provide network proxy configurations to the Kubernetes clusters deployed through Palette, you must use a
PCG cluster. Check out the [Proxy Configuration](./architecture.md#proxy-configuration) section in the Architecture page
for more information.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ Use the following steps to deploy an Azure cluster.
| **Storage Account** | Optionally, if you have a custom storage account available, you can use the **drop-down Menu** to select the storage account name. For information about use cases for custom storage, review [Azure Storage](../azure/architecture.md#azure-storage). |
| **Storage Container** | Optionally, if you will be using a custom storage container, use the **drop-down Menu** to select it. For information about use cases for custom storage, review [Azure Storage](../azure/architecture.md#azure-storage). |
| **SSH Key** | The public SSH key for connecting to the nodes. SSH key pairs must be pre-configured in your Azure environment. The key you select is inserted into the provisioned VMs. For more information, review Microsoft's [Supported SSH key formats](https://learn.microsoft.com/en-us/azure/virtual-machines/linux/mac-create-ssh-keys#supported-ssh-key-formats). |
| **Static Placement** | By default, Palette uses dynamic placement. This creates a new VNet for clusters with two subnets in different Availability Zones (AZs). Palette places resources in these clusters, manages the resources, and deletes them when the corresponding cluster is deleted.<br /><br />If you want to place resources into a pre-existing VNet, enable the **Static Placement** option, and fill out the input values listed in the [Static Placement](#static-placement-settings) table below. <br /> <br /> Select **Static Placement** for clusters that you want to use your network proxy configurations. To learn more about proxy configurations, check out [Proxy Configuration](./architecture.md#proxy-configuration). |
| **Static Placement** | By default, Palette uses dynamic placement. This creates a new VNet for clusters with two subnets in different Availability Zones (AZs). Palette places resources in these clusters, manages the resources, and deletes them when the corresponding cluster is deleted.<br /><br />If you want to place resources into a pre-existing VNet, enable the **Static Placement** option, and fill out the input values listed in the [Static Placement](#static-placement-settings) table below. <br /> <br /> Select **Static Placement** for clusters where you want to use your network proxy configurations. To learn more about proxy configurations, check out [Proxy Configuration](./architecture.md#proxy-configuration). |

#### Static Placement Settings

Expand Down
4 changes: 2 additions & 2 deletions docs/docs-content/release-notes/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ tags: ["release-notes"]
the feature. Check out the [Feature Flags](../enterprise-version/system-management/feature-flags.md) documentation to
learn more.

- Kubernetes clusters deployed on Azure can now use network proxy configurations. To use this new feature, you must
- Kubernetes clusters deployed to Azure can now use network proxy configurations. To use this new feature, you must
deploy a PCG in your Azure environment and configure the PCG to use your network proxy server. Once the PCG is
deployed and configured with the proxy server details, newly deployed Azure clusters will inherit the proxy
deployed and configured with the proxy server details, the newly deployed Azure clusters will inherit the proxy
configurations from the PCG. To learn more, refer to the
[Proxy Configuration](../clusters/public-cloud/azure/architecture.md#proxy-configuration) guide.

Expand Down

0 comments on commit 3034f7b

Please sign in to comment.