Skip to content

Commit 2f3853b

Browse files
benradstonebenradstone
authored
Merge branch 'master' into docs-rel-4-7-a
2 parents 826e2eb + 6cf1bbb commit 2f3853b

File tree

13 files changed

+444
-659
lines changed

13 files changed

+444
-659
lines changed

‎_partials/pcg/_pcg-cluster-provisioning.mdx‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
partial_category: pcg
3+
partial_name: pcg-cluster-provisioning
4+
---
5+
6+
A new PCG configuration file is generated, and its location is displayed on the console.
7+
8+
```bash hideClipboard title="Example output"
9+
==== PCG config saved ====
10+
Location: :/home/demo/.palette/pcg/pcg-20230706150945/pcg.yaml
11+
```
12+
13+
The Palette CLI begins provisioning a PCG cluster in your {props.edition} environment. Take the following steps to monitor the progress of the PCG
14+
deployment.
15+
16+
1. Log in to [Palette](https://console.spectrocloud.com) as a tenant admin.
17+
18+
2. From the left main menu, select **Tenant Settings**.
19+
20+
3. From the **Tenant Settings Menu**, below **Infrastructure**, select **Private Cloud Gateways**.
21+
22+
4. Select the PCG cluster being deployed. Use the **Events** tab to monitor the deployment progress of your PCG cluster.
23+
24+
If you encounter issues during the installation, refer to our <VersionedLink text="PCG Troubleshooting" url="/troubleshooting/pcg" />
25+
guide. For additional assistance, reach out to our [Customer Support](https://spectrocloud.atlassian.net/servicedesk/customer/portals) team.
26+
27+
:::warning
28+
29+
You cannot modify a deployed PCG cluster. If you need to make changes to your PCG cluster, you must delete the existing PCG cluster
30+
and redeploy it with your updated configurations. For this reason, we recommend you save your PCG configuration file for future use.
31+
Use the Palette CLI `--config-only` flag to save the PCG configuration file without deploying the PCG cluster. Refer to our <VersionedLink text="Generate a Configuration File" url="/automation/palette-cli/commands/pcg#generate-a-configuration-file" /> guide.
32+
33+
:::

‎_partials/pcg/_pcg-initial-installation.mdx‎

Lines changed: 157 additions & 0 deletions
Large diffs are not rendered by default.

‎_partials/pcg/_pcg-kind-cleanup.mdx‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
partial_category: pcg
3+
partial_name: pcg-kind-cleanup
4+
---
5+
6+
To avoid potential vulnerabilities, once your PCG cluster is deployed, remove the `kind` images that were installed
7+
in the environment where you initiated the installation.
8+
9+
Issue the following command to list all instances of `kind` that exist in the environment.
10+
11+
```shell
12+
docker images
13+
```
14+
15+
```shell hideClipboard title="Example output"
16+
REPOSITORY TAG IMAGE ID CREATED SIZE
17+
kindest/node v1.26.13 131ad18222cc 5 months ago 910MB
18+
```
19+
20+
Then, use the following command template to remove all instances of `kind`. Replace `<tag>` with your `kind` image tag.
21+
22+
```shell
23+
docker image rm kindest/node:<tag>
24+
```
25+
26+
Consider the following example for reference.
27+
28+
```shell hideClipboard title="Example command"
29+
docker image rm kindest/node:v1.26.13
30+
```
31+
32+
```shell hideClipboard title="Example output"
33+
Untagged: kindest/node:v1.26.13
34+
Untagged: kindest/node@sha256:15ae92d507b7d4aec6e8920d358fc63d3b980493db191d7327541fbaaed1f789
35+
Deleted: sha256:131ad18222ccb05561b73e86bb09ac3cd6475bb6c36a7f14501067cba2eec785
36+
Deleted: sha256:85a1a4dfc468cfeca99e359b74231e47aedb007a206d0e2cae2f8290e7290cfd
37+
```

‎_partials/pcg/_pcg-validate.mdx‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
partial_category: pcg
3+
partial_name: pcg-validate
4+
---
5+
6+
Once installed, the PCG registers itself with Palette. To verify the PCG is registered, take the following steps.
7+
8+
1. Log in to [Palette](https://console.spectrocloud.com) as a tenant admin.
9+
10+
2. From the left main menu, select **Tenant Settings**.
11+
12+
3. From the **Tenant Settings Menu**, below **Infrastructure**, select **Private Cloud Gateways**.
13+
14+
4. Verify your PCG cluster is displayed and that it has a green check mark for its **Health**.
15+
16+
5. Next, from the **Tenant Settings Menu**, below **Infrastructure**, select **Cloud Accounts**.
17+
18+
6. Verify a new {props.edition} cloud account is displayed.

‎_partials/self-hosted/upgrade/_airgap-binary-execution.mdx‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
partial_category: self-hosted
3+
partial_name: airgap-binary-execution
4+
---
5+
6+
```shell hideClipboard title="Example output" {9-10}
7+
Verifying archive integrity... 100% MD5 checksums are OK. All good.
8+
Uncompressing Airgap Setup - Version 4.0.17 100%
9+
Setting up Packs
10+
- Pushing Pack cni-calico:3.25.1
11+
...
12+
Setting up Images
13+
- Pushing image docker.io/kindest/kindnetd:v20230227-15197099
14+
...
15+
Preparing Manifests Archive
16+
Manifests are available in /tmp/spectro-manifests-1696971110.zip.
17+
Setup Completed
18+
```

‎docs/docs-content/clusters/pcg/architecture.md‎

Lines changed: 30 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -49,19 +49,41 @@ also shared with the workload cluster during the cluster deployment.
4949

5050
### Network Proxy
5151

52-
The PCG supports using a proxy server to access the internet if needed. If you are installing the PCG through the
53-
Palette CLI, you can provide the proxy server details, including any required Certificate Authority certificates, during
54-
installation. The PCG will use the provided proxy server to access the internet. The PCG will also provide the proxy
55-
server details to the deployed workload clusters.
56-
57-
A PCG installed onto an existing Kubernetes cluster will inherit the proxy server configuration from the underlying
58-
Kubernetes cluster. Contact your Kubernetes administrator for the proxy server details and guidance on configuring the
59-
underlying Kubernetes cluster to use a proxy server if needed.
52+
The PCG supports using a proxy server to access the internet if needed.
6053

6154
We encourage you to review the [gRPC and Proxies](../../architecture/grps-proxy.md) reference page to better prepare for
6255
using a proxy server with the PCG. Depending on your network proxy configuration and software, you may need to make
6356
updates to ensure compatibility with Palette.
6457

58+
#### Palette CLI
59+
60+
If you are installing the PCG through the Palette CLI, you can provide the proxy server details during installation. The
61+
proxy server details are saved as environment variables (`HTTPS_PROXY`, `HTTP_PROXY`, and `NO_PROXY`) and are propagated
62+
to all PCG cluster nodes, as well as the nodes of all tenant workload clusters deployed with the PCG. The provided proxy
63+
servers are then used by the PCG and workload clusters to access the internet.
64+
65+
You can also provide Certificate Authority (CA) certificates for the proxy server during installation. However, proxy CA
66+
certificates are only propagated to each PCG cluster node; they are not propagated to the nodes of tenant clusters.
67+
68+
Proxy CA certificates must be added to workload clusters at either the tenant level or the cluster profile level in the
69+
OS layer.
70+
71+
- If configured at the tenant level, _all_ workload clusters provisioned from the tenant, with the exception of managed
72+
Kubernetes clusters (EKS, AKS, and GKE) and Edge clusters, will have the CA certificate injected into their cluster
73+
nodes.
74+
75+
- If configured at the cluster profile level, only workload clusters deployed using the cluster profile will be injected
76+
with the CA certificate.
77+
78+
For guidance on configuring proxy CA certificates, refer to appropriate Palette CLI PCG deployment guide for
79+
[MAAS](./deploy-pcg/maas.md), [OpenStack](./deploy-pcg/openstack.md), or [VMware vSphere](./deploy-pcg/vmware.md).
80+
81+
#### Existing Kubernetes Cluster
82+
83+
A PCG installed onto an existing Kubernetes cluster will inherit the proxy server configuration from the underlying
84+
Kubernetes cluster. Contact your Kubernetes administrator for the proxy server details and guidance on configuring the
85+
underlying Kubernetes cluster to use a proxy server if needed.
86+
6587
## Cluster Lifecycle Support
6688

6789
The PCG supports the lifecycle of Kubernetes clusters deployed in your private cloud environments. When you initiate a

0 commit comments

Comments
 (0)