Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document the step for removing kind images after EC and PCG installation #3337

Merged
merged 3 commits into from
Jul 12, 2024
Merged

Document the step for removing kind images after EC and PCG installation #3337

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
27d117e
docs: Document the step for removing kind creates and manages local K…
yuliiiah Jul 11, 2024
7a737be
chore: Trigger build
yuliiiah Jul 11, 2024
8898095
docs: Add the guidance for PCG deployments
yuliiiah Jul 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions docs/docs-content/clusters/pcg/deploy-pcg/maas.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,6 +221,39 @@ is not required for the DNS records to be accessible from the internet.

:::

9. To avoid potential vulnerabilities, once the installation is complete, remove the `kind` images that were installed
in the environment where you initiated the installation.

Issue the following command to list all instances of `kind` that exist in the environment.

```shell
docker images
```

```shell
REPOSITORY TAG IMAGE ID CREATED SIZE
kindest/node v1.26.13 131ad18222cc 5 months ago 910MB
```

Then, use the following command template to remove all instances of `kind`.

```shell
docker image rm kindest/node:<version>
```

Consider the following example for reference.

```shell
docker image rm kindest/node:v1.26.13
```

```shell
Untagged: kindest/node:v1.26.13
Untagged: kindest/node@sha256:15ae92d507b7d4aec6e8920d358fc63d3b980493db191d7327541fbaaed1f789
Deleted: sha256:131ad18222ccb05561b73e86bb09ac3cd6475bb6c36a7f14501067cba2eec785
Deleted: sha256:85a1a4dfc468cfeca99e359b74231e47aedb007a206d0e2cae2f8290e7290cfd
```

## Validate

Once installed, the PCG registers itself with Palette. To verify the PCG is registered, use the following steps.
Expand Down
33 changes: 33 additions & 0 deletions docs/docs-content/clusters/pcg/deploy-pcg/openstack.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -454,6 +454,39 @@ The following permissions are required to deploy a PCG to OpenStack and for Pale

:::

9. To avoid potential vulnerabilities, once the installation is complete, remove the `kind` images that were installed
in the environment where you initiated the installation.

Issue the following command to list all instances of `kind` that exist in the environment.

```shell
docker images
```

```shell
REPOSITORY TAG IMAGE ID CREATED SIZE
kindest/node v1.26.13 131ad18222cc 5 months ago 910MB
```

Then, use the following command template to remove all instances of `kind`.

```shell
docker image rm kindest/node:<version>
```

Consider the following example for reference.

```shell
docker image rm kindest/node:v1.26.13
```

```shell
Untagged: kindest/node:v1.26.13
Untagged: kindest/node@sha256:15ae92d507b7d4aec6e8920d358fc63d3b980493db191d7327541fbaaed1f789
Deleted: sha256:131ad18222ccb05561b73e86bb09ac3cd6475bb6c36a7f14501067cba2eec785
Deleted: sha256:85a1a4dfc468cfeca99e359b74231e47aedb007a206d0e2cae2f8290e7290cfd
```

## Validate

Once installed, the PCG registers itself with Palette. To verify the PCG is registered, use the following steps.
Expand Down
33 changes: 33 additions & 0 deletions docs/docs-content/clusters/pcg/deploy-pcg/vmware.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -536,6 +536,39 @@ The following requirements apply to tags:

:::

13. To avoid potential vulnerabilities, once the installation is complete, remove the `kind` images that were installed
in the environment where you initiated the installation.

Issue the following command to list all instances of `kind` that exist in the environment.

```shell
docker images
```

```shell
REPOSITORY TAG IMAGE ID CREATED SIZE
kindest/node v1.26.13 131ad18222cc 5 months ago 910MB
```

Then, use the following command template to remove all instances of `kind`.

```shell
docker image rm kindest/node:<version>
```

Consider the following example for reference.

```shell
docker image rm kindest/node:v1.26.13
```

```shell
Untagged: kindest/node:v1.26.13
Untagged: kindest/node@sha256:15ae92d507b7d4aec6e8920d358fc63d3b980493db191d7327541fbaaed1f789
Deleted: sha256:131ad18222ccb05561b73e86bb09ac3cd6475bb6c36a7f14501067cba2eec785
Deleted: sha256:85a1a4dfc468cfeca99e359b74231e47aedb007a206d0e2cae2f8290e7290cfd
```

## Validate

Once installed, the PCG registers itself with Palette. To verify the PCG is registered, use the following steps.
Expand Down
41 changes: 37 additions & 4 deletions .../enterprise-version/install-palette/install-on-vmware/airgap-install/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -316,7 +316,40 @@ Use the following steps to install Palette.
export KUBECONFIG=/ubuntu/.palette/ec/ec-20231012215923/spectro_mgmt.conf
```
17. Log in to the system console using the credentials provided in the Enterprise Cluster Details output. After login,
17. To avoid potential vulnerabilities, once the installation is complete, remove the `kind` images that were installed
in the environment where you initiated the installation.
Issue the following command to list all instances of `kind` that exist in the environment.
```shell
docker images
```
```shell
REPOSITORY TAG IMAGE ID CREATED SIZE
kindest/node v1.26.13 131ad18222cc 5 months ago 910MB
```
Then, use the following command template to remove all instances of `kind`.
```shell
docker image rm kindest/node:<version>
```
Consider the following example for reference.
```shell
docker image rm kindest/node:v1.26.13
```
```shell
Untagged: kindest/node:v1.26.13
Untagged: kindest/node@sha256:15ae92d507b7d4aec6e8920d358fc63d3b980493db191d7327541fbaaed1f789
Deleted: sha256:131ad18222ccb05561b73e86bb09ac3cd6475bb6c36a7f14501067cba2eec785
Deleted: sha256:85a1a4dfc468cfeca99e359b74231e47aedb007a206d0e2cae2f8290e7290cfd
```
18. Log in to the system console using the credentials provided in the Enterprise Cluster Details output. After login,
you will be prompted to create a new password. Enter a new password and save your changes. Refer to the
[password requirements](../../../system-management/account-management/credentials.md#password-requirements-and-security)
documentation page to learn more about the password requirements.
Expand All @@ -336,17 +369,17 @@ Use the following steps to install Palette.
![Screenshot of the Palette system console showing Username and Password fields.](/palette_installation_install-on-vmware_palette-system-console.webp)
18. Log in to the system console using the credentials provided in the Enterprise Cluster Details output. After login,
19. Log in to the system console using the credentials provided in the Enterprise Cluster Details output. After login,
you will be prompted to create a new password. Enter a new password and save your changes. You will be redirected to
the Palette system console.
19. After login, a Summary page is displayed. Palette is installed with a self-signed SSL certificate. To assign a
20. After login, a Summary page is displayed. Palette is installed with a self-signed SSL certificate. To assign a
different SSL certificate you must upload the SSL certificate, SSL certificate key, and SSL certificate authority
files to Palette. You can upload the files using the Palette system console. Refer to the
[Configure HTTPS Encryption](../../../system-management/ssl-certificate-management.md) page for instructions on how
to upload the SSL certificate files to Palette.
20. The last step is to start setting up a tenant. To learn how to create a tenant, check out the
21. The last step is to start setting up a tenant. To learn how to create a tenant, check out the
[Tenant Management](../../../system-management/tenant-management.md) guide.
![Screenshot of the Summary page showing where to click Go to Tenant Management button.](/palette_installation_install-on-vmware_goto-tenant-management.webp)
Expand Down
39 changes: 36 additions & 3 deletions docs/docs-content/enterprise-version/install-palette/install-on-vmware/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -290,7 +290,40 @@ Use the following steps to install Palette.
export KUBECONFIG=/ubuntu/.palette/ec/ec-20231012215923/spectro_mgmt.conf
```

17. Log in to the system console using the credentials provided in the Enterprise Cluster Details output. After login,
17. To avoid potential vulnerabilities, once the installation is complete, remove the `kind` images that were installed
in the environment where you initiated the installation.

Issue the following command to list all instances of `kind` that exist in the environment.

```shell
docker images
```

```shell
REPOSITORY TAG IMAGE ID CREATED SIZE
kindest/node v1.26.13 131ad18222cc 5 months ago 910MB
```

Then, use the following command template to remove all instances of `kind`.

```shell
docker image rm kindest/node:<version>
```

Consider the following example for reference.

```shell
docker image rm kindest/node:v1.26.13
```

```shell
Untagged: kindest/node:v1.26.13
Untagged: kindest/node@sha256:15ae92d507b7d4aec6e8920d358fc63d3b980493db191d7327541fbaaed1f789
Deleted: sha256:131ad18222ccb05561b73e86bb09ac3cd6475bb6c36a7f14501067cba2eec785
Deleted: sha256:85a1a4dfc468cfeca99e359b74231e47aedb007a206d0e2cae2f8290e7290cfd
```

18. Log in to the system console using the credentials provided in the Enterprise Cluster Details output. After login,
you will be prompted to create a new password. Enter a new password and save your changes. Refer to the
[password requirements](../../system-management/account-management/credentials.md#password-requirements-and-security)
documentation page to learn more about the password requirements.
Expand All @@ -310,13 +343,13 @@ Use the following steps to install Palette.

![Screenshot of the Palette system console showing Username and Password fields.](/palette_installation_install-on-vmware_palette-system-console.webp)

18. After login, a Summary page is displayed. Palette is installed with a self-signed SSL certificate. To assign a
19. After login, a Summary page is displayed. Palette is installed with a self-signed SSL certificate. To assign a
different SSL certificate you must upload the SSL certificate, SSL certificate key, and SSL certificate authority
files to Palette. You can upload the files using the Palette system console. Refer to the
[Configure HTTPS Encryption](../../system-management/ssl-certificate-management.md) page for instructions on how to
upload the SSL certificate files to Palette.

19. The last step is to start setting up a tenant. To learn how to create a tenant, check out the
20. The last step is to start setting up a tenant. To learn how to create a tenant, check out the
[Tenant Management](../../system-management/tenant-management.md) guide.

![Screenshot of the Summary page showing where to click Go to Tenant Management button.](/palette_installation_install-on-vmware_goto-tenant-management.webp)
Expand Down
43 changes: 43 additions & 0 deletions docs/docs-content/tutorials/cluster-deployment/pcg/deploy-app-pcg.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -257,6 +257,49 @@ You can also track the PCG deployment progress from your terminal. Depending on
environment, the deployment might take up to 30 minutes. Upon completion, the local kind cluster is automatically
deleted from your machine.

:::tip

To avoid potential vulnerabilities, once the installation is complete, remove the `kind` images that were installed in
the environment where you initiated the installation.

<details>

<summary>Remove `kind` Images</summary>

Issue the following command to list all instances of `kind` that exist in the environment.

```shell
docker images
```

```shell
REPOSITORY TAG IMAGE ID CREATED SIZE
kindest/node v1.26.13 131ad18222cc 5 months ago 910MB
```

Then, use the following command template to remove all instances of `kind`.

```shell
docker image rm kindest/node:<version>
```

Consider the following example for reference.

```shell
docker image rm kindest/node:v1.26.13
```

```shell
Untagged: kindest/node:v1.26.13
Untagged: kindest/node@sha256:15ae92d507b7d4aec6e8920d358fc63d3b980493db191d7327541fbaaed1f789
Deleted: sha256:131ad18222ccb05561b73e86bb09ac3cd6475bb6c36a7f14501067cba2eec785
Deleted: sha256:85a1a4dfc468cfeca99e359b74231e47aedb007a206d0e2cae2f8290e7290cfd
```

</details>

:::

![Palette CLI PCG deployment](/clusters_pcg_deploy-app-pcg_pcg-cli.webp)

Next, log in to Palette as a tenant admin. Navigate to the left **Main Menu** and select **Tenant Settings**. Click on
Expand Down
39 changes: 36 additions & 3 deletions ...ntent/vertex/install-palette-vertex/install-on-vmware/airgap-install/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -363,7 +363,40 @@ Use the following steps to install Palette VerteX.
export KUBECONFIG=/ubuntu/.palette/ec/ec-20231012215923/spectro_mgmt.conf
```
18. Log in to the system console using the credentials provided in the Enterprise Cluster Details output. After login,
18. To avoid potential vulnerabilities, once the installation is complete, remove the `kind` images that were installed
in the environment where you initiated the installation.
Issue the following command to list all instances of `kind` that exist in the environment.
```shell
docker images
```
```shell
REPOSITORY TAG IMAGE ID CREATED SIZE
kindest/node v1.26.13 131ad18222cc 5 months ago 910MB
```
Then, use the following command template to remove all instances of `kind`.
```shell
docker image rm kindest/node:<version>
```
Consider the following example for reference.
```shell
docker image rm kindest/node:v1.26.13
```
```shell
Untagged: kindest/node:v1.26.13
Untagged: kindest/node@sha256:15ae92d507b7d4aec6e8920d358fc63d3b980493db191d7327541fbaaed1f789
Deleted: sha256:131ad18222ccb05561b73e86bb09ac3cd6475bb6c36a7f14501067cba2eec785
Deleted: sha256:85a1a4dfc468cfeca99e359b74231e47aedb007a206d0e2cae2f8290e7290cfd
```
19. Log in to the system console using the credentials provided in the Enterprise Cluster Details output. After login,
you will be prompted to create a new password. Enter a new password and save your changes. Refer to the
[password requirements](../../../system-management/account-management/credentials.md#password-requirements-and-security)
documentation page to learn more about the password requirements.
Expand All @@ -383,13 +416,13 @@ Use the following steps to install Palette VerteX.
![Screenshot of the Palette VerteX system console showing Username and Password fields.](/vertex_installation_install-on-vmware_vertex-system-console.webp)
19. After login, a Summary page is displayed. Palette VerteX is installed with a self-signed SSL certificate. To assign
20. After login, a Summary page is displayed. Palette VerteX is installed with a self-signed SSL certificate. To assign
a different SSL certificate you must upload the SSL certificate, SSL certificate key, and SSL certificate authority
files to Palette VerteX. You can upload the files using the Palette VerteX system console. Refer to the
[Configure HTTPS Encryption](/vertex/system-management/ssl-certificate-management) page for instructions on how to
upload the SSL certificate files to Palette VerteX.
20. The last step is to start setting up a tenant. To learn how to create a tenant, check out the
21. The last step is to start setting up a tenant. To learn how to create a tenant, check out the
[Tenant Management](../../../system-management/tenant-management.md) guide.
![Screenshot of the Summary page showing where to click Go to Tenant Management button.](/vertex_installation_install-on-vmware_goto-tenant-management.webp)
Expand Down
Loading